The Progress Bar Hyperlink Step macro allows you to add a stylized progress bar to the page, providing your users with a level of context for the page within a process. A Progress Bar Hyperlink Step macro is needed for each step that you want to create. These are then added to each page within the process. It is helpful to start with a plan that includes the titles of the pages you want to link in the process. 

You can add only one array of progress bar hyperlink steps to a Confluence page. See our FAQ page to learn more.

Walkthrough

Watch our video walkthrough to see the Progress Bar macro in action.


Instructions

  1. Navigate to the page you want to edit.

  2. Click the Edit icon.

  3. Click the position where you want to display the progress bar.
  4. Click Insert > View More.

  5. Select the Progress Bar - Hyperlink Step macro in the Select Macro screen.

    Progress Bar macro editor
  6. Define the progress bar step using the following macro parameters.

    ParameterDescriptionDefaultRequired

    Title

    Enter the title or label for the step, e.g. Welcome.

    none

    (tick)

    URL

    Enter the Confluence page title that is linked to this step; start by typing the title, then select the correct page from the corresponding results that display.

    none

    (tick)

    Ordering Index

    The order you want to assign to this step, e.g. 1 if it is the first step, 2, if it is the second step. If not specified, the step order might be unexpected.

    none

    (error)

    Current Step checkbox

    Select this option to highlight the step when it is the current step in the progress bar. 

    off

    (error)

  7. Click Preview to see how the progress bar will appear on the page, and make any desired changes.

  8. Click Insert. A macro placeholder displays.

  9. Add a Progress Bar Step macro for each step that you want to add as described in steps 2-7, changing the page link to the required page name.

  10. Click Publish to see the progress bar rendered on the page. 

    Rendered progress bar for a 4-step process
  11. Repeat the process above on each page that is linked in the process. Remember to select the Current Step checkbox according to the current page. The example below displays the progress bar on the page for step 2 in the process.
    Progress bar at step 2 in the process

Edit the macro

To make changes to the macro, for example, to change the order of the steps, click the macro placeholder then click the Edit icon. Make the required changes, then click Save.


Try out Content Formatting Macros!

Not an admin? No problem. Share the app with your admin and they can install it.