How to add docu text in a user macro?

Hi,

I created a user macro with one parameter to fill in by users when editing the macro: the name of a space.

I would like to add a sentence to explain the parameter like "Please add the space name here. The current space is the default."

However I only find a way to link to a documentation web page, which would be a bit too much for just one sentence.

How can I add such short explanations to the parameters?

Thanks!

1 answer

0 vote
Ann Worley Atlassian Team Dec 19, 2017

Hello Henning,

It seems like the parameter's title could be used. It could say something like: "Space: Please add the space name here. The current space is the default."

This doc has the syntax for specifying a parameter title: User Macro Template Syntax

I look forward to hearing whether that works for your case.

Thanks,

Ann

Hi Ann, thanks a lot!

I now use the parameter's title, as you suggested, and in addition the parameter's "desc" attribute to add another sentence.

Have a good start into the new year!

Henning

Suggest an answer

Log in or Sign up to answer
Atlassian Community Anniversary

Happy Anniversary, Atlassian Community!

This community is celebrating its one-year anniversary and Atlassian co-founder Mike Cannon-Brookes has all the feels.

Read more
Community showcase
Kesha Thillainayagam
Posted Apr 13, 2018 in Confluence

We want to hear how your non-technical teams are using Confluence!

Hi Community! Kesha (kay-sha) from the Confluence marketing team here! Can you share stories with us on how your non-technical (think Marketing, Sales, HR, legal, etc.) teams are using Confluen...

357 views 20 10
Join discussion

Atlassian User Groups

Connect with like-minded Atlassian users at free events near you!

Find a group

Connect with like-minded Atlassian users at free events near you!

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you