Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
doctypemacro
overridefalse
delegate-documentTransclusion Macro
Doctypemacrohide
NameTransclusion to Text Macro
Short DescriptionTranscludes content from a document marked with the content marker macro and renders it as plain text.
Parent
Parent Property
property-nameName

Audience
Name List
doctyperole
render-no-hits-as-blanktrue

Categories
Name List
doctypecategory
render-no-hits-as-blanktrue
namesTransclusion / Reference

Tags

Tag List
cssprojectdoc-compact
namesTransclusion, Context Control, Remote Control, Remote Controller


Type

Name List
doctypemacro-type
namesContent Reuse


Iteration

Iteration
valueproduction

hide
Since1.17.0
Supports Wiki Markup(tick)(tick)
Sort Keyhide
Section
indextrue
show-titlefalse
titleDescription

The Transclusion To Text Macro includes content from another page at render time and renders it as plain text. Transclusion supports single sourcing.

Since not every environment permits the transclusion of content as plain text due to security considerations, this macro is disabled by default.

This is similar to the Transclusion Macro. The Transclusion Macro, in contrast to this macro, renders the content with target format HTML. Therefore use the Transclusion To Text Macro if you need to process the transcluded content (e.g. with the Body Graph Macro).

The content to be transcluded has to be marked as a section (Section Macro) or region content (Content Marker Macro).

Transclusion
documentTransclusion only from projectdoc Documents
idsSummary


The body provides space for replacements of the form "placeholder=replacement", each on its own line. Specify a placeholder like this ${placeholderName}.

Section
delegatefalse
titleProperties

The macro provides the following parameters.

Section
titleDocument


Section
titleIdentifiers


Section
titleTags


Section
titleForce Show


Section
titleRender Reference Box


Section
titleImpersonate


Section
titleApply Document Properties


Section
titleMissing Content Message


Section
titleRemove Template Buttons


Section
titleNo Cache


Section
titleWrapping Element

Provide the name of an element to wrap around the transcluded content. Only text and digits are allowed. Should be a valid HTML element name, but is not enforced.

Version Box
since4.6.1

Available since version 4.6.1.

Section
titleCSS Classes

CSS classes for the wrapping element. Only applied if a wrapping element is specified.

Version Box
since4.6.1

Available since version 4.6.1.

Section
titleIdentifier


Section
titleIdentifier Classes


Section
titleContext controlled


Section
titleRemote Controls


Transclusion
taget-heading-level*
documentTransclude Documents Macro
idsMacro Body


Section
titleDetails
Transclusion
documentTransclusion Macro
idsDetails


Section
titleActivate Macro

To activate the macro an administrator needs to go to the Add-on page.

Here activate the macros for use by Confluence users:

  • projectdoc-transclusion-to-text-macro - used as a standard macro
  • projectdoc-transclusion-to-text-macro-curly - used in context where Confluence Wiki Markup is required
Note Box
titleConfluence Wiki Markup

In both use cases the name of the macro projectdoc-transclusion-to-text-macro is used.

...