Here’s the scenario: You’re working on a knowledge base where you want to add citations, references, further explanations and commentary. Of course, you don’t want to break down the flow of information by adding the additional info within the body of your text. There’s only one macro you will use in this case: The Confluence footnote macro.
In this article, we will check why the confluence footnote macros are important, how to get started, and the tips and best practices to make the most out of them.
Why Implement a Confluence footnote?
Easily add & organize references:
When writing knowledge base articles, your sources matter. Footnotes offer a structured way to give credit where it’s due, and provide more context. Not only that, but by using dedicated footnote macros in Confluence, you can list all of your references (typically at the bottom of your Confluence pages) for quick and easy access.
Maintain the flow of information:
The perfect example here is Wikipedia. As you know every page there is filled with references. Just imagine how the page experience would be if every source is listed within the text itself. Definitely not ideal. And this is where footnotes come in handy. They help you add sources and references without breaking down the flow.
Is there a native Confluence footnote macro?
In short: No. Confluence, at least at the time of writing, doesn’t offer a dedicated footnote macro. While researching, I came across a couple of workarounds to insert footnotes with native Confluence features. The most popular of which is using anchors to link to specific terms and sections in a Confluence page. Although they might look useful, in truth, they’re not built for scale and easy organization. The more references you add, the more challenging it is to properly list and update them.
The same applies to Confluence comments. While they are customizable, they can create unnecessary distractions and may easily be mistaken for general comments rather than intended footnotes.
Best practices to get the most of Confluence footnotes
Be consistent with your citation style:
Just like any good piece of writing, your footnotes should follow a consistent format. Whether you’re using APA, MLA, or another citation style, keep it consistent throughout your Confluence page. For example, when using Chicago Style footnotes, you can opt for either the short or long form. Mixing both in the same document can confuse your readers and make your content appear disorganized. Choose one format and stick with it. This ensures that your readers know exactly where to find their sources and how they’re formatted.
Avoid Overuse and only include Important references:
This is the case for any macro in Confluence, and especially holds true for footnotes. Although they don’t break down the flow of your content, You don’t want to go overboard with footnotes. Too many can overwhelm the reader and create distractions. Citation styles, like APA, specifically advise against using footnotes for non-essential information. In this case, you can use simple Confluence comments or tooltips for additional content (if you feel the need to highlight).
Update your footnotes regularly:
Content evolves over time, and so do your footnotes. Always make sure to review existing footnotes. Don’t let outdated references sit there on your page—regularly check and update them as needed.
How to add a footnote in Confluence
Content Formatting Toolkit for Confluence comes with two footnote macros: A regular footnote to add citations, and the footnote summary macro to properly list them. Both macros work hand in hand. Once you add your references you need to add the footnote summary macro to visualize your references.
- Navigate to your Confluence page and hit Edit.
- Select the area where you want to insert your footnote and type Footnote | Vectors.
- Enter the term or phrase you want to cite, as well as the source. Of course, here always make sure to follow the same format.
- Choose the display style and colors.
- Click Save, and your footnote will appear where you placed it.
How to list Footnotes in Confluence
Now that you’ve added your references, it’s time to properly list them with the footnote summary macro.
- Decide where you want to list your references. The bottom of your page is typically the best spot for a footnote summary.
- Type /Footnote Summary | Vectors.
- Personalize the summary style and colors.
- Hit Save, and your footnote summary will automatically display all your references in an organized format.
And there you have it! The footnote macros are a great way to better contextualize your content. You can add citations, supplementary information ,and commentary without disrupting the flow of your main content.
Both footnote macros are available within our Content Formatting Toolkit for Confluence Cloud. If you like what you see, make sure to give them a try. And for more posts like this one, check out our blog.
