Versions Compared

Key

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

Description

This macro will hide its contents from the viewer if the context matches the parameters specified.

...

Name

Required

Migratable to Cloud?

Default Value

Description

Start Date

  • Status
    title(X)

  • Status
    titleNO

The date and time from when the content should start being hidden, with respect to the server's timezone.

The system will” then all items listed must match.

End Date

  • Status
    title(X)

  • Status
    titleNO

The date and time from when the content should stop being hidden.

Match Using

  • Status
    titleYES

  • Status
    titleYES

Default value is set to Any.

Set to “all” or “any“

  • If set to any, only one of the specified restrictions needs to match.

  • If set to all, all the specified restrictions should match.

For example:

  • hide if (Match Using All)

User groups added - A, B, C

The “user“ should be part of all the groups A & B & C for the content to be hidden with the Match Using: All criteria. Say if the user is not part of C, then the content is not hidden in this scenario.

  • hide if (Match Using Any)

User groups added - A, B, C

The “user“ can be part of any group (A or B or C), for the content to be hidden with the Match Using: Any criteria.

hide-if.gifImage Removedhide-if.gifImage Added

Users

  • Status
    title(X)

Select the list of users to match.

Special Username

  • Status
    title(X)

The user to match, using unique usernames:

  • @anonymous - No user is currently logged in

  • @authenticated - Any authenticated user is logged in.

  • @self - The current user.

User Groups

  • Status
    title(X)

  • Status
    titleYES

 

The list of user group(s) to match. Type the group name and select from the dropdown option. (Cloud only)

The group(s) to match are separated by a comma or semicolon (Server and Data Center only).

e.g., 'confluence-users' will match all logged-in users.

Space Permissions

  • Status
    title(X)

  • Status
    titleNO

 

This property allows you to define whether the content” then followed by permission type e.g., @self:view

  • Use the Space Key, followed by ":" and permission type. e.g., PROJ:admin

These are the permission types:

  • view - (default) The user can view the space.

  • edit - The user can edit pages.

  • admin - The user can administer the space.

  • news - The user can post a blog entry.

Content Types

  • Status
    title(X)

  • Status
    titleNO

 

The (list of) page types. May be:

  • page

  • blogpost

  • comment

  • spacedesc

Display Types

  • Status
    title(X)

  • Status
    titleNO

 

This property allows the user to hide content only in a document exported to PDF or Word and not on the Confluence page. 

The (list of) display modes:

  • default - content is hidden only in the Confluence default view.

  • printable - content is hidden only in the exported PDF or Word document.

For more detailed information on Display Types usage and behaviors, check the Display Types parameter matrix page.

Current Space

  • Status
    title(X)

  • Status
    titleNO

 

The list of space keys for the spaces will be displayed in

Action Types

  • Status
    title(X)

  • Status
    titleNO

 

The action is taking place.

  • view - The content is editable and is currently being viewed.

  • edit - The content is editable and is currently being edited.

  • template - The content is a template being previewed.

  • dashboard - The content is the dashboard.

 

Labels

  • Status
    title(X)

  • Status
    titleNO

 

The list of labels to test is present or absent.

For more detailed information on Label usage and behaviors, check the Label parameter matrix page.

HTTP Headers

  • Status
    title(X)

  • Status
    titleNO

 

The list of header "name:value" pairs to check for. This can either be of the form "name*:exact value" or "name::*regular expression".

For example, to check if the current browser is Firefox, set it to 'header=User-Agent::.*Firefox.*'

This will confirm that the 'User-Agent' header contains 'Firefox'.

What headers are available will depend on the browser being used.

Scope

  • Status
    title(X)

  • Status
    titleNO

 

(Since 1.6.0) Tests if the current location is in the specified scope.

You can specify a particular page or set the scope to the children, descendants, or ancestors of another page:

  • > children - The direct children of the specified page. e.g.: 'scope=My Page > children'

  • > descendants - All descendants of the specified page. e.g.: 'scope="My Page" > descendants'

  • > ancestors - All ancestors of the specified page. E.g. 'scope=My Page > ancestors'

 

Trim

  • Status
    title(X)

  • Status
    titleNO

true

If set to false, the content will not be trimmed before being output (if appropriate).

Tutorial Examples