Docbook Links

From GnuCash
Revision as of 20:16, 8 February 2017 by Fell (talk | contribs) (First sketch)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Docbook offers several forms of links: link, olink, ulink, xref. This page will one day explain, which form to use in which case.

Motivation

While document internal links are easy, cross references between different documents, here Guide and Help, are difficult.

  • When we supported only xml for yelp, we used URLs with the protocol ghelp:. But they do not work in html, pdf, mobi or epub.
  • One approach to circumvent this issue is the use of http: in a published resource at gnucash.org. The downside: you can not read it offline.

So we will have to use olinks. Because olinks are very powerful, they a complicated, not well documented and their elements changed over the time.

One easy to understand source is Chapter 24. Olinking between documents in DocBook XSL: The Complete Guide