[MGNLCT-97] References to other CT should use the word 'reference' instead of 'ct' Created: 05/Feb/19  Updated: 12/Feb/19  Resolved: 12/Feb/19

Status: Closed
Project: Content Types
Component/s: None
Affects Version/s: 1.0
Fix Version/s: 1.1

Type: Task Priority: Major
Reporter: Christopher Zimmermann Assignee: Unassigned
Resolution: Outdated Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
dependency
depends upon MGNLCT-59 References to other CT should be expl... Closed
is depended upon by MGNLCT-95 DOC: References to other content type... Closed
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Release notes required:
Yes
Documentation update required:
Yes
Epic Link: Content Types finalization

 Description   

Reference properties in a Content Type model should  use the syntax:

type: reference:TourGuide

instead of 

type: ct:TourGuide

as it is currently implemented.

 

Reasoning:

The intention of this ticket is to make the content model very clear to developers. The important thing is that a developer (and other stake holders in the project) should know when a field is a reference, as this will impact the UI, the templating, configuring REST endpoints and working with REST responses.

The word "reference" is a good choice for this as it is easy to read, it is plain english, and it is consistant with how most CMS call reference fields. (Please see the table at the top of this page: https://wiki.magnolia-cms.com/display/TH2/Competitor+Research+-+Content+types )  

I appreciate the reasoning mentioned in the review session that 'ct' is much shorter than 'reference': We do strive to make a compact content type definition. But in this case I think the benefit of a shorter syntax is outweighed by readability, ease of comprehension, and familiarity.



 Comments   
Comment by Christopher Zimmermann [ 12/Feb/19 ]

We will handle this in the original ticket.

Generated at Mon Feb 12 00:37:07 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.