[DOCU-1505] Area definition has no property "title" - but docu claims it has Created: 09/May/18  Updated: 19/Jul/18  Resolved: 17/Jul/18

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

Type: Story Priority: Neutral
Reporter: Christoph Meier Assignee: Martin Drápela
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Attachments: PNG File image-2018-07-17-15-35-01-148.png     Zip Archive test.zip    
Issue Links:
relation
is related to DOCU-1503 YAML area use "title" property, FTL/J... Closed
Template:
Acceptance criteria:
Empty
Date of First Response:
Sprint: Docu Sprint 54
Story Points: 1

 Description   

According to tomwespi - Area definition has no property "title" - but docu claims it has.

The property title is mentioned in https://documentation.magnolia-cms.com/display/DOCS56/Template+definition - to which we refer in https://documentation.magnolia-cms.com/display/DOCS56/Area+definition
And Tom says there is no such property.

However - according to code the property is there in the superclass info.magnolia.rendering.template.RenderableDefinition (see on git)

Maybe the property exists - but it is just not rendered in the dialog?

Tasks:

  • Test Toms claim with an example.
  • If Tom was right: Update the docs (DOCS57, 56, 55, 54 ... :^()

 



 Comments   
Comment by Martin Drápela [ 17/Jul/18 ]

The area DOES have the title property and indeed as our DOCS say, it is rendered in the "Area toolbar in the page editor."

(https://documentation.magnolia-cms.com/display/DOCS56/Template+definition)

See it set as

title: testPage
templateScript: /test/templates/pages/testPage.ftl
renderType: freemarker
dialog: test:pages/testPage
visible: true

areas:
  main:
    title: title-property-of-the-area
    availableComponents:
      form:
        id: test:components/form
 

in a page template called

/test/templates/pages/testPage.yaml

in a simple light module

test.zip

Rendered as follows:

 

Comment by Christoph Meier [ 17/Jul/18 ]

mdrapela - I confirm your findings. Hence, no reason to change the docs.

Comment by Christoph Meier [ 17/Jul/18 ]

tomwespi - since you were my "underlying reason" to create this ticket, would you please check too?

Did we check the "right thing"? If yes, would you agree with our findings?

Generated at Mon Feb 12 01:18:43 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.