There are several advanced services related to the rendering of content fragments. To use these services, the resource types of such components must make themselves known to the content fragments framework.
This is done by configuring the OSGi Service - Content Fragment Component Configuration.
If you do not need the advanced services described below, you can ignore this configuration.
When you are extending or using the out-of-the-box component(s), it is not recommended to change the configuration.
You can write a component from scratch that uses the Content Fragments API only, with no advanced services. However, in such a case, you will have to develop your component so that it handles the appropriate processing.
Therefore, it is recommended to use the core components.
The services that require the registration of a component are:
If you need one or more of these features, then (typically) it is easier to use the out-of-the-box functionality, instead of developing it from scratch.
The configuration needs to be bound to the OSGi service Content Fragment Component Configuration:
See Configuring OSGi for further details.
The OSGi configuration is:
||The resource type to register; e.g.
||The name of the property that contains the reference to the fragment; e.g.
||The name of the property that contains the name(s) of the element(s) to render; e.g.
||The name of the property that contains the name of the variation to render; e.g.
For some functionality (e.g. to render only a paragraph range) you will have to adhere to some conventions:
A string property that defines the range of paragraphs to be output if in single element render mode.
A string property that defines how paragraphs are to be output if in single element render mode.
||A boolean property that defines if headings (for example,
This may change in later 6.5 milestones.
As an example, see the following (on an out-of-the-box AEM instance):
dam.cfm.component.resourceType="core/wcm/components/contentfragment/v1/contentfragment" dam.cfm.component.fileReferenceProp="fragmentPath" dam.cfm.component.elementsProp="elementName" dam.cfm.component.variationProp="variationName"