Just a heads up: On March 24, 2025, starting at 4:30pm CDT / 19:30 UTC, the site will be undergoing scheduled maintenance for a few hours. During this time, the site might be unavailable for a short while. Thanks for your patience.

×
Create
cancel
Showing results for 
Search instead for 
Did you mean: 
Sign up Log in

User macro description not showing in macro browser

David_Bakkers
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
April 23, 2020

When I write user macros for our Confluence server, they appear in the macro browser by title only, with no description:

 

UserMacro1.png

 

The description text only appears when the macro is selected:

UserMacro2.png

 

I'm fairly sure the macro parameters are valid, like this:

## @param BackToTop:title=BackToTop|desc=Shows a 'Back to top' button when the user scrolls down the page

What am I missing to make the description appear in the macro browser window?

Also, the description has the inverted commas stripped out, for some reason

1 answer

1 accepted

0 votes
Answer accepted
Dominic Lagger
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
April 24, 2020

Hi @David_Bakkers 

Everything is correct. You just described the parameter "BackToTop" and not the user macro itself.

For describing the user macro itself, you need to fill these fields:

image.png

Regards, Dominic

David_Bakkers
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
April 24, 2020

Oh, I get it. Each parameter has its own description, and that description is what appears near that parameter on the second screen. I was creating a parameter that did nothing.

I thought the information was parsed out of the macro file itself into the Macro Browser Information panel.

Oh well, I'll just manually type it in and set @noparams in the macro

Thanks,

Like Dominic Lagger likes this

Suggest an answer

Log in or Sign up to answer
TAGS
AUG Leaders

Atlassian Community Events