Versions Compared

Key

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

...

Section
titlePrerequisites

This feature is available for the projectdoc Toolbox for Confluence since version 2.7.

Section
titleImpersonator

What is the impersonator feature?

First: What is transclusion? The Transclusion Macro allows to reuse content from another projectdoc document. The content is referenced from the page that contains the Transclusion Macro. The content is rendered in the referenced page and the rendered content is then inserted at the location of the Transclusion Macro.

Now impersonation: The Transclusion Macro is also in use for impersonation. In the case the Impersonator parameter of the Transclusion Macro must be checked. The Transclusion Macro still references content on another page, but this time the unrendered content is delivered to the transcluding page and the this content is rendered in the context of the transcluding page. The context is typically the document properties and the document sections of the transcluding document.

That's the theory. Now let's have a look at an example!

Section
titleDefine the Live Template

This is what our live template for this example looks like.

  1. The live template contains a query to select on child documents using the Display Table Macro. The template has three child documents named Sample Action 1 to Sample Action 3.
  2. It also transcludes text from its own document body using the Transclusion Macro. An introduction is shown on the lower left. Note that the border around the text is only shown to users with write access for faster navigation.
  3. The image on the upper right is also transcluded from a property that is part of the live template using the Display Document Property Macro.
  4. The text on the lower right is static and is not intended to be overridden by the impersonator using the Tip Box Macro.

The structure of the projectdoc document is this:

Note that the introduction section is hidden because it is transcluded in the live template and – for this example – should only be rendered once on the page. The Section Macro and Column Macro provided by Confluence are used to define the layout.

...