Template availability

Template availability defines which templates editors can use to create pages and components. Available page templates are displayed in a dropdown list in the Pages app. Available component templates are listed in the page editor when adding a component inside an area.

Example: The template dropdown in the Pages app shows available templates

Page template availability

Page template availability is controlled on several levels:

• visible property in a page definition.
• availability node in a site definition
  • to configure the availability per site 
  • configuring role based availability per template (per site).
  • Using page template definition property type 

Availability by page definition

The template availability can be set on page template definition with the visible property.

Availability by site

The availability node in a site definition allows you to make templates available per site. This means, an editor working on site X can only choose templates that are available on site X. As a use case, a small campaign site may only have one available template whereas your main site has many templates.

Use the Site app to configure template availability by site.

Option 1: Define page templates explicitly

You may define page templates explicitly under the availability/templates node in your site definition. Add the child nodes as shown in the example below, where the home and standard templates are made available on the travel site:

Properties:

Option 2: Make all templates available

 From Magnolia 5.4.7, make all templates available by adding the enableAll property to the availability node in your site definition and set the property to true:

Option 3: Make templates available by RenderType

 From Magnolia 5.4.7, by adding the enableAllWithRenderType node to the availability node the templates can be made available by RenderType. In the example below, the templates rendered by freemarker and jsp are made available on the travel site:

Configure template availability under the availability node in the site definition:

• Community Edition and Enterprise Edition Standard:
  • /modules/<my-module>/config/<site-definition>/templates/availability when you want to store the site definition in your own module.
  • /modules/site/config/site/templates/availability when you want to store the site definition in the Site module.
• Enterprise Edition Pro:
  • /modules/multisite/config/sites/<site-definition>/templates/availability when you have multiple sites and use the Multisite module.

Availability by role

The roles node in a site definition allows you to make templates available to users who have a specific role. The roles themselves are managed in the Security app. Reference them by name from the site definition.

Use the Site app to configure template availability by role.

Example: Only users in the superuser role have a permission to create home pages. Users with superuser or editor roles can create pages based on the standard template.

Properties:

Availability by type

The optional type property in a page definition allows you to make templates available per page type. Common page types are home, section and article. Types allow you to control where in the page tree a template can be used. If a template type is not allowed in a given place in the tree, it will not be available to editors.

To limit template availability by type you need to:

1. Add a type property to your page definitions.
2. Implement a custom TemplateAvailability class that reacts to the types.
3. Configure the custom TemplateAvailability class in the site definition. 

Adding a type property

Example: Type home in a page definition

renderType: freemarker
templateScript: /my-module/templates/pages/home.ftl
dialog: my-module:pages/homePageProperties
# areas:
visible: true
type: home
class: com.example.templates.CustomTemplateDefinition
modelClass: com.example.templates.HomePageModel

Properties:

Implementing a template availability class

Implement and configure your own TemplateAvailability class that reacts to the defined types. Write your own implementation of the info.magnolia.rendering.template.TemplateAvailability interface (source). You may want to subclass info.magnolia.module.site.templates.ConfiguredSiteTemplateAvailability (source).

You can find inspiration in info.magnolia.module.templatingkit.sites.TemplateAvailability#isAvailable (source). Templates of type home can only be used on the site root page. Templates of type content can only be used on a page that resides under a page whose template belongs to types section, feature or functional. 

Configuring a template availability class

Example: Configuring a TemplateAvailability class in the Site app.

Component template availability

The availability of a component is defined per area in an Area definition (and an area definition is always part of page template definition).

Restricting component availability in an area template

You can restrict access to components made available in an area template definition to users assigned a specific role.

In this example component textImage can be used by any editor, but only users assigned the superuser role in the Security app can create a HTML component. See Roles for more.

areas:
  myArea:
    availableComponents:
      textImage: 
        id: my-module:components/textImage
      html: 
        id: my-module:components/HTML
        roles:
          - superuser
        # could also be written as
        # roles: [superuser]

Where id is the Component definition ID in <module name>:<path to component definition> format. See Area properties for more.

Restricting the number of components in an area template

You can restrict the number of components that render in a list area by adding a maxComponents property. Once the limit is reached the New Component box is replaced with a Maximum Components Reached notification preventing editors from adding additional components.

areas:
  myArea:
    availableComponents:
      maxComponents: 5
      renderType: freemarker
      type: list

 Restricting component actions in a component template

 You can restrict the actions that editors can take on a component in the component definition using the deletable, writable, and moveable properties, and in Magnolia EE Pro also the personalizable property. By default, all components can be deleted, edited, moved, and personalized but you can change this behavior by setting these properties to false.

deletable: false
writable: false
moveable: false
personalizable: false
dialog: my-module:components/html
renderType: freemarker
templateScript: /my-module/components/html.ftl

 Restricting component actions in an area template

 You can define which roles can edit, move, delete, and in Magnolia EE Pro also personalize components in an area definition .

areas:
  myArea:
    availableComponents:
      myComponent:
        id: my-module:components/myComponent
        permissions:
          write:
            roles: [editors, superuser]
          move:
            roles: [senior-editor, superuser]
          delete:
            roles: [editors, superuser]
          personalize:
            roles: [senior-editor, superuser]

Nodes and properties:

permissions	Required parent item that contains the action restrictions.
<write|move|delete|personalize>	Action to which the restriction applies. ( personalize is available only in Magnolia 5.4.9+ EE Pro)
roles	Note that roles must be added as list in the YAML file. (See YAML-Lists).
<roleName>	identifies the role. The name of the attribute is arbitrary but the value must match an existing role