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.

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.

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

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.

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.

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.

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

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

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":

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

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.

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.

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

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.

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.

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.

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

The identifier is rendered with the encosing HTML element.

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

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

product-name=projectdoc Toolbox
product-version=2.0

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

Remote Controlled Documents allow to control the content at request time. A HTTP  request may override parameters of the transclusion macro. A request parameter addresses a transclusion macro by its identifier. After the identifier the name of the parameter is appended, separated by a colon.

confluence/display/MYS/MyPage?my:document=b2&my:ids=Description

body=Placeholder1%3DMyValue1\nPlaceholderX%3ValueB

The list of parameters allowed to override:

• document
• ids
• tags
• select
• taget-heading-level (yes, the 'r' is missing!)
• render-document-name-as-heading
• apply-document-properties
• render-error-on-no-content
• remove-template-buttons

To search for pages that transclude information from a given document, use the following search syntax:

macroName:projectdoc-transclusion-macro* AND ("{Title of transcluded page}")

This will return all pages that are using the transclusion macro and have the title on their page content.

If you are using documentation modules, the pages transcluding the module will be displayed automatically.

If you have a document with identical titles, it is still possible to transclude the individual sections. Confluence ensures that each heading on a page is unique. This is required by the HTML 5 standard. projectdoc use this service to also make sections unique. Therefore a title that occurs a second time on the same page is suffixed with '.1'. The next with '.2', '.3', and so on.

Here is the page with two sections titled 'Content'.

Here is the macro editor selecting the content of the second section titled 'Content' by selecting on 'Content.1':

A list of macros supporting transclusion or embedding of contents provided by Atlassian:

• Excerpt Include Macro and Excerpt Macro - the native Confluence macro to use for transclusion.
  
• Include Page Macro - includes a complete page into the document.
  
• HTML Include Macro - includes a HTML document into the document.
  
• View File Macro - embeds an Office or PDF document into the document.