Page Comparison

unnamed first parameter

Deprecated v5.2

macro body

The message to display:

• Plain text, or Confluence Wiki Markup

• Supports Value References

Replaces an existing message to the same audience; if the macro is empty, the message panel will be removed for that audience.

{set-message}{set-message}

A message that included view=draft would require the empty macro to be configured with the same parameter to remove the displayed message.

{set-message:view=draft}{set-message}

duration

How long should the message be displayed from the point at which it is set?

• ISO 8601 duration code – see: Expiry Dates

Default behavior depends on message audience:

• unfiltered messages are shown indefinitely

• if a group and/or user is specified, the message for an individual user will expire once viewed by that user

In both cases, specifying a duration will override the default behavior.

group

unfiltered

Only show to users in specific user group(s)?

• Comma separated list of user groups

• Supports Value References

The on-screen display of a message filtered to a specific group(s) can be removed from the screen for that member of the group using an X option displayed in the message panel.

The option to remove the message is not displayed if a duration parameter value is added to the macro.

5.2

style

info

Message style: info, error, warning, success

o

o

o

o

if no style is added the default message display is info.

4.1

user

unfiltered

Only show to specific user(s)?

• Comma-separated list of usernames

• Supports Value References

The on-screen display of a message filtered to a specific user(s) can be removed from the screen for that user by using an X option displayed in the message panel.

The option to remove the message is not displayed if a duration parameter value is added to the macro.

view

both

Which types of content URL should the message be shown on?

Default - no inclusion of the parameter or value. The undisplayed parameter default value is both.

• draft – the normal URL

• published – the /public URL

• both – both normal and public URLs

When view=draft or view=published is included the set-message macro the message is considered as a filtered message and can be used in the same trigger as an unfiltered set-message macro (the view parameter is default value of both)

5.2

This parameter determine which URL the message will be shown on when using same-space publishing:

• view-only users see the /public URL by default

• content producers will still see the normal URL by default, but can Switch between draft and published URLs

If you're not using same-space publishing, all users see the normal URL by default.

For example,

If view=draft, the message is displayed when viewing the content in any state in the workflow

• myconfluence.com/display/MSRM/Our+Page

But this message is not displayed when viewing the last approved version for a page with an applied workflow that includes a final state. The viewer will see this content URL with the /public pathway

• myconfluence.com/public/MSRM/Our+Page

The user and group parameters can be used together:

• groups are treated as if you listed their users via the user parameter

• there can be only one message for a given user per view type

Unfiltered messages, those which do not specify user or group, are treated separately:

• they will be shown in addition to user or group messages