×

You're using an outdated browser

For a better experience, keep your browser up to date. Check here for the latest version.

Manual

Scroll Placeholders

Thomas Rough

Thomas Rough Last update: Jan 5, 2018

You can insert a range of placeholders into your templates to modify the export. Placeholders reference metadata, and insert this metadata into content boxes. This is a list of the available placeholders: 

Default placeholders 

The following placeholders are available to all PDF exporter users:

NameDescriptionSettings
Table of contents

Displays a table of contents for the document.

Control the depth of the TOC and define how many heading levels should be displayed. This number is shown on the placeholder.
Table of TablesDisplays a table of tables for the document
Table of FiguresDisplays a table of figures for the document
IndexDisplays an index with the index terms you defined for this export.

Document Title

Displays the document title.


Document URLDisplays the document's Confluence URL.Select between the full URL or a tiny URL, and display the link as the plain URL text, the page name, or custom text.

Current page number

Displays the number of the current page in this document.

Choose the page numbering format - numbers, letters or roman numerals

Document Page Count

Displays the total number of pages in this document.

Choose the page numbering format - numbers, letters or roman numerals
Document Last Modifier UsernameDisplays the username of the last modifier of the exported root page.
Document Last Modifier Full NameDisplays the full name of the last modifier of the exported root page.
Document Last Modification DateDisplays the last modification date of the exported root page.
Document Page IDDisplays the ID of the exported root page.
Page IDDisplays the ID of the current pageOnly available in Content section for templates.
Chapter Heading

Displays the current chapter's heading (Heading 1).


Section Heading

Displays the current section's heading (Heading 2).


Export DateDisplays the date when the export was created.

Enter a custom string using the supported date formats

Export User UsernameDisplays the username of the user who performed the export.
Export User Full NameDisplays the full name of the user who performed the export.
Space NameDisplays the name of the Confluence space that the content belongs to.
Space DescriptionDisplays the description of the space that contains the exported pages.
Space KeyDisplays the Confluence space key for the exported pages.
Document Creator UsernameDisplays the username of the creator of the exported root page.
Document Creator Full NameDisplays the full name of the creator of the exported root page.
Creator UsernameDisplays the username of the creator of the current page.Only available in Content section for templates.
Creator Full NameDisplays the full name of the creator of the current page.Only available in Content section for templates.
Last Modifier UsernameDisplays the username of the last modifier of the current page.Only available in Content section for templates.
Last Modifier Full NameDisplays the full name of the last modifier of the current page.Only available in Content section for templates.
Page Revision

Displays the revision of the current page.

Only available in Content section for templates.
Document RevisionDisplays the revision of the exported root page.
Include pageInsert the content of a certain page.
  • Specify the space key of the included page
  • Specify page title
  • Add a heading offset number, which is added to the rank of the heading on that page (e.g. if offset = 2, a heading 1 becomes a heading 3.)
Page PropertyDisplays the specified page property on the root page.
Creation date

Displays the creation date of the current page.

Enter a custom string using the supported date formats. Only available in Content section for templates.
Document Creation DateDisplays the creation date of the exported root page.
Last Modification DateThe last modification date of the current page.Enter a custom string using the supported date formats. Only available in Content section for templates.
Space logoThe logo of the exported space (or a fallback logo if none is defined).
  • Define the size
  • Select a fallback logo for if no space logo is defined
  • Choose if you want the logo to be rounded or square

Metadata

The specified Metadata value on the root page. 

Content Property

The specified content property on the root page.

You cannot set content properties manually by yourself – they are only set by third party add-ons.


JSON Content PropertyThe specified JSON content property on the root page.

The path of the content needs to be defined with a forward slash

e.g. /name

Scroll Versions placeholders 

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

NameDescriptionSettings
Version IDDisplays the ID of the exported version.
Version NameDisplays the name of the exported version.
Version DescriptionDisplays the description of the exported version.
Version Release DateDisplays the release date of the exported version.Enter a custom string using the allowed date formats
Variant IDDisplays the ID of the exported variant.
Variant NameDisplays the name of the exported variant.
Variant DescriptionDisplays the description of the exported variant.

Scroll Translations placeholders 

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

NameDescription
Language KeyDisplays the language key of the exported language.
Language NameDisplays the language name of the exported language.
Language LanguageDisplays the language attribute of the exported language.
Language CountryDisplays the country of the exported language.
Language VariantThis depends on the system and environment of the Confluence Server. Normally, it is empty.

Comala Workflows placeholders 

If you have integrated Comala Workflows with Scroll PDF Exporter, you can use the following placeholders in your template:

NameDescription
Workflow State CommentThe comment provided when transitioning the root page into another workflow state without an approval.
Workflow State DateThe date when the root page was transitioned into the current workflow state. The output format is customizable.
Workflow State DescriptionThe description of the workflow state of the root page in the workflow definition.
Workflow State ContentThe content revision that the current workflow state of the root page refers to.
Workflow State UsernameThe name of the user who transitioned the root page into its current workflow state.
Workflow State NameThe name of the workflow state of the root page.
Workflow State is PublicIndicates whether the current workflow state of the root page is in a public state.

2x4.6
We use cookies to create a secure and effective browsing experience for our website visitors and to understand how you use our site (i.e. Google Analytics). For more information: click here.
Ok