Multi-Transclude from a Document

Authors may want to transclude more than one piece of content from a document. There may be a large document with information for novice and expert users. Both audiences may need the basic information. There may be some additional facts for novice users that may be of no interest for experts. And authors would like to give some hints for expert users that may just confuse beginners.

The Transclusion Macro allows to create two documents based on one document with its content tagged as 'common', 'novice' and 'expert'.

Transclude from multiple Documents

Especially for index documents or glossaries authors may need to transclude sections from a number of documents. The Transclude Documents Macro allows to define queries to match documents by their properties and then transclude sections from the documents in the result set.

There are specialized forms of this macro: Index Entries Table Macro and Index Card Macro to support creating documents like indices and glossaries.

Transcluding with Heading Level

Authors often need to transclude content that is specified with a heading level of 1 to a section that is at level 2 or lower. The transclusion macros of the projectdoc Toolbox allow to specify the target level.

From Confluence version 5.8 on, authors do not need to bother with the target level. Simply specify the asterisk ('*') and let projectdoc find the correct level. If the asterisk is defined as the target level, projectdoc will determine the level at which the transclusion is specified at request time.

Transclude into Table Cells

The Display Table Macro allows to reference documents in the form of a table. Authors map properties to table columns. They my also map sections to table columns.

Simply specify the name of the section as you would specify the name of a property. The value will be transcluded to the table column.

While the Display Table Macro fetches the list of documents that meet its search criteria on request time, the Tour Macro allows to render a table of documents. The author selects for each row in the table which document is rendered. The columns define the properties and sections to add.

Trancluding Document Properties

Similar to transcluding sections the Transclusion Macro, the Display Table Macro (and its cousins) allow to excerpt one or more property values from a document.

Trancluding Space Properties

Properties may be defined on space level. Using the Display Space Property Macro allows to render the value. Note that due to the Delegate Space authors may define hierarchies of spaces where the properties are inheritable.

For more information on space properties, please refer to Using Space Properties.

Module Documents

Information can be transcluded from any document. If you want to define chunks of information, sometimes called topics, the Core Doctypes Add-on provides the Module document type. This doctype provides standard properties and sections.

The Transcluded by section lists all documents that transclude content from the module automatically. Use Display Table for Transclusion References explains how to do this for your own documents.