Page History
...
clear | both |
---|---|
width | 343px |
align | right |
class | menu |
This page describes the Magnolia-specific directives !inherit
, !include
and !override
. You can use these directives to reuse configuration in YAML file-based configuration. !include
is supposed to be used when reusing an arbitrary resource, whereas !inherit
comes handy when extending a definition.
Table of Contents maxLevel 4 minLevel 2
Anchor | ||||
---|---|---|---|---|
|
YAML include
UseUse !include
to add a reusable chunk. Include a YAML fragment on a sub-level of your new definition or include a complete YAML definition on top of your new definition. You can also modify the included part of the definition.
Reference the file you want to include by its resource path. The path to such a resource has the following pattern: /<module-name>/path/to/the/reusable/chunk.yaml
.
Bestpractice |
---|
Typically, you include YAML snippets which are not a proper definition. Do not add these snippets to the folders which are meant for definitions (templates, dialogs, app). Instead, add these snippets to a folder which is not scanned, for instance |
Tip |
---|
If your |
Anchor | ||||
---|---|---|---|---|
|
...
The !include
directive exists since Magnolia 5.4, which introduced configuration by YAML. With the release of 5.5.6, the directive's syntax has changed slightly. While the old syntax still works, the new one makes it possible to modify and override the included part of the definition. The new syntax uses a colon :
instead of the space
between !include
and the path to the resource.
Syntax | Requires version | Functions | |
---|---|---|---|
Deprecated syntax. | !include <path/to/a–ressource.yaml> | Magnolia 5.4+ | simple include |
New syntax. | !include:<path/to/a–ressource.yaml> | Magnolia 5.5.6+ | simple include, include and modify |
...
- Prepare a fragment of definition which is suitable to be reused in many other item definitions.
- Include a resource with the
!include
directive. The included resource can contain a fragment or a complete definition. - Modify parts of the included definition.
...
Includable files:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Code Pro | ||||||||
|
A dialog file which includes:
...
language | yaml |
---|---|
title | /module-a/dialogs/components/another-component.yaml |
linenumbers | true |
url | https://git.magnolia-cms.com/projects/DOCUMENTATION/repos/having-fun-with-yaml/raw/light-modules/module-a/dialogs/components/another-component.yaml?at=master |
name: tabCategories
label: Categories
fields:
- name: categories
label: Categories
class: info.magnolia.ui.form.field.definition.MultiValueFieldDefinition
label: Select category
field:
name: linkField
class: info.magnolia.ui.form.field.definition.LinkFieldDefinition
targetWorkspace: category
appName: categories
identifierToPathConverter:
class: info.magnolia.ui.form.field.converter.BaseIdentifierToPathConverter
- name: blackOrWhite
label: Black or white
class: info.magnolia.ui.form.field.definition.SelectFieldDefinition
options:
- name: black
value: black
selected: true
label: Black
- name: white
value: white
label: White |
Code Block | ||||
---|---|---|---|---|
| ||||
commit:
class: info.magnolia.ui.admincentral.dialog.action.SaveDialogActionDefinition
cancel:
class: info.magnolia.ui.admincentral.dialog.action.CancelDialogActionDefinition |
A dialog file which includes:
Code Block | |||||
---|---|---|---|---|---|
|
...
Include and modify a fragment
Include one tab in the form
and all the action definitions in the action
in a dialog definition. This is similar as in the example above. Additionally, modify the included parts of the definition.
This example works only with the new syntax (see syntactic variants).
Includable files:
Code Pro | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Code Pro | ||||||||
|
A dialog file which includes:
...
MultiExcerptName | YAML-include-example |
---|
...
language | yaml |
---|---|
title | /module-a/dialogs/components/lazy-component.yaml |
linenumbers | true |
url | https://git.magnolia-cms.com/projects/DOCUMENTATION/repos/having-fun-with-yaml/raw/light-modules/module-a/dialogs/components/lazy-component.yaml?at=master |
- Line 6: Modify the label of the included tab.
- Lines 9 and 10: Modify the label of the
blackOrWhite
field from the include. - Lines 14 to 16: Add another action to the imported actions.
form:
label: another-component
tabs:
- name: tabMain
label: Main
fields:
- name: title
label: Text
class: info.magnolia.ui.form.field.definition.TextFieldDefinition
label: Title
# an include within a list, here adding a complete tab
- !include:/module-a/includes/categorization-tab.yaml
# an include within a map, here adding the actions for the root (map) item "actions"
actions: !include:/module-a/includes/common-actions.yaml |
Anchor | ||||
---|---|---|---|---|
|
Include and modify a fragment
Include one tab in the form
and all the action definitions in the action
in a dialog definition. This is similar as in the example above. Additionally, modify the included parts of the definition.
This example works only with the new syntax (see syntactic variants).
Includable files:
Code Block | ||||
---|---|---|---|---|
| ||||
name: tabCategories
label: Categories
fields:
- name: categories
label: Categories
class: info.magnolia.ui.form.field.definition.MultiValueFieldDefinition
label: Select category
field:
name: linkField
class: info.magnolia.ui.form.field.definition.LinkFieldDefinition
targetWorkspace: category
appName: categories
identifierToPathConverter:
class: info.magnolia.ui.form.field.converter.BaseIdentifierToPathConverter
- name: blackOrWhite
label: Black or white
class: info.magnolia.ui.form.field.definition.SelectFieldDefinition
options:
- name: black
value: black
selected: true
label: Black
- name: white
value: white
label: White |
Code Block | ||||
---|---|---|---|---|
| ||||
commit:
class: info.magnolia.ui.admincentral.dialog.action.SaveDialogActionDefinition
cancel:
class: info.magnolia.ui.admincentral.dialog.action.CancelDialogActionDefinition |
A dialog file which includes:
Multiexcerpt | ||
---|---|---|
|
Include a complete file and modify
Create a dialog based on a dialog from the basic
page template of the mtk module. Remove its second tabMeta
tab. This task is similar to the example above in the modify section, but instead of inheriting, you include.
...
language | yaml |
---|---|
title | /module-a/dialogs/pages/aa-page.yaml |
linenumbers | true |
url | https://git.magnolia-cms.com/projects/DOCUMENTATION/repos/having-fun-with-yaml/raw/light-modules/module-a/dialogs/pages/aa-page.yaml?at=master |
...
YAML inherit
As the name suggests, with this directive you inherit from an existing registered definition item in order to create a new definition item. Registered items can originate from YAML files, JCR configurations or even from Blossom Java code.
Warning |
---|
It is not a good idea to inherit from a definition which resides in the same module as the dependent one. This can lead to inconsistencies. |
You can inherit only on the root level - which means you can inherit a complete app but not a subapp. Modify the new item according to your needs.
Registered definition items are known to a registry and can be seen in the Definitions app . Every registered definition item has an "identifier" which is unique among all items of the same type within their registry. Some of the items are defined by name, others by ID. Reference the item to inherit by its identifier.
Inherited items are inherited according to their state known by the registry. (For instance, if an items has been decorated, the registry knows its decorated state. Hence inheriting a decorated item inherits the decorated state of the item.)
...
title | Click here to expand for a list of definition item examples and their identifiers. |
---|
...
...
...
Module dependencies due to !inherit
When using !inherit
, you may rely on a definition item which is configured in another module. In this case you must take care of the loading order. If you rely on another module, make sure it is loaded upfront. Use module dependencies to define the loading order of the modules.
...
Module dependencies can be defined within a module descriptor.
A generic recipe
- On the first line of your YAML definition, use the
!inherit
directive followed by a colon (:
) and the identifier of the definition you want to inherit from. - Modify the inherited definition.
Examples
Inherit and override a renderer
A new definition:
...
MultiExcerptName | YAML-inherit-simpleExample |
---|
...
language | yaml |
---|---|
title | /module-a/renderers/json.yaml |
url | https://git.magnolia-cms.com/projects/DOCUMENTATION/repos/having-fun-with-yaml/raw/light-modules/module-a/renderers/json.yaml?at=master |
The new renderer named json
inherits everything from the freemarker
renderer but has a different contentType.
Inherit and override a template definition
The original definition you inherit from:
Code Pro | ||||||
---|---|---|---|---|---|---|
language | yaml | |||||
title | /module-a/templates/components/a-component.yaml |
|
| templates
| a
|
A new definition which inherits:
...
language | yaml |
---|---|
title | /module-b/templates/components/b-component.yaml |
linenumbers | true |
url | https://git.magnolia-cms.com/projects/DOCUMENTATION/repos/having-fun-with-yaml/raw/light-modules/module-b/templates/components/b-component.yaml?at=master |
- Line 1: Inherit.
- Line 2: Override the
title
property. - Lines 3 and 4: Add more properties.
- Line 5: Suppress the
parameters
property.
The module descriptor of module-b
...
language | yaml |
---|---|
title | /module-b/module.yaml |
url | https://git.magnolia-cms.com/projects/DOCUMENTATION/repos/having-fun-with-yaml/raw/light-modules/module-b/module.yaml?at=master |
By setting this dependency, we make sure that module-a
is loaded before module-b
. As a result, the b-component
, which depends on a-component
, can be initialized properly.
...
Modifying reused configuration
Reused configuration originating from !inherit
or from !include
(when using the new !include
syntax) can be modified. You can:
- Add additional properties and modify properties originating from
!include
or!inherit
. This will merge the included or inherited node with the modifications. - Use
!override
to completely ignore the properties of an inherited or included node. As a consequence, you have to add further properties to the given node.
YAML override
Info |
---|
The |
Example:
...
language | yaml |
---|---|
title | /module-a/templates/pages/l-page.yaml |
url | https://git.magnolia-cms.com/projects/DOCUMENTATION/repos/having-fun-with-yaml/raw/light-modules/module-a/templates/pages/l-page.yaml?at=master |
...
language | yaml |
---|---|
title | /module-a/templates/pages/xxl-page.yaml |
url | https://git.magnolia-cms.com/projects/DOCUMENTATION/repos/having-fun-with-yaml/raw/light-modules/module-a/templates/pages/xxl-page.yaml?at=master |
...
language | yaml |
---|---|
title | /module-a/templates/pages/xs-page.yaml |
url | https://git.magnolia-cms.com/projects/DOCUMENTATION/repos/having-fun-with-yaml/raw/light-modules/module-a/templates/pages/xs-page.yaml?at=master |
...
|
Include a complete file and modify
Create a dialog based on a dialog from the basic
page template of the mtk module. Remove its second tabMeta
tab. This task is similar to the example above in the modify section, but instead of inheriting, you include.
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
!include:/mtk/dialogs/pages/basic.yaml
form:
tabs:
- name: tabMeta
fields: !override |
Anchor | ||||
---|---|---|---|---|
|
YAML inherit
As the name suggests, with this directive you inherit from an existing registered definition item in order to create a new definition item. Registered items can originate from YAML files, JCR configurations or even from Blossom Java code.
Warning |
---|
It is not a good idea to inherit from a definition that resides in the same module as the dependent one. Module files are loaded in order of discovery, which however varies over time. This means that after one reload, a definition might work while the next time you edit the definition or restart your application, it may fail to discover an intra-modular dependency and hence load correctly. Due to this behavior, you should not create such dependencies as they are inherently – no pun intended – unstable. |
You can inherit only on the root level - which means you can inherit a complete app but not a subapp. Modify the new item according to your needs.
Registered definition items are known to a registry and can be seen in the Definitions app. Every registered definition item has an "identifier" which is unique among all items of the same type within their registry. Some of the items are defined by name, others by ID. Reference the item to inherit by its identifier.
Inherited items are inherited according to their state known by the registry. (For instance, if an items has been decorated, the registry knows its decorated state. Hence inheriting a decorated item inherits the decorated state of the item.)
Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
|
Module dependencies due to !inherit
When using !inherit
, you may rely on a definition item which is configured in another module. In this case you must take care of the loading order. If you rely on another module, make sure it is loaded upfront. Use module dependencies to define the loading order of the modules.
Include Page | ||||
---|---|---|---|---|
|
Module dependencies can be defined within a module descriptor.
A generic recipe
- On the first line of your YAML definition, use the
!inherit
directive followed by a colon (:
) and the identifier of the definition you want to inherit from. - Modify the inherited definition.
Examples
Inherit and override a renderer
A new definition:
Multiexcerpt | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
The new renderer named |
Inherit and override a template definition
The original definition you inherit from:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
title: a-component
renderType: freemarker
templateScript: /module-a/templates/components/a-component.ftl
dialog: module-a:components/a-component
modelClass: info.magnolia.module.jsmodels.rendering.JavascriptRenderingModel
parameters:
color: blue
size: 50 |
A new definition which inherits:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
!inherit:module-a:components/a-component
title: b-component
description: This is a b-bombastic component to test cool YAML features!
subtype: dummy-components
parameters: !override |
- Line 1: Inherit.
- Line 2: Override the
title
property. - Lines 3 and 4: Add more properties.
- Line 5: Suppress the
parameters
property.
The module descriptor of module-b
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
version: 1.0
dependencies:
module-a:
version: 1.0/* |
By setting this dependency, we make sure that module-a
is loaded before module-b
. As a result, the b-component
, which depends on a-component
, can be initialized properly.
Anchor | ||||
---|---|---|---|---|
|
Modifying reused configuration
Reused configuration originating from !inherit
or from !include
(when using the new !include
syntax) can be modified. You can:
- Add additional properties and modify properties originating from
!include
or!inherit
. This will merge the included or inherited node with the modifications. - Use
!override
to completely ignore the properties of an inherited or included node. As a consequence, you have to add further properties to the given node.
YAML override
Info |
---|
The |
Example:
A definition to inherit or to include | Inherit | Inherit and override | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
| |||||||||||||||||||||||||
The resulting definition merges the inherited defintion and the modifications area, giving five available components in the main area. | The resulting definition ignores all the properties of availableComponents of the inherited definition, thus allowing only one available component in the main area. |
Overriding list items
Tip |
---|
Due to the syntax of a YAML list, you cannot apply |
Example:
A definition to inherit or to include | Inherit | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Overriding list items
Tip |
---|
Due to the syntax of a YAML list, you cannot apply |
Example:
A definition to inherit or to include | Inherit | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
Both tabs and fields are defined with a list. To define these properties, it would have been valid to use the map syntax instead. | To apply !override to the tabMeta tab and the title field, we have used the map syntax here. |
...
(Magnolia 5.7.1+) The order of nodes as defined in a decoration via YAML !override
is is preserved. This is useful especially if the only change needed to the existing configuration of nodes is their order. Previously, when providing a new config with the !override
flag, the config would be picked up by the system, but any change in the order of the nodes (at the level of the !override
) would not be respected.
For example, the list view in the workbench of the Tours app may be adjusted with the following definition decoration placing the Path column column before the Name columncolumn:
Code Block | ||||
---|---|---|---|---|
| ||||
subApps: browser: workbench: contentViews: list: columns: !override path: name: |
...