@database "mapPlug English Guide"
@wordwrap
@author "Esteve Boix"
@remark "$VER: mapPlug v1.1 English Help Guide Guide 1.1 (20 Jun 98)"

@node MAIN "Welcome"

@{b}mapPlug v1.1@{ub}
An HTML client side image map editor

  What is @{"new" link new} in this version

©1998 Esteve Boix

  @{" Introduction " link introduction}
  @{" Requeriments " link require}
  @{" Features " link features}

  @{" Using mapPlug " link using}
  @{" Registering " link reg}
  @{" Getting mapPlug " link get}

  @{" Greetings " link gre}
  @{" The future " link future}

@endnode

@node INTRODUCTION "Introduction to mapPlug"

@{b}@{u}Introduction to mapPlug@{uu}@{ub}

mapPlug is a MUI-based program that will help you to create client side HTML image maps.

An image map in HTML is a way to define "hot spots" in an image. Clicking them will bring you to a new page in the browser. For example:

<img src="test.png" width="400" height="300" border="0" alt="Map test :)" usemap="#map">
<map name="map">
    <area shape="poly" href="0.htm" coords="41, 139, 37, 161, 50, 185, 90, 190, 88, 163, 64, 148">
    <area shape="rect" href="1.htm" coords="10,10,390,60">
    <area shape="rect" href="2.htm" coords="10,70,390,120">
</map>

This code tells the browser to display an image that has two hotspots, two rectangular shapes defined by the coordinates given by each <area> tag.

As you can see, it's a kind of mess. It's even worse when you're not dealing with rectangular shapes, but circles or even multi point polygons.

mapPlug offers a simple way to do this. You load the image (using the AmigaOS v3+ datatype system, so any format for which a datatype exists can be loaded) and draw the shapes with the mouse directly over it. Once defined, the shapes are fully editable (you can move them or resize them for example), so you can adjust them to your needs without having to deal with coordinates.
From v1.1+, mapPlug offers a zoom function, so you can view the image with more detail to adjust the shapes.
You have two string gadgets where you can set the href parameter (i.e., where does the hot-spot point) and the alt parameter (the alternate text for non graphical browsers).
@endnode

@node FEATURES "Features"

@{b}@{u}mapPlug's features@{uu}@{ub}

Here goes an small list of features:

- Map creation completely GUI driven, very easy to use

- Shapes (rectangles, circles and polygons) are *fully* editable once created

- Zoom upto 16x.

- mapPlug's window is an AppWindow. Simply drag an image icon on it and it will be loaded and displayed, ready to be mapped.

- Support for CyberGraphX/P96's v43 datatype (thus working on high/truecolor bitmaps in high/truecolor screens)

- Correct handling of @{"relative dirs" link reldir}

- Maps can be saved into a text file or copied into the clipboard
@endnode

@node RELDIR "Relative directories"

@{b}@{u}Relative dirs@{uu}@{ub}

Relative dirs are an important concept in HTML docs creation. Here goes an small (and I hope helpfull) explanation.

When creating a new web site, usually all the file references (in images, links or whatever) are done relative to an absolute path. For example, imagine the following directory tree:

Work:

    MySite (dir)

        index.html

        concept.html

        images (dir)

            page.html

            myimage1.png

            myimage2.png

            myimage3.png

Ok.

You create the file 'index.html', and you want to make a link to 'concept.html'. Since they are in the same dir, there is not need to specify the full path for 'concept.html'. The link would look like:

    <a href="concept.html">Link</a>

For example, a link from 'index.html' to 'page.html' (which resides in 'images') would look like:

    <a href="images/page.html">Link</a>

A different case is when you want to link from 'page.html' to 'index.html', which resides one level up. This link would be:

    <a href="../index.html'>Link to index</a>

Note the '../', that tells the browser to search the linked document one level up from the current directory.

Uf.... I hope I've explained myself :)

Well... mapPlug handles all this cases correctly (I hope). The only thing you have to do is take care to specify the path from where mapPlug should create the relative links. It may or it may not be the same directory of the image you're mapping. Take this into consideration when creating your map.

@endnode

@node REQUIRE "What do I need ?"

@{b}@{u}What do I need ?@{uu}@{ub}

In order to run mapPlug, you need:

- An Amiga (or compatible :) computer with at least AmigaOS v3.0.

- MUI 3.8 correctly installed.

- BetterString.mcc (included)
  BetterString.mcc is © 1997 Allan Odgaard (duff@DIKU.DK, http://www.diku.dk/students/duff).

- The datatypes for the images you plan to load (usually JPEG or PNG... You do use PNG, don't you ?).

- mapPlug works better in an 1:1 screen resolution like Multiscan or DblPal. Anyway, it will work on a PAL 640x256 screen (you'll see that some buttons are not visible due to space limitations).

- Some maps to create :)
@endnode

@node USING "Using mapPlug"

@{b}@{u}Using mapPlug@{uu}@{ub}

mapPlug has only one window which contains nearly all the options of the program.

The program is (I hope) intuitive and easy to use, but anyway here goes a little description of each option:

@{b}Export to clip:@{ub}

    Saves the current map into the clipboard,so you'll be able to insert the map into any text editor by simply pasting it.

@{b}Export to file:@{ub}

    Pops up an ASL requester, so you can specify an ASCII file where mapPlug will save the current map.

@{b}Reference dir:@{ub}

    All the relative directories are created with this base path. It's automatically set to the current image dir, but of course you can change it whenever you want.
    It should be the dir where the HTML file that will contain the map resides.
    Take a look at @{"relative dirs" link reldir} section.

@{b}Image file:@{ub}

    This is the current image. Whenever you specify a new image, the current map will be cleared (note that clearing the image currently deletes all the shapes) and the image will be loaded into mapPlug.
    The reference dir will be also automatically set to the image dir.

@{b}Alt:@{ub}

    Alternative text for the image for non-graphical browsers. It's a good idea to set it.

@{b}Map name:@{ub}

    This is the name that will identify the map in the HTML code. You should set it before exporting the map (mapPlug will remind this to you :)

@{b}Toolbar:@{ub}

    The toolbar contains the icons that gives access to mapPlug's visual map editor. From top to bottom:

    @{u}New rectangle:@{uu}

        Creates a new rectangular shape. Click over the image where you want it to start, and then click where you want it to end :)
        Pressing "Return" finishes the shape.
        Pressing "Space" cancels the creation process and deletes the shape.

    @{u}New circular shape:@{uu}

        Creates a new circular shape. Click over the image where you want it the center, and then specify the radius.
        Pressing "Return" finishes the shape.
        Pressing "Space" cancels the creation process and deletes the shape.

    @{u}New poly shape:@{uu}

        Creates a new polygonal shape. The maximum number of points is hardcoded to 100 (which should be enough for every one, but this is likely to change in newer versions... Hardcoded limits ? Why ?!?! :).
        Just click where you want new point to be created, and press "Return" (or doubleclick) when finished.
        Pressing "Space" cancels the creation process and deletes the shape.

    @{u}Move Mode (Key "M"):@{uu}

        Clicking any point of a shape and dragging the mouse will make the shape move following the mouse.

    @{u}Edit Mode (Key "S"):@{uu}

        Clicking any point of a shape and dragging the mouse will make this point move following the mouse.

    @{u}Delete shape (Key "Backspace"):@{uu}

        Obvious (isn't it ???).
        Please note that there is no "undo" function yet.

    @{u}Zoom in (RAmiga+","):@{uu}

        Zooms into the image. You can use the menus, too.

    @{u}Zoom out (RAmiga+"."):@{uu}

        Zooms out the image.

@{b}HRef:@{ub}

    This is where should the current shape point. It's automatically set to the image's directory.

@{b}Alt:@{ub}

    Alternative text for this shape for non-graphical browsers, such as Lynx. It's a good idea to set it :)
@endnode

@node REG "Registering mapPlug"

@{b}@{u}Registering mapPlug@{uu}@{ub}

mapPlug is released as shareware. This means that you're allowed to use the program for a trial period of two weeks. If you decide that mapPlug fits you needs and that you'll continue using it, you'll have to register it.

The fee is @{b}just US $10@{ub}.

The program is not fully functional until it's not registered (sorry). The non-registered version will not handle more than 4 shapes, the maximum number of points per shape is 10, is not able to copy the map into the clipboard. Again, mapPlug is not expensive, so please if you use it and like it register it to help the development of this and more products.

You can send the fees to:

Esteve Boix Sánchez
Av.Bases de Manresa 14 1-1a
08240 Manresa (BCN)
Spain

Use the method you prefer, but please (please please) make sure that I have no costs in getting the money. If you send a cheque, add the necessary amount of money to cover all the costs. I will NOT ACCEPT registrations that don't follow this rule.

If you prefer it, you can registrer thorugh one of the following reg-sites.
Contact them for currency exchanges and so:

@{b}UK:@{ub}
  Paul Compton
  36 Priory Road
  Fareham
  Hants PO15 5HT
  UK

  You can call his Bulletin Board System (BBS):

    Elevate BBS     +44 (0) 1329319028

  Write a netmail to the following address:

    2:251/18.0@Fidonet

  EMail: pwcomp@elevate.demon.co.uk
  URL: http://www.elevate.demon.co.uk

@{b}Germany:@{ub}
  Ferst Computer
  Köpenicker St. 11
  15537 Gosen
  Tel. 03362/82 00 97
  Fax. 03362/88 29 88

  EMail: ferst@t-online.de
  URL: http://www.ferst.com

@{b}Canada:@{ub}
  Tristan R. Young
  Apt 506, 2240 Halifax Dr.
  Otawa, Ontario, Canada
  K1G 2W8

  EMail: tyoung@netrover.com (Subject: webPlug/mapPlug registration)
  URL: http://www.netrover.com/~tyoung

@endnode

@node GET "Getting mapPlug"

@{b}@{u}Getting mapPlug@{uu}@{ub}

I will always upload the latest version of mapPlug to Aminet.

You can also get it from my homepage (along with some other programs I've written). Registered users will be notified by email about new updates.

http://www2.minorisa.es/~stv

If you have any questions, don't hesitate to drop me a mail:

stv@minorisa.es

@endnode

@node GRE "Greetings"

@{b}@{u}Greetings@{uu}@{ub}

I would like to thank:

- All the people that have registered this and my other programs, for their continued support and suggestions.

- My brave betatesters team: Victor Carceler, Victor Garcia, Fredrik Zetterlund, Christian Kemp, Angel Alvarez, Phllip Goddard.

- My girlfriend (:D), for all her patience...

All you made me feel that programming the Amiga is more than fun

This program has been completely developed using the AmigaE compiler v3.3a from Wouter van Oortmerssen, and requires MUI (© Stefan Stuntz) and the BetterString.mcc (from Allan Oodgard, thank you again).
@endnode

@node FUTURE "Future"

@{b}@{u}mapPlug's todos@{uu}@{ub}

mapPlug is not a finished product... I'll continue working on it (if there is interest, of course). Here goes a list of ideas:

- Integration with webPlug. This is the second most requested feature (well... now that zoom is here, this becomes the first one). I'm working on it, but you'll have to wait for new versions of both programs.

- More editing tools

- Undo function

- Locale support

- Improve redrawing routines (the speedup will be mostly noticeable on AGA systems).

- Rexx port

The list is longer (actually quite longer). Just register and wait :)

I'm waiting your suggestions.
@endnode

@node NEW "New"

@{b}@{u}mapPlug's new features@{uu}@{ub}

- Zoom option ! At last :) This was one of the Most Requested Features (tm).
  You can zoom into the picture a maximum of 16 times, which should be enough for every one (isn't it ?).

- Added a preferences window. From it you can modify the color for the grid, the color for the shapes, and from which zoom level mapPlug should render the grid over the image.

- Although 'circ' should be accepted as a valid shape, seems that some browsers doesn't like it, so now mapPlug exports 'circle' instead of 'circ'.

- Before loading a new pic, the current one is cleared, hiding all the pen changes in CLUT screen modes.

- Reduced some (useless) blits when loading a new pic. This was specially noticeable on AGA systems. Now mapPlug shows the loaded image directly.

- Added 'Del' as a shortcut for deleting a shape (you can also use backspace as in v1.0).

- Added more 'sanity checks' into the code.
@endnode