============================================================================

                            FX2HT V0.10b - Beta.
                      FishXref to AmigaGuide converter.

                                   and

                            FC2HT V0.10b - Beta.
                      FishCon to AmigaGuide converter.

                                   both

             Copyright ©1993 Barry Wills.  All rights reserved.


============================================================================


DISTRIBUTION.
~~~~~~~~~~~~
   This product may be freely distributed under the following restrictions:

   1.  The complete contents of the original archive must remain intact.
   2.  The original material may in no way be modified.
   3.  This product may not be distributed for profit.  A nominal copying
       fee is authorized (for cost of materials and shipping and handling
       comparable to that charged by Fred Fish.)
   4.  Commercial distribution of this product without written permission
       from the author is forbidden.



USE OF THIS PRODUCT.
~~~~~~~~~~~~~~~~~~~
   This product may be used under the following restrictions:

   1.  Non-commercial use of this product is free of charge.
   2.  Commercial use of this product without written permission from the
       author is forbidden.  This includes shareware.
   3.  Honorable mention of the author and product must be included in the
       client documentation (non-commercial and licensed-commercial.)
   4.  This product may not be used for malicious intent.



DISCLAIMER.
~~~~~~~~~~
   This product is provided without any warranty, express or implied.  The
   user of this product assumes full responsibility for any damage resulting
   from the use and/or misuse of this product.



CONTENTS.
~~~~~~~~
   This archive should contain the following files:

     FX2HT        - Executable V0.10b.
     FC2HT        - Executable V0.10b.
     FD2HT        - Executable V0.10b.
     Fish2HT.doc  - Copyright notice and product information (this file).
     Fishcon.txt  - Short program description.
     FishXref.guide.info -
                    Amigaguide project icon for for FishXref.guide (an end
                    product of the utility FX2HT.)
     FishDisks.guide.info -
                    Amigaguide project icon for for FishDisks.guide (the end
                    product of the utility FD2HT.)


============================================================================


REQUIREMENTS.
~~~~~~~~~~~~
   An Amiga with the minimum configuration.  These programs should not be
   KickStart sensitive.  Of course, you will also need Commodore's Amigaguide
   and the latest (preferably) of Fred Fish's FishXref and any or all of Fred
   Fish's FishCon files, all of which may be obtained via public distribution
   channels.



DESCRIPTION.
~~~~~~~~~~~
   FX2HT.
   ~~~~~
   This utility reads in a text file using the format conventions of Fred
   Fish's Amiga software library cross-reference and converts the contents
   into a form usable by Commodore's hypertext program, Amigaguide.  The end
   product of this program are the following text files:

     FishXref.guide - This contains Amigaguide definitions for links to the
                      following files:

     '.guide,
     0.guide thru 9.guide, and
     A.guide thru Z.guide - These files contain the actual FishXref entries
                      (individual files for faster loading and lower memory
                      consumption) and the links into the disk listings in
                      the FishCon-###.guide text files produced by FC2HT.  As
                      you might imagine, "'.guide" contains all program
                      entries whose names begin with "'", likewise for
                      "0.guide" through "Z.guide".


   FC2HT.
   ~~~~~
     This utility eats the FishCon-### files, splitting up the disks into
     individual nodes which are accessible via the above files.  The FishCon
     files each remains a single file.


   FD2HT.
   ~~~~~
     This utility creates an Amigaguide hypertext document that links into
     the Fish Disk entries.  The buttons are arranged by ten:  001, 010, 020,
     030...990.  For those who just like to browse the disks.


USAGE.
~~~~~
  "Good God!" you exclaim, "this must require alot of work!"  The answer is
  "Yes," but not for you.  To begin the conversion make the following DOS
  assignment in the CLI (or in your Startup-Sequence):

    Assign FISHCON: DH0:FishCon ;or wherever you keep the fishes.

  (This assignment is *required* for Amigaguide to work with the hypertext
  database, but the conversion utilities aren't finicky.)  Make sure FX2HT
  and FC2HT are in the current directory or in your path.  Then type:

    FX2HT FISHCON:FishXref-800 ;800 just happens to be the latest version
                               ; that I have.

  FX2HT will keep you informed of progress.  Where FX2HT gets the file is
  where it's going to put the end product, so be careful not overwrite files
  you want to keep.  See above for names of files produced.

  Now, for each FishCon-### file that you have you must type:

    FC2HT FISHCON:FishCon-### ;where ### is the series number of the file.

  Just like FX2HT, FC2HT will keep you informed of its progress.  Unlike
  FX2HT, you will only get one output file from each run.

  Almost done.  Now type in the CLI:

    FD2HT ;this generates the hypertext file that lets you get at the disk
          ; entries so you can browse through them.

  Finally, copy the FishXref.guide.info and FishDisks.guide.info icon files
  into the FISHCON: directory (or put FishXref.guide and FishDisks.guide and
  their icons anywhere that Workbench can access), make sure Amigaguide is
  correctly installed, and CLICK AWAY!!!

  Hah-hah-haaaah!  Happy Fishing!  Fish fans will absolutely love it!!!



OTHER CONSIDERATIONS.
~~~~~~~~~~~~~~~~~~~~
  I wrote this program with the intention that it would be compatible with
  Fish docs up through disk 9999.  This has NOT been tested though, so when
  we reach disk 1000 (which will occur in the very near future) these
  utilities may break!  Don't discard your old Xrefs and Cons until you're
  sure the new ones work!!!

  FD2HT was a very quick hack and it only accomodates up through disk 999.
  Maybe in the next release I'll implement command-line args to let you
  specify how many buttons to create.



HISTORY.
~~~~~~~
  V0.10b - Released 23 May 93.
  ~~~~~~


============================================================================


MISCELLANEOUS.
~~~~~~~~~~~~~
This product was developed in Amiga E language and tested on a Commodore
Amiga 500 with the following configuration:

   KickStart V1.3, WorkBench V1.3, ©Commodore-Amiga, Inc.
   Amiga E V2.1, ©Wouter van Oortmerssen
   AZ V1.50, ©Jean-Michel Forgeas
   Amigaguide(Trademark) V34, ©David N. Junod

   DataFlyer 500 SCSI controller
   Quantum 52M HD
   Dual 880K floppy drive
   1M 16-bit Chip RAM
   CSA Derringer 030 accellerator:
      68030 CPU @25MHz
      68881 FPU @27MHz
      4M 32-bit Fast RAM


============================================================================


CREDITS.
~~~~~~~
Special thanks go to:

  · Wouter van Oortmerssen for Amiga E!

  · Jean-Michel Forgeas and The Software Winery for their AZ text editor!

  · David N. Junod and Commodore-Amiga, Inc. for Amigaguide!

  · And last, but certainly not least, thanks to Fred Fish for his dedication
    to preserving such a huge (the hugest?) library of PD and Shareware
    titles.



============================================================================


CONTACTING THE AUTHOR.
~~~~~~~~~~~~~~~~~~~~~
I can be reached by the following means:

  Internet:  bwills@enterprise.safb.af.mil

  USnail:    Barry Wills
             5528D Pryor Dr.
             Scott AFB, IL 62225 (USA)
             (618)-744-1096

I wrote this for my own use, but I hope you get as much use out of it as I
do.  Send mail, money, software, warm weather to the address(es) above.  I
am very interested in feedback; I will answer all mail.  Good luck and
enjoy!

  -- Barry



P.S. - If you send money (huh?) only send a buck or two, cash!  This is *NOT*
obligatory, but it would be nice to hear that someone appreciates my work
(a post-card, a hello on the net...?)
