Skip to main content
Skip table of contents

Add Placeholders

Besides static content, you can also add placeholders. Placeholders reference metadata, and insert this metadata into content boxes. To add placeholder, click the + icon in the toolbar and choose your placeholder from the available list. Alternatively, you also add placeholders via the / or { keyboard shortcuts.

If you are an app developer and want to create your own placeholder for our Scroll PDF Exporter, please have a look at our Create Custom Template Placeholders (Server/DC versions only) documentation page.

Default placeholders

The following placeholders are available to all PDF exporter users:

NameDescriptionSettings
Chapter Heading

Displays the current chapter's heading (Heading 1)


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

  • Only for Confluence Data Center
Creation date

Displays the creation date of the current page

Creator UsernameDisplays the username of the creator of the current page
  • Only for Confluence Data Center
  • 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.
  • Confluence cloud - if the Full name option in the Confluence user's Profile & Visibility settings is restricted (ie. not set to Anyone), then the Public name option will be printed instead

Current page number

Displays the number of the current page in this document

  • Choose the page numbering format - numbers, letters or Roman numerals
Document Creation DateDisplays the creation date of the exported root page
Document Creator UsernameDisplays the username of the creator of the exported root page
  • Only for Confluence Data Center
Document Creator Full NameDisplays the full name of the creator of the exported root page
  • Confluence cloud - if the Full name option in the Confluence user's Profile & visibility settings is restricted (ie. not set to Anyone), then the Public name option will be printed instead
Document LabelsInclude the Confluence page labels of the export root page
  • Placeholder options:
    • Capitalisation - convert first letter of each label to upper case
    • - text to insert between individual label names
Document Last Modifier UsernameDisplays the username of the last modifier of the exported root page
  • Only for Confluence Data Center
Document Last Modifier Full NameDisplays the full name of the last modifier of the exported root page
  • Confluence cloud - if the Full name option in the Confluence user's Profile & visibility settings is restricted (ie. not set to Anyone), then the Public name option will be printed instead
Document Last Modification DateDisplays the last modification date of the exported root page
Document Owner Full NameDisplays the full name of the owner of the export root page
  • Only for Confluence Cloud
  • Default value - in this field an alternate value can be defined if the owner's privacy setting are set to hide their full name
Document Owner UsernameDisplays the username of the owner of the export root page
  • Only for Confluence Cloud
  • Default value - in this field an alternate value can be defined if the owner's privacy setting are set to hide their full name
Document Page IDDisplays the ID of the exported root page

Document Page Count

Displays the total number of pages in this document

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

This placeholder is not compatible when using the segmentation mode on Confluence Server/Data Center.

Document RevisionDisplays the revision of the exported root page

Document Title

Displays the page title of the exported root page


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
Export DateDisplays the date when the export was created
Export User UsernameDisplays the username of the user who performed the export
  • Only for Confluence Data Center
Export User Full NameDisplays the full name of the user who performed the export
  • Confluence cloud - if the Full name option in the Confluence user's Profile & visibility settings is restricted (ie. not set to Anyone), then the Public name option will be printed instead
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.)
IndexDisplays an index with the index terms you defined for this export
JSON Content Property

The specified JSON content property on the root page. This refers to properties available at:

<BASE_URL>/rest/api/content/<PAGE_ID>/property/<PROPERTY_KEY>

The placeholder returns the contents of the value field. For further information, please see the Atlassian docs for Cloud and Server/Datacenter

(Optional) Specify a JSON Pointer to extract a specific field of a JSON structure. The path/JSON pointer of the content needs to be defined with a forward slash.

For example, if the value of a property is:

CODE
{
"hello": "world",
"foo": ["bar", "baz"]
}

Then you may use paths like these to extract the following values:

/helloworld

/foo/0 bar

Last Modification DateThe last modification date of the current page
Last Modifier UsernameDisplays the username of the last modifier of the current page
  • Only for Confluence Data Center
  • 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.
  • Confluence cloud - if the Full name option in the Confluence user's Profile & visibility settings is restricted (ie. not set to Anyone), then the Public name option will be printed instead

Metadata

The specified Metadata value on the root page (Server / Data Center versions only)
  • Enable the Fallback option to use a metadata property on either the Scroll Document versioned root page, or space home page, if it is not defined on export root page
  • Within the Alternate text field you can enter specific text to show if the page property does not exist on the export root page or space home page
  • This placeholder requires an additional app, Comala Metadata for Confluence Server / Data Center
Page Content StateDisplays the state of the current page or blogpost
  • Only available on Confluence Cloud
Page IDDisplays the ID of the current page
  • Only available in Content section for templates
Page LabelsInclude the Confluence page labels of the current page
  • Placeholder options:
    • Capitalisation - convert first letter of each label to upper case
    • - text to insert between individual label names
Page Owner Full NameDisplays the full name of the owner of the current page
  • Only for Confluence Cloud
  • Default value - in this field an alternate value can be defined if the owner's privacy setting are set to hide their full name
Page Owner UsernameDisplays the username of the owner of the current page
  • Only for Confluence Cloud
  • Default value - in this field an alternate value can be defined if the owner's privacy setting are set to hide their full name
Page Revision

Displays the revision of the current page.

  • Only available in Content section for templates
Page PropertyDisplays the specified page property on the root page
Page TitleDisplays the current page title
  • Only available in Content section for templates
PDF Author

Displays the value that is set in the PDF Author parameter within the Export Properties


PDF KeywordsDisplays the value that is set in the PDF Keywords parameter within the Export Properties
PDF SubjectDisplays the value that is set in the PDF Subject parameter within the Export Properties
PDF TitleDisplays the value that is set in the PDF Title parameter within the Export Properties
Space DescriptionDisplays the description of the space that contains the exported pages
Space KeyDisplays the Confluence space key for the exported pages
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
Space NameDisplays the name of the Confluence space that the content belongs to

Section Heading

Displays the current section's heading (Heading 2)


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 Figures

Displays a table of figures for the document

Table of TablesDisplays a table of tables for the document
Table of CodesDisplays a table of code blocks for the document
Table of EquationsDisplays a table of equations for the document
Template TitlePrints the name of the export template
Template Last Modification DateDisplays the last modification date of the export template used

Scroll Document placeholders

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

Please note that these placeholders are available when using Scroll Documents v3.6.0 (and newer)

NameDescriptionSettings
Document ID (Scroll Documents)Displays the ID of the exported document
  • Define an Alternate text as a fallback if the exported document ID is unavailable
Document Title (Scroll Documents)Displays the title of the exported Scroll Document
  • Define an Alternate text as a fallback if the exported document title is unavailable
Language (Scroll Documents)Displays the language of the exported version
  • Define an Alternate text as a fallback if the variant name is unavailable
  • The use of translations in Scroll Documents requires an extension app, Translations for Scroll Documents
Variant Name (Scroll Documents)Displays the name of the exported variant
  • Define an Alternate text as a fallback if the variant name is unavailable
  • The use of variants in Scroll Documents requires an extension app, Variants for Scroll Documents
Version Name (Scroll Documents)Displays the name of the exported version
  • Define an Alternate text as a fallback if the version name is unavailable
Version Saved Date (Scroll Documents)Displays the ID of the exported version
Version Status (Scroll Documents)Displays the status of the exported version
  • Define an Alternate text as a fallback if the version status is unavailable

Scroll Versions placeholders 

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

NameDescriptionSettings
Version ID (Scroll Versions)Displays the ID of the exported version
Version Name (Scroll Versions)Displays the name of the exported version
Version Description (Scroll Versions)Displays the description of the exported version
Version Release Date (Scroll Versions)Displays the release date of the exported versionEnter a custom string using the allowed date formats
Variant ID (Scroll Versions)Displays the ID of the exported variant
Variant Name (Scroll Versions)Displays the name of the exported variant
Variant Description (Scroll Versions)Displays 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 Key (Scroll Translations)Displays the language key of the exported language
Language Name (Scroll Translations)Displays the language name of the exported language
Language Language (Scroll Translations)Displays the language attribute of the exported language
Language Country (Scroll Translations)Displays the country of the exported language
Language Variant (Scroll Translations)This depends on the system and environment of the Confluence Server - normally, it is empty

Comala Document Management placeholders

If you have integrated Comala Document Management 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

Communardo Metadata placeholder

If you have installed Communardo Metadata for Confluence, you can use the following placeholder in your template:

NameDescription
MetadatafieldRenders a metadata field value defined via the Communardo Metadata for Confluence app



JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.