Difference between revisions of "Documentation Components"

Revision as of 04:12, 9 August 2017

The Docbook based Gnucash documentation makes use of several components to produce the different output forms. See also the README file.

Supported Output formats

The primary target is the context sensitive help for the program. It's format is OS dependent:

• Docbook for Gnome's Yelp
• HTML
  • plain for MacOs's browser
  • compiled for Windows help viewer.

Additional supported are for offline reading:

• PDF
• Mobi
• ePub

Source file templates

TODO

Processing

The processing is done by Extensible Stylesheet Language Transformations (XSLT), where xsltproc applies on the elements of the source XML file the instructions of the respective XSL file.

For that reason the repository contains in the xsl directory a copy of docbook-xsl, currently 2017 in version 1.75.2.

Alternatives by yelp

Yelp offers its own tools and stylesheets. yelp-build can process

• from: Mallard, DocBook, man, info, and HTML documents
• to: HTML, EPUB, ...

It might be useful to run sometimes yelp-check to verify the compatibility.