Versions Compared

Key

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

...

Section
titleProperties
Section
titleDocument

The Confluence page from which to transclude content. As this field is mandatory you have to enter the page from which to transclude content. In the case of transcluding content from the current page combined with a theme like the ones provided by Brikit Theme Press for Confluence you can use @self as the name of the page to indicate that the content shall be transcluded from the page that uses this layout.

The following graphic illustrates the usage of @self.

Transclusion
documentGraphic to Illustrate the @self use-case
idsSummary

Section
titleIdentifiers
tagsproperty

The identifiers of marked content or sections to include.

Usually only one identifier is used to include one content, but it need not to be only one.

Transclusion
documentTransclude Documents Macro
idsselection-options

Section
titleTags
tagsproperty

The tags of marked content or sections to include. Multiple elements are added in the order they appear in their document.

Section
titleTarget Heading Level
tagsproperty

Specifies the new base level of the transcluded fragment. The top-level heading will be set to this level and subsections are transformed accordingly.

This modifier allows to render a section with subsections within another page adjusted to the target's heading level.

Example Box

If the target heading level is set to 2 and the top-level heading is a h1, each heading within the transcluded fragment is incremented by one.

Note Box

We are referring to the projectdoc Section Macro, not the Confluence Section Macro.

Since version 1.7 the Target Heading Level may be set to '*'. In this case the level is calculated depending on the location of the macro. If the parent is a section at level X, the target level will be set to X+1.

Warning Box

You typically should not combine a target level of 'blank' with documents using sections (with levels or a '*').

The use of the blank target level may be deprecated in the future.

Tip Box
titleTip on Heading Level Transposition

The tip Heading Level Transposition provides an example on how this feature is used.

Section
titleImpersonate
tagsproperty

This feature allows to define a template that is rendered in the context of the transcluding document.

If checked the transcluding document is used to render the content of the transcluded document.

projectdoc-box-noteversion
since2.7

This parameter is available since version 2.7.

See Impersonator - using Live Templates for a tip on using this feature.

Section
titleApply Document Properties
tagsproperty

If checked properties of the document and space are applied as placeholders.

Note Box

This parameter is available since version 1.13.0.

Section
titleSelect
tagsproperty

Specify a comma-separated list of page properties from the transcluded document to be rendered in a table. You may also specify section names.

Transclusion
documentPDAC:Deep Link
idsDeep Links for Select Clauses

Section
titleRender Reference Box
tagsproperty

If checked, a box that marks the transcluded text is rendered with a link to the part in the document (if the transcluded part is uniquely identifiable).

Here is an example of transcluded content from an example page named "A Document":

Example of transcluded content with box.

If you click on the name you jump to the document of the transcluded content.

Transclusion
documentrender-transclusion-box
idsDescription

Note Box
titleLive Templates with Impersonator

The impersonator box has edges on the upper left and lower right corner.

Section
titleMissing Content Message
tagsproperty

If unchecked, no message will be rendered, if no content is to be transcluded.

Usually maintainers of the documentation site require to take notice of missing transclusions. So if this option is checked (per default), a warning message will be rendered on missing content.

Example message on missing content 'Content2'.

Section
titleRemove Template Buttons
tagsproperty

If checked template buttons are not transcluded.

This makes it easy to remove buttons from content. Otherwise the button would create new pages as children to the transcluding page.

Section
titleName as Heading
tagsproperty

If checked renders the name of the transcluded document as heading. Requires target level to be set to a value between 1 and 6.

Section
titleExtract Short Description
tagsproperty

If the transclusion renders properties of the transcluded document (see 81035939), the state of this checkbox controls the rendering of the Short Description property. If checked the short description is rendered on top of the table showing the properties. If unchecked the description is rendered as a key/value property in the properties table.

Section
titleSuppress Selection
tagsproperty

Transclusions may slow down the rendering process. To help authors to speed up rendering, the space property suppress-transclusion helps to suppress transclusions. This allows to render the properties table without actually transcluding sections from the page.

If this box is checked, the specified select is only applied if the space is suppressing transclusions.

Section
titleNo Cache
tagsproperty

If checked the macro will not use the page fragment cache to calculate the transcluded page fragment.

This does only apply if the space is using the transclusion cache. Otherwise the state of the checkbox has no effect.

Note Box

This parameter is available since version 1.9.0.

If the macro uses placeholders, caching will automatically switched off.

Section
titleIdentifier

The identifier is rendered with the encosing HTML element.

It is also useful to uniquely identify the macro in a page.

Note Box

This parameter is available since version 1.12.0.

Section
titleReplacements (Body of Macro)
tagsproperty

Specify the replacements in the macro's body.

Placeholder/replacement pairs, separated by an '=' character of the form "placeholder=replacement", each on its own line.

Specify a placeholder like this ${placeholderName}.

Example Box

This is an example for placeholder replacements in the body:

Code Block
languagetext
product-name=projectdoc Toolbox
product-version=2.0

And this is an example of a fragment that defines the placeholders:

Code Block
languagetext
There current version of ${product-name} is ${product-version}.

...