description macro

Overview

The description macro is used to define the description of your workflow template.

The description appears in the following places:

Additionally, in Page Mode:

Where to use it?

Optional, but recommended.

One description can be put in a workflow macro.

Parameters

ParameterRequiredDefaultNotes

macro body

(tick)


The description:

  • Plain text
  • Can use any character set supported by your Confluence server – except some reserved characters.

Example

{workflow:name=Described Workflow}
   {description}
      This is my awesome workflow
   {description}
   {state:Example}
   {state}
{workflow}

See also

Workflow Authoring Guide:

Administration Guides:

User Guide: