{builder-show} Macro

Description

The builder-show macro is used to show content within panels only in specific contexts, modes and other filters, essentially customising the panel content to the location within your site being viewed by the end-user.

Usage

{builder-show:mode=view|context=page|label=meetings|metadata=mykey:myvalue}
stuff to show
{builder-show}

Parameters

Note:
Some parameters, marked "Theme Only", can only be used within Builder theme panels, ie. you cannot use them within pages, 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".

Contexts and Modes

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.

Modes for context: page

All of these modes have a context of page and apply when working with content pages (including the Space home page):

Modes for context: space-blogposts

This mode relates to the view of recent blogposts in a space:

Modes for context: space-labels

All of these modes have a context of space-labels and relate to the label views within spaces.

Modes for context: space-attachments

This mode applies to the index of attachments within a space:

Modes for context: space-administration

All space administration pages have a single mode as far as we can tell:

Modes for context: space-pages

All of these modes have a context of space-pages and apply to standard space features such as the alphabetical index and site map.

Modes for context: global

These modes relate to global (outside a space) locations:

more to follow

Examples

Display content on news items

To display some content only on news items (blogposts), you must use the macro within a panel in the Builder theme:

{builder-show:context=news}
{menulink:news}Back to News Summary{menulink}
{builder-show}

Display content on pages and news items

To show something in multiple contexts, simply separate them with commas:

{builder-show:context=page,blogpost}
something to show
{builder-show}

Display content in edit mode

When you change the view of something, eg. look at the normal view or editable view, the "mode" changes and you can take advantage of this to customise your theme depending on which mode is currently active. For example, if you only want to show something when it's being edited (eg. editing a page or news item), use the following:

{builder-show:mode=edit}
something to show
{builder-show}

You can show something in multiple modes by separating them with commas:

{builder-show:mode=edit,view}
something to show
{builder-show}

Specific modes within specific contexts

If you only want to show something in view mode within the context of a page, use the following:

{builder-show:mode=view|context=page}
something to show
{builder-show}

When more than one parameter of the macro is specified, both parameters must match so in the example above the user must be looking at a page context in view mode.

You can specify multiple modes and contexts, for example:

{builder-show:mode=view,edit|context=page,blogpost}
something to show
{builder-show}

In the example above, the content would be shown if the user is looking at either a "page" or a "blogpost" (news item) that must also be in either the "view" or "edit" mode.

Display content based on labels

You can display content if the current location has one or more of the specified labels:

{builder-show:labels=my:favourite,meetings}
This stuff is either in my favourites list or something to do with meetings!
{builder-show}

Beware! Most people assume that only pages and news articles can have labels, but this is not the case. When viewing space-level pages that aren't normal content pages or news articles, for example when viewing the space labels or even space admin, this macro uses any defined space labels and even team labels.

Displaying content if a space exists

You can show content only if a space exists by specifying it's space key as follows:

{builder-show:space=ACCOUNTS}
Here's some info about the accounts space, but you'll only see this
if you have privileges to access the accounts space.
{builder-show}

As you can see, this is ideal for customising content based on which spaces a user has privilegs to access.

Display content based on existence of a page

You can display content only if a specific page exists:

{builder-show:page=My Page}
{include:My Page}
{builder-show}

In the example shown above, we only include the page if it exists. This hides the nasty error message that the include macro generates if that page does not exist. While it might seem a little strange to only show things if a specific page exists (especially considering you know the title of that page), it's extremely useful in scenarios where you are using templates and only want to show content or links if a specific page exists within the current space.

Display content if the page has a parent

You can show content only if the current page has a parent page using the following notation:

{builder-show:page=@parent}
This page has a parent page!
{builder-show}

This is useful because you often want to include additional navigation on pages that have a parent page, for example you might want to include the scrollbar macro to show a linear navigation bar.

Pages which don't have a parent are:

• The space homepage
• Orphan pages (pages within a space that don't have a parent)

Display content for specific page titles

You can display content if the current page has a specific title, for example:

{builder-show:title=My Homepage}
Hi all, this must be my home page because it's title is "My Homepage"!
{builder-show}

This can come in handy if you are using templates to generate content and want to show something based on the page title.

Another use is if users are constantly using a page title that causes problems, for exmaple they might call a page "Meetings" and you want them to call it "yyyy/mm/dd - Meeting with x, y, z") - as such you could add this to the Title panel within theme configuration:

{builder-show:title=Meeting}
You muppet! Use a more descriptive page title that includes
the date (and time if appropriate), type of meeting and who
was involved, etc.
{builder-show}

OK, you might not want to be that harsh in explaining to users that "Meeting" isn't a great page title and that they should use something more descriptive, but you get the general idea.

Another use is to add labels to pages based on their title:

{builder-show:title=Home}{add-label:home-page}{builder-show}

Simply add that to the Header panel in theme config and any page called "Home" will get a label of "home-page" added to it thanks to the add-label macro. This is useful because it allows you to search all home pages within the site!

Displaying content based on metadata

Alain to fill this bit in as I have no idea how it works! Also note the hierarchical nature of the checking on this.

CSS Customisation

Not applicable for this macro.

Hints and Tips

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.

Frequently Asked Questions

None at present.

See Also

• builder-hide macro
• Visibility Plugin - show-to macro, hide-from macro, show-if macro, hide-if macro
• Composition Plugin - cloak macro, toggle-cloak macro
• menuitem macro - can be used to automatically hide content if it does not contain a hyperlink