Docbook Processing

From GnuCash
Jump to: navigation, search

The Docbook sources are processed into several output format:

- : Yelp
HTML: several Browsers on several OSes
FOP: PDF, epub, mobi

They interpret some Docbook elements different - the reason could be outdated XSLTs in the repo. The purpose of this page is to collect them to know what to watch in test builds.

Table

Docbook Yelp HTML PDF (other FOP need verification) Notes
<bookinfo>
<title>
<edition>
<authorgroup>
<publisher>
<releaseinfo>
<copyright>
<revhistory>
<legalnotice>
-
dispayed + window title
ignored
displayed in About page
displayed in About page
ignored
displayed in About page
ignored
displayed in About page
-
dispayed + window title
ignored
displayed in About page
ignored
displayed in About page
displayed in About page
displayed in About page
displayed in About page
-
displayed on Title & About page + window title
ignored
displayed on Title & About page
ignored
displayed in About page
displayed in About page
ignored
displayed in About page

Examples

Examples, which need caution:

Links

Docbook Yelp HTML PDF (other FOP need verification) Notes
in <ulink type="http" url="&url-selinger;accounting/tutorial.html"> &tit-sel-tut;</ulink> by Peter Selinger in Tutorial on multiple currency accounting by Peter Selinger in Tutorial on multiple currency accounting by Peter Selinger in Tutorial on multiple currency accounting [https://www.mathstat.dal.ca/~selinger/accounting/tutorial.html] by Peter Selinger links, OK
in <ulink type="http" url="&url-selinger;accounting/tutorial.html"><foreignphrase>&tit-sel-tut;</foreignphrase> by Peter Selinger</ulink>. in https://www.mathstat.dal.ca/~selinger/accounting/tutorial.html. in Tutorial on multiple currency accounting by Peter Selinger. in Tutorial on multiple currency accounting by Peter Selinger [https://www.mathstat.dal.ca/~selinger/accounting/tutorial.html]. yelp 3.36.0 can not handle inline tags in link labels and eats the label.

Verbatim Output

Put the closing tag on the last line of the output to avoid an empty bottom line.

literallayout
same font as text;
Screen and Programlisting
usually Monospaced
Screen
*
Yelp
page wide framed, but without respecting width attribute.
html
without frame.
Programlisting
*
  • attribute language produces syntaxhighlighting – at least in yelp, html probably needs configuration.
See https://github.com/GNOME/yelp-xsl/tree/master/js for yelp's usage of highlight.js.

Gui elements

Accel
not displayed in HTML, but in Yelp.