Editing this is now officially like pulling teeth

[Chunky Kibbles]

OK. I'm right here, right now, proposing some new standards for the
lgfaq, because editing it is becoming a chore, and the whole thing is
becoming harder and harder to read, aswell.


Formatting the text in the editor:
All lines should be 70 or 72 cols. Just push everything through "fmt -s"
when you're done, and it'll be fine. If you need a tutorial for vi on
this, I will gladly provide one. [it'll be a two-line item]

And although HTML tags as ALL CAPS are officially deprecated, I like
them, I think they make the source easier to read.


Question and answer formats:
It is the browser's job to get the final output formatting right. We
even say that in the coding_guidelines.

Notably, for almost everything we do, we should NOT need to use <BR>
at all, ever. The raw HTML for any given section should appear thusly:

<UL>

<LI>
<P CLASS="Question">Q: How do I do {mumble}?</P>
<P CLASS="Answer">A: You could try this: {mumble}</P>
<P CLASS="Answer">A: Alternatively, try this: {different mumble}</P>
</LI>

....

</UL>

I'm reserving judgement one some of this, but the "Q:" and "A:" need
to be there for browser that don't support stylesheets.

We will then have a stylesheet common to all of this.


Sections:
Sections should be made available piecemeal. As in, it should be
possible to view "/lgfaq/index.php?section=install" and just see that.
The rest of the time, I'm not sure, but I think a <HR> would be really
good for sepatating the sections. Pure eye-candy, open to debate.



Most importantly, it's time we had a search feature. I think that
anytime now would be a good time to actually do some work on greg's
XML parser, hence rendering most of what I've said invalid, as it will
be easy to change whenever.

I don't mind spending a few minutes converting what we have now to
XML. I believe it will be worth it in the long run. But I definitely
won't do it until at least the 70-col standard is agreed upon.

Gary (-;

PS Think what you will, but this was sparked off because I've just
read the UT2k3 installation help for the first time, and it's a
hassle. Agree ot disagree, but just bloody look at it. It's actually a
challenge to read.