Fragments de contenu – Configuration des composants pour le rendu

Il existe plusieurs services avancés liés au rendu des fragments de contenu. Pour l’utilisation de ces services, les types de ressources de ces composants doivent être connus de la structure de fragments de contenu.

Pour ce faire, définissez la Configuration du composant de fragment de contenu du service OSGi.

ATTENTION

Si vous n’avez pas besoin des services avancés décrits ci-dessous, vous pouvez ignorer cette configuration.

ATTENTION

Lorsque vous étendez ou utilisez les composants prêts à l’emploi, il n’est pas recommandé de modifier la configuration

ATTENTION

Vous pouvez créer de A à Z un composant n’utilisant que l’API de fragments de contenu, sans services avancés. Cependant, dans ce cas, vous devrez développer votre composant de sorte qu’il traite le traitement approprié.

Par conséquent, il est recommandé d’utiliser les composants de base.

Définition des services avancés nécessitant une configuration

Les services qui nécessitent l’enregistrement d’un composant sont les suivants :

Déterminer correctement les dépendances au cours de la publication (c.-à-d. s’assurer que les fragments et les modèles peuvent être publiés automatiquement avec une page s’ils ont été modifiés depuis la dernière publication).
Prise en charge des fragments de contenu dans la recherche de texte intégral.
Gestion/traitement du contenu intermédiaire.
Gestion/traitement des ressources multimédias mixtes.
Purge par le Dispatcher des fragments référencés (si une page contenant un fragment est republiée).
Utilisation du rendu basé sur les paragraphes.

Si vous avez besoin d’une ou de plusieurs de ces fonctionnalités, il est alors (généralement) plus facile d’utiliser la fonctionnalité prête à l’emploi, plutôt que de la développer à partir de rien.

Service OSGi – Configuration du composant de fragment de contenu

La configuration doit être liée à la Configuration du composant de fragment de contenu du service OSGi :

com.adobe.cq.dam.cfm.impl.component.ComponentConfigImpl

REMARQUE

Voir Configuration d’OSGi pour plus de détails.

Par exemple :

cfm-01

La configuration OSGi est la suivante :

Libellé	Configuration OSGi	Description
Type de ressource	`dam.cfm.component.resourceType`	Le type de ressource à enregistrer ; par exemple, `core/wcm/components/contentfragment/v1/contentfragment`
Propriété de référence	`dam.cfm.component.fileReferenceProp`	Nom de la propriété qui contient la référence au fragment ; par exemple, `fragmentPath` ou `fileReference`
Propriété d’élément(s)	`dam.cfm.component.elementsProp`	Nom de la propriété qui contient le ou les noms des éléments dont le rendu doit être effectué ; par exemple,`elementName`
Propriété de variation	`dam.cfm.component.variationProp`	Nom de la propriété qui contient le nom de la variation dont le rendu doit être effectué ; par exemple,`variationName`

Pour certaines fonctionnalités (par exemple pour n’afficher qu’une plage de paragraphes), vous devez respecter certaines conventions :

Nom de la propriété	Description
`paragraphRange`	Propriété de chaîne qui définit la plage de paragraphes à sortir en mode de rendu d’élément unique. Format : `1` ou `1-3` ou `1-3;6;7-8` ou `-3;5-` évalué uniquement si `paragraphScope` est défini sur `range`
`paragraphScope`	Propriété de chaîne qui définit le mode de sortie des paragraphes en mode de rendu d’élément unique. Valeurs : `all` : pour restituer tous les paragraphes `range` : pour restituer la plage de paragraphes fournie par `paragraphRange`
`paragraphHeadings`	Propriété booléenne qui définit si les en-têtes (par exemple, `h1`, `h2`, `h3`) sont comptés comme des paragraphes (`true`) ou non (`false`)

ATTENTION

Cela peut changer dans les étapes ultérieures de la version 6.5.

Exemple

À titre d’exemple, reportez-vous aux sections suivantes (sur une instance AEM prête à l’emploi) :

/apps/core/wcm/config/com.adobe.cq.dam.cfm.impl.component.ComponentConfigImpl-core-comp-v1.config

Contient :

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"