Documentation for Confluence 5.7.
Documentation for Confluence Cloud and earlier versions of Confluence is available too.

Skip to end of metadata
Go to start of metadata

The Status macro displays a coloured lozenge (a rounded box) that is useful for reporting project status. You can choose the colour of the lozenge and the text that appears inside the lozenge. The macro also displays its current status in the editor, and you can change the status directly in the editor.

ALL GOOD!

Screenshot: Click on the Status macro lozenge to change the status.

Using the Status macro

To add the Status macro to a page using the Macro Browser:

  1. In the Confluence editor, choose Insert > Other Macros
  2. Find and select the required macro

Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete.

To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro.

Parameters

Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example).

Parameter

Default

Description

Colour
(colour

Grey

The colour of the lozenge. The following colours are available: Grey , Red, Yellow, Green and Blue.

Title
(title

The colour that you select.

The text that will appear inside the lozenge. If you do not specify any text, the title will be the colour of the lozenge, that is 'Grey', 'Red', 'Yellow', 'Green' or 'Blue'.

Use outline style
(subtle
False

The style of the lozenge and its border. The default style lozenge is a solid background colour with white text. The outline style lozenge is white with a coloured border and coloured text as shown here

ALL GOOD!

Code examples

The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. 

Macro name: status

Macro body: None.

Storage format example

Wiki markup example

  • No labels

35 Comments

  1. Anonymous

    Attempting to display a percent sign as the title appears not to work. For example, I want the title to say "75%". When I do this, Confluence hangs when I attempt to save the page. I can URL encode the % (i.e. %25). This seems to work when I view the page in Edit mode, but when I view the page in Display mode I see "75%25". Any ideas here?

  2. Should be possible to insert a text that is longer than 10 characters. The macro will automatically add 3 dots after the text if it is too long.

    1. Anonymous

      did u find a way to expand the width?

  3. I wasn't able to put a link on that status-bar. Adding a link to the panel renders a simple link when saving.

    STATUS PANEL WITHOUT LINK

    Status MacroWorking with Tables

     

    Any solution?

    Thanks in advance

    1. Did you find out how to add a link to the Status Bar?  I'd like to use this macro but need it to be able to link to another confluence page.

      1. Yes i found out, just do it

        LINK

        Create a Status Bar, click it and then click on "Link"

        I really don't know why I had this problem or how i solved it, maybe only an update is needed.

        And you'll still be able to change the status (clicking on it) or the link (focus on the status bar and click "link" again)

         

        regards

  4. Hi all,

    a status is fine - it would be even finer when youre able to find pages with a status e.g. when you enter the content of the statusfield. This would help to identify e.g. pages with a status like "draft". A simple search after the keyword of the status field seems not to work. Any hints for me?

    Thanks,

    1. Hi Marcus Sternberg, I agree with you, although you could try and use labels to achieve that.  But I still think the status macro content being searchable would be useful and assumed.  I created an issue for that enhancement.

      CONF-31884 - Status macro is not searchable New

      1. Thanks David, very appreciated.

  5. Anonymous

    What is the keyboard shortcut or wiki markup to speed up the creation of status macros? 

    Thanks!

    1. Here's the wiki markup.  Type the following ... {status:title=Whatever|color=red}

      • "Whatever" can be anything up to 10 characters (which is definitely not enough - 20 characters would be about right)
      • color can be grey, red, green, yellow or blue
  6. Same question for me here - what's the keyboard shortcut or markup - we do lots of project status update pages every day/week and want to do them nice and quickly!

  7. Anonymous

    Hi all,

    is it possible to save a status for each colour just in one single status macro? I want to change the status text just by changing a colour.

    Do you know other macros or plugins, which provide this feature?

    Best regards,

    Sebastian

     

    1. Anonymous

      I want to do this too, any update about this? Thanks!

    2. There is a feature request for this. Feel free to watch, vote for, or comment on this issue:

      CONF-26322

       

      1. Anonymous

        Yes, that would have been the intuitive way of solving it. I was sure it worked that way until I realized this "bug". 

  8. Anonymous

    Can't find the command syntax documented in this page. Is this macro available in 3.5.9?

    1. No, the Status macro was added to Confluence in version 4.0.

      If upgrading is not an option for you, you can recreate the functionality in a user macro. There is a guide for doing this in Confluence 3.5 on this page: Writing the Status User Macro.

      Cheers,
      Mark

       

  9. Is there a way to add additional colors to the Status macro?  Thanks,

  10. Is there any way to change the color of the box AND attach the tag to the page in one go?

  11. Is it possible to dynamically generate the status macro based on the results of a JQL query, like if all of the subtasks of a ticket are completed, it can be green and set to "COMPLETED"?

  12. From what I can see this is really just serves as a visual element. Is it possible to have a library of status states so a user can assign from that library, rather than making up an arbitrary status each time? Sorry, just saw the request for this feature :  CONF-26322

  13. Since 5.1 UNFORTUNATEYL all text is changed to uppercase.

    Please remove this "feature" in next release. Up to 5.0.3 the text was displayed as entered.

    Bugreport filed:  CONF-28822 - Status macro converts all text into UPPERcase Resolved

  14. Is it possible to define some default statuses that can easily be re-used in a space? So that you are not obliged to re-create them each time you want to use a certain status.

    1. Hi Dieter, no, this is not currently possible.  Feel free to create a feature request for this. Where would you want to be able to define the statuses?  

      1. May it's possible to remember the already created statuses, like done with the labels. So when you create a new status, you can choose one of the already created onces.

  15. Is it possible to define user specific colours (like pink)? 

    1. Hi Christian, no, it is not possible to add more colours to the status macro in Confluence. It may be possible to change the colours by using some custom CSS in a space.  You could ask at Answers as someone in the community may have a workaround for you. 

  16. CONF-26322

    Could anybody tell me, what exactly is resolved? We use confluence 5.3.4 with the "Status Macro" version 2.13. However I cannot find a way to change the text per color of the status macro! Am I missinterpreting anything here?

    Thanks for a clarifying answer.

  17. You could create a user macro for this with the help of the parameters that are available for the status macro. 

    ## @param Status:title=Status|type=enum|required=true|enumValues=RED,GREEN,GRAY|desc=Choose a status.

    #if ( $paramStatus == "RED" )
    #set ( $color = "Red" )
    #set ( $title = "RED STATUS" )
    #elseif ( $paramStatus == "GREEN" )
    #set ( $color = "Green" )
    #set ( $title = "GREEN STATUS" )
    #elseif ( $paramStatus == "GRAY" )
    #set ( $color = "Gray" )
    #set ( $title = "GRAY STATUS" )
    #else
    #set ( $color = "RED" )
    #end

    <ac:macro ac:name="status">
    <ac:parameter ac:name="colour">$color</ac:parameter>
    <ac:parameter ac:name="title">$title</ac:parameter>
    </ac:macro>

  18. I'm trying to make a status bar a link. I followed the suggestion in another comment here and selected the status bar and clicked Link in the Confluence toolbar. This looked like it was going to work - but when I save or preview the changes, the status bar has disappeared. Is this a bug?

    1. Hi James, there's an issue for this here  CONF-33834 - Relative Links Causes Status Macro to Vanish Open

  19. Is there some sort of offline image rendering that happens using the status macro? Does it render the macro as an image eventually? We have a user that when they remove an existing status and insert>status and then publish the updates, the update shows as "Image added," instead of the pseudo markup of existing status macros. You can see this when flipping through the versions.  When you try to change the status, it just thinks it's an image to be edited, instead of giving you the status macro options. I notice that when I right click a previously saved status, it thinks it's an image. Other people just copy the status from elsewhere, then paste it. It doesn't show as an image then.