×

You're using an outdated browser

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

Manual

Get started with default templates

Thomas Rough

Thomas Rough Last update: Jun 27, 2018

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

Export content 

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: 

NameDescription
Confluence Page Layout

Exports content in the same look and feel as in Confluence

ArticleSame as the Documentation Layout, but only includes the page content (not the page title etc.) This setting is recommended for single-page exports
Documentation LayoutCreates exports in a style suited to documentation

After selecting your desired template, you can click More Details to display several customization options:

TabNameDescription
LabelsInclude/excludeInclude/exclude child pages with particular page labels
LabelsIndex termsCheck to use page labels as index terms
ContentEnable numbered headingsCheck to number your headings
Content

Keep multi-column page layouts

Uses the Confluence page layout in the export
ContentEnable links to external websitesIf checked, web links in the PDF will be clickable
ContentEnable links to ConfluenceIf checked, links to your Confluence site will be clickable
ContentRepeat table header if table breaks to a new pageIf checked, table headers will be repeated on all pages that the table is exported onto
MacrosShow 'Table Of Content' macro outputDisplays TOC content in exports
MacrosShow 'Children' macro outputDisplays children macro content in exports
MacrosConvert image gallery tables to listsImages in gallery macros are displayed in a list rather than a grid
CaptionsFigure captionsIf an image is assigned a caption using the Scroll Title macro, you can select whether to display that caption before or after the image
CaptionsTable captionsIf an table is assigned a caption using the Scroll Title macro, you can select whether to display that caption before or after the table
Print optionsOptimize export for printingadds a footer section displaying the full URLs of all links on the page

PDF Metadata

Title/Author/Subject/KeywordsAdds metadata to the exported PDF

After you have selected the customization options you want, click Export.

Hide default templates from users 

 Expand to learn how to 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:

http://<base_url>/plugins/servlet/scroll-settings/?key=<space_key>

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.

Next steps

If you want to create your own custom template that fits your precise needs, you can use the inbuilt custom template designer.

2x4.0
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