Overview

The {comment} macro is used to annotate the workflow template to explain rationale and other useful information.

The comments are only visible while editing the template in the markup editor. They will not be seen by end-users.

Where to use it?

Optional.

One or more {comment} macros can be put in a {workflow} macro.

Parameters

Example

{workflow:name=Example}
   {comment}
      Plain text comment.
   {comment}
   {state:Example}
   {state}
{workflow}

All examples

See also

Workflow Authoring Guide:

• Templates

User Guide:

• Edit Workflow - Page Tools
• Using Workflow Builder

Administration Guides:

• Document Management - Space Tools
• Page Workflows - Space Tools
• Workflows - Global