The Status macro displays a coloured lozenge (a rounded box), useful for reporting project status. You can choose the colour of the lozenge and the text that appears inside the lozenge.
What you need to type |
What you will get |
|---|---|
{status:colour=Green|title=All good!}
|
ALL GOOD! |
On this page:
Usage with the Macro Browser
To insert the Status macro into a page using the Macro Browser,
- Open the Confluence page or blog post that you want to edit, then click the 'Edit' button.
- Click the Macro Browser icon
on the toolbar. The macro browser window will open. - Scroll through the list of macros to find the one you want. Alternatively, start typing the macro name into the search box at the top right of the macro browser. Macros with a matching name will appear in the main pane.
- Click the desired macro.
- Set the macro parameters to your requirements. If desired, you can preview these changes by clicking 'Refresh'.
- Click 'Insert' to add the macro onto the page.
You can also insert macros via autocomplete. For more information, see Using Autocomplete in the Rich Text Editor.
Usage with the Wiki Markup Editor
{status:colour=Green|title=Go}
Parameters
Parameters are options that you can include in Confluence macros to control the content or format of the macro output. The table below lists relevant parameters for this macro.
Parameter names are different in the macro browser and in wiki markup. Below we show the macro browser parameter names in bold text, and the equivalent wiki markup parameters in (bracketed) text. If we do not show any parameter name for the wiki markup, then you should leave out the parameter name and simply include the parameter value as the first parameter, immediately after the colon (:).
Parameter |
Default |
Description |
|---|---|---|
Colour |
Grey |
The colour of the lozenge and its border. The border will be a darker version of the same colour. The following colours are available: 'Red', 'Green', 'Yellow' and 'Grey'. |
Status Title |
The colour that you select. |
The text that will appear inside the lozenge. If you do not specify any text, the colour of the lozenge will appear as the title: 'Red', 'Green', 'Yellow' or 'Grey'. |
Prerequisites, Limitations and Other Notes
- Your administrator must define this user macro. The Status macro is a user macro that your administrator must define on your Confluence site. You will only be able to use this macro if it has been defined via the Confluence Administration Console. See the administrator's guide to writing the Status user macro.
RELATED TOPICS
Writing the Status User Macro
Working with Macros
Take me back to the Wikis Help Guide.