NOTICE: The html files in this directory are generated automatically.
NOTICE: Do not edit them yourself.
The file "index.html" and supporting *.html files are generated by the
update-index script found in this directory. To use, simply upload your MP3
file here and type:
./update-index
And then wait for the script to finish.
The update-index script makes some assumptions about the format of the MP3
filenames, and it is very important that any user names their file appropriately
or the resulting html will be "wonky" (technical term).
The file name of an MP3 must adhere to the following format:
.mp3
Where:
:= <4-digit year> + '-' + <2-digit month> + '-' + <2-digit day>
Ex: 2009-08-23
The may also optionally be appended with "-am", "-pm", "-a", "-b",
"-c", etc, if there are multiple recordings for the same date.
Ex: 2007-10-14-am
:= "___" (that's three underscores)
The format of the delimiter is critical. Screw this up and the resulting html
will be screwed up as well.
:= a string composed of: 'A' to 'Z', 'a' to 'z', '0' to '9', '-', '_'
That's upper and lower case characters, the numbers 0-9, a hyphen, and an
underscore. No puctucation allowed, and spaces should be replaced with
underscrores.
Ex: Welcome_To_The_City_Of_Refuge
:= a string composed of: 'A' to 'Z', 'a' to 'z', '0' to '9', '-', '_'
That's upper and lower case characters, the numbers 0-9, a hyphen, and an
underscore. No puctucation allowed, and spaces should be replaced with
underscrores.
Ex: Mark_Smith
Example:
2009-08-23___Welcome_To_The_City_Of_Refuge___Mark_Smith.mp3
Q: What? Why does my filename need to be special like this?
A: Because some operating systems still barf on spaces and puctuation. And
since we have no idea what operating system viewers are likely to be running
when the aim their browser at our web site, we need to be prepared by sticking
to the greatest common denominator supported by all operating systems; and
because this allows us to generate the html files automatically, so that anyone
may maintain these files withouth having to know anything about authoring html.
Q: What if I have a file other than MP3?
A: The update-index script isn't picky about the file types listed. The only
thing it needs is a GIF file of an icon to display for the file's extension in
the html files that it creates. As of this writing, the currently recognized
file extensions that have GIF icons are: mp3, pptx, and txt. If, for instance,
you wanted to upload a *.wav file, then all you would need to do is also upload
a wav.gif file of a wave icon to be displayed in the html pages generated.
Icon images should be around 50x50 pixels in size.