| Table of Contents | ||||||||
|---|---|---|---|---|---|---|---|---|
|
...
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:
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 |
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
Value can be one of:
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).
|
| Info |
|---|
Use of the template parameter for the K15t Scroll Exporter app in the |
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
copy template ID from the K15t app popup template information
add to the
pdf-exportmacro in the workflow trigger macro
...
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
...