@DATABASE MP32HTMLv2.GUIDE
@AUTHOR Gareth Griffiths

@NODE Main "MP3-2-HTML v2.1 Documentation"
   
   MP3-2-HTML v2.1
   Documentation.
   
   Program and Documentation written by Gareth Griffiths.
      E.Mail:  @{FG HIGHLIGHT}gazchap@btinternet.com@{FG TEXT}
      Website: @{FG HIGHLIGHT}http://www.gazchap.co.uk@{FG TEXT}
   
   
   
   @{" Introduction                 " LINK Introduction}
   @{" Distribution Notice          " LINK Distribution}

   @{" Requirements                 " LINK Requirements}
   @{" Installation                 " LINK Installation}

   @{" Using MP3-2-HTML             " LINK UsingMP32HTML}

   @{" History                      " LINK History}
   @{" The Future                   " LINK TheFuture}

   @{" Credits                      " LINK Credits}
   @{" The Author                   " LINK TheAuthor}

@ENDNODE

@NODE Introduction "MP3-2-HTML v2.1 Documentation"

   @{FG HIGHLIGHT}@{U}Introduction@{UU}@{FG TEXT}

   If you are anything like me, and you are obsessed with downloading
   MP3 files from the Internet, then this tool is quite a useful thing
   to have.

   Basically, it creates an attractive HTML listing of all of your MP3
   files, which you can distribute, so you can show off to your mates
   about your vast collection.

   @{" Back to Main                 " LINK Main}

@ENDNODE

@NODE Distribution "MP3-2-HTML v2.1 Documentation"

   @{FG HIGHLIGHT}@{U}Distribution Notice@{UU}@{FG TEXT}

   This program is @{B}MAILWARE@{UB} which means that you are free to use
   the program, but if you can, you must e.mail me to let me know! This
   is just so I can see how far the program has spread. And let's face it,
   how long is it going to take to send one e.mail?

   You can copy the distribution archive as much as you want, as long as
   it remains unaltered. None of the files inside the distribution archive
   (including when extracted) may be altered or tampered with.

   You must only distribute the distribution archive, not separate files.
   
   The author's e.mail address is @{FG HIGHLIGHT}gazchap@btinternet.com@{FG TEXT}

   @{" Back to Main                 " LINK Main}

@ENDNODE

@NODE Requirements "MP3-2-HTML v2.1 Documentation"

   @{FG HIGHLIGHT}@{U}Requirements@{UU}@{FG TEXT}

   MP3-2-HTML v2.1 requires the following to run:-

      · An Amiga

      · Workbench 2.04 or above (untested on Workbench 3.1/3.5)

      · reqtools.library (included)

   Some MP3 files to list may also be a good idea :)

   @{" Back to Main                 " LINK Main}

@ENDNODE

@NODE Installation "MP3-2-HTML v2.1 Documentation"

   @{FG HIGHLIGHT}@{U}Installation@{UU}@{FG TEXT}

   Installing the program is so simple that an Installation Script is
   not needed. Simply copy the extracted directory anywhere.

   @{" Back to Main                 " LINK Main}

@ENDNODE

@NODE UsingMP32HTML "MP3-2-HTML v2.1 Documentation"

   @{FG HIGHLIGHT}@{U}Using MP3-2-HTML@{UU}@{FG TEXT}

   This is simple. You can, if you are not comfortable with the CLI,
   just double click on the icon and follow the instructions @{"here" LINK WBUsage}.

   If you are OK with using the CLI, read on.

   There are three parameters that you can pass to MP3-2-HTML, and these
   affect it's operation. They are as follows:-

      · DIR       -  Specifies the directory to read files from.
                     *IMPORTANT*: If the value you specify for this
                     is NOT a volume/assign, PUT A '/' on the end!

                     i.e. "Work:Music/MP3" will not work!
                     but  "Work:Music/MP3/" will!!!

      · OUTFILE   -  Specifies the file to write to.
                     A requester will appear if the file already
                     exists (unless FORCE has been specified)

      · FORCE     -  Turns off the overwrite requester.

   Any of these can be omitted, and if you do omit any, a file requester
   will pop up for the relevant values.


   @{FG HIGHLIGHT}@{U}Examples@{UU}@{FG TEXT}

   @{B}MP3-2-HTML DIR MP3: OUTFILE MP3:List.HTML@{UB}

      This will read all files from the MP3: directory, and write
      them to the file MP3:List.HTML. If this file exists, an
      overwrite requester will be displayed.
   
   @{B}MP3-2-HTML OUTFILE MP3:List.HTML FORCE@{UB}

      This will show a path requester, so you can select the MP3
      directory yourself. It will write to MP3:List.HTML, and will
      ignore the fact that the file exists, if it does.

   @{B}MP3-2-HTML DIR MP3: @{UB}

      This will read all files from the MP3: directory, and will
      show a file requester allowing you to choose the output file.
      If the file exists, a requester is shown.

   @{B}MP3-2-HTML DIR Work:MP3@{UB}

      This example will @{B}NOT@{UB} work!

   @{B}MP3-2-HTML DIR Work:MP3/@{UB}

      This is the corrected version of the above. Note the '/' on the
      end. This reads files from the Work:MP3/ directory, and shows
      a file requester for the output file. If it exists, a requester
      is shown.

   @{" Back to Main                 " LINK Main}

@ENDNODE

@NODE WBUsage "MP3-2-HTML v2.1 Documentation"

   @{FG HIGHLIGHT}@{U}Workbench Usage@{UU}@{FG TEXT}

   Just double-click the icon, as mentioned previously. A path
   requester will be shown first to allow you to select the directory
   to read your MP3's from.

   Then, a file requester is shown. Select the file you want to
   write to in this requester.

   If the file exists, an overwrite requester is shown.

   And that's it!

   @{" Back to Main                 " LINK Main}

@ENDNODE

@NODE Credits "MP3-2-HTML v2.1 Documentation"

   @{FG HIGHLIGHT}@{U}Credits@{UU}@{FG TEXT}

   MP3-2-HTML was written in Blitz Basic 2 entirely by Gareth Griffiths.

   Thanks to the following people:-
      
      · @{B}Francis G. Loch@{UB} for helping me with the sort routine.

      · @{B}David McMinn@{UB} for telling me about the mydir.bb example!

      · @{B}Acid Software@{UB} for making Blitz2, the best BASIC interpreter
        on the Amiga.

   Greets to the following people:-

      Andrea, Amy, Joanne, Nikki, Meep^, Boom^, Garrett, Lockpick,
      Glover, ZimZum, Zorbo, Philbo, Bingley, Loki, Fanta, Hawkeye, r!K,
      the rest of the SDS crew...

      ...and anyone else who knows me!

   @{" Back to Main                 " LINK Main}

@ENDNODE

@NODE TheAuthor "MP3-2-HTML v2.1 Documentation"

   @{FG HIGHLIGHT}@{U}The Author@{UU}@{FG TEXT}

   My name is Gareth Griffiths, and I am a 16 year old lad from the
   small(ish) town of Shrewsbury in the UK.

   I am an avid collector of MP3 files, and am also obsessed with the
   Alien Saga. Check out my website at @{FG HIGHLIGHT}http://www.gazchap.co.uk@{FG TEXT}

   I am the founder of the IRC channel #AmigaZone on the Undernet IRC 
   Network, and my nick is Auriga (the craft from Alien Resurrection,
   natch!) so if you want to suggest something to me, you can either
   e.mail me at @{FG HIGHLIGHT}gazchap@btinternet.com@{FG TEXT} or find
   me on IRC and talk to me!

   @{" Back to Main                 " LINK Main}

@ENDNODE

@NODE TheFuture "MP3-2-HTML v2.1 Documentation"

   @{FG HIGHLIGHT}@{U}The Future@{UU}@{FG TEXT}

   Things I might implement in the future:-
   (*) - definitely implementing soon)

      (*) Configurable colour scheme for the HTML file.

      (*) Configurable page title, like v2.0.

      (*) Support for recursive scanning in the MP3 directory.

		(*) Support for more than one MP3 directory.

      (·) Extra fields for Hertz and bit-rate maybe?

      (·) Maybe an MUI GUI, like the previous version?

   If you have any further suggestions, please e.mail me at
   @{FG HIGHLIGHT}gazchap@btinternet.com@{FG TEXT} and tell me!

   @{" Back to Main                 " LINK Main}

@ENDNODE

@NODE History "MP3-2-HTML v2.1 Documentation"

   @{FG HIGHLIGHT}@{U}History@{UU}@{FG TEXT}

   @{B}v2.1 (18-05-2000)@{UB}

      · Removed MUI GUI for now, it makes for easier usage I find.
      · Now does not use an external database, it reads directly
        from the ID3 tags of the MP3.
      · Complete re-write of the code.
      · Can no longer configure page title (yet)

   @{B}v2.0 (13-05-2000)@{UB}

      · First Aminet release.
      · Added MUI GUI, all previous versions were CLI only.
      · Easier handling of CLI parameters, now they can be
        specified in any order.
      · Complete re-write of code, some features from old
        versions are currently omitted.

   @{FG HIGHLIGHT}-------- Versions below were unreleased!! --------@{FG TEXT}

   @{B}v1.8 (09-05-2000)@{UB}

      · Added '%t' placeholder to the title function.
   
   @{B}v1.6 (04-05-2000)@{UB}

      · Added '%d' placeholder to the title function.
      · Added the '%%' placeholder to the title function.
      · Added FORCE CLI parameter to disable the 'Overwrite'
        requester.

   @{B}v1.5 (01-05-2000)@{UB}

      · Changed the colour scheme of the HTML file, it is
        nowhere near as dark as it was. Looks better.
      · Added a configurable title.

   @{B}v1.4 (24-04-2000)@{UB}

      · 'Improved' the output to CLI, it now tells you how
        many MP3 files were added to the HTML file.

   @{B}v1.2 (20-04-2000)@{UB}

      · Changed the colour scheme of the HTML file, the table
        is now a different colour to the page background.

   @{B}v1.1 (18-04-2000)@{UB}

      · Altered the layout of the HTML file slightly to make it
        more readable. Made the Artists @{B}emboldened@{UB} for example.

   @{B}v1.0 (10-04-2000)@{UB}

      · First version. No optimisation needed, is very fast already :)

   @{" Back to Main                 " LINK Main}

@ENDNODE

@NODE Nothing "Nothing"
@ENDNODE