Anyway, jproulx's been working on it and came up with this:
A ton is missing (my fault), but the structure is there, and the build tools are there, and it's all pretty beautiful. (well, the file layout and such... the stylistic formatting we don't care about now... that's easy to change)
The point is: we finally have a good infrastructure for doing documentation!
So, if you want to help a ton, review the documentation and nit-pick. Find errors. Suggest new parts. Write more. Whatever.
If you don't know DocBook, just send jproulx the text and he'll DocBook-itize it.
I'll be working on the API and DB documentation over the next few days, and hope that everybody elses works on & tests the beginning parts (the installation / etc).
The next big part will be documenting how to run properly a derivative site, like DeadJournal. DeadJournal does it "wrong" now, only because all the English isn't scrubbed yet, which avva will be continuing to work on.
Then, 1.0 release.
P.S. Compiling the docs on your own machine (or your goathack) should be trivial... just run doc/raw/build/generate.pl and it'll complain if you're missing things it needs.
The HTML cleaner is still cleaning a lot of HTML elements out of comments/responses that are non-harmful and useful to users. I'd like to add them to the list of accepted elements.
While replying to some comments this morning, it hit me that the HTML cleaner is still cleaning elements out of comments that ought not to be cleaned. So I checked on it.
Group 1 – HTML 4.01 elements that are currently being cleaned:
ABBR ACRONYM ADDRESS APPLET AREA BASE BASEFONT BDO BODY BUTTON CAPTION COL COLGROUP DEL DFN DIR FIELDSET FORM FRAME FRAMESET H4 H5 H6 HEAD HTML IFRAME INPUT INS ISINDEX KBD LABEL LEGEND LINK MAP MENU META NOSCRIPT OBJECT OPTGROUP OPTION PARAM Q SAMP SCRIPT SELECT STYLE TBODY TEXTAREA TFOOT THEAD TITLE VAR
Group 2 – HTML 4.01 Elements that are being cleaned that I can see a good reason for cleaning:
APPLET BASE BASEFONT BODY BUTTON FIELDSET FORM FRAME FRAMESET HEAD HTML IFRAME INPUT ISINDEX LABEL LEGEND LINK META NOSCRIPT OBJECT OPTGROUP OPTION PARAM SCRIPT SELECT STYLE TITLE TEXTAREA
Group 3 – HTML 4.01 Elements that are being cleaned that are non-harmful and potentially useful:
ABBR ACRONYM ADDRESS AREA BDO CAPTION COL COLGROUP DEL DFN H4 H5 H6 INS KBD MAP Q SAMP
TBODY TFOOT THEAD VAR
- Most of the phrase elements:
ABBR, ACRONYM, DFN, KBD, SAMP, VAR. —Very useful.
- Inline quotations:
- Many of the
HTML 4 table elements:
CAPTION, COL, COLGROUP, TBODY, TFOOD, THEAD. —Useful.
- The lower end of the headings:
H4, H5, H6. —Useful.
- The document change elements:
DEL, INS. —Don't see why anybody would need these, but don't see any reason to exclude them, either.
- The image map elements:
AREA, MAP. —If we're going to allow
IMG, I see no reason to exclude these.
- The address element:
ADDRESS. —Why not?
- The BiDi override:
BDO.—I don't know much about how this works, but it seems to me that it might be useful for the non-English users, and I see no reason to exclude it.
As I see no reason why the use of these elements should be prohibited, I would like to have each of these Group 3 elements approved and enabled for use in comments.
In the event that there are no objections to these additions, here is a patch
adding all Group 3 elements to cleanhtml.pl's
I'd like to know where this is, as I believe it exists, so that I can add closing of the <marquee> tag if possible.
Thank you to anyone who can help point me in the right direction.