Macro Reference Guide
Macro Reference Guide
Macros are pre-built pieces of code that can be inserted into Confluence pages.
Atlassian Confluence installs with a set of macros to help you build pages, and we have documented some of the more common ones here. Brikit Theme Press installs with additional macros that also help you create and design content, and we have documented all of those.
The functionality provided by macros can sometimes be achieved through custom CSS with HTML. However, by using macros, you achieve a better level of compatibility and operability, as all Brikit add-ons are tested and confirmed against new software versions to assure "future proofing."
Macros in Action
Authors can include macros into individual pages for increased functionality. Designers can include macros in architect pages to build functionality throughout the site.
Insert macros while editing from the "+" menu. Selected macros appear in the bottom half of that menu, or the entire macro library is available by choosing "Other macros." The shortcut for inserting a macro while editing is to type the "left curly bracket" ("{") and then typing the first few letters of the macro name.
Macro Name | Usage | Version |
|---|---|---|
| displays a linkable button with text | 1.0 | |
| displays a list of files attached to the current page | 1.0 | |
| Attachment Reference (Pinboards) | a reference macro placed in the comment field of a page or blog post when a user comments on a Pinboard tile | PB 1.0 |
| turns the containing block into a link | 1.0 | |
| Blog Tree | displays a list of blog posts organized by year then month; works on blog posts or the Blog Layout page. | 1.1.6 |
| displays linked images from one or more Confluence pages | 1.1 | |
| displays a list of child pages related to a specific parent page | 1.0 | |
| displays a dropdown from which a user can set his or her timezone | 1.0 | |
| Comment | a container for entering content that should be hidden from the page view but visible in the rich text editor | 2.0 |
| Content Block | wraps wiki content; facilitates page design and layout | 1.0 |
| Content Column | wraps blocks; facilitates page design and layout | 1.0 |
| Content Layer | wraps columns; facilitates page design and layout | 1.0 |
| Content Layout | defines layout settings for all applicable pages | 1.0 |
| Content Query | displays a list of pages, blog posts, comments and/or attachments based on a customized query | 1.1 |
| Create from Blueprint Maker | displays a Blueprint Maker button used to create a page from a template | 1.1 |
| displays the user's favorites list | 1.0 | |
| Hello | displays a greeting or login link | 1.0 |
| adds class name(s) to targeted HTML elements | 1.0 | |
| HTML Clear | clears the effect of float properties that come before this macro | 1.0 |
| duplicates an HTML element including its styling | 1.0 | |
| displays linkable text | 1.0 | |
| HTML Move Element | moves the HTML element and places it in the position of this macro | 2.0 |
| wraps a <div> or <span> tag around its content | 1.0 | |
| Image Map | displays a base image to use in conjunction with the Image Map Area macro | 1.3 |
| Image Map Area | displays a linked hotspot and rollover image when hovering over a specified area of the base image; nest within the Image Map macro | 1.3 |
| displays content from specific pages or blocks | 1.0 | |
| Interactive Search | allows creation of an interactive search with multiple configuration options | TS 1.2 |
| Invite User | displays a username field where the current user can invite an existing user and grant permissions to participate in the current space; higher-level permissions are not granted | 2.0 |
| Label Select Field | displays a dropdown from which users can select filters and apply them to a page or blog post | 1.1 |
| Open Links in Current Window | opens links within the macro in the current window | 1.0 |
| Open Links in New Window | opens links within the macro in a new window | 1.0 |
| Page Title | displays the name of the current page | 1.1 |
| Page Tree | displays a listing of the pages in the space | 1.1 |
| displays links to the previous and next pages | 1.0 | |
| restricts content within the macro to specific users | 1.0 | |
Pinboard | dynamically loads content from across the site and presents that content within tiles | PB 1.0 |
| Rollover Image Link | displays a linkable image with a hover image | 1.1 |
| displays content (randomly or sequentially) from a specific page | 1.1 | |
| Social Media Bar | displays social media buttons where users can share the current page | 2.0 |
| displays the description of the specified space | 1.0 | |
| displays a list of spaces | 1.0 | |
| displays the name of the specified space | 1.0 | |
| Targeted Search Field | displays an input field where users enter a search query | 1.1 |
| Targeted Search Link | displays a search link (or button) that generates results for a specific search term | 1.1 |
| Topic Tree | displays a topical content tree based on labels | 1.3 |
| Upload Attachment Button | displays a button that allows users to upload attachments with pre-defined labels | 1.1 |
| User Group Navigator | displays a list of group members and their profile images | 2.0 |
| Macro Name | Usage |
|---|---|
| displays a linkable button with text | |
| Attachment List | displays a list of files attached to the current page |
| Block Link | turns the containing block into a link |
| Children List | displays a list of child pages related to a specific parent page |
| displays a dropdown from which a user can set his or her timezone | |
| Favorites List | displays the user's favorites list |
| Hello | displays a greeting or login link |
| displays content from specific pages or blocks | |
| Invite User | presents a username field where the current user grants access to the current space |
| Page Title | displays the name of the current page |
| Page Tree | displays a list of the pages in the space |
| displays links to the previous and next pages | |
| Space Description | displays the description of the specified space |
| Space Name | displays the name of the specified space |
| Space List | displays a list of spaces |
| Topic Tree | displays a topical content tree based on labels |
| Macro Name | Usage |
|---|---|
| Create from Blueprint Maker | displays a Blueprint Maker button used to create a page from a template |
| HTML Add Class | adds class name(s) to targeted HTML elements |
| HTML Clear | clears the effect of float properties that come before this macro |
| HTML Copy Element | duplicates an HTML element including its styling |
| HTML Move Element | moves the HTML element and places it in the position of this macro |
| HTML Wrap | wraps a <div> or <span> tag around its content |
| Image Map | displays a base image to use in conjunction with the Image Map Area macro |
| Image Map Area | displays a linked hotspot and rollover image when hovering over a specified area of the base image; nest within the Image Map macro |
| Page Title | displays the name of the current page |
| Rollover Image Link | displays a linkable image with a hover image |
| Rotate Content | displays content (randomly or sequentially) from a specific page |
| Space Description | displays the description of the specified space |
| Space Name | displays the name of the specified space |
| Macro Name | Usage |
|---|---|
| Action Button | displays a linkable button with text |
| Attachment List | displays a list of files attached to the current page |
| Block Link | turns the containing block into a link |
| Blog Tree | displays a list of blog posts organized by year then month; works on blog posts or the Macro Reference Guide page. |
| Catalog Navigator | displays linked thumbnails of specific images; image comments appear as tooltips |
| Children List | displays a list of child pages related to a specific parent page |
| Favorites List | displays the user's favorites list |
| HTML Link | displays linkable text |
| Image Map | displays a base image to use in conjunction with the Image Map Area macro |
| Image Map Area | displays a linked hotspot and rollover image when hovering over a specified area of the base image; nest within the Image Map macro |
| Open Links in Current Window | opens links within the macro in the current window |
| Open Links in New Window | opens links within the macro in a new window |
| Page Tree | displays a list of the pages in the site (used in Handbook layout, among others) |
| Page Turner | displays links to the previous and next pages |
| Rollover Image Link | displays a linkable image with a hover image |
| Space List | displays a list of spaces |
| Topic Tree | displays a topical content tree based on labels |
| User Group Navigator | displays a list of group members and their profile images |
| Macro Name | Usage |
|---|---|
| Invite User | presents a username field where the current user grants access to the current space |
| Restrict Content | restricts content within the macro to specific users |
Macro Name | Usage |
|---|---|
| Social Media Bar Macro | displays social media buttons where users can share the current page |
| dynamically loads content from across the site and presents that content within tiles |
These are macros that Theme Press and Confluence use to manage your pages behind the scenes. In most cases, you will have no reason to access them or modify them.
| Macro Name | Usage |
|---|---|
| Pinboard Attachment Reference (Pinboards) | a reference macro automatically placed in the comment field of a page or blog post when a user comments on a Pinboard tile |
| Content Block | wraps wiki content; facilitates page design and layout |
| Content Column | wraps blocks; facilitates page design and layout |
| Content Layer | wraps columns; facilitates page design and layout |
| Content Layout | defines layout settings for all applicable pages |
| Macro Name | Usage |
|---|---|
| Content Query | displays a list of pages, blog posts, comments and/or attachments based on a customized query |
Interactive Search (TS 1.2) | allows creation of an interactive search with multiple configuration options |
| Label Select Field | displays a dropdown from which users can select filters and apply them to a page or blog post |
| Targeted Search Field | displays an input field where users enter a search query |
| Targeted Search Link | displays a search link (or button) that generates results for a specific search term |
| Upload Attachment Button | displays a button that allows users to upload attachments with pre-defined labels |
Still need help?
