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

[Bahar Çağlar]

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

[Deleted user]

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.

[Bahar Çağlar]

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

Anyway, thanks eirik.

[Deleted user]

Remember to accept ;)

[Jobin Kuruvilla [Adaptavist]]

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 ;)

[Bahar Çağlar]

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?

[Deleted user]

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.