# Content Inheritance¶

Crafter CMS support content inheritance out of the box, and supports it via a pluggable mechanism that allows developers to augment or override what’s out of the box.

## Content Inheritance Basics¶

Content objects in Crafter CMS are essentially structured markup, XML by default, and house data authored via Crafter Studio by content authors. Content objects are typically structured as a tree which naturally suits the notion of inheriting from a parent (not to say that the inheritance mechanics are limited to that topology). Inheritance works as follows:

Assume we have two objects, one called Parent and one called Child and they’re set up as follows:

Parent: Below you’ll see a typical level descriptor which will be the parent of another object. You’ll note the level descriptor defines multiple elements that are common to everything at this level in the hierarchy and below it. This level descriptor defines a primary CSS file main.css, a common header component default-header.xml and a common footer component default-footer.xml.

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37  /component/level-descriptor inherit-levels 4123 41d1c0c5-bfc9-8fe8-2461-dc57a82b6cab crafter-level-descriptor.level.xml /static-assets/css/main.css /static-assets/css/main.css css 2/7/2016 19:40:03 10/8/2016 19:58:30 /site/components/components/header/default-header.xml Default Header /site/components/components/header/default-header.xml false /site/components/components/footer/default-footer.xml Default Footer /site/components/components/footer/default-footer.xml false 10/8/2016 19:58:30 

Child: Below is the XML file of a page residing under the above level descriptor and is setup to inherit from it. You’ll note the definition of the merge-strategy as inherit-levels, this invokes the level-based inheritance mechanics that require Crafter CMS to look at current and higher levels for files named crafter-level-descriptor.level.xml (this is configurable). You’ll also note that this page doesn’t specify the CSS file/group of files to include, nor will it need to specify the header nor footer components.

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23  /page/one-col-parallax /templates/web/pages/one-col-parallax.ftl inherit-levels 9cef 001f0955-6da3-8b7a-4e6b-6b373139d0ba index.xml child-page Child CHILD Child Page no-overlap true 12000 This is the Child page. false 7/31/2016 16:52:39 8/1/2016 18:55:09

Hello World



Crafter CMS will invoke the inheritance mechanics implemented in the merge strategy inherit-levels to merge the page and the level descriptor and the merge strategy will pull in the elements defined in the level descriptor into the child page before handing the new model (XML) to the rendering system. This means that when the page renders, the model will automatically contain the meta-data defined in the parent level descriptor. In our example above, the page will automatically inherit the meta-data fields cssGroup, defaultHeader, and defaultFooter.

Note

When an element is defined by the level descriptor and then subsequently defined by a child, the child’s definition overrides the level descriptor.

This mechanism allows you to define meta-data that flows down the information architecture of the site such that an entire site can have defaults and those defaults can be overwritten by sections individual page. Some examples of real-life use of inheritance:

• Site logo
• Global stylesheet and JS includes
• Section meta-data (flows to all pages/subsections)

Note

The inherit-levels mechanism allows you to set level descriptors at various levels of the information architecture with lower levels overriding upper levels.

What we discussed thus far is a single inheritance strategy implementation, inherit-levels, the code to which is available here: InheritLevelsMergeStrategy.java. There are more inheritance strategies implemented out of the box with Crafter CMS and you can build your own to suit your needs.

## Out of the Box Strategies¶

Strategy
Description
single-file
No content should be inherited.
inherit-levels

Content from Crafter level descriptors (crafter-level-descriptor.xml)
in the current and upper levels should be inherited.
explicit-parent

The parent descriptor to inherit is specified explicitly in the XML
tag parent-descriptor.
targeted-content

The page will be merged with other pages in a targeted content
hierarchy, including level descriptors. For example,
/en_US/about-us will generate the following merging list:
/en_US/about-us/index.xml,
/en_US/about-us/crafter-level-descriptor.xml,
/en/about-us/index.xml,
/en/about-us/crafter-level-descriptor.xml,
/about-us/index.xml, /about-us/crafter-level-descriptor.xml,
/crafter-level-descriptor.xml.

Todo