I've been discussing writing HTML with Simo. Here is the very first draft
of a discussion document. (Nothing cast in stone, but somewhere to
start a discussion):
===============================================================================
To make integration easier, I'd like to set up a standard for the
organisation of the HTML, the files etc. Here's a first stab:
1) Files organised into directories by subject, for example: kites/oracle
with an index document called "index.html", which guides you through
the documents in that directory. This is in keeping with the standard
that if you point a browser at a directory, it will look for and display
this file. All my stuff is like this.
2) All files should have 8-character-dot-extension file names, for consistant
transfer to DOS. I've not done this.
3) File name extensions:
.html HTML (but I should be able to convert readily)
.txt Flat ascii text
.gif gif <- used for all diagrams and in-line pictures
.jpg jpeg <- used for non-in-line pictures
.ps postscript
4) Close every HTML thing that you open, don't rely on end of file doing
it for you. This is because I concatenate stuff together for the
master index. I try to do this currently, but I plan to get
HTML-lint in the future. The master index picks up index.html files.
5)
... must all be on one line. This makes it easier for me
to remove it from the master index. I do this.
6) Use blank lines in HTML to split up lists and paragraphs - this makes
it easier identify and move chunks round in the editor. I'm starting to
do this.
7) Max line length of 80 characters, for editing convenience. I mostly do this.
8) Every page should have a standard footer, with a pointer to the /kites
page and a mail-to: the author.
9) Use local pointers which are absolute to the local machine. This will
allow us to:
a) mirror the whole thing unchanged (because we don't mention
www.kfs.org, except for in one place in the Link Farm.)
b) identify all links and change them with a script if we move
stuff about.
(Until today, all my links specified the full URL!)
10) Not use gratuitous graphics. A gallery of thumbnails is appropriate,
but should be mentioned in the preceeding link. No large in-line graphics.
no fancy buttons or lines. I have a rec.kites logo on the top page
and that's it.
11) Don't use any Netscape-only stuff.
12) All file names and directory names in lower case for DOS migration.
Currently my files are in lower and my directories start with a capital.
13) I don't use italics, bold and the like - it won't show in ascii, so if
it doesn't make sense without, it's no use.
14) Bear in mind that I intend this to be used by EMail!
15) State the size of all images
16) I want to think hard about how to organise stuff. If I've got the space,
I might store a Hawaii mirror and an file-by-file archive of all postings.
Then I'll want only one copy of everything. The your Prossik knot
fits in with the Rasseri, but should also be in the FAQ. Mybe we'll have
a whole "knots" directory... I don't know. Flexi stuff needs to be linked
to the review FAQ, maybe to some kite stores, maybe under buggying, and the
picture linked to a gallery... I will probably stumble on for a bit, then
re-organise and re-link everything.
I'm not laying down the law. I'm just trying to find a way that we can work
together effectively.
Your input is most welcome!
andrew@tug.com