Versions Compared

Key

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

...

Section
titleImpersonator by Example

The impersonator feature requires two documents. One that defines the template to be reused, one uses the template and applies information from its own context.

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.

Section
titleImpersonator Document

The impersonator uses the layout defined by the live template.

The following content is from the context of the impersonator.

  1. The child documents are the ones of the impersonator
  2. The introduction is transcluded from the impersonator (see below)
  3. The image is from the impersonator (see below)

The static context, the Tip of the Day is rendered as is from the live template.

So here is the context the impersonator provides.

  1. A hidden Section Macro (the macro provided by the projectdoc Toolbox, not the macro provided by Confluence!) with the introduction text
  2. An image as value to the Image property
  3. The two child documents

The impersonator uses the Transclusion Macro with the impersonator feature switched on.

The macro references the live template as would be the case by a regular transclusion.

Section
titleWhy is it called "Live Template"?

Well, if you change the layout in the template, the impersonating documents are updated accordingly on the next request.

Changing lines and the image to the left ...

Image Added

.. on next request on the impersonator, the layout is applied!

Image Added

Section
titleWrap-up

You have seen an example using the impersonator feature of the PDAC1. Impersonation is similar to transclusion, but instead of fetching a fully rendered part of a document, only the layout information is fetched as is. This layout is then rendered in the context of the transcluding page. This way the document properties and sections of the transcluding page are used for rendering. In the context of a normal transclusion the document properties and sections of the transcluded document would be used.

The impersonator is activated by checking the Impersonate parameter of the Transclusion Macro.

Impersonating – as simple as that!

...