Difference between revisions of "Documentation Components"

From GnuCash
Jump to: navigation, search
(Source file templates: GDP 2 vs.GDU)
(Processing: XSLT documentation)
Line 29: Line 29:
  
 
For that reason the repository contains in the <code>xsl</code> directory a copy of docbook-xsl, currently 2017 in version 1.75.2.
 
For that reason the repository contains in the <code>xsl</code> directory a copy of docbook-xsl, currently 2017 in version 1.75.2.
 +
 +
After you installed it locally, you should have its ''reference documentation'' under <code>file:///usr/share/doc/packages/docbook-xsl-stylesheets/html/index.html</code>. For the ''HowTo'' see Bob Stayton's [http://www.sagehill.net/docbookxsl/index.html DocBook XSL: The Complete Guide].
  
 
=== Alternatives by yelp ===
 
=== Alternatives by yelp ===

Revision as of 15:43, 10 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

Current Source files have a marker

<!--
      (Do not remove this comment block.)
  Template Maintained by the GNOME Documentation Project:
	  http://developer.gnome.org/projects/gdp
  Template version: 2.0 beta
  Template last modified Feb 12, 2002
-->

Fell (talk) considers replacement by Gnome Doc Utils.

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.

After you installed it locally, you should have its reference documentation under file:///usr/share/doc/packages/docbook-xsl-stylesheets/html/index.html. For the HowTo see Bob Stayton's DocBook XSL: The Complete Guide.

Alternatives by yelp

Yelp offers its own tools and stylesheets. [1]

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.