Design .content.xml node writing guidelines for components (Sling ressource type path)? | Community
Skip to main content
Eduard_Seifert
Eduard_Seifert
October 16, 2015
Solved

Design .content.xml node writing guidelines for components (Sling ressource type path)?

  • October 16, 2015
  • 1 reply
  • 1220 views

Hi @all,

sorry, for rusty english. I'll do my best ;).

Given example: a node from the designs .content.xml:

<stage jcr:primaryType="nt:unstructured" sling:resourceType="ORG/components/stage" dontUseTargetValues="true" hideTargetValuesPolicy="[jcr:description]" stage.renderMode="general"> <par jcr:primaryType="nt:unstructured" sling:resourceType="foundation/components/parsys" components="[/apps/ORG/components/image,/apps/ORG/components/teaser,/apps/ORG/components/text/textimage]"> </par> </stage>

If the components increase (in combintaion with the Sling ressource type path), the readability of this line will decrease. This will become very difficult and hard to maintain. Is it allowed to write those "components" lines like this?

<stage jcr:primaryType="nt:unstructured" sling:resourceType="ORG/components/stage" dontUseTargetValues="true" hideTargetValuesPolicy="[jcr:description]" stage.renderMode="general"> <par jcr:primaryType="nt:unstructured" sling:resourceType="foundation/components/parsys" components="[ /apps/ORG/components/image, /apps/ORG/components/teaser, /apps/ORG/components/text/textimage ... etc. ]"> </par> </stage>

Is AEM/CRX able to interpret those lines correctly? Is this a valid way to write this XML node entry?

Thanks for your help and any suggestions.

Eddie (Greetings from germany)

This post is no longer active and is closed to new replies. Need help? Start a new post to ask your question.
Best answer by

Go ahead and try it, but my guess is that it will not work. I know if you put a space between the comma delimited list items, it will not work. And, unfortunately the almost silent failure is that the property just simply isn't set in CRX. You'll need to pay close attention to whether your XML file was appropriately deployed as nodes/properties.

Are you aware of component groups? The best practice is to place your components in groups, then specify which groups are allowed in the design. That allows you to keep things much simpler and you don't have to add components to the design every time (as long as they are in the group).

On the component definition itself set the property "componentGroup" to whatever value...typically one group that corresponds with the name of your site/organization is enough. Then in the "components" property on your paragraph system node in the design configuration, instead of using a path to a component, specify "group:MyGroup". Then all components in that group will be allowed, per the design.

Note, I've also had issues with line delimiting the XML namespace declarations for a .content.xml file. When I do that it will deploy an nt:file node called .content.xml instead of translating them to JCR nodes.

You may want to double check my syntax - it's off the top of my head - but component groups should help you clean things up.

1 reply

A
Anonymous
Accepted solution
October 16, 2015

Go ahead and try it, but my guess is that it will not work. I know if you put a space between the comma delimited list items, it will not work. And, unfortunately the almost silent failure is that the property just simply isn't set in CRX. You'll need to pay close attention to whether your XML file was appropriately deployed as nodes/properties.

Are you aware of component groups? The best practice is to place your components in groups, then specify which groups are allowed in the design. That allows you to keep things much simpler and you don't have to add components to the design every time (as long as they are in the group).

On the component definition itself set the property "componentGroup" to whatever value...typically one group that corresponds with the name of your site/organization is enough. Then in the "components" property on your paragraph system node in the design configuration, instead of using a path to a component, specify "group:MyGroup". Then all components in that group will be allowed, per the design.

Note, I've also had issues with line delimiting the XML namespace declarations for a .content.xml file. When I do that it will deploy an nt:file node called .content.xml instead of translating them to JCR nodes.

You may want to double check my syntax - it's off the top of my head - but component groups should help you clean things up.

Terms & ConditionsAccessibility statement

Loading footer...