@database T.H.E.
@$VER: THE.guide 1.3 (25.12.99) © by Nils Görs <nils@goers.line.org>

@node main "T.H.E. manual"

                      Workbench Tools-Menu and Hotkey Editor

@{" What is T.H.E.? " link Overview}
@{" Copyright and Warranty " link Copyright}
@{" Requirements " link Requirements}
@{" Installation " link Installation}
@{" known Bugs " link knownErrors}
@{" Usage " link usage}
@{" Arexx commands " link arexx}
@{" Thanks " link thanks}
@{" History " link History 9999}
@{" FAQ " link FAQ}


        Nils Görs
        Kaiserstr.97a
        42329 Wuppertal

        Germany

EMail:  nils\@goers.line.org
T.H.E. is MAILWARE and copyrighted © 1999 by Nils Görs.
No commercial use without perimission of the author. Read the @{"copyright" link Copyright} !
@endnode

@node Overview "What is T.H.E."

T.H.E. is an editor for two new functions supported by workbench.library.
Now it is possible to add, delete and to edit Hotkeys and the Workbench
Tools-Menu via Workbench itself.
@endnode

@node Requirements

To use T.H.E. you need the following things:

- OS3.5
  `->	CD-ROM
	Harddisk
	68020 processor or better
	Amiga 3.1 ROMs
	4 MB FastRAM

- AWNPipe 2.22 or newer. (developed with this archiv)
@endnode

@node Installation

Simply use the installer script.
@endnode

@node knownErrors "known Bugs"

During programming T.H.E. i recognized some bugs in ClassAction/ReAction classes.

- If you choose an entry from the Tools-Menu listview, the shortcut will not be
  used in the stringgadget.
* Since awnpipe-handler v2.22 a workaround is included. - Thank you Bill!

- If you "add" a new entry to the listview the stringgadget will not be activated
  automatically.  This could force a system-crash under special circumstances.

@endnode


@node Copyright

This License applies to the computer programs known as "T.H.E.".
The "Program", below, refers to such program.


The programs and files in this distribution are freely distributable
under the restrictions stated below, but are also Copyright (c) Nils Görs.


Distribution of the Program by a commercial organization without written
permission from the author to any third party is prohibited if any payment
is made in connection with such distribution, whether directly
(as in payment for a copy of the Program) or indirectly (as in payment
for some service related to the Program, or payment for some product
or service that includes a copy of the Program "without charge";
these are only examples, and not an exhaustive enumeration of prohibited
activities). However, the following methods of distribution involving
payment shall not in and of themselves be a violation of this restriction:


(i) Posting the Program on a public access information storage and
retrieval service for which a fee is received for retrieving information
(such as an on-line service), provided that the fee is not
content-dependent (i.e., the fee would be the same for retrieving the same
volume of information consisting of random data).


(ii) Distributing the Program on a CD-ROM, provided that the files
containing the Program are reproduced entirely and verbatim on such
CD-ROM, and provided further that all information on such CD-ROM be
redistributable for non-commercial purposes without charge.


Everything in this distribution must be kept together, in original
and unmodified form.


THE PROGRAM IS PROVIDED TO YOU "AS IS," WITHOUT WARRANTY. THERE IS NO
WARRANTY FOR THE PROGRAM, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS. THE ENTIRE
RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD
THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY
SERVICING, REPAIR OR CORRECTION.


IF YOU DO NOT ACCEPT THIS LICENCE, YOU MUST DELETE ALL FILES CONTAINED IN
THIS ARCHIVE.
@endnode

@node Usage

The GUI
-------

The pagegadget swaps from Tools-Menu to Hotkey editor. You can use the [TAB] key
to swap between both listviews.

Listview displaying the entries from either Tools-Menu or Hotkey functions. You can
walk trough the list with the cursor keys. To jump to the top of the listview press
[Home] and to jump to the buttom use [End] key.


Add		- add a new command to the listview. The new entry will be placed
		  below the cursor.
Remove		- removes the selected entry.
Duplicate	- will create a new entry with exactly the same options of the entry
		  where the cursor is placed on.
Up		- the selected entry one position up.
Down		- the selected entry one position down.

To add a seperator line choose a name you like and use in the title stringgadget an
"-", "~" or "_" (without ""), thats it.

Please don't use spaces in drawer nor filenames. I only implement a basic
identification routine to check for arguments.


The Configfile
--------------
T.H.E. creates an ARexx-script that will be placed in WBStartup-drawer. During boot-up
this script will install the Hotkey commands and/or the Tools-Menu.
@endnode

@node arexx
Since v1.1 T.H.E. offers an ARexx host under the name of "T.H.E.". It supports
some commands as will be described below.

1. UNICONIFY

If the T.H.E. window is iconified it will be pop up.


2. ICONIFY

iconify the T.H.E. window.


3. QUIT

will quit T.H.E. @{b}without@{ub} a requester.


4. ACTIVATE

activates the T.H.E. window.


5. FRONT				(v1.3)

window to front.


6. BACK					(v1.3)

window to back.
@endnode

@node thanks "Thank you"

I have to thank:

William Parker	- for the support and the help with AWNPipe.

Oliver Tacke	- for the quick support of fab Icons.

Kurt Berghaus 	- he had the idea for localisation when he saw a snapshot
		  with an english GUI.

@{"Ynot7" link /ynot7.jpg/MAIN}		- for the very fab thai rock music i heard during
		  T.H.E. development ("rUang kii mah").

and i have to thank you to the following people for translating
the catalog (alphabetically sorted by country!):
- Vit Sindlar
- Jacob Laursen
- Alfredo Soro
- Hervé Dupont
- Andrea Monni & Marco De Vitis
- Guno Heitman
- Mario Gonzalez
- Alfredo Martins
- Jari Komulainen

@endnode

@node FAQ "frequently asked questions"

Q: How can i start an external (shell) program without using startexe.rexx?
A: I wrote startexe.rexx to simplify the usage of shell programs. If you
   prefer to start shell programs directly delete the Command String-Gadget
   and use the Argument String-Gagdet as command line:

   'address command ''<program>'''
   Example: 'address command ''WBRun StackSnoop'''


Q: I would like to send an ARexx command to another port, possible?
A: Yes, nothing easier than this. Delete the Command String-Gadget and use
   the argument String-Gadget instead:

   'address ''hostname'' <Arexx command>'
   Example: 'address ''ZPoint'' BOARDMENU'


Q: How can i make use of the ARexx-Port from Workbench?
A: Again, delete the Command String-Gadget and use the Argument
   String-Gadget:

   '<ARexx command>'
   Example:  'MENU INVOKE WORKBENCH.ABOUT'


Q: It is possible to give an Menu-entry, for example "Snapshot all" a
   shortcut with T.H.E.?
A: No it's not possible. You can only change the Tools-Menu but you can
   call every menu function from a Hotkey or you can create a new entry
   to Tools-Menu:

   'options results; GETATTR OBJECT WINDOWS.ACTIVE; MENU WINDOW result INVOKE WINDOW.SNAPSHOT.ALL'
@endnode

@node History

v0.1 - v0.10	: - internal versions -

v1.0		: - first public release -

v1.1		: - @{"Arexx-Port" link arexx} added.
		  - Bug in argument parsing removed, which could
		    force the script to exit.
		  - Bug removed that forced troubles when removing
		    an entry with spaces.
		  - When adding a new entry it will be placed under
		    the entry-cursor.
		  - new "Duplicate" button added.
		  - cursor movements implemented.
		  - [TAB], [Home] and [End] keys are supported.
		  - behaviour of buttons changed completly.
		  - GUI will be locked under special circumstances.
		  - improved argument parsing.
		  - smaller optimizations.
		  - standard language is not part of the main program.
		    THE.strings is not necessary anymore.
		  - more predefined Hotkeys (f-keys).
v1.2		  - I forget to close the used catalog! (herve dupont)
		  - The catalog file will be searched in PROGDIR: too (herve dupont)
		  - It is possible to switch off the horizontal lines in
		    listview gadget (herve dupont)
		  - small internal changes.
v1.3		  - new @{"ARexx" link arexx}-Commands.
@endnode
