projectdoc Toolbox

Macros to help authors to reference other documents that are relevant to the current document.

Parent
Audience
Level of Experience
Type

Reference in a document allow readers to find related documents quickly. Good references enhance the navigability of the documentation.

Automatic Lists

By using automatic lists, document authors may specify links to related documents that have been written after the current document. Therefore automatic lists are a major enhancement to manually adjusted lists of references.

Value References

Creates references to documents by their names or other identifying information.

NameShort Description
Renders a locale dependent link to an external resource. The body of the macro contains the link label.
Tour Macro
Renders a predefined list of documents in a table.
Tour-by-Property Macro
Renders a predefined list of documents in a table . Documents are selected by a document property. Allows to select document properties for columns. Also non-list representations are provided.

Remote References

Creates references to remote information servers.

NameShort Description