Difference between revisions of "Docbook Links"
From GnuCash
(→Motivation: Add Categories) |
(→Motivation: http->https, minor changes in highlight) |
||
| Line 2: | Line 2: | ||
==Motivation== | ==Motivation== | ||
While document internal links are easy, cross references between different documents, here Guide and Help, are difficult. | 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 | + | * When we supported only xml for yelp, we used URLs with the protocol <tt>ghelp:</tt>. But they do not work in ''html'', ''pdf'', ''mobi'' or ''epub''. |
| − | * One approach to circumvent this issue is the use of | + | * One approach to circumvent this issue is the use of <tt>https:</tt> in a published resource at ''gnucash.org''. The downside: you can not read it offline. |
| − | So we will have to use | + | So we will have to use <tt>olink</tt>s. Because olinks are very powerful, they a complicated, not well documented and their elements changed over the time. |
One easy to understand source is [http://www.sagehill.net/docbookxsl/Olinking.html Chapter 24. Olinking between documents] in [http://www.sagehill.net/docbookxsl/ DocBook XSL: The Complete Guide] | One easy to understand source is [http://www.sagehill.net/docbookxsl/Olinking.html Chapter 24. Olinking between documents] in [http://www.sagehill.net/docbookxsl/ DocBook XSL: The Complete Guide] | ||
Revision as of 17:07, 23 June 2019
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 https: 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
