@DATABASE MP32HTML.GUIDE
@$VER: MP3-2-HTML.guide v3.0.20 (28-04-2002)
@AUTHOR Gareth Griffiths
@NODE main "MP3-2-HTML Documentation"
@{FG HIGHLIGHT}@{U}MP3-2-HTML v3.0.20 (28.04.2002)@{UU}@{FG TEXT}
Documentation.
Program and Documentation written by Gareth Griffiths.
e-Mail: @{FG HIGHLIGHT}mail@gazchap.com@{FG TEXT}
Website: @{FG HIGHLIGHT}http://mp32html.gazchap.com@{FG TEXT}
@{" " LINK introduction} Introduction
@{" " LINK distribution} Distribution Notice
@{" " LINK requirements} System Requirements
@{" " LINK installation} Installation
@{" " LINK usage} Usage
@{" " LINK muiinterface} The MUI Interface
@{" " LINK bugs} Known Bugs
@{" " LINK history} Version History
@{" " LINK future} Future Plans
@{" " LINK translators} Information for Translators
@{" " LINK credits} Credits
@ENDNODE
@NODE introduction "MP3-2-HTML Documentation"
@{FG HIGHLIGHT}@{U}Introduction@{UU}@{FG TEXT}
Back in 1999, I acquired a larger hard drive for my Amiga. The 4.3GB of
space that I now had was a luxury compared to the 772MB of space that I
had before.
I made use of this larger drive by converting my audio CD's to MP3
format for convenience. Before long I had accumulated quite a lot of the
things, over 500. I wanted an easy way of cataloguing the MP3s I had,
yet couldn't find any tools to do the job how I wanted.
So I wrote one.
The original versions of MP3-2-HTML, v1.0 to v2.0, were never released.
They relied on an external text file that contained a database the
artists and titles of the MP3s on my hard drive. This was good, but for
me wasn't automatic enough, so I created a new version of the program.
This new version used the ID3 tags that can be embedded into MP3 files
to produce the HTML listing and was much faster all round.
Since then, in two years of near-constant development, many new features
and options have made it into the program. People are contacting me all
the time with more suggestions and ideas - some of which are very good,
and some of which are, quite frankly, not very good. Even so, most of
them make it into the program eventually!
Anyway, enough drivel. Thanks for downloading the program, and I hope it
is as useful for you as it is for me!
@{" " LINK main} Main
@ENDNODE
@NODE distribution "MP3-2-HTML Documentation"
@{FG HIGHLIGHT}@{U}Distribution Notice@{UU}@{FG TEXT}
This software has been classified as @{B}MAILWARE@{UB} by the author.
This means that the software is freely distributable as long as the
software remains in its distribution archive and is not modified in
any way.
You are free to use the software without restriction for an unlimited
amount of time. The author only asks that you contact him/her to let
them know that you are using the software. Contact details are given at
the end of this distribution notice.
Note that whilst the software is free to use and redistribute, the
copyright of the software remains firmly in the hands of the author and
any breaches of that copyright will be dealt with to the full extent of
the law.
In short, you can use the software for free, you can copy the program
for free, but if you modify anything included within the distribution
archive and then redistribute that modified version, you are breaking
copyright laws and are liable to prosecution. You have been warned!
You can e-mail the author at this address: @{FG HIGHLIGHT}
mail@gazchap.com@{FG TEXT}
@ENDNODE
@NODE requirements "MP3-2-HTML Documentation"
@{FG HIGHLIGHT}@{U}System Requirements@{UU}@{FG TEXT}
To use MP3-2-HTML, you need the following:
@{B}Hardware:@{UB}
- An Amiga :)
@{B}Software:@{UB}
- Workbench 2.04 or above.
- MUI 3.8 (Available from Aminet: util/libs/mui38usr.lha)
- reqtools.library in your LIBS: directory. (Available from
Aminet: util/libs/ReqToolsUsr.lha)
@{B}Miscellaneous:@{UB}
- Some MP3 files to list :)
Please note that the program has only been tested on Workbench 3.0 and
above, so it may not work on Workbench 2.04. Theoretically it should
work fine. The program may also work with MUI versions below 3.8, but
it has not been tested.
@ENDNODE
@NODE installation "MP3-2-HTML Documentation"
@{FG HIGHLIGHT}@{U}Installation@{UU}@{FG TEXT}
Installing MP3-2-HTML is simple. You can do it the easy way (the
Installer script) or the hard way (manually).
@{B}The Easy Way:@{UB}
- In the "Install" directory in MP3-2-HTML's distribution,
just double click on the relevant install icon for your
language.
MP3-2-HTML will install everything automatically to a
directory of your choice.
@{B}The Hard Way:@{UB}
- Make a directory in a location of your choice, and call
it whatever you want (although MP3-2-HTML might be a good
name :)
- Copy the Docs, Install, and languages directories from the
distribution archive to this directory, making sure you
keep the directory structure, i.e.
MP3-2-HTML/Docs
MP3-2-HTML/Install
MP3-2-HTML/languages
- Copy the executable and its icon to the main directory.
- Thats it! MP3-2-HTML is now installed on your system!
@ENDNODE
@NODE usage "MP3-2-HTML Documentation"
@{FG HIGHLIGHT}@{U}Usage@{UU}@{FG TEXT}
To start the program, you can either double click on its icon from the
Workbench (this will use the @{" MUI interface " LINK muiinterface}, or you can run it from
the CLI.
The advantage of running from the CLI is that you can automate the
process (if you run the program a lot on the same directory).
If you run the program from the CLI, you can pass the following
arguments to it:
@{" DIR " LINK cliparam_dir}
@{" OUTFILE " LINK cliparam_outfile}
@{" TITLE " LINK cliparam_title}
@{" RECURSE " LINK cliparam_recurse}
@{" NUMBERS " LINK cliparam_numbers}
@{" ALBUMS " LINK cliparam_albums}
@{" SIZES " LINK cliparam_sizes}
@{" BSIZES " LINK cliparam_bsizes}
@{" KBSIZES " LINK cliparam_kbsizes}
@{" MBSIZES " LINK cliparam_mbsizes}
@{" LINKS " LINK cliparam_links}
@{" LINKPREFIX " LINK cliparam_linkprefix}
@{" NORMLINKS " LINK cliparam_normlinks}
@{" UNIXLINKS " LINK cliparam_unixlinks}
@{" RELLINKS " LINK cliparam_rellinks}
@{" LANGUAGE " LINK cliparam_language}
@{" LOADPREFS " LINK cliparam_loadprefs}
@{" NOGUI " LINK cliparam_nogui}
@{" FORCE " LINK cliparam_force}
Note that the arguments may be passed in any order, and if the @{" LOADPREFS " LINK cliparam_loadprefs}
argument is specified first, the settings within the preferences file will
be overridden by any other specified arguments.
@ENDNODE
@NODE cliparam_dir "MP3-2-HTML Documentation"
@{FG HIGHLIGHT}@{U}CLI Arguments: DIR@{UU}@{FG TEXT}
Usage: DIR
The DIR argument tells MP3-2-HTML which directory to scan for MP3
files. If the specified directory does not exist, you will be told
and the program will quit.
If you omit the DIR argument, a file requester will be displayed
allowing you to select a directory.
Example:
DIR Work:Music/MP3
@ENDNODE
@NODE cliparam_outfile "MP3-2-HTML Documentation"
@{FG HIGHLIGHT}@{U}CLI Arguments: OUTFILE@{UU}@{FG TEXT}
Usage: OUTFILE
The OUTFILE argument tells MP3-2-HTML where to generate the
HTML file. If the specified file already exists, you will be
given the option of overwriting it (unless the @{" FORCE " LINK cliparam_force} argument
has also been specified.
If you omit the OUTFILE argument, a file requester will be
displayed allowing you to select a destination file.
Example:
OUTFILE Work:Music/MP3/List.HTML
@ENDNODE
@NODE cliparam_title "MP3-2-HTML Documentation"
@{FG HIGHLIGHT}@{U}CLI Arguments: TITLE@{UU}@{FG TEXT}
Usage: TITLE ""
The TITLE argument tells MP3-2-HTML what to use as the page title.
The page title is displayed at the top of the HTML file, as well as
in the titlebar of the web browser you use to view the HTML file.
Always remember to enclose the title in quotes.
You can use HTML tags inside the title, like <BR> for a line break.
Note that any <BR> tags in the title will be converted to hyphens
when displayed in the browser title bar (but not on the page itself)
There are also a few placeholder characters you can use in the title
to insert information in to the title. These are:
%c - This displays the total number of MP3 files found during
the scan.
%d - This displays the current date.
%i - This displays the directory specified using the @{" DIR " LINK cliparam_dir}
argument.
%n - This displays the number of MP3 files found without ID3
tags during the scan.
%s - This displays the total file size of all the MP3 files
found during the scan, depending on your Size Format
preferences.
%t - This displays the current time (including seconds)
%% - This displays a percent symbol (%).
These placeholders are case-sensitive, so %C will not work, whereas
%c will.
Note:
Page titles are always centred on the page, but unlike previous
versions of MP3-2-HTML, they don't have any font sizes specified, so
you can add those yourself using HTML tags.
Examples:
TITLE "My MP3 Listing"
TITLE "My MP3 List on %d at %t <br> Total Files: %c"
@ENDNODE
@NODE cliparam_recurse "MP3-2-HTML Documentation"
@{FG HIGHLIGHT}@{U}CLI Arguments: RECURSE@{UU}@{FG TEXT}
Usage: RECURSE
The RECURSE argument tells MP3-2-HTML to scan all sub-directories in
the specified directory for MP3 files too.
The default mode is to just scan the directory specified, but when
RECURSE is active, it scans ALL directories in the specified
directory.
Example:
DIR Work:Music/MP3/
This will scan only the MP3 directory.
DIR Work:Music/MP3/ RECURSE
This will scan all directories within the MP3 directory, i.e.
Work:Music/MP3/A/
Work:Music/MP3/B/
Work:Music/MP3/C/
Work:Music/MP3/C/Chemical Brothers/
Work:Music/MP3/D/
...
...
Work:Music/MP3/Z/
Using RECURSE in this way means you can alphabetise your MP3
collection easily and still catalogue it.
@ENDNODE
@NODE cliparam_numbers "MP3-2-HTML Documentation"
@{FG HIGHLIGHT}@{U}CLI Arguments: NUMBERS@{UU}@{FG TEXT}
Usage: NUMBERS
The NUMBERS argument tells MP3-2-HTML to number each individual MP3
file in the list, starting from 1.
Example:
With NUMBERS specified, the HTML file will look similar to this:
+-----+----------------------------------------- - - -
| Num | Artist: Title
+-----+----------------------------------------- - - -
| 1 | Ace Of Base: All That She Wants
| 2 | Aqua: Barbie Girl
.........................................................
.........................................................
| 500 | Zombie Nation: Kernkraft 400
+-----+----------------------------------------- - - -
With NUMBERS not specified, the HTML file will look similar to this:
+----------------------------------------------- - - -
| Artist: Title
+----------------------------------------------- - - -
| Ace Of Base: All That She Wants
| Aqua: Barbie Girl
.........................................................
.........................................................
| Zombie Nation: Kernkraft 400
+----------------------------------------------- - - -
@ENDNODE
@NODE cliparam_albums "MP3-2-HTML Documentation"
@{FG HIGHLIGHT}@{U}CLI Arguments: ALBUMS@{UU}@{FG TEXT}
Usage: ALBUMS
The ALBUMS argument tells MP3-2-HTML to include information taken
from the MP3 file's Album tag in the HTML file.
Example:
With ALBUMS specified, the HTML file will look similar to this:
+----------------------------------------------- - - -
| Artist (Album): Title
+----------------------------------------------- - - -
| Semisonic (Feeling Strangely Fine): Secret Smile
| Stereophonics (J.E.E.P.): Have A Nice Day
.........................................................
.........................................................
| Zombie Nation: Kernkraft 400
+----------------------------------------------- - - -
With ALBUMS not specified, the HTML file will look similar to this:
+----------------------------------------------- - - -
| Artist: Title
+----------------------------------------------- - - -
| Semisonic: Secret Smile
| Stereophonics: Have A Nice Day
.........................................................
.........................................................
| Zombie Nation: Kernkraft 400
+----------------------------------------------- - - -
@ENDNODE
@NODE cliparam_sizes "MP3-2-HTML Documentation"
@{FG HIGHLIGHT}@{U}CLI Arguments: SIZES@{UU}@{FG TEXT}
Usage: SIZES
The SIZES argument tells MP3-2-HTML to add a column at the end of
each row in the HTML file with that MP3's filesize in it.
Using the @{" KBSIZES " LINK cliparam_kbsizes} and @{" MBSIZES " LINK cliparam_mbsizes} arguments, you can
specify how sizes are displayed (in bytes, kilobytes, or megabytes
respectively)
Thousand separators are added into the filesize to enhance
readability.
See also: @{" BSIZES " LINK cliparam_bsizes}
@{" KBSIZES " LINK cliparam_kbsizes}
@{" MBSIZES " LINK cliparam_mbsizes}
@ENDNODE
@NODE cliparam_bsizes "MP3-2-HTML Documentation"
@{FG HIGHLIGHT}@{U}CLI Arguments: BSIZES@{UU}@{FG TEXT}
Usage: BSIZES
The BSIZES argument tells MP3-2-HTML to show all sizes in bytes.
See also: @{" SIZES " LINK cliparam_sizes}
@{" KBSIZES " LINK cliparam_kbsizes}
@{" MBSIZES " LINK cliparam_mbsizes}
@ENDNODE
@NODE cliparam_kbsizes "MP3-2-HTML Documentation"
@{FG HIGHLIGHT}@{U}CLI Arguments: KBSIZES@{UU}@{FG TEXT}
Usage: KBSIZES
The KBSIZES argument tells MP3-2-HTML to show all sizes in kilobytes.
See also: @{" SIZES " LINK cliparam_sizes}
@{" BSIZES " LINK cliparam_bsizes}
@{" MBSIZES " LINK cliparam_mbsizes}
@ENDNODE
@NODE cliparam_mbsizes "MP3-2-HTML Documentation"
@{FG HIGHLIGHT}@{U}CLI Arguments: MBSIZES@{UU}@{FG TEXT}
Usage: MBSIZES
The MBSIZES argument tells MP3-2-HTML to show all sizes in megabytes.
See also: @{" SIZES " LINK cliparam_sizes}
@{" BSIZES " LINK cliparam_bsizes}
@{" KBSIZES " LINK cliparam_kbsizes}
@ENDNODE
@NODE cliparam_links "MP3-2-HTML Documentation"
@{FG HIGHLIGHT}@{U}CLI Arguments: LINKS@{UU}@{FG TEXT}
Usage: LINKS
The LINKS argument tells MP3-2-HTML to include links to each MP3
file in the HTML. Each MP3 will have a link defined around it.
See also: @{" LINKPREFIX " LINK cliparam_linkprefix}
@{" NORMLINKS " LINK cliparam_normlinks}
@{" UNIXLINKS " LINK cliparam_unixlinks}
@{" RELLINKS " LINK cliparam_rellinks}
@ENDNODE
@NODE cliparam_linkprefix "MP3-2-HTML Documentation"
@{FG HIGHLIGHT}@{U}CLI Arguments: LINKPREFIX@{UU}@{FG TEXT}
Usage: LINKPREFIX "<link prefix>"
The LINKPREFIX argument tells MP3-2-HTML what to put at the front
of links generated using the @{" LINKS " LINK cliparam_links} argument.
When you first install MP3-2-HTML, LINKPREFIX is set to "file:///"
which allows you to play MP3 files from your web browser using a
suitable MP3 player and a defined MIME type (see your web browser's
documentation for information on MIME types)
If you run a web server on your Amiga, you may wish to set LINKPREFIX
to the address of your web server, so that visitors who look at your
list can download MP3 files from it. For example:
LINKPREFIX "http://myserver.dyndns.org/"
will make MP3-2-HTML generate links like this:
http://myserver.dyndns.org/Work:Music/MP3/A/AceOfBase_....MP3
See also: @{" LINKS " LINK cliparam_links}
@{" NORMLINKS " LINK cliparam_normlinks}
@{" UNIXLINKS " LINK cliparam_unixlinks}
@{" RELLINKS " LINK cliparam_rellinks}
Note:
Most web servers will not work using Amiga style pathnames (i.e.
Work:Music/MP3) and will require the use of the @{" UNIXLINKS " link cliparam_unixlinks}
argument to convert them to a web server usable format.
@ENDNODE
@NODE cliparam_normlinks "MP3-2-HTML Documentation"
@{FG HIGHLIGHT}@{U}CLI Arguments: NORMLINKS@{UU}@{FG TEXT}
Usage: NORMLINKS
The NORMLINKS argument tells MP3-2-HTML to use Amiga style pathnames
when generating links (see the @{" LINKS " LINK cliparam_links} argument)
This means that links will not be changed in any way, they stay as
they are when first established.
i.e. Work:Music/MP3/A/AceOfBase_AllThatSheWants.MP3
See also: @{" LINKS " LINK cliparam_links}
@{" LINKPREFIX " LINK cliparam_linkprefix}
@{" UNIXLINKS " LINK cliparam_unixlinks}
@{" RELLINKS " LINK cliparam_rellinks}
@ENDNODE
@NODE cliparam_unixlinks "MP3-2-HTML Documentation"
@{FG HIGHLIGHT}@{U}CLI Arguments: UNIXLINKS@{UU}@{FG TEXT}
Usage: UNIXLINKS
The UNIXLINKS argument tells MP3-2-HTML to use UNIX style pathnames
when generating links (see the @{" LINKS " LINK cliparam_links} argument)
This means that any colon's in the pathname will be replaced with
forward slashes, i.e.
Work:Music/MP3/S/Semisonic_SecretSmile.MP3
becomes:
Work/Music/MP3/S/Semisonic_SecretSmile.MP3
This allows most web servers to use the files properly.
See also: @{" LINKS " LINK cliparam_links}
@{" LINKPREFIX " LINK cliparam_linkprefix}
@{" NORMLINKS " LINK cliparam_normlinks}
@{" RELLINKS " LINK cliparam_rellinks}
@ENDNODE
@NODE cliparam_rellinks "MP3-2-HTML Documentation"
@{FG HIGHLIGHT}@{U}CLI Arguments: RELLINKS@{UU}@{FG TEXT}
Usage: RELLINKS
The RELLINKS argument tells MP3-2-HTML to use relative pathnames
when generating links (see the @{" LINKS " LINK cliparam_links} argument)
This means that device names in the path will be stripped completely.
Work:Music/MP3/S/Semisonic_SecretSmile.MP3
becomes:
Music/MP3/S/Semisonic_SecretSmile.MP3
This is most useful when using CD-ROMs to store your MP3's and
accompanying lists.
See also: @{" LINKS " LINK cliparam_links}
@{" LINKPREFIX " LINK cliparam_linkprefix}
@{" NORMLINKS " LINK cliparam_normlinks}
@{" UNIXLINKS " LINK cliparam_unixlinks}
@ENDNODE
@NODE cliparam_language "MP3-2-HTML Documentation"
@{FG HIGHLIGHT}@{U}CLI Arguments: LANGUAGE@{UU}@{FG TEXT}
Usage: LANGUAGE <language>
The LANGUAGE argument tells MP3-2-HTML which language to use for
it's text strings and other information.
The built-in language is English, but you can specify another
language using this argument. Note that if the specified language
is not in the MP3-2-HTML/languages/ directory, MP3-2-HTML will
revert back to English.
Language files must be called <language>.language (where <language>
is the name of the language, e.g. "deutsch")
Examples:
LANGUAGE deutsch
LANGUAGE francais
@ENDNODE
@NODE cliparam_loadprefs "MP3-2-HTML Documentation"
@{FG HIGHLIGHT}@{U}CLI Arguments: LOADPREFS@{UU}@{FG TEXT}
Usage: LOADPREFS
The LOADPREFS argument tells MP3-2-HTML to load settings from
a file: ENVARC:MP3-2-HTML.prefs.
If the preferences file does not exist, the default settings
will be used.
Note:
LOADPREFS should always be specified first, otherwise any preceding
arguments will be overridden by the contents of the prefs file, e.g.:
MP3-2-HTML LOADPREFS DIR MP3: RECURSE
Even if DIR is set to something different in the preferences file, it
will be set to MP3: here because the DIR argument follows the LOADPREFS
argument. If you were to use:
MP3-2-HTML DIR MP3: RECURSE LOADPREFS
Then the directory specified in the prefs file would override the DIR
argument.
@ENDNODE
@NODE cliparam_nogui "MP3-2-HTML Documentation"
@{FG HIGHLIGHT}@{U}CLI Arguments: NOGUI@{UU}@{FG TEXT}
Usage: NOGUI
The NOGUI argument tells MP3-2-HTML to not use the MUI interface,
and use the CLI for everything.
This is useful if you want to automate your MP3 list creation, as
you can redirect MP3-2-HTML's output to NIL:
Note:
You still need MUI installed even if you use the NOGUI argument!
This is due to Blitz Basic's handling of MUI.
@ENDNODE
@NODE cliparam_force "MP3-2-HTML Documentation"
@{FG HIGHLIGHT}@{U}CLI Arguments: FORCE@{UU}@{FG TEXT}
Usage: FORCE
The FORCE argument tells MP3-2-HTML to go ahead and write the HTML
even if the output file already exists.
This argument is only useful when used with the NOGUI argument.
If this argument is omitted, a requester will be displayed asking
you if you want to overwrite the existing file or not.
@ENDNODE
@NODE muiinterface "MP3-2-HTML Documentation"
@{FG HIGHLIGHT}@{U}The MUI Interface@{UU}@{FG TEXT}
The MUI interface in MP3-2-HTML is provided for those uncomfortable with
a CLI environment.
I won't go into great detail about what each gadget on the interface does,
I'll just link it to a page detailing the CLI parameter, which will explain
everything.
@{B}The Main Window@{UB}
@{B}Directory:@{UB} Enter the input directory in this string gadget, or
use the pop-gadget to the right of the string to
select one from a file requester.
See @{" DIR " LINK cliparam_dir}
@{B}Output File:@{UB} Enter the full path to the HTML file in this string
gadget, or use the pop-gadget to the right to select
one from a file requester.
See @{" OUTFILE " LINK cliparam_outfile}
@{B}Page Title:@{UB} Enter the title for your HTML page in this string
gadget. Special characters may be used, see the link
below for details.
See @{" TITLE " LINK cliparam_title}
@{B}Recursive Scan:@{UB} Checking this box makes MP3-2-HTML scan all
sub-directories in the Directory specified above. If
left unchecked, MP3-2-HTML will just scan the root of
the Directory specified.
See @{" RECURSE " LINK cliparam_recurse}
@{B}Numbers:@{UB} Checking this box makes MP3-2-HTML number each MP3
individually in the HTML file.
See @{" NUMBERS " LINK cliparam_numbers}
@{B}Albums:@{UB} Checking this box makes MP3-2-HTML include Album
information in the HTML file.
See @{" ALBUMS " LINK cliparam_albums}
@{B}Sizes:@{UB} Checking this box makes MP3-2-HTML include file size
information in the HTML file.
See @{" SIZES " LINK cliparam_sizes}
@{B}Size Format:@{UB} This cycle gadget sets the type of size to show: bytes,
kilobytes, or megabytes.
@{B}Links:@{UB} Checking this box makes MP3-2-HTML generate links to
the MP3 files. It also enables the following two
gadgets.
See @{" LINKS " LINK cliparam_links}
@{B}Link Prefix:@{UB} Type the prefix for your links in here.
See @{" LINKPREFIX " LINK cliparam_linkprefix}
@{B}Link Type:@{UB} This cycle gadget sets the type of link to generate:
Normal, Unix, or Relative.
See @{" NORMLINKS " LINK cliparam_normlinks}
@{" UNIXLINKS " LINK cliparam_unixlinks}
@{" RELLINKS " LINK cliparam_rellinks}
@{B}Generate:@{UB} This button starts the HTML generation process.
@{B}Colours:@{UB} This button opens the @{" Edit Colours " LINK mui_editcols} window.
@{B}Language:@{UB} This button opens the @{" Languages " LINK mui_languages} window.
@{B}Save Prefs:@{UB} This button saves the current preferences to ENVARC:
@{B}About:@{UB} This button brings up the MP3-2-HTML About Window.
To quit the program, click the close gadget in the top left corner of the main window.
@ENDNODE
@NODE mui_editcols "MP3-2-HTML Documentation"
@{FG HIGHLIGHT}@{U}The MUI Interface@{UU}@{FG TEXT}
@{B}The Edit Colours Window@{UB}
This is where you specify what colours MP3-2-HTML should use for
various items on the HTML file.
Type in the hexadecimal colour code for the colour you want in
each string gadget, but don't include the hash (#).
If you don't know hexadecimal colour codes, you can click on the
pop-gadget next to each string and select one of the 16 pre-defined
colours (these colours follow the HTML standard, they aren't of my
own selection!)
@{B}Page Bkgd:@{UB} This is the colour to use for the main page
background.
@{B}Page Text:@{UB} This colour is for any text outside of the main
table. (i.e. the page title)
@{B}Header Bkgd:@{UB} This sets the background colour of the column
headers and the footer.
@{B}Header Text:@{UB} This sets the text colour of the column headers
and the footer.
@{B}Cell Bkgd:@{UB} This sets the background colour of each cell in
the main table.
@{B}Cell Text:@{UB} This sets the text colour of each cell in the main
table.
@{B}Link:@{UB} Lastly, this sets the colour of any links generated.
To close this window, click on OK.
@ENDNODE
@NODE mui_languages "MP3-2-HTML Documentation"
@{FG HIGHLIGHT}@{U}The MUI Interface@{UU}@{FG TEXT}
@{B}The Languages Window@{UB}
This window is where you set the language used by MP3-2-HTML.
To select a new language, click on its name from the language list,
and then click on OK.
The Cancel button closes the window, and the Refresh button refreshes
the list of languages.
Note that the English language is built-in and cannot be removed.
@ENDNODE
@NODE bugs "MP3-2-HTML Documentation"
@{FG HIGHLIGHT}@{U}Known Bugs@{UU}@{FG TEXT}
This is a list of all currently known bugs in MP3-2-HTML, and any
workarounds that exist for them.
@{B}When selecting a new language, some strings aren't replaced with
the new language strings@{UB}
This mostly happens on the cycle gadgets, as I can't seem to change
the items in a cycle gadget after creating it without crashing the
program. I don't know if this is a Blitz or MUI problem.
@{B}Workaround:@{UB} Save your preferences, and then quit and restart the
program. All of the strings should now be in the new language.
@{B}My HTML file has strange characters in the Artist/Album/Title
columns! Whats happening?@{UB}
This seems to be a very rare bug, which is most likely caused by
illegal characters in the ID3 tags. MP3-2-HTML strips all trailing
spaces and null characters from all the tags, but if there are other
characters in the way then it can't do it effectively.
There is no workaround for this, other than to try and repair the
ID3 tags yourself.
@{B}All of my MP3s are showing up as having no tags, but I know there are
some in there!@{UB}
This is almost certainly because the tags are in the ID3v2 format,
which MP3-2-HTML does not yet support. I am getting around to
implementing support for ID3v2, so keep your eyes peeled for new
releases :)
If there are some MP3s that you KNOW have ID3v1 tags, then the chances
are that MP3-2-HTML couldn't get an AmigaDOS lock on the file. This is
a problem with your filesystem, not MP3-2-HTML.
Try running MP3-2-HTML in "CLI mode" to find out if this is the case.
If you find any other bugs or strange occurrences in MP3-2-HTML, please let me
know via e-mail and I'll see if I can fix them! My e-mail address is:
@{FG HIGHLIGHT}mail@gazchap.com@{FG TEXT}
@ENDNODE
@NODE History "MP3-2-HTML Documentation"
@{FG HIGHLIGHT}@{U}History@{UU}@{FG TEXT}
@{B}> 3.0.20 (28.04.2002)@{UB}
@{B}Bug Fixes/Tweaks:@{UB}
- The total-size had a limit of 2048MB (2 GB). If you
had more than 2 GB of MP3's, it would still say you
had 2 GB. Fixed.
- The numbers column had ".00" put on the end of the
numbers in some cases. Fixed.
@{B}> 3.0.15 (21.04.2002)@{UB}
@{B}Bug Fixes/Tweaks:@{UB}
- A couple of new gadgets weren't in the TAB cycle chain.
Fixed.
- Too many unnecessary spaces in the HTML file. Fixed.
- A very slight (i.e. unnoticeable) optimisation in the
HTML writing code. A couple of things weren't necessary.
@{B}> 3.0 (18.04.2002)@{UB}
@{B}New Features:@{UB}
- Localisation. Users of the program can now translate all
text strings into their native language and use them.
See @{" Notes for Translators " LINK translators}
- Enhanced link generation:
See @{" LINKS " LINK cliparam_links}
@{" LINKPREFIX " LINK cliparam_linkprefix}
@{" NORMLINKS " LINK cliparam_normlinks}
@{" UNIXLINKS " LINK cliparam_unixlinks}
@{" RELLINKS " LINK cliparam_rellinks}
- Sizes can now be displayed in bytes, kilobytes, or megabytes.
- The NOID3 argument from previous versions (and the No
ID3 Count feature) has been removed, and is replaced by the
%n placeholder (see @{" TITLE " LINK cliparam_title}) that was added in this version.
- More placeholders to put in page titles.
See @{" TITLE " LINK cliparam_title}
- New preferences file system, more readable.
@{B}Bug Fixes/Tweaks:@{UB}
- Directory scanning code optimised, as well as other
smaller bits of code.
@{B}> 2.97.2 (22.03.2002)@{UB}
@{B}Bug Fixes/Tweaks:@{UB}
- Some drives (especially CD-ROM's and other removable
media) were causing "Directory does not exist!" errors.
This should now be fixed.
@{B}> 2.97 (11.02.2002)@{UB}
@{B}New Features:@{UB}
- There is now another progress bar in the progress window
(when using the MUI interface) that gives more information
into what is currently happening.
- The MP3 sorting routine has been changed and is now
dramatically faster. Creating a list from my MP3 directory
takes 91 seconds (just over a minute and a half!) using
the last release (2.96.2) and that is on a 50MHz 68060!
This release takes just 20 seconds to do the same!
@{B}Bug Fixes/Tweaks:@{UB}
- Albums are now sorted, I forgot about this in 2.96.2!
- Hashes (#) are now put in front of all colour codes in the
HTML. This was causing some problems with older browsers.
@{B}> 2.96.2 (09.02.2002)@{UB}
@{B}Bug Fixes/Tweaks:@{UB}
- Thousand separators weren't inserted into some entries for
some reason. This is now fixed.
- Not so much a fix, more a tweak. The sorting speed has
been slightly improved.
@{B}> 2.96 (08.02.2002)@{UB}
@{B}New Features:@{UB}
- You can now opt not to include the Sizes column in the
HTML file if you don't want it there!
- You can now have the Album field from the ID3 tags listed
next to the artist.
- You can now tell MP3-2-HTML to number each MP3 file on the
HTML page.
- You now have the option of showing the total number of
MP3's that don't contain any ID3 tags, on the HTML page.
- The sizes now have thousands separators inserted to
enhance readability.
- Page title handling is improved. Any <br> HTML tags (line
breaks) will be converted to hyphens for the browser's
title bar.
@{B}Bug Fixes/Tweaks:@{UB}
- Tweaked the program code to execute faster, especially
whilst generating the HTML file.
- Creating more than one HTML file in the same session
always used the date from the first file. This is now
fixed.
@{B}> 2.93 (14.03.2001)@{UB}
@{B}New Features:@{UB}
- The program now uses ASL file requesters instead of
ReqTools.
- Your settings can now be saved for future use.
- Changed the version numbering system. No letters now.
@{B}Bug Fixes:@{UB}
- Pressing Cancel in MUI file requesters no longer causes
the program to exit.
- Using the file requester to select an output file no
longer shortens the path to 24 characters.
- Creating more than one file per session doesn't join the
page titles together any more.
@{B}> 2.90.2 (05.03.2001)@{UB}
@{B}Bug Fixes/Tweaks:@{UB}
- The AmigaDOS lock on the output file is now unlocked after
the file is created, not after the program is closed.
@{B}> 2.90 (19.02.2001)@{UB}
@{B}New Features:@{UB}
- Integrated the separate MUI and CLI versions into one.
@{B}Bug Fixes/Tweaks:@{UB}
- Tweaked and optimised the HTML output.
- Both versions now scan directories recursively.
@{B}> 2.4 CLI (20.08.2000)@{UB}
@{B}New Features:@{UB}
- Recursive directory scanning is now working!
- Added LINKS option to generate local links to MP3 files.
- Added an error counter.
- More informative CLI output.
@{B}Bug Fixes/Tweaks:@{UB}
- If the selected directory contained no MP3 files, the
program tried to list them anyway. This has been fixed.
- If you did not select an input directory/output file, the
program continued anyway and then failed. This has been
fixed, it now aborts straight away if you don't select one
or the other.
@{B}> 2.3 (02.08.2000)@{UB}
@{B}New Features:@{UB}
- Configurable page titles and headers.
- MUI and CLI versions are now in the same distribution.
@{B}Bug Fixes/Tweaks:@{UB}
- Tidied up HTML output - its now valid HTML 4.0.
@{B}> 2.2 MUI (24.05.2000)@{UB}
@{B}New Features:@{UB}
- The MUI interface is back again.
- Colour scheme of HTML file is now configurable.
- The page title is now configurable.
- Option to make local links to MP3 files.
- Various CLI parameters have been added.
@{B}> 2.1 CLI (18.05.2000)@{UB}
@{B}New Features:@{UB}
- The program code was re-written from scratch.
- Not so much a feature, but the MUI interface is gone for
now.
- Now does not use an external database, it reads
information directly from the ID3 tags of the MP3.
@{B}Bug Fixes/Tweaks:@{UB}
- Neither a bug, tweak, or a new feature. But the page title
is now no longer configurable (yet, anyway)
@{B}> 2.0 MUI (13.05.2000)@{UB}
@{B}New Features:@{UB}
- Complete re-write of the program code. As a result, some
features from the old versions are currently missing.
- Added an MUI interface. All previous versions were CLI
only.
- Easier handling of CLI parameters. Now they can be
specified in any order.
@ENDNODE
@NODE future "MP3-2-HTML Documentation"
@{FG HIGHLIGHT}@{U}Future Plans@{UU}@{FG TEXT}
I still have quite a lot planned for MP3-2-HTML. Here are just some of
the ideas for future releases:
- Totally configurable layout - fonts, sizes, page headers and
footers, even setting column orders yourself!
- ID3v2 support.
- Built-in ID3 tag editor for MP3s without tags.
- A "preview in browser" option.
- Support for bit-rate, frequency, and duration information.
- A "highlight new files" option.
If you have any suggestions for features you'd like to see in future
releases, don't hesitate to let me know! My e-mail address is:
@{FG HIGHLIGHT}mail@gazchap.com@{FG TEXT}
@ENDNODE
@NODE translators "MP3-2-HTML Documentation"
@{FG HIGHLIGHT}@{U}Notes for Translators@{UU}@{FG TEXT}
If you would like to translate MP3-2-HTML into another language,
please e-mail me and let me know!
The file you need to translate is already present in the
distribution archive, so you can begin whenever you want. The file
is called TRANSLATORS.TEXT and can be found in the languages/
directory of the MP3-2-HTML installation.
The format of the file is:
1 =Directory:
2 =Output File:
3 =Page Title:
...
...
87 =No files found!
The numbers at the beginning of each line are VERY important - DO NOT
change any of the numbers as they tell MP3-2-HTML where to put that
string. The equals sign (=) tells MP3-2-HTML where the string begins,
so unless there is one in the string already, do not put a space after
the equals sign!
Also make sure you don't delete any lines. If you want to delete a line,
just leave it as it is.
To test the translation, save the file as <language>.language in the
languages/ directory (where <language> is the name of the language you
are translating to), and start MP3-2-HTML with the @{" LANGUAGE " LINK cliparam_language}
argument specified:
MP3-2-HTML LANGUAGE <language>
Do not include the .language extension, just the name of the language.
@{B}Uploading to Aminet@{UB}
Please do NOT upload your translations to Aminet yourself, send them to
me and I will upload the translation archive and give you proper credit!
My e-mail address is mail@gazchap.com
@ENDNODE
@NODE credits "MP3-2-HTML Documentation"
@{FG HIGHLIGHT}@{U}Credits@{UU}@{FG TEXT}
MP3-2-HTML was designed and programmed by me, @{B}Gareth Griffiths@{UB}.
But I couldn't have done it without the help of the following:
- @{B}Francis G. Loch@{UB} for help with the original sort routine.
- @{B}Jean-Marc Gigandet@{UB} for help with the new fast sort routine.
- @{B}David McMinn@{UB} for helping me get recursive scanning working!
- @{B}Acid Software and Bernd Roesch@{UB}, for writing/updating Blitz2!
- @{B}Stefan Martens@{UB}, for beta-testing, bug-reporting, and translating
the documentation to German (albeit the older version, sorry
Stefan!)
- @{B}EVERYONE@{UB} who has e-mailed me with suggestions and feedback.
And lastly,
- @{B}Emma@{UB}, for putting up with my late-night programming binges :)
@ENDNODE
@ENDBASE