Page Comparison

Table of Contents

absoluteUrl	true
exclude	See Also
type	flat
separator	pipe

...

The pdf-export macro is used as an action to export a page or blog post in PDF format and adds the pdf to the page as an attachment.A .

...

The macro adds a pdf export file to the page with the following name format

<confluence_filename>_<document_version>_<date_pdf_file_created>_<time_pdf_created>.pdf

This macro is only functional when either Comala Publishing or K15t Scroll PDF Exporter is installed.

When using with K15t Scroll PDF Exporter, a parameter can be added to specify a PDF template to be used for the export. This parameter value will be a K15t Template Name or K15t Template ID value sourced from the K15t Scroll PDF Exporter app template information.

For more information, see:

Integration Guides > Content Integrations > K15t Scroll PDF Exporter App

Requirements

You must install either Comala Publishing or the K15t Scroll PDF Exporter app in order to use this macro.

If the K15t Scroll PDF Exporter app is disabled or not installed, then the macro is ignoredFor Comala Publishing - the Snapshot Publishing app must be enabled in Comala Publishing global configuration.

If you wish to export only content that is in a Comala workflow final state then you must install the Comala Document Management for Scroll Exporter app (it is free but it can only be installed after K15t Scroll PDF Exporter and Comala Document Management have been installed).

Info
The `pdf-export` macro is only supported if used with Scroll PDF Exporter 4.10.11 or higher

Use of the the macro with Comala Publishing is only available with Comala Publishing 3.0+ and Comala Document Management 6.17.6+

Where to use it?

Optional

The pdf-export macro can be put in a trigger macro.

The pdf-export macro will check first for an active install of Comala Publishing and then for an active install of K15t Scroll Exporter. If Comala Publishing Snapshot Publishing and the K15t Scroll PDF Exporter app are both disabled or not installed, then the macro is ignored.

Parameters

Parameter

Required

Default

Notes

template

No*

BlankIf

Parameter to specify a PDF template to be used for the export

Info
The template parameter is only valid if K15t Scroll Exporter app is installed.

if the template parameter is not specified, the bundled 'Documentation' template is used

.

Value can be one of:

Template Name
Template ID

K15t recommend this parameter value to be added as the template id. The template ID is found in the K15t Scroll PDF Exporter dashboard.

If the specified template is not recognized, the exported pdf will use the bundled 'Documentation' template (default template).

Comala Publishing does not support the use of this parameter - use of the macro in this case creates a basic pdf format. For greater control of the pdf format and layout K15t should be used.

Info
Use of the template parameter for the K15t Scroll Exporter app in the `pdf-export` macro is only available with Comala Document Management 6.13 or higher.

Setting a template

...

when the macro is used with K15t Scroll Exporter

To specify a template to use for export, use the template name in the {pdf-export} macro as shown.

Code Block
{pdf-export:template=Article}

...

Space Tools > Apps > Scroll PDF Exporter
Global Admin > Scroll PDF Exporter > Templates
find the template you want to use (or create a new template)
choose Template Information from the template ellipsis dropdown menu
Image RemovedImage Added
copy template ID from the K15t app popup template information
Image RemovedImage Added
add to the pdf-export macro in the workflow trigger macro