Jira-Plugin development-Velocity(vm) files #controlHeader and #controlFooter

Hi,

I am new to jira plugin development. I am designing vm pages.

I noticed that there are #controlHeader and #controlFooter tags in vm file.

Examples:

1. #controlHeader($action 'root' ${i18n.getText("common.params.cacheTimeout.name")} true $displayParameters.noHeader)

For this, I am writing a something from properties file (i18n). But, How can I set the text alignment, size, vs?

When I delete the controlHeader and write it simply with <p> tag, the text is displayed so above. (not the some position)

2. #controlFooter($action ${i18n.getText("params.linkto.desc")} $displayParameters.noHeader)

How can I use these tags? Can anyone suggest a tutorial or answer my question?

Thanks

1 answer

I had a related question. The #controlHeader is a JIRA specific macro, and has to be used as is. They are not documented. If you have access to the source code you can find the macro definition, then use it in your own code. Alternatively you can override the styling in JIRA, but I don't think I'll recommend that.

Atlassian usually documents all things. Why not to these velocity macros? :S

Anyway, thanks eirik.

Remember to accept ;)

You can find the macro detail in WEB-INF/classes/templates/plugins/jira/macros.vm file, even if you don't have the source.

I don't think Atlassian had a documentation about all those available macros. There are too many helper macros for that I guess ;)

well, Can I add a makro to macros.vm file? or Can I change an existing macro?

I think that it will effect all pages if I edit an existing macro.

It will be better if I add a new macro. Am I right?

If it is your own macros then maintain them in your own code, yes. I'm quite sure you can have an extra .vm file in your plugin and include macros from it.

Suggest an answer

Log in or Join to answer
Community showcase
Bridget Sauer
Published Wednesday in Agile

Community Showcase: Thomas Deiler, Mountaineering Agile Coach

Thomas Deiler is a Bavarian, Mountaineering, Senior Agile Coach. In this Showcase, you will learn about his journey from software engineer to project manager, his freelance philosophy, and much more....

102 views 3 6
Read article

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
Atlassian Team Tour

Join us on the Team Tour

We're bringing product updates and pro tips on teamwork to ten cities around the world.

Save your spot