Page tree

Macro Reference Guide

Last updated

Theme Press installs with macros that help you create and design content. You can use these macros on individual pages or architect pages.

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

Action Button

displays a linkable button with text1.0

Attachment List

displays a list of files attached to the current page1.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 tilePB 1.0

Block Link

turns the containing block into a link1.0
Blog Treedisplays a list of blog posts organized by year then month; works on blog posts or the Blog Layout page.1.1.6

Catalog Navigator

displays linked images from one or more Confluence pages1.1

Children List

displays a list of child pages related to a specific parent page1.0

Choose Timezone

displays a dropdown from which a user can set his or her timezone1.0
Commenta container for entering content that should be hidden from the page view but visible in the rich text editor2.0
Content Blockwraps wiki content; facilitates page design and layout1.0
Content Columnwraps blocks; facilitates page design and layout1.0
Content Layerwraps columns; facilitates page design and layout1.0
Content Layoutdefines layout settings for all applicable pages1.0
Content Querydisplays a list of pages, blog posts, comments and/or attachments based on a customized query1.1
Create from Blueprint Makerdisplays a Blueprint Maker button used to create a page from a template1.1

Favorites List

displays the user's favorites list1.0
Hellodisplays a greeting or login link1.0

HTML Add Class

adds class name(s) to targeted HTML elements1.0
HTML Clearclears the effect of float properties that come before this macro1.0

HTML Copy Element

duplicates an HTML element including its styling1.0

HTML Link

displays linkable text1.0
HTML Move Element moves the HTML element and places it in the position of this macro2.0

HTML Wrap

wraps a <div> or <span> tag around its content1.0
Image Mapdisplays a base image to use in conjunction with the Image Map Area macro1.3
Image Map Areadisplays a linked hotspot and rollover image when hovering over a specified area of the base image; nest within the Image Map macro1.3

Include Content

displays content from specific pages or blocks1.0
Interactive Searchallows creation of an interactive search with multiple configuration optionsTS 1.2
Invite Userdisplays 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 granted2.0
Label Select Fielddisplays a dropdown from which users can select filters and apply them to a page or blog post1.1
Open Links in Current Windowopens links within the macro in the current window1.0
Open Links in New Windowopens links within the macro in a new window1.0
Page Titledisplays the name of the current page1.1
Page Treedisplays a listing of the pages in the space1.1

Page Turner

displays links to the previous and next pages1.0

Restrict Content

restricts content within the macro to specific users1.0

Pinboard
(
Pinboards)

dynamically loads content from across the site and presents that content within tilesPB 1.0
Rollover Image Linkdisplays a linkable image with a hover image1.1

Rotate Content

displays content (randomly or sequentially) from a specific page1.1
Social Media Bardisplays social media buttons where users can share the current page2.0

Space Description

displays the description of the specified space1.0

Space List

displays a list of spaces1.0

Space Name

displays the name of the specified space1.0
Targeted Search Fielddisplays an input field where users enter a search query1.1
Targeted Search Linkdisplays a search link (or button) that generates results for a specific search term1.1
Topic Treedisplays a topical content tree based on labels1.3
Upload Attachment Buttondisplays a button that allows users to upload attachments with pre-defined labels1.1
User Group Navigatordisplays a list of group members and their profile images2.0
Macro NameUsage

Action Button

displays a linkable button with text
Attachment Listdisplays a list of files attached to the current page
Block Linkturns the containing block into a link
Children Listdisplays a list of child pages related to a specific parent page

Choose Timezone

displays a dropdown from which a user can set his or her timezone
Favorites Listdisplays the user's favorites list
Hellodisplays a greeting or login link

Include Content

displays content from specific pages or blocks
Invite Userpresents a username field where the current user grants access to the current space
Page Titledisplays the name of the current page
Page Treedisplays a list of the pages in the space

Page Turner

displays links to the previous and next pages
Space Descriptiondisplays the description of the specified space
Space Namedisplays the name of the specified space
Space Listdisplays a list of spaces
Topic Treedisplays a topical content tree based on labels
Macro NameUsage
Create from Blueprint Makerdisplays a Blueprint Maker button used to create a page from a template
HTML Add Classadds class name(s) to targeted HTML elements
HTML Clearclears the effect of float properties that come before this macro
HTML Copy Elementduplicates an HTML element including its styling
HTML Move Elementmoves the HTML element and places it in the position of this macro
HTML Wrapwraps a <div> or <span> tag around its content
Image Mapdisplays a base image to use in conjunction with the Image Map Area macro
Image Map Areadisplays a linked hotspot and rollover image when hovering over a specified area of the base image; nest within the Image Map macro
Page Titledisplays the name of the current page
Rollover Image Linkdisplays a linkable image with a hover image
Rotate Contentdisplays content (randomly or sequentially) from a specific page
Space Descriptiondisplays the description of the specified space
Space Namedisplays the name of the specified space
Macro NameUsage
Action Buttondisplays a linkable button with text
Attachment Listdisplays a list of files attached to the current page
Block Linkturns the containing block into a link
Blog Treedisplays a list of blog posts organized by year then month; works on blog posts or the Macro Reference Guide page.
Catalog Navigatordisplays linked thumbnails of specific images; image comments appear as tooltips
Children Listdisplays a list of child pages related to a specific parent page
Favorites Listdisplays the user's favorites list
HTML Linkdisplays linkable text
Image Mapdisplays a base image to use in conjunction with the Image Map Area macro
Image Map Areadisplays 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 Windowopens links within the macro in the current window
Open Links in New Windowopens links within the macro in a new window
Page Treedisplays a list of the pages in the site (used in Handbook layout, among others)
Page Turnerdisplays links to the previous and next pages
Rollover Image Linkdisplays a linkable image with a hover image
Space Listdisplays a list of spaces
Topic Treedisplays a topical content tree based on labels
User Group Navigatordisplays a list of group members and their profile images
Macro NameUsage
Invite Userpresents a username field where the current user grants access to the current space
Restrict Contentrestricts content within the macro to specific users
Macro Name
Usage
Social Media Bar Macrodisplays social media buttons where users can share the current page

Pinboard

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 NameUsage
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 Blockwraps wiki content; facilitates page design and layout
Content Columnwraps blocks; facilitates page design and layout
Content Layerwraps columns; facilitates page design and layout
Content Layoutdefines layout settings for all applicable pages
Macro NameUsage
Content Querydisplays a list of pages, blog posts, comments and/or attachments based on a customized query
allows creation of an interactive search with multiple configuration options
Label Select Fielddisplays a dropdown from which users can select filters and apply them to a page or blog post
Targeted Search Fielddisplays an input field where users enter a search query
Targeted Search Linkdisplays a search link (or button) that generates results for a specific search term
Upload Attachment Buttondisplays a button that allows users to upload attachments with pre-defined labels

Still need help?