Download PDF
Download page Scroll Placeholders.
Scroll Placeholders
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:
| Name | Description | Settings |
|---|---|---|
| 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 Tables | Displays a table of tables for the document | Define the Alternate text and style to be rendered if the exported content contains no tables |
| Table of Figures | Displays a table of figures for the document | Define the Alternate text and style to be rendered if the exported content contains no figures |
| Index | Displays an index with the index terms you defined for this export. | |
Document Title | Displays the document title. | |
| Document URL | Displays 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 Username | Displays the username of the last modifier of the exported root page. | |
| Document Last Modifier Full Name | Displays the full name of the last modifier of the exported root page. | |
| Document Last Modification Date | Displays the last modification date of the exported root page. | |
| Document Page ID | Displays the ID of the exported root page. | |
| Page ID | Displays the ID of the current page | Only 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 Date | Displays the date when the export was created. | Enter a custom string using the supported date formats |
| Export User Username | Displays the username of the user who performed the export. | |
| Export User Full Name | Displays the full name of the user who performed the export. | |
| Space Name | Displays the name of the Confluence space that the content belongs to. | |
| Space Description | Displays the description of the space that contains the exported pages. | |
| Space Key | Displays the Confluence space key for the exported pages. | |
| Document Creator Username | Displays the username of the creator of the exported root page. | |
| Document Creator Full Name | Displays the full name of the creator of the exported root page. | |
| Creator Username | Displays the username of the creator of the current page. | Only available in Content section for templates. |
| Creator Full Name | Displays the full name of the creator of the current page. | Only available in Content section for templates. |
| Last Modifier Username | Displays the username of the last modifier of the current page. | Only available in Content section for templates. |
| Last Modifier Full Name | Displays 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 Revision | Displays the revision of the exported root page. | |
| Include page | Insert the content of a certain page. |
|
| Page Property | Displays 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 Date | Displays the creation date of the exported root page. | |
| Last Modification Date | The last modification date of the current page. | Enter a custom string using the supported date formats. Only available in Content section for templates. |
| Space logo | The logo of the exported space (or a fallback logo if none is defined). |
|
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 Property | The 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:
| Name | Description | Settings |
|---|---|---|
| Version ID | Displays the ID of the exported version. | |
| Version Name | Displays the name of the exported version. | |
| Version Description | Displays the description of the exported version. | |
| Version Release Date | Displays the release date of the exported version. | Enter a custom string using the allowed date formats |
| Variant ID | Displays the ID of the exported variant. | |
| Variant Name | Displays the name of the exported variant. | |
| Variant Description | 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:
| Name | Description |
|---|---|
| Language Key | Displays the language key of the exported language. |
| Language Name | Displays the language name of the exported language. |
| Language Language | Displays the language attribute of the exported language. |
| Language Country | Displays the country of the exported language. |
| Language Variant | This 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:
| Name | Description |
|---|---|
| Workflow State Comment | The comment provided when transitioning the root page into another workflow state without an approval. |
| Workflow State Date | The date when the root page was transitioned into the current workflow state. The output format is customizable. |
| Workflow State Description | The description of the workflow state of the root page in the workflow definition. |
| Workflow State Content | The content revision that the current workflow state of the root page refers to. |
| Workflow State Username | The name of the user who transitioned the root page into its current workflow state. |
| Workflow State Name | The name of the workflow state of the root page. |
| Workflow State is Public | Indicates whether the current workflow state of the root page is in a public state. |