[Etherboot-developers] update: documentation
Brought to you by:
marty_connor,
stefanhajnoczi
|
From: <ke...@et...> - 2003-07-26 12:07:53
|
What I've been doing with the 5.2 documentation in the CVS: I've fixed up all the content so that it's XML (as XML is also SGML, sgmltools-lite doesn't mind). This allows well-formedness to be checked with tidy -e -xml. I've updated the structure to be Docbook 4.2. I've merged security and vendortags into userman as appendices, and spec and *compressor into devman as appendices. This reduces the number of documents by 5. oldREADME, atnetboot and 16 are gone. I've been trying out a free XML editor from Morphon (www.morphon.com). It keeps the document syntax conformant to the DTD and provides a rough view of it using CSS. However as it's written in Java and uses swing, it isn't the snappiest. There's another problem and that is the editor might write things out with its own idea of whitespacing. It's still the same XML, but cvs will think there are big differences because the differencing is line oriented. So for the time being we should stick to using text editors to edit the content and use tidy and morphon to check. I might run the content through tidy soon, the conversion from linuxdoc resulted in some rather strange indentation. Now to bring the words up to date with reality. |