Hide If

Description

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


Parameters

NameRequiredAvailable InDefault ValueDescription

Match Using

 (error)

Server & Cloud

any

If set to all, then all items listed must match.

Users

 (error)

Server & Cloud

 

The user(s) to match, separated by comma. e.g.: "bob,marley" will match both "bob" and "marley".

Special Usernames

 (error)

Server

 

The user to match, using special usernames:

  • @anonymous - No user is currently logged in
  • @authenticated - Any authenticated user is logged in.
  • @self - The current user.

User Groups

 (error)

Server & Cloud

 

The group(s) to match, separated by comma.

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

Space Permissions

 (error)

Server

 

This property allows you to define whether the content inside this macro is hidden to a certain user based on his space permissions. This can be done by either of the following:

  • Using @self to specify current space, followed by ":", then followed by permission type e.g. @self:view
  • Using Space Key then 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

 (error)

Server

 

The (list of) page types. May be:

  • page
  • news
  • comment
  • spacedescription

Display Types

 (error)

Server

 

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

The (list of) display modes:

  • default - content is hidden in both Confluence and the exported PDF or Word document
  • printable - content is hidden only in the exported PDF or Word document

Current Space

 (error)

Server

 

The (list of) spaces this will be displayed in.

Action Types

 (error)

Server

 

The action 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

 (error)

Server

 

The list of labels to test are present or absent.

HTTP Headers

 (error)

Server

 

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 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

 (error)

Server

 

(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

 (error)

Server

true

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

Tutorial Examples