[MGNLUI-5098] DOC: previewDefinition property of JcrDatasourceDefinition Created: 25/Mar/19  Updated: 31/May/19  Resolved: 31/May/19

Status: Closed
Project: Magnolia UI
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Neutral
Reporter: Christoph Meier Assignee: Ashraf Khamis
Resolution: Done Votes: 0
Labels: new-UI-framework
Remaining Estimate: 0d
Time Spent: 41m
Original Estimate: Not Specified

Issue Links:
Relates
relates to MGNLUI-4989 DOC: JcrDatasourceDefinition API Closed
dependency
depends upon MGNLUI-5060 New framework: move filtering logic f... Closed
depends upon MGNLUI-5116 previewDefinition in jcr data source ... Closed
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:
Epic Link: DOC: Documentation for Magnolia 6.1
Sprint: Foundation 10, Foundation 12
Story Points: 2

 Description   

Context

This is a follow-up of MGNLUI-4989

The previewDefinition can be seen as the successor of the Image provider definition.
It is defined as a property of the JCR data source definition.

The property previewDefinition currently must be of the type info.magnolia.ui.contentapp.preview.JcrPreviewDefinition.

Example 

of a JCR data source definition with a previewDefinition:

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

Depending on the size of the documentation for the preview definition,
we could add the previewDefinition part to the already existing page JCR data source definition or we create a distinct page (as we already have it for the Image provider definition).

For the properties table, see https://git.magnolia-cms.com/projects/PLATFORM/repos/ui/browse/magnolia-ui-framework-jcr/src/main/java/info/magnolia/ui/contentapp/preview/JcrPreviewDefinition.java.



 Comments   
Comment by Ashraf Khamis [ 31/May/19 ]

Content added to the existing JCR data source definition page (see https://documentation.magnolia-cms.com/display/DOCS61/JCR+data+source+definition#JCRdatasourcedefinition-Previewdefinition). Entire page reviewed by Roman.

Generated at Mon Feb 12 09:23:11 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.