TkMapedit 2.1 Hand Book

1. REQUIREMENTS
2. FUNCTIONS
3. INSTALL
4. WINDOW OVERVIEW
5. MENUS
6. CANVAS
7. CONFIGURATION
8. FAQ

• Software Requirements ---

  Tcl7.4/ Tk4.0 or later (*MUST*)

  TkMapedit is written as Tcl script. So You need its interpreter.

  "Postscript Generation for Images in Canvases"patch (*MAY BE*)

  Original Tk can not print out any image on canvas widget. If you want to print out with background GIF image, you must apply Henry Rowley <har@cs.cmu.edu>'s this good patch.

• Hardware Requirements ---
  Unix box with X window system (X11R4 or later).
  Windows NT/95/3.1(with win32s) and WIN-OS2 version will coming soon. Actually, current one contains some code for these environments. but I think it will not work fine. I must do more debugging. Mac version is still under going. I have a problem that I can not understand mac's wizard-full file system!

• Read an image file in *.xbm/*.ppm/*.gif format. if you wish to support *.xpm format, use Tix extension.
• Read and Write in a CERN, NCSA, Netscape NetSite, ClientSideMap format map file. you can read CERN map file and write down it using ClientSideMap format.
• create, move, edit, copy, cut/paste, delete, resize/reshape, and fore/back the following objects:
  • circle
  • rectangle
  • polygon
  • point (CERN/NCSA only)
• edit URL and ALT (ClientSideMap only) attributes on these objects.
• display objects on top of the image. and you can hide them.
• interactively test the validity of all URL's associated with objects and default. you can use Netscape 2.x, SurfIt!, and tkWWW as W3 browser.

INSTALL:

1. extract tkmapedit distribution as following:

   % gzcat tkmapedit-2.1.tar.gz | tar xvf -

   and enter tkmapedit directory:

   % cd tkmapedit-2.1

2. run install script as following:

   % wish4.1 install.tcl

   or

   % wish4.0 install.tcl

3. the install script will display following window:
   then, fill out forms as following:
   1. "directory" forms:
      
      

      bin dir:

      Lets you enter a directory path where execution file will be installed.

      lib dir:

      Lets you enter a directory path where library and icon files will be installed. tkmapedit-2.1 use following path hierarchy:

      $libdir/lib  - tcl library files
             /icon - icon (xbm and ppm formats)

      resource dir:

      Lets you enter a directory path where resource file will be installed. the resource file is used for configuration. for more detail, see configuration section.

   2. "doc URL" form:
      
      Lets you enter a URL of documentation for tkmapedit2.1. default URL is

      http://www.ifnet.or.jp/~translator/tools/TkMapedit/

      This is a official URL for tkmapedit. But this means you have to access the INTERNET when you want to view a help message. I think this is *NOT* good for some peoples using DialUp-PPP connection. Don't worry! you've already everything for tkmapedit. *This* document is one. So you can enter as following:

      file:/Where/You/Extract/tkmapedit-2.1/doc/index.html

   3. "path hierarchy" forms:
      
      Lets your enter your http server's path hierarchy for HTML docs. This is for Util menu.

      server top dir:

      If URL which associated with some object on canvas takes "http://Server/path/..." form, and you wish to edit its file entry, tkmapedit will substitute contents of this form for "http://Server/", and launch your editor.

      public html dir:

      If URL contains "~YourLoginName", tkmapedit will substitute "$HOME/ContantsOfThisForm". "public_html" is used in many site.

      welcome file name:

      If URL is any directory path, then tkmapedit will add contents of this form to the URL. Many site use "index.html". but some site use "welcome.html". for more detail, please ask your web master, or your admin.

   4. default map format form:
      
      choices default map format.
   5. WWW Utils forms:
      
      

      WWW Viewer:

      choices your WWW browser which tkmapedit will launch.

      WWW Editor:

      choices your HTML editor which tkmapedit will launch.

      you can use another browser and/or editor. see configuration section.
   6. Icon forms:
      
      Try this default setting, install, execute tkmapedit, iconic it, and move mouse cursor to tkmapedit icon;-)
   Next, you must compile and install tkmapedit.
   
   Firstly, click "Compile" button. Actually, tkmapedit doesn't need any compiler. but some file needs rewriting to reflect your settings. So installer itself do this. the installer will rewrite some tcl files, and generate minimum resource file. Secondly, click "install" button. the installer will copy tkmapedit files. Then instlation done! click "Dismiss" button. Now, you can execute tkmapedit as following:

          % tkmped2 &

   or

          % tkmped2 YourMapFileName&

WINDOW OVERVIEW

MENUS

File Menu

provides following menu item.

1. New
   Clear canvas. and initialize all.
2. load Mapfile...
   Produces the FileSelectionBox that lets you select a map file and its format to load.
3. load Imagefile...
   Produces FileSelectionBox that lets you select a image file to load.
4. Save mapfile
   Save map data to current map file. If current map file name is empty, tkmapedit will produces the FileSelectionBox.
5. save mapfile As...
   Produces FileSelectionBox that lets you select a map file name and map format to save.
6. save imageFile as...
   Produces FileSelectionBox that lets you select a image file name and its format to save.
7. Print...
   Produces following print dialog:
   
   This print dialog provide following function.

   select target

   Lets you select a target, PS file or PS Printer.

   lpr command

   Lets you enter a lpr command line. tkmapedit refer "PRINTER" environment variable.

   file name

   Lets you enter a PS filename. FileSelectionBox is available.

   page layouts

   Lets you choice page layouts.

   Print button

   generates PS Data, and send it to printer OR save as a file.

   Dismiss button

   closes Print dialog.

8. Exit
   exits tkmapedit.

Edit Menu

provides following menu items.

1. Delete
   deletes selected object on the canvas.
2. Cut
   cuts selected object on the canvas and save it to cut buffer.
3. cOpy
   copy selected object to cut buffer.
4. Paste
   pasts a contents of cut buffer to the canvas.
5. Fore item
   puts the selected object to top of them.
6. Back item
   puts the selected object to bottom of them.
7. Raise image
8. Lower image

View

provides following menu items.

1. Fill
   selects set/unset fill mode.

provides following menu items.

1. editor
   selects "launch editor" mode. In this mode, If you click any object on the canvas, then tkmapedit will launch a editor to edit the file which associated the object by URL.
2. viewer
   select "launch viewer" mode. In this mode, If you click any object on the canvas, then tkmapedit will launch a WWW browser to browse the URL which associated the object.
3. clear
   clear any launch mode.

Help

provides following menu items.

1. About
   display version and patch level.
2. Handbook
   display this documents using your web browser.

CANVAS

url and alt forms

Lets you enter URL and/or ALT attribute which will be associated to the selected item.

select button

enters "select mode". In this mode, you can select any item on the canvas.

circle, rectangle, polygon, and point button

draw each item.

IMPORTANT

point object is only supported in CERN/NCSA format. this means you can not save this object using NetSite or ClientSideMap format.

ALT attribute is only supported in ClientSideMap format.

File Selection Box

CONFIGURATION

FAQ