[DOCU-1900] Improve the "Definition decoration" docu Created: 16/Apr/19  Updated: 31/May/19  Resolved: 16/May/19

Status: Closed
Project: Documentation
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Neutral
Reporter: Christoph Meier Assignee: Christoph Meier
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:
Sprint: Docu Sprint 74, Docu Sprint 75, Docu Sprint 76
Story Points: 2

 Description   

The Definition decoration docu page is partially incomplete or not 100% clearly understandable (imho) ... and yes, I know, I have written the original version, hence my fault.

Tasks

Explain, how a decorator file is

  • merging the original with the decorator
  • completely overridding (parts of) the original by using the !override tag

Example(s)

override:

datasource: !override
  class: info.magnolia.ui.datasource.jcr.JcrDatasourceDefinition
  workspace: contacts
  includeProperties: true
  previewDefinition:
    nodeName: photo
  allowedNodeTypes:
  - mgnl:contact
  - mgnl:folder
  - mgnl:content
  - mgnl:contentNode

 

merge:

datasource: !override
  class: info.magnolia.ui.datasource.jcr.JcrDatasourceDefinition
  allowedNodeTypes:
  - mgnl:contentNode

 

 



 Comments   
Comment by Christoph Meier [ 16/May/19 ]

Summary of the changes:

  • Added the new section Decorate for merging or for overriding
  • Refined the example Changing the cssFiles property the mtk page template basic
  • Updated all screenshots (Using the Magnolia-6.0.1-SNAPSHOT)
  • Removed the very last section ("Overriding properties and changing subitems") -which now seems obsolete after having explained the how one can decorate without !override ("merging") or by using !override

All done on DOCS61 - https://documentation.magnolia-cms.com/display/DOCS61/Definition+decoration

!override has been introduced with M.-5.5.6, see http://tinyurl.com/y2szdx84.
Let us backport it to to DOCS60, DOCS57 and DOCS56.
(DOCS57,56 backport needs bit of extra-work to create screenshots (for the refined example).)

 

Comment by Christoph Meier [ 16/May/19 ]

Sasha has reviewed it already.

Comment by Julie Legendre [ 24/May/19 ]

To do: backport it to DOCS60, DOCS57 and DOCS56.

Comment by Ashraf Khamis [ 28/May/19 ]

cmeier, lang. reviewed

Comment by Christoph Meier [ 31/May/19 ]

Backported to:

  • DOCS60
  • DOCS57
  • DOCS56
Generated at Mon Feb 12 01:22:17 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.