Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Section


Column
width60%


Document Properties Marker
overridefalse


 
Short DescriptionThere are basically five ways to render navigation links with additional properties with the projectdoc Toolbox. 
Doctypetopichide
NameRendering Navigation Links 
Short Name
Parent
Parent Property
propertyParent
property-nameName
 
Audience

Name List
doctyperole
render-no-hits-as-blanktrue
render-list-as-comma-separated-valuestrue
namesAuthor, Template Author, Documentation Architect
propertyAudience

 
Level of Experience

Name List
doctypeexperience-level
render-no-hits-as-blanktrue
namesNovice
propertyLevel of Experience

 
Expected Duration15 min 
Subject
Name List
doctypesubject
propertySubject
 

Categories
Name List
doctypecategory
propertyCategories
 
Tags

Tag List
render-list-as-comma-separated-valuestrue
namesConfluence, projectdoc Toolbox, Navigation
propertyTags


Flagslinks, navigation, dynamic links, automatic links
propertyTags
hide
Iteration

Iteration
valueproduction

hide
Type

Name List
doctypetopic-type
render-no-hits-as-blanktrue
namesTip
propertyType

 


Sponsors
Name List
doctypestakeholder
render-no-hits-as-blanktrue
propertySponsors
 

Sort Keyhide
enable-heading-numbersfalsetruehide




Column


Panel
titleContents

Table of Contents
outlinetrue
indent20px
stylenone



...

Section
titleSummary

The projectdoc Toolbox for Confluence provides the following macros to render navigation links.

Tour
render-as-definition-listtrue
replace-title-with-nametrue



In addition to the name of the document, any property or section may be displayed for the link.


Section
titleList Static 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.

Section
titleTour 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.


Section
titleTour-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.

 



Section
titleDisplay Document Properties Macro

If there is only one link to render, the Display Document Properties Macro is doing the job.

Using the template

Code Block
languagetext
$[Name] - ${Short Description} (${Audience})

the rendered links shows up like this:



Section
titleDynamic Links

So far the links for navigation have been explicitly specified. In case you want to specify a subject or category and list all links that match this specification, you'll employ dynamic links (aka automatic links).

Section
titleDisplay Table Macro

The Display Table Macro allows to specify a query and list documents with a given set of properties.

Image Added

Tip Box

The Display Table Macro can be configured to render the list of document links in alternative representations or apply style information. Please refer to Render Mode for details.



Section
titleDisplay List Macro

The Display List Macro is similar to the Display Table Macro, but is rendering the result set of document links as a list.

Image Added

Note Box

With version 1.17 of the projectdoc Toolbox there will be the Display List Template Macro that allows to have more control over what is rendered in the name and data parts of definition lists.




Section
titlePrerequisites


Section
titleSubordinate Topics
Display Table
doctypetopic
render-no-hits-as-blanktrue
selectName, Short Description
restrict-to-immediate-childrentrue
sort-bySort Key, Name

...

Section
titleResources

Information on related topics.

Tour
render-as-definition-listtrue
replace-title-with-nametrue





Piwik Set Multiple Custom Variables


NameValue
Departmentprojectdoc
Categoryprojectdoc-tip
Typehowto