Template prototype is like a master page template. Anything you configure in the prototype is applied to all page templates. The prototype makes configuration efficient as you only need to do it once. For example, add an area to the prototype to make it available on all pages. You can override the prototype at the page definition level if needed.
Do I need a prototype?
No, it is not necessary to use a prototype. You can configure a separate page definition for each page template instead. This works fine if you have a small number of templates that are very different from each other.
Prototype is an optional templating mechanism that offers a number of benefits:
- Ensures uniformity across templates
- Avoids repeating and duplicating configuration
- Creates similar templates quickly
- Site module. You need to install the Site module and configure a site definition in order create a prototype.
Configuring a prototype
You can configure a prototype in:
If you have the Multisite module (DX Core) you can configure a different prototype for each site or use the same prototype for all sites.
Configuring a prototype in JCR
In the site definition configure the prototype in the
Example: Prototype in the site definition in the Site app.
Configuring a prototype in YAML
While it is not possible to configure a site definition completely in YAML, you can configure the prototype in YAML and reference it in the site definition. The prototype definition can reside in any module.
To configure the prototype in YAML:
- In the site definition in
- Set the:
info.magnolia.module.site.templates.ReferencingPrototypeTemplateSettings. This class allows you to use a prototype defined in YAML.
prototypeIdto the location of the YAML prototype definition in the
<module name>:<relative path to definition>format, for example,
- Set the:
- Remove the
/prototypenode, if it exists.
travelsite definition in the Site app.
Node name Value
Create the prototype YAML file in the location defined in the
prototypeIdproperty and set the class property to
info.magnolia.module.site.templates.PrototypeTemplateDefinition(or a subclass).Click here to see the complete prototype.yaml used in travel demo
Prototype template properties
Prototype is a TemplateDefinition which means it supports the same properties as page definition, including common template properties. However, typically you don't use them all. Here are the typical use cases:
Common areas such as footer or navigation that are used on most pages. Each child node is an area definition. Define the areas in the prototype so you don't have to repeat them in each page definition.
A page template script typically starts with an opening
Example: The travel demo demo defines a template script in the prototype. This common script is used for all pages. It is also the reason why no YAML page definition in the demo has an explicit
A custom definition class which extends ConfiguredTemplateDefinition, an implementation of TemplateDefinition. You only need a custom class if you want to add your own nodes and properties in the prototype. Implement corresponding methods to operate on those properties in the definition class.
Example: PageTemplateDefinition (Git) is a custom definition class used in the Travel Demo. It adds support for a
Merging a prototype with a page definition
When a user requests a page Magnolia merges the prototype with a page definition. The result is a merged template definition which is then used to render the page.
The merged definition is virtual. You won't find its configuration anywhere. It is created dynamically at the time of rendering. However, you can access the merged definition in a template script using the
def rendering context object .
Example: Merging a prototype (configured in JCR) with a home page definition (configured in YAML)
- Prototype defines the
mainarea type as
list. Page definition adds
availableComponentsfor the area. The result contains both.
- Prototype defines a
templateScript. Page definition says nothing about script. The result is that the home page uses the script defined in the prototype.
- Prototype defines the
footerarea as not editable. Page definition overrides this decision by allowing footer editing on the home page. The result is that the footer can be edited on the home page only.
|Before merge||After merge|
Page template definition:
Merged template definition: