...
visible
| optional , default is true true makes the template available to editors.
When visible is set to false , the template is not available. However, the opposite is not always true. There are more ways to control page template availability. |
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.
...
Advanced Tables - Table Plus |
---|
heading | 0 |
---|
multiple | false |
---|
enableHeadingAttributes | false |
---|
enableSorting | false |
---|
class | m5-configuration-tree |
---|
enableHighlighting | false |
---|
|
Node name | Value |
---|
| |
| |
| |
| |
| | |
| | travel-demo:pages/home | |
| | travel-demo:pages/standard |
|
...
Advanced Tables - Table Plus |
---|
heading | 0 |
---|
multiple | false |
---|
enableHeadingAttributes | false |
---|
enableSorting | false |
---|
class | m5-configuration-tree |
---|
enableHighlighting | false |
---|
|
|
Option 3: Make templates available by RenderType
...
Advanced Tables - Table Plus |
---|
heading | 0 |
---|
multiple | false |
---|
enableHeadingAttributes | false |
---|
enableSorting | false |
---|
class | m5-configuration-tree |
---|
enableHighlighting | false |
---|
|
Node name | Value |
---|
|
| | |
| |
| | |
| | |
| | freemarker | | jsp | |
...
Advanced Tables - Table Plus |
---|
heading | 0 |
---|
multiple | false |
---|
enableHeadingAttributes | false |
---|
enableSorting | false |
---|
class | m5-configuration-tree |
---|
enableHighlighting | false |
---|
|
Node name | Value |
---|
| |
| |
| | |
| |
| | |
| | |
| | superuser | | travel-demo:pages/home | | |
| | |
| | superuser | | editor | | travel-demo:pages/standard |
|
...
Localtab Group |
---|
Localtab |
---|
| Code Block |
---|
language | js |
---|
title | example/templates/pages/home.yaml |
---|
| 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 |
|
Localtab |
---|
| Advanced Tables - Table Plus |
---|
heading | 0 |
---|
multiple | false |
---|
enableHeadingAttributes | false |
---|
enableSorting | false |
---|
class | m5-configuration-tree |
---|
enableHighlighting | false |
---|
| Node name | Value |
---|
|
| | |
| |
| |
| |
| | com.example.templates.CustomTemplateDefinition | | my-module:pages/homePageProperties | | com.example.templates.HomePageModel | | freemarker | | /my-module/templates/pages/home.ftl | | home | | true |
|
|
|
...
Advanced Tables - Table Plus |
---|
heading | 0 |
---|
multiple | false |
---|
enableHeadingAttributes | false |
---|
enableSorting | false |
---|
class | m5-configuration-tree |
---|
enableHighlighting | false |
---|
|
Node name | Value |
---|
| |
| | |
| | com.example.myModule.site.CustomTemplateAvailability |
|
...
Localtab Group |
---|
Localtab |
---|
active | true |
---|
title | YAML file (fragment) |
---|
| Code Block |
---|
| areas:
myArea:
availableComponents:
textImage:
id: my-module:components/textImage
html:
id: my-module:components/HTML
roles:
- superuser
# could also be written as
# roles: [superuser] |
|
Localtab |
---|
| Advanced Tables - Table Plus |
---|
heading | 0 |
---|
multiple | false |
---|
enableHeadingAttributes | false |
---|
enableSorting | false |
---|
class | m5-configuration-tree |
---|
enableHighlighting | false |
---|
| Node name | Value |
---|
|
| |
| | |
| |
| | |
| | my-module:components/textImage | |
| |
| | superuser | | my-module:components/HTML |
|
|
|
...
Localtab Group |
---|
Localtab |
---|
active | true |
---|
title | YAML file (fragment) |
---|
| Code Block |
---|
| areas:
myArea:
availableComponents:
maxComponents: 5
renderType: freemarker
type: list |
|
Localtab |
---|
| Advanced Tables - Table Plus |
---|
heading | 0 |
---|
multiple | false |
---|
enableHeadingAttributes | false |
---|
enableSorting | false |
---|
class | m5-configuration-tree |
---|
enableHighlighting | false |
---|
| Node name | Value |
---|
|
| |
| |
| | 5 | | freemarker | | list | |
|
|
...
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 moveable
and personalizable
(EE Pro) properties. By default, all components can be deleted, edited, moved, and personalized but you can change this behavior by setting these properties to false
.
Localtab Group |
---|
Localtab |
---|
active | true |
---|
title | YAML file (fragment) |
---|
| Code Block |
---|
language | js |
---|
title | my-module/templates/components/html.yaml |
---|
| renderTypedeletable: falsefreemarker
writable: false
moveable: false
personalizable: falsetemplateScript: /my-module/components/html.ftl
dialog: my-module:components/html
renderType
deletable: false
writable: false
moveable: freemarkerfalse
templateScriptpersonalizable: /my-module/components/html.ftlfalse |
|
Localtab |
---|
| Advanced Tables - Table Plus |
---|
heading | 0 |
---|
multiple | false |
---|
enableHeadingAttributes | false |
---|
enableSorting | false |
---|
class | m5-configuration-tree |
---|
enableHighlighting | false |
---|
| Node name | Value |
---|
| |
| | false | | false | | false | | false | | my-module:components/html | | freemarker | | /my-module/components/html.ftl | |
|
|
...
Localtab Group |
---|
Localtab |
---|
active | true |
---|
title | YAML file (fragment) |
---|
| Code Block |
---|
| 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] |
|
Localtab |
---|
| Advanced Tables - Table Plus |
---|
heading | 0 |
---|
multiple | false |
---|
enableHeadingAttributes | false |
---|
enableSorting | false |
---|
class | m5-configuration-tree |
---|
enableHighlighting | false |
---|
| Node name | Value |
---|
| |
| | |
| | |
| |
| |
| | |
| | |
| | editors | | superuser | | |
| |
| | senior-editors | | superuser | |
| | senior-editors | | superuser | | |
| |
| | senior-editors | | superuser | | my-module:components/myComponent | |
|
|
...
permissions | optional Required parent item that contains the action restrictions. |
<write|move|delete|personalize>
| optional Action to which the restriction applies. ( personalize is available only in Magnolia 5.4.9+ EE Pro) |
roles
| required Note that roles must be added as list in the YAML file. (See YAML-Lists). |
<roleName>
| required identifies Identifies the role. The name of the attribute is arbitrary but the value must match an existing role |