Templating functions perform typical templating tasks such as creating links and navigating content. This page explains where you can use templating functions and how to create your own.
Templating functions are grouped into sets according to their purpose:
|Function set||Purpose||Installed by module|
|Navigate content and create links.||Templating (available in every bundle)|
|Get assets and renditions and create links to assets.||DAM Templating|
|Get sites and themes.||Site 1.0+|
|Create site navigation.||Templating essentials (MTE) 0.14+|
|Get categories (tags) and access content by category.||Categorization 2.4+|
|Search pages and content.||Templating essentials (MTE) 0.6+|
|Access REST clients.||REST client module 1.0.4+|
|Get links to images from any workspace.||Imaging module 3.2+|
|Create links to css and js files by given patterns||Resources module 2.5.1+|
|Generate JSON from JCR nodes of any workspace.||magnolia-jsonfn|
Templating function is not available?
- Check that the module that includes the function set is installed.
- Check that the functions are configured in the renderer, especially if you have a custom renderer.
Using functions in template scripts
Use templating functions in template scripts for common tasks such as navigating content. You typically pass arguments to a function and get an object in return. You can assign the returned object to a variable to process it further.
Example: Getting a page title with the
In this example we use the
contentByPath function in a Freemarker script. We pass the path
/hello to the function as an argument. At the path is a page named
hello. The function returns a
ContentMap object that represents the page node and its properties. We assign the ContentMap to the
myPage variable. ContentMap provides easy access to a node's properties. We use the
title method to retrieve the page title and render it on the page.
See the function sets for more examples.
Using functions in Java classes
You can also use templating functions in Java classes. This is useful when you write your own templating functions or want to use the existing functions in a model class.
TemplatingFunctions into a model class and creating a link to the site root page
- Line 5: Inject a
TemplatingFunctionsobject in the constructor. All Magnolia templating functions can be injected. Never instantiate a templating function class directly.
Lines 11-12: Use the instance in the methods.
Creating custom templating functions
To create custom templating functions:
- Configure the functions in a renderer.
- Enable instantiation by IoC of the new custom templating functions class (see Dependency injection and inversion of control).
Implement a templating function class
This example introduces a custom function set
examplesfn. It provides a function
getRandomNumber which returns a random integer.
Configure the functions in a renderer
A renderer executes a template script and evaluates any templating functions in it. Every templating function must therefore be configured as a context attribute in the renderer.
In order to use your own templating functions with the default FreemarkerRenderer, register the functions in the Freemarker renderer configuration. The Freemarker renderer is configured in
Any module can register templating functions. Magnolia adds the functions to the Freemarker renderer configuration during module installation. When you add a module that registers functions to your webapp bundle, the functions become available to your template scripts.
Similarly, if you want to use standard Magnolia function sets such as
cmsfn in your custom renderer, register them in your renderer configuration.
In this example, we assume the Site module is installed. We enable the custom function class
MyCustomTemplatingFunctions in both
site renderers. Use InstallRendererContextAttributeTask in the module version handler class of your custom module to add the function configuration to the renderers:
After module installation both renderers are configured with the custom functions.
Enable instantiation by IoC
Magnolia uses Dependency injection and inversion of control. Context attributes such as templating functions configured in a renderer are instantiated via IoC in the RenderingContext. To enable instantiation, make sure your templating function class has a public constructor and register the class as a component in a module descriptor.