Versions Compared

Old Version 1

changes.mady.by.user Robert Alexander Marshall

Saved on

compared with

New Version Current

changes.mady.by.user Robert Alexander Marshall

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

Status

...

subtletrue

...

Warning

...

titleDeprecated
The comment macro is deprecated. 

Please use the description field of other macros to include extra contextual information.

Overview
Status
subtletrue
titleDeprecated

Excerpt
hiddentrue

Status
subtletrue
titleDeprecated
- Annotate workflow templates.

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?
Status
subtletrue
titleDeprecated

Optional.

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

Parameters
Status
subtletrue
titleDeprecated

Parameter

Required

Default

Notes

Ver

macro body

(tick)

(tick)

 


The comment:

  • Plain text

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

4.0+

Example
Status
subtletrue
titleDeprecated

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

All examples

...

See also
Workflow Authoring Guide:
User Guide:
Administration Guides: