SGML and friends

Essential links

• SGML primer
• Get going with DocBook
• Reference for the DocBook DTD
• Visual introduction to DSSSL (Java)
• Jade
• DocBook
• Tidy

Documentation project, IDI

Goal: produce lots of small introductions to various programs, and the dtd+stylesheet for such introductions, for the benefit of newbies/lusers.

The example used: introduction to XFontSel

• Results of the docbook-classic stylesheet. Clearly, having each introduction as a book is severe overkill :)
• Using a slightly customized stylesheet, and using <article> in stead of <book> definitely improves matters
• More or less finished introductions

The following files are used to produce the finished product:

• mouse.frag.sgml defines standardized mouse actions, like left-click etc.
• shortcuts.frag.sgml defines other useful and important entities
• template.sgml is the basis for each intro.
• footer.frag.html is spliced into the resulting html-file using the sed-commands in fix.sed or with a similar convenient tool...

Commands to generate an html file (I put them in an alias):

   1. jade -d PATH_TO/appetizers.dsl -t sgml -i html FILE.sgml > TEMPFILE1
   2. tidy < TEMPFILE1 > TEMPFILE2
   3. sed -f fix.sed TEMPFILE2 > FILE.html

Command to generate a tex-file for further use:

   jade -d PATH_TO/appetizers.dsl -t sgml -i tex FILE.sgml

This generates the file FILE.tex

More to come as things are done