How to use velocity templates?

Hi.

I found many questions and answers about velocity templates in Confluence. And what about JIRA?

I have tried example from this page:

// Create the Velocity Context
Map context = MacroUtils.defaultVelocityContext();
context.put("myCustomVar", customVar);
context.put("otherCustomVar", otherCustomVar);
// Render the Template
String result = VelocityUtils.getRenderedTemplate("/com/myplugin/templates/macro.vm", context);

 but I cannot find appropriate packages for MacroUtils and VelocityUtils in JIRA.

What packages I need to user for it? Or does exists anything else way to use velocity templates in JIRA?

Thanks.

2 answers

1 vote

Hi Yanduganov,

You'll want to use the JIRA templates and JSP's guide for Velocity Templates in JIRA.  MacroUtils and VelocityUtils appear to be for Confluence per the Confluence Velocity template documentation and I was unable to find references to those methods in the JIRA docs.

Cheers,

Branden

Gaston Valente Community Champion Jul 26, 2017

great doc, saves a lot of time, thanks!

Hi Branden.

Your answer isn't about templates which I meant.

I write JIRA plugin and I have servlet. And I wanna render it using velocity template. I tryed write HTML just in java but I think that it's a wrong way.

To use Velocity Template you need:

  1. add Scanned annotation to your class
  2. add TemplateRenderer field with ComponentImport annotation
  3. add TemplateRenderer to constructor
  4. use it

For example:

@Scanned
public class MyClass {
@ComponentImport
private final TemplateRenderer templateRenderer;

public MyClass(TemplateRenderer templateRenderer) {
this.templateRenderer = templateRenderer;
}
}

 After that you can use it, for example

@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
Map<String, Object> context = Maps.newHashMap();
resp.setContentType("text/html;charset=utf-8");

context.put("key", "value");

templateRenderer.render("path_to_vm_template", context, resp.getWriter());
}

Suggest an answer

Log in or Sign up to answer
How to earn badges on the Atlassian Community

How to earn badges on the Atlassian Community

Badges are a great way to show off community activity, whether you’re a newbie or a Champion.

Learn more
Community showcase
Published Monday in Jira Software

How large do you think Jira Software can grow?

Hi Atlassian Community! My name is Shana, and I’m on the Jira Software team. One of the many reasons this Community exists is to connect you to others on similar product journeys or with comparabl...

688 views 6 13
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