Magnolia allows to reuse configuration items with JCR and with YAML.
include mechanism in YAML files
Instead of adding a list item or a value of a map entry you can include a file.
Use the Magnolia
!include directive to add a reusable YAML chunk. Include a fragment on a sub-level of your definition. Reference the file you include by its resource path starting with
!include directive is Magnolia specific. The
! is a special character in YAML for a non-specific tag, see http://www.yaml.org/refcard.html.
If you have created the includable fragment after the creation of the file which includes it, save the latter again to force the YAML parser to properly register the definition.
/<module-name>/includes is the recommended directory for YAML fragment files. Avoid adding the YAML fragment files into the following directories:
With Magnolia 5.5.6+, the
!include directive has been extended to provide more functionalities. (See YAML inherit and include).
extends mechanism in JCR node based configuration
You can extend a configuration by defining an
extends property and setting its value to the source configuration you want it to inherit. The target configuration inherits everything from the source and adds its own exceptions. This can save time and effort as you only need to define exceptions explicitly. The mechanism is only available in the
config repository. In the example below, the
sportstation site definition extends the
The definition inherits all configuration from the
default configuration and adds its own domains, internationalization and URI-to-repository mappings. The
extends property can point to the source configuration with an absolute or relative path.
Example: Generic tabs in dialogs
You can use Magnolia's extends mechanism to minimize configuration. For example, if you have a number of components that include an image, you can configure a generic image tab and use it by extension in all relevant dialogs.
This example configuration shows the use of a generic
imageTab in a
Path to the configuration that is extended.
Example: Extending JCR node based template definitions
You can configure one template in full and create as many extensions with slight differences as you like. Theis used to minimize configuration. Only changes, exceptions and additions are configured in the extended configuration. All other configurations are taken from the original configuration.
extends property has two possible values:
</path to extended template>: Used to reference the template that is extended.
override: Used to override a portion or part of the configuration that is extended.
In the example below
page-template-1. The extended template uses the full configuration of the template it extends except the configurations in the extended template.