Macros

The Theme Builder plugin includes numerous macros to make customising content and navigation easier:

Menu Macros

These macros are used to create links to Confluence features, display icons associated with those links and organise these in to hierarchical menus.

• compound-menuitem macro — This macro creates a link to a specific Confluence feature or page relative to the current location in the wiki.
• editmenu macro — inserts the contents of the edit menu as defined in theme config into a menu definition.
• Links - Quick Reference — This page provides a quick-reference guide to the parameters and features of the menulink macro and compound-menuitem macro (click for more information when/where to use each macro).
• menu macro — creates an item in your menu
• menubar macro — an extremely powerful and flexible macro that allows you to create superb on-screen navigation tools
• menuicon macro — creates an icon for use within the menu
• menuitem macro — used for containing individual menu items
• menulink macro — This macro creates a link to a specific Confluence feature or page relative to the current location in the wiki.
• menuseparator macro — used for inserting separators between menu items
• sub-submenu macro — used to embed a submenu within a submenu
• submenu macro — used to embed a submenu within a menu
• viewmenu macro — inserts the contents of the view menu as defined in theme config into a menu definition.
• watch-menu macro — used to embed a submenu with an icon that reflects the watch state
• webui-list macro — generates an unordered list of webui items for a given location
• wikimenu macro — used to embed wiki notation menus and the output from other macros

Panel Macros

These macros allow you to move or delete standard Confluence user interface features such as the breadcrumb trail and comments, or optionally show parts of the theme depending on the current view (e.g. only show the label editor on pages and news items). Unlike most other macros, you can only use them inside Builder panels - they will not work anywhere else.

• builder-breadcrumbs macro — This macro defines where the breadcrumb trail will appear within the theme layout. You can move this macro to another panel to relocate the breadcrumbs or remove it altogether if you do not want a breadcrumb disaply.
• builder-children macro — defines where the list of child pages, if enabled, will be shown
• builder-comments macro — defines where the page/news comments, if enabled, will be shown
• builder-favicon macro — adds a "favourite" icon to your layout
• builder-infopanel macro — defines where the infopanel, if required, will be shown
• builder-labels macro — creates a duplicate of the quick label editor
• builder-pagetitle macro — returns the name of the currently viewed page
• builder-sidebar macro — This macro is used to force the collapse/display of the sidebars on a page-by-page basis.
• builder-watchicon macro — creates a duplicate of the 'watch' icon from the standard confluence theme
• builder-welcome-message macro — defines where the site welcome message will be shown

Utility Macros

These macros are utility macros which can be used anywhere

• blog-archive macro — used to display a nested list of blog posts and optionally excerpts.
• blog-calendar macro
• blog-list Macro — used to display a list of blog posts and excerpts.
• blog-rss macro — used to display a list of blog posts in rss format.
• blog-rss-feed macro — used to generate an rss feed link included in the header of the builder theme.
• builder-hide macro — used to hide content in specific contexts, modes and other filters
• builder-logo macro — displays the logo applicable to the location being viewed
• builder-show macro — used to show content in specific contexts, modes and other filters
• builder-spacetitle macro — returns either the name of the currently displayed space or the site title
• create-child macro
• import macro — imports the contents of another page into the current page
• list-* macros — render a bullet-point list of content matching the given search criteria
• list-spaces macro — allows you to generate an unordered list of spaces
• move-to macro — used to move a chunk of content from one place on the screen to another.
• page-state-interface macro
• pagetree2 macro
• use-layout macro — This macro allows you to automatically change the layout used for a specific page, optionally latching that layout for the rest of the user's session.
• with-* macros — render a block of wiki markup in the context of another page