Can I add collapsible sections within my Confluence page? This was one of the first questions I asked when I first started using Confluence. And the answer is obviously yes. The Confluence native expand macro helps you better structure your content and add supplementary information, offering a way to hide and reveal content on demand. The macro is easy to use, edit and customize (depending on which macros you are using).
Although it is quite handy, Confluence expands are often misused, at least according to my previous experiences. This bears two questions: When should I use them, and most importantly, when shouldn’t I use them? If you’re asking yourself these questions, then you are at the right place, and the right time since we just revamped our very own expand macro 😀.
Why are Collapsible sections Important in Confluence
Understanding the importance of collapsible Confluence sections is key to optimizing your content. These sections allow you to:
- Make use of space: We often fall into the trap of making our pages long simply because we can. That is obviously an absolute no no for obvious reasons: unnecessary scrolling, low engagement, and the list goes on. Collapsible sections are just ideal to make use of space. Without having to trim down the content, it can simply be embedded into specific sections that, of course, the reader can expand or collapse.
- Facilitate Navigation: Navigation is the first thing to keep in mind when creating a Confluence page. That is why we have templates and a host of formatting macros in place. Collapsible sections help break down content and present detailed information in a structured manner without overwhelming the reader. This results in a cleaner, well-organized Confluence page.
- Give Users Control: Users are not expected to read the content from A to Z for specific types of pages. Think of an updated page, or one based on user roles for example. Collapsible sections allow users to explore topics at their own pace, focusing on areas that are most relevant to them. By giving readers the ability to choose what they want to see, you not only enhance their experience but also encourage deeper engagement with the content.
Understanding the Native Confluence Expand Macro: When Good Is (at Times) Not Enough
As is the case with any native feature, Confluence expand is a good place to start adding collapsible sections within your content. It is simple, easy to implement and edit. However, while the native Expand macro serves its purpose in many scenarios, it does have its limitations. Here’s what you need to know about when the Confluence Expand macro.
What to Expect with Confluence Expand Macro
The native Expand macro is an excellent starting point to organize content in Confluence. It is:
Easy to Use & Implement: The Expand macro is both simple and highly intuitive. Simply type /expand, select the expand title, add your text, and VOILA! Users can then click on the title to reveal hidden content.
Perfect for Basic Needs: If you are just getting started with Confluence, you need to explore its basic features first, then identify any gaps. And when it comes to creating collapsible sections for basic pages, expand is your starting point. You can use them to add detailed FAQs, troubleshooting sections, and more.
Blend within Content: Due to intentional lack of customization options, the macro seamlessly integrates with your existing content, maintaining both the flow and structure of your page.
Where the Native Expand Macro Falls Short
Despite its utility, the native Expand macro has some limitations that may not meet the needs of more complex use cases:
Lack of Customization: The native Expand macro offers minimal customization options. You can’t easily style the expanded or collapsed sections differently, which can be limiting if you want to match your Confluence pages to a specific brand or design standard.
No Nested Content: The native Expand macro doesn’t support nested macros, meaning you can’t place other macros within it. Personally, I don’t think expanders are designed to be filled with other content, rather than text. But for specific use cases, one might need to include other macros such as buttons, and more.
Limited Interaction Options: Click to show, click to hide. Simple and to the point. But the more content you have, the more expands you will need, and obviously, the more interaction options. There’s no support for more advanced interactions, such as expanding all sections at once or having multiple expanders open simultaneously.
On a FAQ page where users might want to view several questions at once, the native macro’s lack of multi-expander support could hinder user experience.
When (and When Not) to Use Confluence Collapsible Sections
One of the common mistakes we fall for when using macros is we only ask when to use them. For sure, that is the first question you need to ask, but we also need to know when not to use and opt for other alternatives. Now that we know the basic benefits of having collapsible sections, let’s learn when (and when not) to use them.
Use When…
Providing Supplementary Information: When you have supplementary information such as references, additional resources, or context that complements the main content, expanders can keep your page uncluttered while still providing access to this extra material.
Organizing FAQs or Troubleshooting Guides: This is perhaps the most common use case for expanders in Confluence. If you have a long list of FAQs or troubleshooting steps, expanders can make it easier to navigate and find information.
Hiding Detailed Information: When you have a page with detailed or supplementary information that doesn’t need to be visible at all times, expanders can help keep the page clean and focused. They allow users to expand sections only when they need to see more details.
Don’t Use When…
Long Content: What is the ideal text length to put within an expander? I don’t have the exact number, but a safe answer is not too much. If your content is quite long, then you should think of using tabs. If it is really that long, you can simply create dedicated Confluence pages and rely on hierarchy and child pages.
Check out this dedicated Atlassian community post to learn more about Confluence tabs
Minimal & Simple Content: If your content is short and straightforward, expanders might add unnecessary complexity. Use headings or simple formatting to organize brief content effectively.
Check out this article to learn how to better organize your Confluence space
Linear Flow of Information: Grouping information within macros is convenient, but it also means it can break the flow of information. If you want your readers to read the content in a sequential way, then avoid using expanders. In such cases, a continuous format might be more effective. Think of simply using headers and subheaders to guide users through your content.
Critical Information: For critical or time-sensitive information that users need to see immediately, hiding it behind expanders might lead to missed details. In thai example, think of using panels to properly highlight information.
Best Practices to Create & Manage Collapsible Sections
To use Confluence expanders effectively, follow these best practices:
Be Clear and Descriptive: The title is the first (if not the only thing) users will see on the expander. This is why you should carefully choose titles that properly reflect the content.
Implement Responsibly: Don’t overuse expanders on a single page. Too many collapsible sections can make the page crowded and obviously overwhelm the reader.
Maintain Consistency: Although the native Confluence Expand macro doesn’t offer customization options, third party macros do. Keep the style and structure of your expanders consistent across your Confluence space to ensure a coherent user experience.
Build on Confluence with Advanced Expanders (Powered by Vectors)
As mentioned earlier, the native Expand often comes short for more advanced use cases. This is where our two Expander macros come in handy: The Expander container and box. Both macros work hand in hand to help you seamlessly integrate advanced expanders.
But why should I use the expander macros when I can simply use the native ones?
In two words? Advanced customization.
With a brand new creation experience, you can customize your expanders in terms of:
- Display Options: Choose to display your expanders in either a list or grid format to optimize space and create a cohesive layout.
- Customization: Personalize headers, select colors and icons for your expanders to perfectly match your branding style.
How to Get Started:
- Type /Expander Container | Vectors. Select the display and style options and then fill with one or multiple expander boxes.
- Once the container is created, you can start adding your boxes that will be displayed following the specific display criteria you have already specified. Type /Expander Box | Vectors.
- And Voila! You can start filling your expanders with content. And remember, of course, the best practices while doing so.
- Finally, hit update to see your expanders in action
Confluence expanders are a great tool for organizing and streamlining your content, but knowing when and how to use them is crucial. By following the guidelines and best practices outlined above, you can enhance the usability of your Confluence pages and improve the overall user experience. If you like what you saw, the make sure to give Content Formatting for Confluence a try here.
