Macros
Macros are plugins that enhance Confluenceâs functionality. A wide variety is available, from official options to community-created tools. While some are premium and offer advanced features, there are plenty of free options to explore.
You are probably already familiar with common plugins like:
But there are a lot more combinations that you can make from them. The following section will include a list of amazing Macros worth checking out.
There will be examples of a few combinations and how to make the most of them.
Advanced Macros
I wouldnât suggest you going and trying all of them, instead go to the next section to start learning simple combinations and go from there.
Small Details:
- Table of Contents: Help readers navigate directly to specific sections of a page.
- Expand Macro: Hide content, such as memes, within expandable sections.
- Live Search: Add a search bar with predefined parameters.
- Contributor Summary: Display recent updates from a page and its subpages.
- Alert: Create customizable alerts that display when a page loads.
- Background Color: Change the background color of a page.
Page Optimization:
- ChildTabs: Navigate between pages easily; view content from child pages without opening multiple tabs.
- Include Page: Display content from another page or blog post.
- Form: Add a text box and submit button for creating a new page, with options for templates or parent pages.
- Page Properties Report: Create reports from multiple pages using the Page Properties macro.
- Page Properties: Combine with Page Properties Report to create a table of information from multiple pages.
- Content Report Table: Generate a content report in table format based on labels.
- Multiexcerpt: Export multiple elements like text and images across Spaces and Pages, and reuse them with the Multiexcerpt Include.
- Excerpt: Define a snippet of content for reuse on another page.
- Table Excerpt: Reuse tables from one page to another by using the Table Include macro.
- Table Filter: Query data across multiple pages.
Page Organization:
Pay To Win Macros:
- Bob Swift - Markdown: allows you to connect to Gitlab, Github and Bitbucket using defined profiles.
- Default Markdown Plugin doesnât have the features to use authentication, for Gist it may be useful.
- Bob Swift - HTML: renders content from HTML.
- Default HTML Include plugin may be disable by default as it could make the site vulnerable to cross-site scripting attacks.
- Comala - Questions: it makes a space to have questions that you can filter an render in pages.
Cloud Macros
Hardcore Macros
Macro Combinations
Macros are comparable to Terraform functions. Itâs essential to recognize that there are easier ways to accomplish tasks. Yet, to fully leverage the tool, itâs crucial to stretch its capabilities and intertwine multiple functions with a specific goal in mind.
Practical Enhancements
Sometimes people donât use certain options of their macros which can impact in the way things are felt.
If you document is heavy on code I could assume your readers wonât care most of the time in the code itself but rather what you are talking about. For those cases, the expand option from the Code Macro will make a difference.
This can also be done for images of even sections, with the expand macros. I personally hid memes this way.
Quick Wins
If youâve only got the mental bandwidth for a few Macros, prioritize the following macros to get ahead of multiple documentations:
- Multiexcerpt: I consider Multiexcerpt Include to be part of it, so it counts as one. This will allow you to reuse content in other pages. Like coding!
- Table Filter: There are such great things that you can do with filters and queries. Itâs sad that you have to but at least is not painful!
- ChildTabs: For when youâve got a bunch of subpagesâthis helps you keep it all organized without endless tabs.
In the following example, the main page âMacros Exampleâ displays two results with the ChildTabs that are the pages under it. The context behind those pages will be explained in the Datasource Pageâs example. Still, you must know that separated pages are loaded simultaneously and quickly accessible through the parent page.
The cross-reference between those is not limited by location but just for simplicity.
Panels, Cards, Sections, and Layouts
The Panel allows to create a section with colored background, but you can get more creative and do more by also using it with Deck of Cards
Letâs begin with a new page example, the âCloud Guardiansâ team:
Compared to the first example of the âGotta Go Fastâ team, it looks more imposing. Even though it seems similar, there are a lot of changes, but for now, letâs focus on the main ones:
- The page contains a logo with a background.
- Titles are in red to match the theme.
- The content table is on the side with a slightly different color (baby powder, precisely).
- There is a section with tabs and cards containing information about products.
It may look similar to the configuration, but it has its nuances. Starting from the title:
- A Panel sets the background to match set the color.
- The Knuckles SEGA logo is centered and has a smaller size.
- The title image was generated using the Tech Headlines font on the Font SpaceTech site.
- It looks invisible as I change it with the MacOS image editor to be white and compatible with the background.
- A simple line made with the Horizontal Rule macro separates the contents from the logo.
- Not much thought was put into it; it felt right.
- Next section is divided with a Layout section of 2/3.
- Titles start at level 2 with red color. This makes the transition from huge L1 text to normal-sized paragraphs less weird.
- We use the Panel macro with a background of #FAFFFD (Baby Powder color) to highlight the content section, ensuring important sections stand out.
- We make sure the Content Table section contains the rule to start at level 2; otherwise, it will have a weird indentation.
And well, that was the fun part. For the next part we will see the Deck of Cards,
Letâs first refresh the Macros that we will use for this section:
- Deck of Cards
- Section
- Column
- Section
- Panel
- Span
Please note that for screenshots, the last card of the first tab wonât be visible. Youâre not missing anything.
Yeah, I know. Itâs quite messy to read and probably hard to edit, too. However, I can only say that the result is worth the trouble.
So it goes like this:
- Originally the first Panel was going to set a different color for the whole Deck of Cards, but it didnât looked right, so I avoided doing it like that. See images below to understand the pain:
On that note, keep in mind that other Macros do not render in the preview:
- The Deck of Cards creates horizontal tabs containing one or multiple Cards.
- Inside of a Card we will have the Section.
- Section will contain the Column macro.
- Column will have a Panel.
- Each Panel will have the text and display using a Span.
- The Span is used for set parameters to the block and have consistency.
- A Button Hyperlink is used to provide a way for users to access the other links related to each Product.
- The rest of Columns follow the same pattern. The percentage associated with it may variate but it is suggested to stick to percentages to not have issues when displaying.
Optimized Colors and Contrast
Originally the example didnât looked like the one shown before. It was like this:
Click to expand
Even thought it may look alright, reading with highcontrast or weird colors can throw your attention away.
There are plenty of tools to get ideas of how to get better colors based on a palette by either of concepts of complementary colors or the like.
For this site I used Coolors, and took as main color the Knuckles red (#E63D26) locked that color and started generating palettes like pulling for a Gacha Character, and in the end I went with the Baby Powder as it was more subtle.
The contrast is another element to keep in mind if you are going to user bright colors. As it may affect the readiblity and chakra mislalignment.
Just to recap:
- Be mindful of the colors that you use.
- If you are unsure of what to use, there are plenty of tools that can give you an answer regarding if a color is balanced with the existent or if the contrast of the text and background is correct.
You can Customize Button Hyperlink With CSS by using the CSS Style Sheet