We're happy that you've decided to get started with Scroll PDF Exporter. This article will guide you through the steps required to set up your first export, using the built-in default templates.
Prefer to watch the video?
Click here if you want to watch the Scroll PDF Get Started video
Exporting to PDF is simple – just open the page you want to export, then click Tools > Export to PDF. Make sure to select the option with the PDF icon, otherwise you'll be using Confluence's inbuilt PDF Exporter.
On the Exporting PDF menu, you can pick which default template you want to use – Article, Confluence Page Layout, or Documentation. The templates have different designs and are intended for different purposes:
|Confluence Page Layout|
Exports content in the same look and feel as in Confluence
|Article||Same as the Documentation Layout, but only includes the page content (not the page title etc.) This setting is recommended for single-page exports|
|Documentation Layout||Creates exports in a style suited to documentation|
After selecting your desired template, you can click More Details to display several customization options:
|Labels||Include/exclude||Include/exclude child pages with particular page labels|
|Labels||Index terms||Check to use page labels as index terms|
|Content||Enable numbered headings||Check to number your headings|
Keep multi-column page layouts
|Uses the Confluence page layout in the export|
|Content||Enable links to external websites||If checked, web links in the PDF will be clickable|
|Content||Enable links to Confluence||If checked, links to your Confluence site will be clickable|
|Content||Repeat table header if table breaks to a new page||If checked, table headers will be repeated on all pages that the table is exported onto|
|Content||Pagebreak||Selecting this option will insert a page break after every Confluence page in the PDF export|
|Macros||Show 'Table Of Content' macro output||Displays TOC content in exports|
|Macros||Show 'Children' macro output||Displays children macro content in exports|
|Macros||Convert image gallery tables to lists||Images in gallery macros are displayed in a list rather than a grid|
|Captions||Figure captions||If an image is assigned a caption using the Scroll Title macro, you can select whether to display that caption before or after the image|
|Captions||Table captions||If an table is assigned a caption using the Scroll Title macro, you can select whether to display that caption before or after the table|
|File Options||Export filename|
Use placeholders and/or text to define the filename for the generated PDF. Selecting the + icon provides a selection of placeholders that can be used. If this field is empty, the filename will revert to the default.
i.e. Document Title-Document Revision-Export date
|File Options||Optimize links for printing||Adds a footer section displaying the full URLs of all links on the page. Further customisation options remain available for link suffixes, see Define template settings for additional information.|
|File Options||Make document PDF/A-3 compliant|
Enabling this setting, creates a PDF/A (ISO-standardized) version of the PDF upon export. This file type is intended for archiving purposes and long-term preservation of electronic documents.
|File Options||Image compression|
Define whether images are compressed in the export. Reducing the image quality (e.g. Low quality), increases the compression for exported images and will reduce the size of the exported file. As a result, images may appear distorted.
|Title/Author/Subject/Keywords||Adds metadata to the exported PDF|
|Bookmarks||PDF Bookmarks||PDF bookmarks will be added to the export for the selected heading level and all previous heading levels. e.g. Choosing Heading 3 will create bookmarks for heading levels 1, 2 and 3|
After you have selected the customization options you want, click Export.
Hide default templates from users
It is possible to hide/display the default templates on a global or space level. To change the setting on the space level, Confluence administrator or Space administrator permissions are required, and to change the setting on a global level, Confluence administrator permissions are required.
To hide/display the templates on the global level, navigate to General configuration > Scroll Runtime > Advanced plugin settings, and select Scroll PDF Exporter in the dropdown in the top-right of the screen. Now, edit the templates.bundled.visibility.global key and select Hidden or Visible.
By default, all spaces use the global setting unless the space setting is defined explicitly. If a space setting is defined explicitly, it will always overwrite the global setting. To change the setting for a specific space, you can use the following URL replacing base_url and a space_key with values from your instance:
Following this, select Scroll PDF Exporter in the dropdown in the top-right of the screen. Now, edit the templates.bundled.visibility.space key and select Hidden or Visible.
If you want to create your own custom template that fits your precise needs, you can use the inbuilt custom template designer.