Uploaded image for project: 'Magnolia Frontend Helpers'
  1. Magnolia Frontend Helpers
  2. MGNLFE-184

DOCS: Indicate which templating features are available with SPA and Freemarker

    XMLWordPrintable

Details

    • Improvement
    • Resolution: Done
    • Major
    • None
    • None
    • None
    • None
    • DevX 10
    • 3

    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

       

       

       

       

      Checklists

        Acceptance criteria

        Attachments

          Issue Links

            There are no Sub-Tasks for this issue.

            Activity

              People

                mdrapela Martin Drápela
                czimmermann Christopher Zimmermann
                DeveloperX
                Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved:

                  Checklists

                    Task DoD