Magnolia 5.4 reached end of life on November 15, 2018. This branch is no longer supported, see End-of-life policy.
Pages are based on page templates. A page definition knows which script should be used to render a page. It may also define areas. You can configure a template in a YAML file or a JCR node.
Page template properties
You can use common template properties and the following properties in a page definition:
example/templates/pages/home.yaml
renderType: freemarker templateScript: /my-module/templates/pages/home.ftl dialog: my-module:pages/homePageProperties # areas: visible: true class: com.example.templates.CustomTemplateDefinition modelClass: com.example.templates.HomePageModel
| Node name | Value |
|---|---|
| com.example.templates.CustomTemplateDefinition | |
| my-module:pages/homePageProperties | |
| com.example.templates.HomePageModel | |
| freemarker | |
| /my-module/templates/pages/home.ftl | |
| true |
Properties specific to page template definition:
| optional, default is
When |
type | optional, default is Assigns a type to the template. Types control template availability in the page hierarchy. For example type This property is different from the |
subType | optional Assigns a subtype to the template. You can use subtypes to aggregate content. For example, aggregate all content pages of subtype |
autoPopulateFromRequest | optional, default is The population of request parameters is typically enabled globally in |
areas | optional |
Location of page definitions
Put your page definitions here:
- YAML file:
$magnolia.resources.dir/<module-name>/templates/pages - JCR node:
/modules/<module-name>/templates/pages
Page subtypes
The optional subType property is useful for aggregating related page templates. For example, you could use this property to aggregate the latest news articles and then create a component that displays a list of excerpts that point to the news pages.
There are no default values and you can use arbitrary values to categorize your templates in any way you like.
Adding page areas
Page area definitions are added in the areas node of a page template.
How to configure area definitions is covered in Area definition.
This example configuration adds two areas to a page template.
<module name>/templates/pages/<page template name>.yaml
areas:
area-1:
# area-1 configuration
area-2:
#area-2 configuration
| Node name | Value |
|---|---|
| <area-1 configuration> | |
| <area-2 configuration> |
Overview
Content Tools