[MGNLFE-184] DOCS: Indicate which templating features are available with SPA and Freemarker Created: 29/Mar/22  Updated: 25/Apr/23  Resolved: 25/May/22

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

Type: Improvement Priority: Major
Reporter: Christopher Zimmermann Assignee: Martin Drápela
Resolution: Done Votes: 0
Labels: None
Σ Remaining Estimate: Not Specified Remaining Estimate: Not Specified
Σ Time Spent: Not Specified Time Spent: Not Specified
Σ Original Estimate: Not Specified Original Estimate: Not Specified

Issue Links:
Relates
relates to MGNLFE-160 DOCS: Review and overhaul SPA editor ... Selected
relates to MGNLFE-185 DOCS: Indicate which features are not... Closed
Sub-Tasks:
Key
Summary
Type
Status
Assignee
MGNLFE-198 DOCSub: Indicate which templating fea... Sub-task Closed Martin Drápela  
MGNLFE-199 Confirm the SPA-relevance of some Mag... Sub-task Completed Robert Šiška  
Template:
Acceptance criteria:
Empty
Task DoD:
[X]* Doc/release notes changes? Comment present?
[X]* Downstream builds green?
[X]* Solution information and context easily available?
[X]* Tests
[X]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Epic Link: SPA Editor Backlog
Sprint: DevX 10
Story Points: 3
Team: DeveloperX

 Description   

As a developer I want to know which Magnoila templating features I can use if I am doing a Visual SPA project, in comparison to a Freemarker project.

Several features are not availaable on SPA.

This should be clearly indicated in our documentation.

Ideally we would want to not show this in too negative a light.

TBD:

How to indicate?

  • Flag each feature that is not available on SPA?
  • Or next to every feaature include a "Freemarker" and "SPA" badge as appropriate?

Could break ticket into smaaller tickets in order to make progress faster.

Docs to change

https://docs.magnolia-cms.com/product-docs/6.2/Templating/Template-definition/Area-definition/Component-inheritance.html

Not available on SPA

https://docs.magnolia-cms.com/product-docs/6.2/Templating/Template-definition/Area-definition/Component-autogeneration.html

Not available on SPA

https://docs.magnolia-cms.com/product-docs/6.2/Templating/Template-definition.html

"modelClass" - is not relevant for SPA.

"baseUrl" - not relevant for Freemarker

"routeTemplate" - not relevant for Freemarker

Custom template properties - not relevant for SPA.

https://docs.magnolia-cms.com/product-docs/6.2/Templating/Template-definition/Area-definition.html

"optional" - not available on SPA

"createAreaNode" - Confirm if it is relevant to SPA.

"autoGeneration" - not available on SPA

"inheritance" - not available on SPA

fragmentDefinition - Confirm if it is relevant to SPA.

"type" - Confirm what is available on SPA - "single", "list", "noComponent"

https://docs.magnolia-cms.com/product-docs/6.2/Templating/Template-definition/Component-definition.html

"deletable" - Confirm if it is relevant to SPA.

"fragmentDefinirtion" - Confirm if it is relevant to SPA.

"moveable" - Confirm if it is relevant to SPA.

"personalizable" - Confirm if it is relevant to SPA.

"writeable" - Confirm if it is relevant to SPA.

https://docs.magnolia-cms.com/product-docs/6.2/Templating/Template-scripts.html

Not relevant on SPA

https://docs.magnolia-cms.com/product-docs/6.2/Templating/Template-scripts/Directives.html

Not relevant on SPA

https://docs.magnolia-cms.com/product-docs/6.2/Templating/Template-scripts/Templating-functions.html

And all subpaages...

Not relevant on SPA

https://docs.magnolia-cms.com/product-docs/6.2/Templating/Template-scripts/Rendering-context-objects.html

Not relevant on SPA

https://docs.magnolia-cms.com/product-docs/6.2/Templating/Template-scripts/How-to-work-with-images.html

Not relevant on SPA

https://docs.magnolia-cms.com/product-docs/6.2/Templating/Template-scripts/How-to-work-with-images/How-to-work-with-images-using-damfn.html

Not relevant on SPA - Except for defining image variaations on the theme.

https://docs.magnolia-cms.com/product-docs/6.2/Templating/Template-scripts/How-to-work-with-images/How-to-work-with-images-using-imgfn.html

Not relevant on SPA

https://docs.magnolia-cms.com/product-docs/6.2/Templating/Rendering-content.html

Not relevant on SPA

https://docs.magnolia-cms.com/product-docs/6.2/Templating/Theme.html

"cssFiles" - is not relevant for SPA.

"jsFiles" - is not relevant for SPA.

"Using theme resources in template scripts" - is not relevant for SPA.

https://docs.magnolia-cms.com/product-docs/6.2/Templating/Templates-in-MTK.html

Not relevant on SPA

 

 

 

 


Generated at Mon Feb 12 05:45:03 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.