Documentation Tools

Inter-document Links

Links between documents are provided by their own XML Namespace.

http://xml.water-powered.com/docs provides tags to aid in cross-linking between documents. These are:

<gloss term="Term"/>

Link to a glossary entry of the given term. For example, <gloss term="Fishing"/>.

<wiki page="Page"/>

Link to a wiki page of the given name. For example, <wiki page="XmlNamespaces"/>. As with all wiki links, convention is to leave the link text in wiki form, and not to rewrite it as something more "proper" - this helps indicate that the link is to a wiki page.

<doc name="name"/>

Link to a document of the given name. Names are flexible; they are usually expected to be over-ridden by DocumentThemes to contain parseable information. For example, to specify a section within more organised bases of documentation.

<source path="path"/>

Link to a path within the source (rather like Trac's source: macro). A leading slash should not be given. For example <source path="project/doc"/>.

All have optional element contents which, if given, will override the default link text.

Links within one document are expressed using the standard Docbook elements (for example <xref/>).