Table of Contents | ||||||||
---|---|---|---|---|---|---|---|---|
|
...
Excerpt | ||
---|---|---|
| ||
Add/remove a page message |
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 messages are shown between the page title and body content whilst viewing content (it's hidden from the edit screen)
- If if triggered by
stateexpired
ortaskexpired
Eventsevents, the message won't be shown until the page is refreshed
...
One or more {set-message}
can be put macros can be added as action macros in a {trigger} macro macro.
Parameters
Parameter | Required | Default | Notes | Ver | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
unnamed first parameter |
user parameter instead | 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 behaviour behavior depends on message audience:
In both cases, specifying a | ||||||||||||||||
group | unfiltered | Only show to users in specific user group(s)?
| 5.2 | |||||||||||||
|
| Message style: if no
| 4.1 | |||||||||||||
tip and hint styles are no longer supported (since v4.1) – use success and info , respectively, instead. | ||||||||||||||||
user | unfiltered | Only show to specific user(s)?
| ||||||||||||||
view | both | Which types of content URL should the message be shown on?
| 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. | ||||||||||||||||
Notes 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. Note that youYou 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 paramparameter. |
Example
Code Block | ||||
---|---|---|---|---|
| ||||
{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} |
...