Magnolia 5.7 reached extended end of life on May 31, 2022. Support for this branch is limited, see End-of-life policy. Please note that to cover the extra maintenance effort, this EEoL period is a paid extension in the life of the branch. Customers who opt for the extended maintenance will need a new license key to run future versions of Magnolia 5.7. If you have any questions or to subscribe to the extended maintenance, please get in touch with your local contact at Magnolia.

Templates are blueprints for creating pages, areas and components. When you add a page in the Pages app you must choose a template.

A template consists of:

Template definition

required

A template definition gives a template a name and makes it available to the system. At a minimum a template definition must specify a script and a renderer.

Template script

required

A template script defines the output, typically HTML, and is interpreted by a Renderer. The script is written in a templating language such as FreeMarker or JSP.

Dialog definition

optional

Dialogs are used for content entry. A dialog defines the editable content properties of a template. Pages, area and component templates can all use dialogs.

Model

optional

The model is a JavaBean implementing

$webResourceManager.requireResource("info.magnolia.sys.confluence.artifact-info-plugin:javadoc-resource-macro-resources") RenderingModel
. Use it to implement complex logic. The model can execute any Java code to retrieve data from the repository or from an external source. The results are available to the template script for rendering on the page.

optional

The model can be implemented in Java or via JavaScript. Use models to implement complex logic. The results are available to the template script for rendering on the page.

A Java model is a bean implementing RenderingModel. The model can execute any Java code to retrieve data from the repository or from an external source.

In order to use JavaScript models, make sure the Magnolia instance contains the JavaScript Models module.

Elements of the Magnolia template mechanism:

(warning) The diagram abbreviates the field class as i.m.u.f.f.d.TextFieldDefinition to save space. This is not a valid value. Use fully-qualified field class names such as info.magnolia.ui.form.field.TextFieldDefinition in your definitions.

The Magnolia CLI speeds up template creation for light developers. The tool provides commands that automatically create basic template definitions and scripts on the file system.