This is the documentation for an older version of Scroll Office. Scroll Office is now Scroll Word Exporter. Here you can view the most up-to-date version of Scroll Word Exporter.

Using Placeholders

Additionally, the templates can contain placeholders. During export, the Scroll Exporters can replace the placeholders with metadata from Confluence, such as the page creator’s name or email address.

On top of the placeholders listed here, you can also define your own placeholders using the Page Properties Macro. Please have a look at the following page for further details: Using Page Properties as placeholder

Available Placeholders

The following table lists the available placeholders:

Placeholder

Description

Variations

Page Information

   

$scroll.title

The title of the exported root page.

none

$scroll.version

The version of the exported root page.

none

$scroll.creator

The creator of the exported root page.

$scroll.creator.name  - Creator's account name
$scroll.creator.fullName  - Creator's full name
$scroll.creator.email - Creator's email

 $scroll.pageurlThe URL of the exported root page. 
 $scroll.tinyurlThe tiny URL of the exported root page.none

$scroll.creationdate

The creation date of the exported root page.

You can apply SimpleDateFormat on the date by appending .(FORMATTING-EXPRESSION).
For example $scroll.creationdate.(yyyy-MM-dd) creates a date in the format: 2010-08-27.

$scroll.modifier

The last modifier of the exported root page.

$scroll.modifier.name - Modifier's account name
$scroll.modifier.fullName - Modifier's account name
$scroll.modifier.email - Modifier's account name

$scroll.modificationdate

The last modification date of the exported root page.

You can apply SimpleDateFormat on the date by appending .(FORMATTING-EXPRESSION).
For example $scroll.creationdate.(yyyy-MM-dd) creates a date in the format: 2010-08-27.

$scroll.metadata.(YOUR_METADATA_KEY)

This placeholder can be used to access metadata defined on the root page of your export.
(warning) This placeholder depends on the Confluence Metadata Plugin as a prerequisite. 

See Defining Your Own Metadata for more information.

Space Information

Placeholder

Description

Variations

$scroll.spacelogo

The space logo of the current space.

You can scale the space logo by appending .(HEIGHT, WIDTH).
For example $scroll.spacelogo.(200,100) renders the space logo with 200px height and 100px width.

 $scroll.space.keyThe spacekey of the current space. 
 $scroll.space.nameThe name of the current space. 
 $scroll.space.groupThe group of the current space. 
 $scroll.space.urlThe URL of the current space. 

Export Information

Placeholder

Description

Variations

$scroll.content

The full content of the export.
(warning) This placeholder will be replaced only once.

none

$scroll.exporter

The user who exported the export.

$scroll.exporter.name - Exporter's account name
$scroll.exporter.fullName - Exporter's account name
$scroll.exporter.email - Exporter's account name

$scroll.exportdate

The date of the export.

You can apply SimpleDateFormat on the date by appending .(FORMATTING-EXPRESSION).
For example $scroll.creationdate.(yyyy-MM-dd) creates a date in the format: 2010-08-27.

 $scroll.globallogoThe global logo of the Confluence system. 
 

$adhocState

The state of the export root page taken from Comala Workflows. Possible values: 'DRAFT', 'PUBLISHED' or null (if there are no Comala Workflows in this space).
You may want to use $!adhocState to avoid 'null' printouts.
 
Static Content   
 $scroll.includepageThe content of a specific page.

$scroll.includepage.(pagename)
$scroll.includepage.(SPACEKEY:pagename)
$scroll.includepage.(pageid)

Inserting a placeholder

  1. Open your Word template and enter the placeholder you want to insert.
  2. Save the template and upload it to your space.

Scroll Versions Placeholders 

If you are using Scroll Versions, you can use the following placeholders in your template:

When exporting a page from Currently Published (<Scroll Versions 3.0) or Reader View (>Scroll Versions 3.0), only these placeholders are resolved:

PlaceholderRendered value
$scrollVersions.Version.Idcurrent
$scrollVersions.Version.NameCurrently Published
$scrollVersions.Version.Descriptioncurrently published version
PlaceholderDescription
$scroll.versions.Version.IdThe ID of the exported version.
$scroll.versions.Version.NameThe name of the exported version.
$scroll.versions.Version.DescriptionThe description of the exported version.
$scroll.versions.Version.ReleaseDateThe release date of the exported version.
$scroll.versions.Version.Archived

The archive status of the exported version:
(info) Returns "true" if the exported version is archived.
(info) Returns "false" if the exported version is not archived.

$scroll.versions.State.KeyThe key of the Scroll Versions workflow.
$scroll.versions.State.NameThe name of the current Scroll Versions workflow of the exported page.
$scroll.versions.Variant.IdThe ID of the exported variant.
$scroll.versions.Variant.NameThe name of the exported variant.
$scroll.versions.Variant.DescriptionThe description of the exported variant.

Scroll Translations Placeholders 

If you are using Scroll Translations, you can use the following placeholders in your template:

Placeholder

Description

Example
$scroll.versions.Language.KeyThe language key of the exported language.pt_BR
$scroll.versions.Language.NameThe language name of the exporter language.Portuguese (Brazil)
$scroll.versions.Language.LanguageThe language of the exported language.Portuguese
$scroll.versions.Language.CountryThe country of the exported language.Brazil
$scroll.versions.Language.VariantThe variant of the exported language.(This depends on the system and environment of the Confluence Server, usually empty)