[All Adaptavist Apps]
The builder-show macro is used to show content in specific contexts, modes and other filters...
{builder-show:mode=view|context=page|label=meetings|metadata=mykey:myvalue} stuff to show {builder-show}
Note:
Some parameters, marked "Theme Only", can only be used within Builder theme panels, ie. you cannot use them within pages, etc.
Property |
Required |
Default |
Notes |
Theme Panels Only |
---|---|---|---|---|
decorator |
all decorators |
Only show the content when a specific decorator us being used, eg. "printable", etc. |
||
context |
all contexts |
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. |
|
|
page |
n/a |
Only show the content if a specific page (referred to by the page title) exists. |
|
|
title |
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. |
|
|
metadata |
n/a |
Metadata associated with the current location in the frormat: "myKey1:myValue1", etc. |
|
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:
{builder-show:mode=view,edit|context=page,blogpost} stuff to show {builder-show}
In the example above, "stuff to show" would only be shown if the content is being shown in "view" or "edit" mode and is also either a "page" or "blogpost".
You can determine the context and mode for any page by viewing the page source using your browser. A HTML comment output at the top of all pages shows the context and mode for each page.
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.
Some common contexts and modes are listed below, along with the associated menulink macro settings to create links to them.
All of these modes have a context of page and apply when working with content pages (including the Space home page):
Mode |
Notes |
Menulink |
---|---|---|
view |
Normal view of a page, including when adding comments to a page |
|
edit |
Edit view of an existing page (see space-pages context for details of adding or copying pages). |
|
view-attachments |
Viewing attachments on a page. |
|
view-information |
Displaying page information. |
|
This mode relates to the view of recent blogposts in a space:
Mode |
Notes |
Menulink |
---|---|---|
view-blogposts |
List of recent blogposts in a space. |
|
All of these modes have a context of space-labels and relate to the label views within spaces.
Mode |
Notes |
Menulink |
---|---|---|
view-labels-popular |
View popular labels |
|
view-labels-all |
View all labels |
|
This mode applies to the index of attachments within a space:
Mode |
Notes |
Menulink |
---|---|---|
view-attachments |
Index of space attachments. |
|
All space administration pages have a single mode as far as we can tell:
Mode |
Notes |
Menulink |
---|---|---|
view-space-administration |
Any page within space admin area, regardless of whether you are viewing or editing, etc. |
|
All of these modes have a context of space-pages and apply to standard space features such as the alphabetical index and site map.
Mode |
Notes |
Menulink |
---|---|---|
create-page |
Applies when creating a new page or copying an existing page. |
|
list-recently-updated |
List of recently updated pages. |
|
list-alphabetically |
Alphabetical page index. |
|
list-content-tree |
Site map (i.e. pages tree view). |
|
These modes relate to global (outside a space) locations:
Mode |
Notes |
Menulink |
---|---|---|
rss |
RSS Feed Builder |
|
more to follow
Not applicable for this macro.
You can use this macro, and the associated builder-hide macro to customise navigation and panel content depending on what the user is looking at.
When using either the mode, context or decorator parameters, remember that they only work if used within a panel of the Builder theme. If you put them inside a normal page, etc., they won't work. Even if you use the move-to macro to move something from a page in to a panel, it still won't work - the mode, context and decorator settings will only work if the macro is actually in the panel notation in the theme cofiguration settings.
If you need to show or hide content based on the privileges within a space, use the show-if or hide-if macros that be found in the Visibility Plugin.
None at present.