Content Formatting Macros for Confluence Cloud

Progress Bar

The Progress Bar - Hyperlink Step macro allows you to add a stylized progress bar to the page, to provide users with a level of context for the page within a process. A Progress Bar Hyperlink Step macro is added for each step that you want to create.

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

Instructions

  1. Navigate to the page you want to edit.

  2. Click the Edit icon.

  3. Click Insert > View More.

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

    progress-bar-parameters

  5. Define the progress bar step using the following macro parameters.

    Parameter Description Default Required

    Title

    The name or label of the step that is displayed to users

    none

    check

    URL

    The URL that the step links to

    none

    check

    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

    Highlights the step when it is the current step in the progress bar

    off

    error

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

  7. Click Insert. A macro placeholder is displayed on the page.

    progress-step-placeholder

  8. Add a Progress Bar - Hyperlink Step macro for each step that you want to add as described in steps 2-7.

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

    rendered-progress-steps

Progress Bar in Use

The example below illustrates the Progress Bar - Hyperlink Step macro in use. The Background and Outcomes steps are complete and the current step, Survey is highlighted.

progress-active

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.