Difference between revisions of "Docbook Processing"
From GnuCash
(→Examples: Verbatim Output) |
(→Verbatim Output: https://github.com/GNOME/yelp-xsl) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 4: | Line 4: | ||
:FOP: PDF, epub, mobi | :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. | 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. | ||
| + | [[Category:Documentation Development]] | ||
==Table== | ==Table== | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 93: | Line 94: | ||
===Verbatim Output=== | ===Verbatim Output=== | ||
| + | Put the closing tag on the last line of the output to avoid an empty bottom line. | ||
;literallayout: same font as text; | ;literallayout: same font as text; | ||
| − | ;Screen and | + | ;Screen and Programlisting: usually Monospaced |
| − | :;Screen: | + | :;Screen: * |
::;Yelp: page wide framed, but without respecting <tt>width</tt> attribute. | ::;Yelp: page wide framed, but without respecting <tt>width</tt> attribute. | ||
::;html: without frame. | ::;html: without frame. | ||
| − | + | :;Programlisting: * | |
| + | * attribute <tt>language</tt> produces syntaxhighlighting – at least in yelp, html probably needs configuration. | ||
| + | ::: See {{URL:GH}}GNOME/yelp-xsl/tree/master/js for yelp's usage of highlight.js. | ||
| + | |||
| + | ===Gui elements=== | ||
| + | ;Accel: not displayed in HTML, but in Yelp. | ||
Latest revision as of 17:40, 30 July 2021
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>
|
-
|
-
|
-
|
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.
