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.


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.

Version Box
since3.0

Since version 3.0 the blank level removes the heading of the first section, while '*' renders it. For all other sections the rendering algorithm is the same.

This is because not aligning the heading levels makes no sense in most if not all use cases.


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 The Impersonate 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.

Version Box
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 Apply Document Properties is checked properties of the document and space are applied as placeholders.

Version Box
since1.13

The parameter is available since version 1.13.



Section
titleTransitive Transclusion
tagsproperty

If Transitive Transclusion is checked then transclusion from transcluded content is allowed.

Otherwise the transclusion macros only have access to fragments that are physically part of the document.

Version Box
since4.0

The parameter is available since version 4.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



Transclusion
taget-heading-level*
documentDisplay Table Macro
idsHeader Translations


Section
titleForce Show
tagsproperty

If checked then content that is hidden in its original location is shown.

This effectively overrides the hide parameter of a Section Macro or Content Marker Macro.

Version Box
since3.0.2

This parameter is available since version 3.0.2 of the projectdoc Toolbox.

Prior to version 3.0 sections and content has been made visible independent of the hide configuration. Since version 3.0 the configuration of the transcluded content is strongly taken into account. This parameter again supports those use cases, where content is provided by a projectdoc document, but should not be shown in its original location.



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-boxRender 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
titleRepresents Document
tagsproperty

If checked the transcluded content represents the referenced document. Use if Names as Heading 123634169 is not selected, but the contents represents the document.

When this option is selected, localized links pointing to a document (with a link without an anchor) will target this section. Authors must only tag one transclusion to represent a document per page.

Localized links are supported by the Section Macro and the Content Marker Macro.

Version Box
since3.0

This parameter is supported since version 3.0.



Section
titleExtract Short Description
tagsproperty

If the transclusion renders properties of the transcluded document (see Select 123634169), 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 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 123634169 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.



Transclusion
taget-heading-level*
documentDisplay Table Macro
idsIdentifier Classes


Transclusion
taget-heading-level*
documentDisplay Table Macro
idsContext controlled


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}.




...