How are Design Cell Ids built?


How are the Cell Ids (and with that the structure in the design tree) built in CQ5?

Answer, Resolution

The Cell Id is always created from the path the component is included with.
For example the Cell Id of a component /apps/myApp/components/myComponent included by <cq:include path="myPath" resourceType="myApp/components/myComponent" /> i.e. in your pagecomponent is myPath.
Also the name of the Node created in the design tree is myPath.

There are two exceptions:

  • toplevel components (page components): These components are not included by <cq:include> and represent the start of the component includes
  • components in a paragraph system: For components in a paragraph system we don't want a design for every own paragraph (path) but for every component itself (type of paragraph).

For these two exceptions the component label (in our example myComponent) is used as the Cell Id.
If the property cq:cellName in the component definition is set, the value of this property is taken as Cell Id.

Therefor with this property cq:cellName you can enforce separate Cell Ids for different components with the same label (i.e in a paragraph system).
It's also possible to enforce the same Cell Id for components with different labels, for example if you want to use the same design for your homepage- and contentpage-component.

Note: For CQ 5.2 the property cq:cellName is only respected for non toplevel components. This is fixed in CQ 5.2.1

Applies to