[All Adaptavist Apps]
The builder-show macro is
Excerpt |
---|
used to show content in specific contexts, modes and other filters |
Code Block |
---|
{builder-show:mode=view|context=page|label=meetings|metadata=mykey:myvalue}
stuff to show
{builder-show}
|
...
Property | Required | Default | Notes | Theme Panels Only | Ver |
---|---|---|---|---|---|
decorator | n/a | Only show the content when a specific decorator us being used, eg. "printable", etc. |
| ||
action | n/a | Only show the content for specific action(s), eg. "viewpage". NB: The ".action" part of the action name should not be included. |
| 3.0 | |
context | n/a | Only show the content for specific context(s), eg. "page", "global", etc. |
| ||
mode | all modes | Only show the content for specific modes, eg. "view", "edit", etc. |
| ||
space | n/a | Only show the content if a specific space (referred to by the Space Key) exists. |
|
| |
spacekey | current space | The space against which permission checks will be made. Default is current space. |
|
| |
pagetitle | current page | the page against which permission checks will be made. Default is current page |
|
| |
pageexists | n/a | Only show the content if a specific page (referred to by the page title) exists. @parent can be used to show data if the page is not at the root level, @child can be used to show data if the page has children. |
|
| |
pluginkey | n/a | The key of a plugin which must be enabled for the content to be shown |
|
| |
titlehastitle | n/a | Only show the content if the current page has a specific title |
|
| |
label | n/a | Only show the content if the the current location (page, news, etc) has the specified label(s), eg. "my:favourite", "meetings", etc. |
|
| |
spacelabel | n/a | Only show the content if the the current space has the specified label(s), eg. "meetings", etc. |
|
| |
teamlabel | n/a | Only show the content if the the current space has the specified team label(s), eg. "sales,marketing", etc. |
|
| |
metadata | n/a | Metadata associated with the current location in the format: "myKey1:myValue1, myKey1:myValue1, etc". when checking for a key with a specific value. To check for the existance of metadata with any value supply a commas separated list of key names, eg: "mykey1, mykey2, mykey3" or mix & match "mykey1, mykey2:myvalue2" |
|
| |
user | n/a | Matches against the current user (NB: modified by withuser) - A comma separated list of usernames. Use |
| 3.0 | |
withuser | @current | username that user/group/permission checks should be run against. This includes @anonymous, @creator, @author, @current |
| 3.2.2 | |
group | n/a | A comma separated list of user groups that the current user (NB: modified by withuser) should be a member of |
| 3.0 | |
permission | n/a | A comma separated list of permissions:
|
| 3.0 | |
recurse | false | Should parent pages (if applicable) be checked for title, labels and metadata?
|
| 3.0 | |
restriction | n/a | display content if the page has a restriction in place (none/view/edit/vieworedit/viewandedit - recursable) |
| 3.0 | |
useragent | n/a | A comma separated list of tokens to match against the user agent string of the requesting browser. | 3.2.1 | ||
attachment | n/a | comma separated list of filenames, one of which must be attached to the current page for the content to be displayed. | 3.2.2 | ||
olderthan | n/a | Content is shown if the current page was modified before the given time period from the current date. The date is shown in this format: olderthan=1y6m1d1h (year/month/day/hour) |
| 3.3.0 | |
newerthan | n/a | Content is shown if the current page was modified after the given time period from the current date. The date is shown in this format: olderthannewerthan=1y6m1d1h (year/month/day/hour) |
| 3.3.0 |
While none of the parameters are mandatory, you must specify at least one of them for this macro to work.
flag |
| Content is shown if one or more of the specified flags are set. See Working with Flags for more details. | 3.3.6 | |
---|---|---|---|---|
notflag |
| Content is shown if none of the specified flags are set. See Working with Flags for more details. | 3.3.6 |
While none of the parameters are mandatory, you must specify at least one of them for this macro to work.
You can specify multiple values for any parameter, for example:
Code Block |
---|
{builder-show:mode=view,edit|context=page,blogpost}
stuff to show
{builder-show}
|
...
Expand | ||||
---|---|---|---|---|
| ||||
If you view the HTML source of this web page you'll see the following:
|
You can specify multiple contexts and modes by separating them with commas as shown in the usage example earlier. For the macro content to show, all contexts and modes specified must match.
...
Expand | ||||
---|---|---|---|---|
| ||||
|
Expand | ||||
---|---|---|---|---|
| ||||
|
Expand | ||||
---|---|---|---|---|
| ||||
|
Expand | ||||
---|---|---|---|---|
| ||||
|
Expand | ||||
---|---|---|---|---|
| ||||
|
Expand | ||||
---|---|---|---|---|
| ||||
|
Expand | ||||
---|---|---|---|---|
| ||||
|
Expand | ||||
---|---|---|---|---|
| ||||
|
Expand | ||||
---|---|---|---|---|
| ||||
|
Expand | ||||||
---|---|---|---|---|---|---|
| ||||||
|
Expand | ||||
---|---|---|---|---|
| ||||
|
Expand | ||||
---|---|---|---|---|
| ||||
|
Expand | ||||||
---|---|---|---|---|---|---|
| This only works if it is used inside a page or news item
| |||||
|
Not applicable for this macro.
...