Magnolia 4.5 reached end of life on June 30, 2016. This branch is no longer supported, see End-of-life policy.
Page is the highest level template. Pages are the building blocks of the site hierarchy visible in AdminCentral. Each part of the site URL is also a page. For example, bikeshop.com/products/bicycles
would have at least three pages: a home page, a products
section page, and a bicycles
page. Pages consist of areas which can consist of further areas or components.
The STK contains a number page templates:
The Demo Project Home page is based on the stkhome
template and contains Stage, Teasers, Base and Promos areas.
When an editor adds a new component to an area, the available components are based on that area type:
Many Magnolia modules come with page templates. For example:
A page definition configures the properties of the page template. It is similar to the component definition ; both template types use the same template definition object:
ConfiguredTemplateDefinition
. In addition, pages and components reference their dialogs using the same path syntax and are rendered using the same renderer. You can find page definitions in the <module name>/templates/pages
folder in AdminCentral.
Property | Description | Valid values | Mandatory |
---|---|---|---|
| The |
| Yes |
| The | A valid Magnolia path. | Yes |
| The | The value has two parts. The first part before the colon (:) is the name of the module folder where the dialog definition resides. The second part is a relative path. Example: | No |
| Page description. Type a literal value or retrieve the value from a message bundle using a key. The message bundle is defined in the | No limitations. Conventional alphanumeric characters are recommended. Otherwise a properly defined key. | No |
| Message bundle used for the page. | Any properly defined message bundle. This value should match the message bundle set in the dialog definition. | No |
| Defines the concrete Java class to instantiate. For STK page templates the class is | Fully-qualified class name. This property needs to be in appropriate Magnolia class syntax. | No |
| A Java class that contains business logic for the page. The model class needs to implement the
RenderingModel
interface. The renderer creates a bean based on the | Fully-qualified class name. This property needs to be in appropriate Magnolia class syntax and specifically refer to the | No |
| Title of the page. You can type a literal value or retrieve the value from a message bundle using a key. The message bundle is defined in the | If typed, no limitations. Conventional alphanumeric characters are recommended. Otherwise a properly defined key. | No |
| The |
| No |
| Assigns the page to a category such as |
| No |
| Makes the page template available to editors. |
| No |
| Inherits the configuration from another page definition. See Extending configuration . | A valid Magnolia path. | No |
In the page definition skeleton below, mandatory properties are red while optional properties are black.
Read more about pages in the Introduction to templating tutorial.