Overview
Snapshot publishing allows you create static versioned documents from your dynamic Confluence content, freezing content from Confluence macros that display live content in the snapshot document. A snapshot of a Confluence document can be created using a workflow trigger.
Once a snapshot is created, it can be organized and managed in one or more themed groupings of snapshot documents - called collections - to create manuals, static records for audit. View permissions for each collection can be added outside space permissions.
A global collections viewer in the Confluence header allows users to view snapshots in PDF or HTML format.
The Comala Publishing (Snapshot Publishing) app v3.0+ must be installed to enable snapshot publishing. |
Requires Comala Document Management v6.17.6+
Activating snapshot publishing
There are two steps to setting up snapshot publishing:
/wiki/spaces/AHP/pages/14172848373 to enable snapshot publishing in a space
Update your workflow to trigger the snapshot publishing process (see below)
Workflow markup
The publishing is triggered by an action macro, snapshot-page, which must be used in a trigger.
{workflow:name=Snapshot Publishing} {state:Editing|submit=Review} {state} {state:Review|approved=Published|rejected=Editing} {approval:Review|assignable=true} {state} {state:Published|final=true|updated=Editing} {state} {trigger:statechanged|state=Published} {set-metadata:lastapprover} @user@ {set-metadata} {snapshot-page|collection=@collectionname@|editor=@lastapprover@} {trigger} {workflow}
The example markup above based on the example from same-space publishing, but we've added the trigger at the bottom.
When the state changes to Published, the trigger is activated and the snapshot-page
macro instructs the Comala Publishing app to create a snapshot document from the Confluence document.
the collection parameter is required to add the snapshot to a named collection. The example uses a workflow parameter value reference @collectionname@ for the value of this parameter
the editor parameter adds the user who be set as the creator of the snapshot. The example uses a metadata value set on transition to the Published state for the value of this parameter
The user must have been added as a collection contributor to the collection permissions by the user who created the collection.
For snapshot publishing all the work is done by the snapshot-page
macro. The snapshot-page
macro can be used to publish the content from any state using an appropriate trigger event.
Macros
-
pdf-export macro — export content as a pdf
-
snapshot-page macro — Create a static versioned snapshot of a document
Examples
Filter by label
There are no items with the selected labels at this time.
See also
Comala Publishing