Page Comparison

...

Table of Contents

absoluteUrl	true
exclude	See Also
type	flat
separator	pipe

Overview

Excerpt

hidden	true

export content as a pdf

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

...

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 ignored

For 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
Note that the {The `pdf-export}` macro is only supported if used with Scroll PDF Exporter 4.10.11 or higher11 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.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*	Blank

If

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
Note that use Use of the template parameter for the K15t Scroll Exporter app in the `{pdf-export}` macro 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}

K15t recommend the use of the template ID.

You can find the value of the template ID by accessing the K15t Scroll PDF Exporter dashboard

Space Tools > Apps > Scroll PDF Exporter
Image Modified
Global Admin > Scroll PDF Exporter > Templates
Image Removed
Image Added
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

If you have created or downloaded a new pdf template in the K15t PDF Exporter app the template id will be a slightly different format to the K15t app supplied templates.

...

Copy the hexadecimal template id from the Template Information.

...

Paste the template id into the pdf-export macro in the trigger.

Code Block
{pdf-export:template=4e0e8c19-67ac-4f3e-864e-1090d5ae0556}

Basic example

Code Block

language	text	theme	RDark

{workflow:name=Export PDF on Approval}
   {state:Editing|submit=Review}
   {state}
   {state:Review|approved=Approved|rejected=Editing}
      {approval:Review}
   {state}
   {state:Approved|updated=Editing|final=true}
   {state}
   {trigger:statechanged|state=Approved}
      {pdf-export}
   {trigger}
{workflow}

The statechanged event for the transition to the Approved state will add a pdf export of the current content as a file attachment to the current page. If no template name of id is specified the K15t PDF Exporter app uses the default template.

each occurrence adds a further pdf export attachment

...

The exported pdf filename by default is generated as

the content filename
the Confluence content version at the time of the export
and the date and time of the export.

The K15t admin can change the export filename structure.

If the K15t app is unable to recognize a template id or name

the pdf export will still occur but the default template will be used
an on-screen message will confirm the use of the default pdf export template

...

Events

The following Events events are associated with pdf-export

pdf-export-success
pdf-export-error

Example