Using macros for advanced functionality - Confluence Tutorial

Welcome to this tutorial on using macros in Confluence. Macros are powerful tools that allow you to add advanced functionality, automate tasks, and enhance collaboration within your Confluence pages. In this guide, we will explore the concept of macros and provide step-by-step instructions on how to use them effectively to extend the capabilities of Confluence.

less Copy code

Understanding Macros

Macros are predefined scripts or plugins that add specific functionality to your Confluence pages. They enable you to perform a wide range of tasks, from displaying dynamic content to integrating external applications. Let's look at a couple of examples:

Info Macro

The Info macro allows you to display important information or tips within your page. Here's an example of how to use the Info macro:

{info:title=Important Tip}


This is an important tip that you should be aware of.
{info}
less Copy code

JIRA Issues Macro

The JIRA Issues macro allows you to embed JIRA issues within your Confluence page, providing seamless integration between the two applications. Here's an example:

{jiraissues:project=PROJECTKEY}

Using Macros in Confluence

To use macros in Confluence, follow these steps:

  1. Edit the Confluence page where you want to add the macro.
  2. Click on the "+" button in the editor toolbar to open the macro browser.
  3. Browse or search for the desired macro.
  4. Configure the macro settings, such as specifying parameters or linking external content.
  5. Click "Insert" to add the macro to your page.
  6. Save the page to apply the changes.

Common Mistakes

  • Overusing macros, which can lead to cluttered and confusing pages.
  • Not properly configuring the macro settings, resulting in incorrect or incomplete functionality.
  • Using outdated or incompatible macros, causing errors or issues with page rendering.

Frequently Asked Questions

  1. Can I create my own custom macros in Confluence?

    Yes, Confluence provides a development platform that allows you to create custom macros using various programming languages, such as Java or JavaScript.

  2. Can macros be used across multiple Confluence spaces?

    Yes, macros can be used across multiple spaces, allowing you to reuse and share functionality across your Confluence site.

  3. Are macros supported in Confluence Cloud?

    Yes, macros are supported in Confluence Cloud. However, the available macro options may vary compared to Confluence Server.

  4. Can I customize the appearance of macros?

    Yes, you can customize the appearance of some macros using CSS or by modifying the macro settings. Consult the documentation or the specific macro's instructions for more details.

  5. Can I import macros from third-party sources?

    Yes, Confluence allows you to import macros from third-party sources, such as the Atlassian Marketplace, to extend the functionality of your Confluence instance.

Summary

In this tutorial, you learned how to use macros in Confluence to add advanced functionality and automate tasks. Macros provide a wide range of capabilities, allowing you to display dynamic content, integrate external applications, and enhance collaboration within your Confluence pages. Remember to avoid common mistakes, properly configure macro settings, and ensure compatibility with your Confluence version. Now you're ready to leverage the power of macros for enhanced collaboration in Confluence.