Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCU-266

Update inheritable components article to 4.5

    XMLWordPrintable

Details

    • Task
    • Resolution: Unresolved
    • Neutral
    • None
    • None
    • content
    • None

    Description

      The way components are inherited changed in Magnolia CMS 4.5. While the idea is the same, configuration is done differently. Make the Inheritable components article to adhere to the new convention.

      Inheritance is now configured in the area definition, see for example Site Definitions > /default/templates/prototype/areas/promos.

      + <area name>
        + inheritance
          - components = <all|filtered|none>
          - enabled = <true|false>
      

      An area that has an inheritance content node can inherit its content from the parent. An enabled data node under it, when set to true, enables inheritance for components inside the area. The components data node defines which components are inherited:

      • all means that all the components from the parent area are inherited.
      • filtered means that only components whose inheritable property is set to true are inherited. The property is set with the "Show in subpage" checkbox.
      • none means that no components are inherited

      Validate the article against 4.5. At least the following sections need updating:

      • "Footer, metanavigation and section header" section has outdated text and screenshot of footer area in the prototype. The cms.includeTemplate directive is deprecated. An area loops through its components automatically now so the whole code snippet is irrelevant. The text says the template script ensures that inherited components are rendered without area bars. The script doesn't need to do this anymore. If the component is inherited (Show in subpage checkbox is checked = has inheritable property when viewed in JCR Browser) then the component doesn't get a toolbar. Simple as that.
      • "Automatic inheritance" section. Procedure is incorrect. Replace with a procedure for creating the inheritance configuration under the area definition and setting components to all.
      • "Optional inheritance" section. Exactly the same as "Automatic" except add the Show in subpage control in the component dialog and set components to filtered.

      Resources:

      Checklists

        Acceptance criteria

        Attachments

          Activity

            People

              ahietala Antti Hietala
              ahietala Antti Hietala
              Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

                Created:
                Updated:

                Checklists

                  Task DoR