@database guide2html

@node main "guide2html"

  guide2html
  ----------

  Written 1994 by Christian 'Kochtopf' Scholz


  @{" Disclaimer   " link disclaimer}    Please note!
  @{" Introduction " link intro}    What's it ?
  @{" Requirements " link require}    What you need to run
  @{" Usage        " link usage}    How to use it
  @{" Credits      " link Credits}    I have to thank...
  @{" Contact      " link contact}    How to contact me ?

@endnode


@node disclaimer "Disclaimer"
@next intro
@toc main

    guide2html is freeware. Feel free to copy it all over the world.
    It is allowed to put in on any CDROM, especially on one of the FreshFishs.

       THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
    APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
    HOLDER AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
    OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
    THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
    PURPOSE. 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.

       IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
    WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY REDISTRIBUTE THE
    PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
    GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
    USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS
    OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR
    THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
    PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
    POSSIBILITY OF SUCH DAMAGES.

    Short: Use it at your own risk!

@endnode


@node intro "Introduction"
@next require
@prev disclaimer
@toc main

  Introduction
  ------------

  This program will convert Amigaguide-Files into HTML-Documents. 
  It is useful for manuals, which you want to make accessible via 
  WWW or similar things.

@endnode


@node require "Requirements for guide2html"
@next usage
@prev intro
@toc main

  Requirement
  -----------

  There are not so many things. Here a list :

  - an Amiga ;-)

  - OS2.0 or better

  - an Amigaguide-File to convert

  - perhaps an HTML-Browser to view the result (AMosaic)

  - Stack of at least 9000 Bytes!!

@endnode



@node usage "Usage of guide2html"
@next credits
@prev require
@toc main

  Usage
  -----

  That's really easy.
  Here is how you have to call the program (it works only from
  CLI, btw.)

  guide2html File/A A=ARROWS/S


  File   : Just supply the name of the Amigaguide-File you want to convert.
           The HMTL-Files will be created in the same directory.

  ARROWS : If the Amigaguide-File includes @NEXT, @PREV and @TOC-Commands,
           they will be converted to arrows. The images of these must be
           in an directory called 'pics' in the upper directory.
           So the path to the arrows will be '../pics/'. Your directory
           structure should look like @{"this" link directory}.

           If you do not want arrows, just do not supply this keyword.

  That's all!

  (remember to set stack to 9000)

@endnode


@node directory "The directory structure"
@toc usage

  The directory structure
  -----------------------

  If you want to convert more than one guide-file and want to use arrows you
  should use a structure like this :

      pics/ArrowRight.gif
           ArrowLeft.gif
           ArrowUp.gif
      guide1/MAIN.html
             BLAH1.html
      guide2/MAIN.html
             BLAH2.html
             .
             .
             .

  So if you convert the first guide-file you change to guide1 and invoke 
  guide2html. Then change to guide2, etc.

@endnode


@node credits "Credits"
@next contact
@prev usage
@toc main

  Credits
  -------

  I have to thank the following people :

  - Andreas Harrenberg for testing and debugging at the meeting in Ulm
  - Bernhard Möllemann for writing the a2hex-routine and testing.
  - Kai Hofmann for bugfixing

  and my beta testers :

  - Michael van Elst
  - Bernd Ernesti
  - Michael Bauer
  - Bernhard Scholz

  That's enough for such a little program ;-)

@endnode



@node contact "How to contact the author"
@prev credits
@toc main

  How to contact the author
  -------------------------

  Just write to one of the following adresses :

  Mail :

    Christian Scholz
    Adalbertstr. 67a
    52062 Aachen
    Germany

  EMail :

    ruebe@pool.informatik.rwth-aachen.de or
    kochtopf@tornado.oche.de

  IRC :

    kochtopf @ #amigager

  HTTP :

    http://www-users.informatik.rwth-aachen.de/~ruebe/


@endnode