You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
Version 1
Next »
There are basically five ways to render navigation links with additional properties with the projectdoc Toolbox.
The projectdoc Toolbox makes it easy to display links with additional information from the document's properties. Especially the short description is often used to inform the reader what the document the link points to is all about.
This short tip lists all macros that support navigation.
Summary
The projectdoc Toolbox for Confluence provides the following macros to render navigation links.
In addition to the name of the document, any property or section may be displayed for the link.
List Links
The first way to add links to other documents to support navigation for users is to manually list them. Using the Tour Macro, the Tour-by-Property Macro, or the Display Document Properties Macro the links may also display additional properties from the document the link points to.
Tour Macro
The Tour Macro supports a table where each additional property is rendered in a table column.
In the example above the first column has the title of the documents to point to as links. The second column will render the short description of the documents the links point to. There may be any number of columns. The column containing the links does not need to be the first column.
Tour-by-Property Macro
In case you also need to access the linked documents in queries, you already have the list of documents to point to as a value to a document property.
Properties are part of the Document Properties Marker Macro every projectdoc blueprint provides.
Display Document Properties Macro
If there is only one link to render, the Display Document Properties Macro is doing the job.
Using the template
$[Name] - ${Short Description} (${Audience})
the rendered links shows up like this:
Resources
Information on related topics.