This page last changed on Aug 31, 2011 by pwatson.

User macros are short pieces of code that perform an often-used function or add some custom formatting to a page. People can call the macro into action by adding the macro keyword to their Confluence pages. You can write a 'user macro' by adding code on a screen in the Confluence Administration Console.

Notes:

  • You need System Administrator permissions in order to perform this function.
  • See Shared User Macros for a list of community-donated macros.
    Warning Be careful when installing user macros from unknown authors.
  • If you remove a user macro that is in use on Confluence pages, you will need to remove the macro from the pages manually. When you remove the user macro, the usage of the macro on the page will become invalid. Hint: Use the Confluence search to find all occurrences of the macro on pages and blog posts.

To add a user macro:

  1. Go to the Confluence 'Administration Console':

    • Choose Browse > Confluence Admin. The 'Administrator Access' login screen will be displayed.
    • Enter your password and click Confirm. You will be temporarily logged into a secure session to access the 'Administration Console'.
  2. Click User Macros in the left-hand panel.
  3. Click Click here to create a new User Macro at the top of the list of macros.
  4. Enter the macro details as explained in the guide to writing user macros.
  5. Click Save.

To edit a user macro:

  1. Go to the Confluence 'Administration Console':

    • Choose Browse > Confluence Admin. The 'Administrator Access' login screen will be displayed.
    • Enter your password and click Confirm. You will be temporarily logged into a secure session to access the 'Administration Console'.
  2. Select User Macros in the left-hand panel. This will list the currently configured user macros.
  3. Click Edit next to the relevant macro.
  4. Update the macro details as explained in the guide to writing user macros.
  5. Click Save.

To remove a user macro:

  1. Go to the Confluence 'Administration Console':

    • Choose Browse > Confluence Admin. The 'Administrator Access' login screen will be displayed.
    • Enter your password and click Confirm. You will be temporarily logged into a secure session to access the 'Administration Console'.
  2. Select User Macros in the left-hand panel. This will list the currently configured user macros.
  3. Click Remove next to the relevant macro.
Related Topics
No content found for label(s) admin-macros.

Document generated by Confluence on Sep 19, 2011 02:41