Docbook XML: Reference Books and Extensive User Manuals
Prev Chapter 14. Writing Documentation Next

Docbook XML: Reference Books and Extensive User Manuals

The main documentation of the Lire project is done in DocBook


Google

XML 4.1.2. E.g. this document is maintained in DocBook XML, as is the Lire User's Manual and the Lire FAQ. The Lire User's Manual has more information about DocBook.

After editing the Lire Developer's Manual or the Lire User's Manual, make sure the document is still a valid DocBook document. You should fix any errors before committing your changes.

If everything went right, documentation is built in txt, tex, html and pdf format by running make dist, or just make in doc/. We give some hints which might be helpful in case you have to build the documentation manually.

To generate PDF: 

	  $ pdfjadetex roadmap.tex
The last step is actually done two or three times to resolve page numbers.

To generate HTML:
And now you can use the html.dsl in the doc/source directory. (If necessary, adjust it to reflect the location of your DSSSL stylesheets). Use lynx to generate TXT output from HTML with: 
            $ lynx -nolist -dump roadmap.html > roadmap.txt