builder-hide macro

If you view the HTML source of this web page you'll see the following:

<!-- main.vmd
  themebuilder : 'com.adaptavist.confluence.sitebuilder.SiteBuilderVelocityHelper@524c9770'/'$themebuilder.initialise'
  spaceKey : 'USERGUIDE'
  pageId : '10578'
  currentURL : '/pages/viewpage.action?spaceKey=USERGUIDE&title=builder-hide+macro'
  contextPath : ''
  spaceName : 'User Guides'
  decorator : '$decorator'
  printable : 'false'
  mailId : '$mailId'
  mode : 'view'
  context : 'page'
-->

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

{builder-hide:context=news}
This text will not be shown on news items
{builder-hide}

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

{builder-hide:context=page,blogpost}
something to hide on pages and news items
{builder-hide}

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 hide something when it's being edited (eg. editing a page or news item), use the following:

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

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

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

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

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

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-hide:mode=view,edit|context=page,blogpost}
something to hide
{builder-hide}

In the example above, the content would be hiden 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.

You can use the useragent parameter to check for certain sub-strings such as browser names and operating systems in the user agent string. This could be used to hide incompatible content from devices such as mobile phones.
Useragent will accept a comma separated list of tokens to be tested for. This acts like an OR, if any of the tokens match then the enclosed code will not be rendered.

For example you could hide Flash content from iPhones like this:

{builder-hide:useragent=iphone}
This content won't be rendered on iphone.
{builder-hide}

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

{builder-hide:labels=my:favourite,meetings}
don't show this on content labelled as the users' favourite or meetings
{builder-hide}

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.

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

{builder-hide:space=ACCOUNTS}
The space with key "ACCOUNTS" does not exist!
{builder-hide}

As you can see, this is ideal for customising content based on which spaces a user has privilegs to access. If the user doesn't have access to a space, it's as if the space doesn't exist.

You can hide content if a specific page (within the current space) exists:

{builder-hide:page=My Page}
The page "My Page" does not exist!
{builder-hide}

This is really useful because you can show warnings or links, etc., if pages don't exist. For example, you might want a legal disclaimer in a space and you could warn users if it doesn't exist.

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

{builder-hide:page=@parent}
This page does not have a parent page!
{builder-show}

This is useful because you often want to include specific navigation on pages that do not have a parent page, for example you might want to include the pagetree macro on your home page to ease navigation.

Pages which don't have a parent are:

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

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

{builder-hide:title=My Homepage}
This is not my home page!
{builder-hide}

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

Alternatively, you might want a specific page title to be used whenever a certain template is used, for example:

{builder-hide:title=Meeting}
(!) Please rename this page to "Meeting" to aid consistency throughout this site.
{builder-hide}

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

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

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

This works if used in a page or a news item.

 
{builder-hide:attachment=foo.jpg,bar.png}
hide this if either foo.jpg or bar.png are attached to the current page/news
{builder-hide}