Difference between revisions of "Documentation Components"
m (→Alternatives: yelp-xsl URI) |
(→Processing: OMF section) |
||
| Line 26: | Line 26: | ||
== Processing == | == Processing == | ||
| + | === XML === | ||
The processing is done by Extensible Stylesheet Language Transformations (XSLT), where <code>xsltproc</code> applies on the elements of the source XML file the instructions of the respective XSL file. | The processing is done by Extensible Stylesheet Language Transformations (XSLT), where <code>xsltproc</code> applies on the elements of the source XML file the instructions of the respective XSL file. | ||
| Line 32: | Line 33: | ||
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]. | 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 === | + | === OMF === |
| + | Our omf.make has in its header <syntaxhighlight lang="sh"> | ||
| + | # This file was taken from scrollkeeper_example2, a package illustrating | ||
| + | # how to install documentation and OMF files for use with ScrollKeeper | ||
| + | # 0.3.x and 0.4.x. For more information, see: | ||
| + | # http://scrollkeeper.sourceforge.net/ | ||
| + | # Version: 0.1.2 (last updated: March 20, 2002) | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | === Alternatives to docbook-xslt === | ||
| + | |||
==== by yelp ==== | ==== by yelp ==== | ||
Yelp offers its own tools and stylesheets [https://wiki.gnome.org/Apps/Yelp], which are significant smaller: <code>file:///usr/share/yelp-xsl/xslt</code>. | Yelp offers its own tools and stylesheets [https://wiki.gnome.org/Apps/Yelp], which are significant smaller: <code>file:///usr/share/yelp-xsl/xslt</code>. | ||
Revision as of 22:25, 10 August 2017
The Docbook based Gnucash documentation makes use of several components to produce the different output forms. See also the README file.
Contents
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:
- 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
XML
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.
OMF
Our omf.make has in its header# This file was taken from scrollkeeper_example2, a package illustrating
# how to install documentation and OMF files for use with ScrollKeeper
# 0.3.x and 0.4.x. For more information, see:
# http://scrollkeeper.sourceforge.net/
# Version: 0.1.2 (last updated: March 20, 2002)
Alternatives to docbook-xslt
by yelp
Yelp offers its own tools and stylesheets [1], which are significant smaller: file:///usr/share/yelp-xsl/xslt.
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.
by GDU
is based on the usually make and has his own xslts, too:
file:///usr/share/xml/gnome/xslt
