Community contributed extensions

Integration Guide

Migrate your current project from Groovy template engine to Rythm

PlayRythm is designed to support smooth migrating from Groovy template engine.

By default “system” (i.e. groovy) template engine is used. Meaning without special annotation, controller’s render request will be handled by groovy template engine. And this give developer a good base to move to Rythm template step by step.

  1. Step 1, rewrite a groovy template using rythm syntax.
  2. Step 2, annotate the relevant controller action method with @UseRythmTemplateEngine annotation

Continue the above steps until all your controller migrated to rythm, you can annotate the controller with @UseRythmTemplateEngine and drop all that from action method

Tip: enclose all your rythm template with #{verbatim} and #{/verbatim} can help you avoid groovy compile exception and does not impact your rythm template

Create an new project and use Rythm engine from the beginning

If you decide to use Rythm engine in a new project, you can add one line to your application.conf

rythm.default.engine=rythm

And you can start using rythm template without @UseRythmTemplateEngine annotation. On the contrary if you decide one or a few controller methods should use groovy template engine for some reason, you can annotate that action with @UseSystemTemplateEngine annotation

See Also

  1. Rythm Template User guide
  2. Reference manual