diff options
author | Gaetan Nadon <memsize@videotron.ca> | 2011-02-27 15:06:18 -0500 |
---|---|---|
committer | Gaetan Nadon <memsize@videotron.ca> | 2011-03-30 20:18:36 -0400 |
commit | fd4973cb7986e69bf47264430fbd17c58be9d0cd (patch) | |
tree | 8910989ec0969cf0be34e2f9b1344b39e45c259b /xcmiscstr.h | |
parent | 485c361562e986efa1cf05d2c70553e99c1b9382 (diff) | |
download | xorg-proto-xcmiscproto-fd4973cb7986e69bf47264430fbd17c58be9d0cd.tar.gz |
Documentation: add Docbook external references support
When writing technical documentation, it is often necessary to cross
reference to other information. When that other information is not in the
current document, additional support is needed, namely <olink>.
A new feature with version 1.7 of xorg-sgml-doctools adds references to
other documents within or outside this package.
This patch adds technical support for this feature but does not change
the content of the documentation as seen by the end user.
Each book or article must generate a database containing the href
of sections that can be referred to from another document. This database
is installed in DATAROOTDIR/sgml/X11/dbs. There is a requirement that
the value of DATAROOTDIR for xorg-sgml-doctools and for the package
documentation is the same. This forms a virtual document tree.
This database is consulted by other documents while they are being generated
in order to fulfill the missing information for linking.
Refer to the xorg-sgml-doctools for further technical information.
Co-authored-by: Matt Dew <marcoz@osource.org>
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Diffstat (limited to 'xcmiscstr.h')
0 files changed, 0 insertions, 0 deletions