@database "KarmaHelp.Guide"
@author "Christopher Landmark Naas"

@node Main "INDEX"

        @{b}KarmaHelp documentation.
        KarmaHelp is ©1995 Christopher Landmark Naas@{ub}


        @{" Read this first and laugh " Link "FUNSTUFF"}

        @{" What is it?               " Link "N1"}
        @{" Features                  " Link "N2"}
        @{" Installation              " Link "N3"}
        @{" Contacting the author     " Link "N4"}
@ENDNODE

@node FUNSTUFF "Laugh?"

KarmaHelp was created over a period of one big pizza, 1.5 litres of
Coca Cola, the latest Prodigy CD and one freezing drive to get the
pizza. Oh, I nearly forgot one hour on the phone with Kjell Gudim
and a 454 caliber nose crusher. In other words, a couple of hours
effective programming and 3 hours of fun.

KarmaHelp has not been tested on anything other than my custom built
Amiga 4000/040 Black Tower (no, not the wine). If it doesn't work on
your system, please let me know. I think it should work on all Amigas
as long as you run OS2.x or better.

If you have any ideas for improving KarmaHelp, please let me know.

A special thanks to Kjell Gudim for good music, great pizza and
moral support in my hour of need (no, not that kind of need, Thorkild).

Uhm.. nothing more to say, really. Please enjoy the fruits of my labour,
while I relax with some good music and a lovely headache.

Oh, one more thing while you're still there, if you want to, you are
allowed to write "finger christon@powertech.no" at the unix prompt.

Be good, and stay away from that cat, Mathias.

Bye.

@ENDNODE

@node N1 "What is it?"

KarmaHelp is a small commodity that lies dormant until you activate it by
using the CX_POPKEY defined in the program icon. KarmaHelp then scans the
defined HELP: directory (the place you keep all your documentation files,
and creates an AmigaGuide file with entries for all the files found in
the defined HELP: directory, and loads it in the defined AmigaGuide
viewer.

In other words, KarmaHelp pops up an AmigaGuide document with links to
all your documentation files.

@ENDNODE

@node N2 "Features"

KarmaHelp was made to be as small and easy to use as possible, but it
still has several features.

All user definable settings are controlled through the icon tooltypes.
The tooltypes are:


       HELPDIR=<directory name>

HELPDIR is the directory where you keep your documentation files. The
name must end with a / or a :, that is, you must "terminate" the path.
E.g. HELPDIR=HELP:
or   HELPDIR=Sys:Help/


       FONT=<fontname and size>

FONT is the font you wish KarmaHelp to use in the AmigaGuide file it
creates.
E.g. FONT=xen.font 9
or   FONT=topaz.font 8


       GUIDEREADER=<guidereader path and name>

GUIDEREADER is the AmigaGuide viewer you wish to use.
E.g. GUIDEREADER=Sys:Utilities/MultiView
or   GUIDEREADER=Sys:Utilities/AmigaGuide


       CX_POPKEY=<hotkey>

CX_POPKEY is the hotkey you wish to use to pop up the AmigaGuide
document with links to all your documentation files.
E.g. CX_POPKEY=rawkey help
or   CX_POPKEY=rawkey control ralt h


      CX_PRIORITY=<priority>

CX_PRIORITY sets KarmaHelp's CX priority.
E.g. CX_PRIORITY=0
or   CX_PRIORITY=10


      DONOTWAIT

DONOTWAIT is simply there so Workbench won't wait for KarmaHelp to
return when loading.


Every time you open the Master Guide created by KarmaHelp, it will
scan the directory and create a brand new AmigaGuide file. All entries
are alphabetically sorted, and the files' comments are displayed behind
the name of the entry. All filetypes you have a datatype for are supported,
so you can have pictures, soundfiles, amigaguide files, pure ascii files
etc. in your HELP directory.

Just try it and see for yourself. :)

@ENDNODE

@node N3 "Installation"

KarmaHelp is very easy to install. To install it simply follow these
easy steps ;)

1. Drag the KarmaHelp icon into your Sys:WBStartup drawer.
2. Click on the KarmaHelp icon once, and choose "Information" from
   the menu. It is located under the "Icon" heading.
3. Edit the tooltypes to suit your needs.
4. Drag the KarmaHelp.Guide icon in the directory you defined as
   your HELPDIR. Put all other programmes documentation files here
   also.
5. Reboot
6. Use the hotkey you defined, and enjoy.

@ENDNODE

@node N4 "Contacting the author"

If you wish to contact me for any reason, here's how you can do it:

EMail:    christon@powertech.no
Snail M.: Christopher Landmark Naas
          Solveien 3a
          1533 Moss
          Norway
Telep:    +47 69251264
BBS:      +47 69256117 (Username: "Christopher Naas")

Remember, if you use this program, you have to let me know. Either
EMail me or write me a postcard. Source tradable for a CyberVision
graphics card ;)

@ENDNODE