Overview
Use the set-message macro to display an on-screen message. It's great for keeping the user informed during the content production process.
- messages are shown between the page title and body content whilst viewing content (it's hidden from the edit screen)
- if triggered by
stateexpired
ortaskexpired
events, the message won't be shown until the page is refreshed
Where to use it?
Optional.
One or more {set-message}
macros can be added as action macros in a trigger macro.
Parameters
Parameter | Required | Default | Notes | Ver |
---|---|---|---|---|
unnamed first parameter | DEPRECATED Use the | Deprecated 5.2 | ||
macro body | The message to display:
| |||
Replaces existing message to the same audience; if empty, the message panel will be removed for that audience. | ||||
| How long should the message be displayed from the point at which it is set?
| |||
Default behavior depends on message audience:
In both cases, specifying a | ||||
group | unfiltered | Only show to users in specific user group(s)?
Filter by labelThere are no items with the selected labels at this time. | 5.2 | |
|
| Message style: o o o o if no
| 4.1 | |
OBSOLETE The | ||||
user | unfiltered | Only show to specific user(s)?
Filter by labelThere are no items with the selected labels at this time. | ||
view | both | Which types of content URL should the message be shown on?
Filter by labelThere are no items with the selected labels at this time. | 5.2 | |
This parameter determine which URL the message will be shown on when using Same-space publishing:
If you're not using same-space publishing, all users see the normal URL by default. | ||||
The
Unfiltered messages, those which do not specify user or group, are treated separately:
Use the macro body empty to remove the previously set message. You need to use the same parameters that are in the message you want to remove e.g., if the message contained view=draft, then, your empty set-message macro must have the very same view=draft parameter. |
Example
{workflow:set-message test} {state:Ready} {state} {state:Test} {state} {trigger:statechanged|state=Test} {set-message} This message shown to everyone {set-message} {set-message:user=@user@} You transitioned to the {{Test}} state {set-message} {trigger} {trigger:statechanged|state=Ready} {set-message}{set-message} {trigger} {workflow}
All examples
-
-
-
Attachment events — Triggering events when attachments are created, updated or removed.
-
Blog Post Events — Workflow events associated with blog posts
-
Message notification styles — Test the
style
parameter of the{set-message}
macro -
Using set-message and metadata to display different information for the draft and published content — Using the
view
parameter of the{set-message}
macro to display a different metadata when users view the draft or published versions