Personnalisation et extensions de fragments de contenu

Dernière mise à jour : 2023-12-19

Un fragment de contenu étend une ressource standard, voir :

Architecture

Les éléments de base d’un fragment de contenu sont les suivants :

  • Un fragment de contenu,
  • comportant un ou plusieurs éléments de contenu,
  • et qui peut avoir une ou plusieurs variations de contenu.

Selon le type de fragment, des modèles sont également utilisés :

ATTENTION

Les modèles de fragment de contenu sont désormais recommandés pour créer tous les fragments.

Les modèles de fragment de contenu sont utilisés pour tous les exemples dans WKND.

REMARQUE

Avant la version 6.3 d’AEM, les fragments de contenu étaient créés à partir de modèles (templates) différents des modèles (models) actuels.

Les anciens modèles (templates) de fragment de contenu sont désormais obsolètes. Ils peuvent toujours être utilisés pour créer des fragments, mais il est recommandé d’utiliser à la place les nouveaux modèles de fragment de contenu. Aucune nouvelle fonctionnalité ne sera ajoutée aux modèles de fragment et elles seront supprimées dans une version ultérieure.

  • Modèles de fragment de contenu :

    • Utilisés pour définir des fragments de contenu qui contiennent du contenu structuré.
    • Les modèles de fragment de contenu définissent la structure d’un fragment de contenu lors de sa création.
    • Un fragment référençant le modèle, les modifications du modèle peuvent impacter tous les fragments dépendants.
    • Les modèles sont composés de types de données.
    • Les fonctions permettant d’ajouter de nouvelles variations, etc., doivent mettre à jour le fragment en conséquence.
    ATTENTION

    Toutes les modifications apportées à un modèle de fragment de contenu existant peuvent impacter les fragments dépendants, ce qui peut engendrer des propriétés orphelines dans ces fragments.

  • Modèles de fragment de contenu :

    • utilisés pour définir des fragments de contenu simples.
    • Les modèles définissent la structure (de base, texte seul) d’un fragment de contenu lors de sa création.
    • Le modèle est copié dans le fragment lors de sa création. De ce fait, les modifications supplémentaires apportées au modèle ne seront pas répercutées dans les fragments existants.
    • Les fonctions permettant d’ajouter de nouvelles variations, etc., doivent mettre à jour le fragment en conséquence.
    • Modèles de fragment de contenu fonctionnent différemment des autres mécanismes de création de modèles au sein de l’écosystème AEM (par exemple, les modèles de page, etc.). C’est la raison pour laquelle ils doivent être pris en compte séparément.
    • S’il est basé sur un modèle, le type MIME du contenu est géré sur le contenu. Cela signifie que chaque élément et variation peut présenter un type MIME différent.

Intégrer à Assets

La gestion des fragments de contenu fait partie d’AEM Assets, car :

  • les fragments de contenu sont des ressources ;
  • ils utilisent la fonctionnalité Assets existante ;
  • ils sont entièrement intégrés à Assets (consoles d’administration, etc.).

Mappage de fragments de contenu structuré à Assets

fragment-to-assets-structured

Les fragments de contenu avec du contenu structuré (c’est-à-dire basé sur un modèle de fragment de contenu) sont mappés à une ressource unique :

  • L’ensemble du contenu est stocké sous le nœud jcr:content/data de la ressource :

    • Les données d’éléments sont stockées sous le sous-nœud maître :

      jcr:content/data/master

    • Les variations sont stockées sous un sous-nœud portant le nom de la variation :
      par exemple, jcr:content/data/myvariation.

    • Les données de chaque élément sont stockées dans le sous-nœud respectif en tant que propriété avec le nom d’élément :
      par exemple, le contenu de l’élément text est stocké en tant que propriété text sur jcr:content/data/master.

  • Les métadonnées et le contenu associé sont stockés sous jcr:content/metadata
    Hormis le titre et la description, qui ne sont pas considérés comme des métadonnées traditionnelles et sont stockés sur jcr:content.

Mappage des fragments de contenu simples à Assets

chlimage_1-90

Les fragments de contenu simples (basés sur un modèle) sont associés à un composite constitué d’une ressource principale et de sous-ressources (facultatives) :

  • Toutes les informations autres que le contenu d’un fragment (titre, description, métadonnées, structure, etc.) sont gérées exclusivement sur la ressource principale.

  • Le contenu du premier élément d’un fragment est mappé au rendu d’origine de la ressource principale.

    • Les variations (le cas échéant) du premier élément sont mappées à d’autres rendus de la ressource principale.
  • Les éléments supplémentaires (s’ils existent) sont mappés aux sous-ressources de la ressource principale.

    • Le contenu principal de ces éléments supplémentaires est mappé au rendu d’origine de la sous-ressource respective.
    • Les autres variations (le cas échéant) de tout élément supplémentaire sont mappées aux autres rendus de la sous-ressource respective.

Emplacement des ressources

Comme pour les ressources standard, un fragment de contenu est conservé sous :

/content/dam

Autorisations de ressources

Pour plus d’informations, voir Fragments de contenu – considérations sur la suppression.

Intégration de fonction

  • La fonctionnalité de gestion des fragments de contenu (CFM) repose sur le noyau Ressources, mais doit être aussi indépendante que possible.
  • CFM possède ses propres mises en œuvre pour les éléments dans les vues Carte/Colonnes/Liste. Celles-ci se connectent aux mises en œuvre de rendu de contenu existantes d’Assets.
  • Plusieurs composants d’Assets ont été étendus pour prendre en charge les fragments de contenu.

Utilisation des fragments de contenu dans les pages

ATTENTION

Le composant de base Fragment de contenu est désormais recommandé. Consultez la section Développement des composants principaux pour plus d’informations.

Les fragments de contenu peuvent être référencés à partir des pages AEM, comme tout autre type de ressource. AEM fournit le composant de base de fragment de contenu qui permet d’inclure des fragments de contenu sur vos pages. Vous pouvez également étendre ce composant principal Fragment de contenu.

  • Le composant utilise la propriété fragmentPath pour référencer le fragment de contenu. La propriété fragmentPath est traitée de la même façon que les propriétés similaires d’autres types de ressources, par exemple, lorsque le fragment de contenu est déplacé vers un autre emplacement.

  • Le composant vous permet de sélectionner la variation à afficher.

  • En outre, une plage de paragraphes peut être sélectionnée pour limiter la sortie. Par exemple, cela peut être utilisé pour la sortie multi-colonnes.

  • Le composant accepte le contenu intermédiaire :

    • Ici, le composant vous permet de placer d’autres ressources (images, etc.) entre les paragraphes du fragment référencé.

    • Pour le contenu intermédiaire, vous devez :

      • être conscient du risque de références instables ; le contenu intermédiaire (ajouté lors de la création d’une page) n’a pas de rapport fixe avec le paragraphe adjacent, et l’insertion d’un nouveau paragraphe (dans l’éditeur de fragments de contenu) avant la position du contenu intermédiaire peut entraîner la perte de l’emplacement relatif ;
      • prendre en compte les paramètres supplémentaires (tels que les filtres de variation et de paragraphe) pour éviter les faux positifs dans les résultats de recherche.
REMARQUE

Modèle de fragment de contenu :

Lors de l’utilisation d’un fragment de contenu basé sur un modèle de fragment de contenu sur une page, le modèle est référencé. Cela signifie que si le modèle n’a pas été publié lorsque vous publiez la page, celui-ci est marqué et le modèle ajouté aux ressources à publier avec la page.

Modèle de fragment de contenu :

Lors de l’utilisation d’un fragment de contenu qui était basé sur un modèle de fragment de contenu sur une page, il n’y a aucune référence car le modèle a été copié lors de la création du fragment.

Configurer avec la console OSGi

L’implémentation principale des fragments de contenu est, par exemple, chargée de rendre les instances d’un fragment utilisé sur une page consultable ou de gérer le contenu multimédia mixte. Cette implémentation doit savoir quels composants sont utilisés pour le rendu des fragments et comment le rendu est paramétré.

Les paramètres correspondants peuvent être configurés dans la console Web pour le lot OSGi Configuration des composants de fragments de contenu.

  • Types de ressources
    Une liste de sling:resourceTypes peut être fourni pour définir les composants utilisés pour le rendu des fragments de contenu et l’emplacement auquel le traitement en arrière-plan doit être appliqué.

  • Propriétés de référence
    Une liste de propriétés peut être configurée pour spécifier l’emplacement où la référence au fragment est stockée pour le composant correspondant.

REMARQUE

Il n’existe pas de mappage direct entre la propriété et le type de composant.

AEM utilise simplement la première propriété disponible sur un paragraphe. Vous devez donc choisir les propriétés avec précaution.

screenshot_2019-03-18at100941

Il existe d’autres instructions que vous devez respecter pour vous assurer que votre composant est compatible avec le traitement des fragments de contenu en arrière-plan :

  • Le nom de la propriété dans laquelle le ou les éléments dont le rendu doit être effectué sont définis doit être element ou elementNames.

  • Le nom de la propriété dans laquelle est définie la variation dont le rendu doit être effectué doit être variation ou variationName.

  • Si la sortie de plusieurs éléments est prise en charge (à l’aide de elementNames pour spécifier plusieurs éléments), le mode d’affichage est défini par la propriétédisplayMode :

    • Si la valeur est singleText (et il n’y a qu’un seul élément configuré), l’élément est rendu sous forme de texte avec du contenu intermédiaire, la prise en charge de la mise en page, etc. Il s’agit de la valeur par défaut des fragments dans lesquels un seul élément est rendu.
    • Dans le cas contraire, une approche beaucoup plus simple est utilisée (qui peut être qualifiée de « vue de formulaire »), dans laquelle aucun contenu intermédiaire n’est pris en charge et le contenu du fragment est rendu « tel quel ».
  • Si le fragment est rendu pour displayMode == singleText (de manière implicite ou explicite), les propriétés supplémentaires suivantes entrent en jeu :

    • paragraphScope définit si tous les paragraphes ou uniquement une plage de paragraphes doivent être rendus (valeurs all ou range).

    • Si paragraphScope == range, alors la propriété paragraphRange définit la plage de paragraphes dont le rendu doit être effectué.

Intégration à d’autres structures

Les fragments de contenu peuvent être intégrés aux éléments suivants :

  • Des traductions

    Les fragments de contenu sont entièrement intégrés au workflow de traduction AEM. Sur le plan architectural, cela signifie :

    • Les traductions individuelles d’un fragment de contenu sont en fait des fragments distincts, par exemple :

      • elles se trouvent sous différentes racines de langue :

        /content/dam/<path>/en/<to>/<fragment>

        ou

        /content/dam/<path>/de/<to>/<fragment>

      • mais ils partagent exactement le même chemin relatif sous la racine de langue :

        /content/dam/<path>/en/<to>/<fragment>

        ou

        /content/dam/<path>/de/<to>/<fragment>

    • Outre les chemins basés sur des règles, il n’existe aucune connexion entre les différentes versions linguistiques d’un fragment de contenu ; elles sont traitées comme deux fragments distincts, bien que l’IU fournisse les moyens de naviguer entre les variantes de langues.

    REMARQUE

    Le workflow de traduction AEM fonctionne avec /content :

    • Les modèles de fragment de contenu résidant dans /conf ; ils ne sont pas inclus dans ces traductions. Vous pouvez internationaliser les chaînes de l’IU.

    • Les modèles étant copiés pour créer le fragment, ce processus est donc implicite.

  • Des schémas de métadonnées

    • Les fragments de contenu (ré)utilisent des schémas de métadonnées, qui peuvent être définis avec des ressources standard.

    • CFM fournit son propre schéma spécifique :

      /libs/dam/content/schemaeditors/forms/contentfragment

      il peut être étendu si nécessaire.

    • Le formulaire de schéma respectif est intégré à l’éditeur de fragments.

API de gestion des fragments de contenu – côté serveur

Vous pouvez utiliser l’API côté serveur pour accéder à vos fragments de contenu, voir :

com.adobe.cq.dam.cfm

ATTENTION

Il est vivement recommandé d’utiliser l’API côté serveur au lieu d’accéder directement à la structure de contenu.

Interfaces principales

Les trois interfaces suivantes peuvent faire office de points d’entrée :

  • Modèle de fragment (FragmentTemplate)

    Utilisation FragmentTemplate.createFragment() pour créer un fragment.

    Resource templateOrModelRsc = resourceResolver.getResource("...");
    FragmentTemplate tpl = templateOrModelRsc.adaptTo(FragmentTemplate.class);
    ContentFragment newFragment = tpl.createFragment(parentRsc, "A fragment name", "A fragment description.");
    

    Cette interface représente :

    • un modèle de fragment de contenu utilisé pour créer un fragment de contenu ;
    • et (après la création) les informations relatives à la structure de ce fragment.

    Ces informations peuvent inclure les éléments suivants :

    • Accès aux données de base (titre, description)

    • Accès aux modèles pour les éléments du fragment :

      • Répertorier les éléments de liste
      • Obtenir les informations structurelles pour un élément donné
      • Accès au modèle d’élément (voir ElementTemplate)
    • Accès aux modèles pour les variantes du fragment :

      • Répertorier les modèles de variantes
      • Obtention des informations structurelles pour une variation donnée
      • Accès au modèle de variation (voir VariationTemplate)
    • Obtenir le contenu associé initial

    Interfaces qui représentent des informations importantes :

    • ElementTemplate

      • Obtenir des informations de base (nom, titre)
      • Obtenir le contenu initial de l’élément
    • VariationTemplate

      • Obtention des informations de base (nom, titre et description)
  • Fragment de contenu (ContentFragment)

    Cette interface vous permet d’utiliser un fragment de contenu de façon abstraite.

    ATTENTION

    Il est vivement recommandé d’accéder à un fragment via cette interface. La modification directe de la structure de contenu doit être évitée.

    L’interface permet les actions suivantes :

    • Gestion des informations de base (par exemple, obtenir le nom ou obtenir/définir le titre/la description)

    • Accéder aux métadonnées

    • Accéder aux éléments :

      • Répertorier les éléments

      • Obtenir les éléments par nom

      • Création des éléments (voir Restrictions)

      • Accès aux données des éléments (voir ContentElement)

    • Répertorier les variations définies pour le fragment

    • Créer globalement des variations

    • Gérer le contenu associé :

      • Répertorier les collections
      • Ajouter des collections
      • Supprimer des collections
    • Accès au modèle ou au modèle du fragment

    Les interfaces qui représentent les éléments principaux d’un fragment sont les suivantes :

    • Élément de contenu (ContentElement)

      • Obtention des informations de base (nom, titre et description)

      • Obtenir/définir du contenu

      • Accéder aux variations d’un élément :

        • Répertorier des variations
        • Obtentir les variations par nom
        • Créer des variations (voir Restrictions)
        • Suppression de variations (voir Restrictions)
        • Accès aux données de variation (voir ContentVariation)
      • Raccourci pour résoudre les variations (application d’une logique de secours supplémentaire spécifique à l’implémentation si la variation spécifiée n’est pas disponible pour un élément)

    • Variation de contenu (ContentVariation)

      • Obtention des informations de base (nom, titre et description)
      • Obtenir/définir du contenu
      • Synchronisation simple, basée sur la dernière information modifiée

    Chacune des trois interfaces (ContentFragment, ContentElement et ContentVariation) étend l’interface Versionable, ce qui ajoute des fonctionnalités de contrôle de version, requises pour les fragments de contenu :

    • Création d’une version de l’élément
    • Liste des versions de l’élément
    • Obtention du contenu d’une version spécifique de l’élément versionné

Adaptation – utilisation d’adaptTo()

Ce qui suit peut être adapté :

  • ContentFragment peut être adapté en :

    • Resource : la ressource sous-jacente de Sling ; notez que la mise à jour directe de la Resource sous-jacente requiert la reconstruction de l’objet ContentFragment ;

    • Asset – Abstraction Asset de gestion des ressources numériques représentant le fragment de contenu ; la mise à jour directe de la Asset sous-jacente nécessite la reconstruction de l’objet ContentFragment.

  • ContentElement peut être adapté en :

    • ElementTemplate pour accéder aux informations structurelles de l’élément.
  • FragmentTemplate peut être adapté en :

    • Resource : la Resource déterminant le modèle référencé ou le modèle d’origine qui a été copié ;

      • les modifications apportées par l’intermédiaire de la Resource ne sont pas répercutées automatiquement dans le FragmentTemplate.
  • Resource peut être adapté en :

    • ContentFragment
    • FragmentTemplate

Restrictions

Il convient de noter les éléments suivants :

  • L’API est mise en œuvre afin de fournir des fonctionnalités prises en charge par l’interface utilisateur.

  • L’API entière est conçue pour ne pas conserver les modifications automatiquement (sauf indication contraire dans l’API JavaDoc). Vous devrez donc toujours valider le résolveur de ressources de la requête correspondante (ou le résolveur que vous utilisez réellement).

  • Tâches pouvant nécessiter un effort supplémentaire :

    • La création/suppression d’éléments ne met pas à jour la structure de données de fragments simples (basés sur le modèle de fragment).

    • La création de variations de ContentElement ne met pas à jour la structure de données (tandis que la création globale à partir de ContentFragment la met à jour).

    • La suppression de variations existantes ne met pas à jour la structure de données.

L’API de gestion des fragments de contenu – côté client

ATTENTION

Pour AEM 6.5, l’API côté client est interne.

Informations supplémentaires

Reportez-vous aux informations suivantes :

  • filter.xml

    Le fichier filter.xml pour la gestion des fragments de contenu est configuré pour ne pas chevaucher le package de contenu de base d’Assets.

Sessions de modification

Une session de modification est lancée lorsque l’utilisateur ouvre un fragment de contenu dans l’une des pages de l’éditeur. La session de modification est terminée lorsque l’utilisateur quitte l’éditeur en sélectionnant Enregistrer ou Annuler.

Conditions requises

Les conditions pour contrôler une session de modification sont les suivantes :

  • La modification d’un fragment de contenu qui peut être réparti sur plusieurs vues (= pages HTML) doit être atomique.
  • La modification doit également être transactionnelle ; à la fin de la session de modification, les modifications doivent être validées (enregistrées) ou restaurées (annulées).
  • Les cas Edge doivent être gérés correctement, notamment lorsque l’utilisateur ou l’utilisatrice quitte la page en saisissant une URL manuellement ou en utilisant la navigation globale.
  • Un enregistrement automatique périodique (toutes les x minutes) doit être disponible pour empêcher la perte de données.
  • Si un fragment de contenu est modifié simultanément par deux personnes, elles ne doivent pas remplacer les modifications de l’autre.

Processus

Les processus impliqués sont les suivants :

  • Démarrage d’une session

    • Une nouvelle version du fragment de contenu est créée.
    • L’enregistrement automatique est démarré.
    • Les cookies sont configurés afin de définir le fragment actuellement modifié et de signifier qu’une session de modification est ouverte.
  • Achèvement d’une session

    • L’enregistrement automatique est arrêté.

    • Lors de la validation :

      • Les informations de dernière modification sont mises à jour.
      • Les cookies sont supprimés.
    • Lors de la restauration :

      • La version du fragment de contenu créé au démarrage de la session de modification est restaurée.
      • Les cookies sont supprimés.
  • Modification

    • Toutes les modifications (enregistrement automatique inclus) sont effectuées sur le fragment de contenu actif, et non dans une zone séparée et protégée.
    • Par conséquent, ces modifications sont répercutées immédiatement sur les pages AEM qui font référence au fragment de contenu correspondant.

Actions

Les actions possibles sont les suivantes :

  • Entrée sur une page

    • Vérifiez si une session de modification est déjà présente en vérifiant le cookie correspondant.

      • S’il en existe une, vérifiez que la session de modification a été lancée pour le fragment de contenu en cours de modification.

        • Si le fragment est actif, rétablissez la session.
        • Dans le cas contraire, essayez d’annuler la modification du fragment de contenu précédemment modifié et supprimez les cookies (aucune session de modification n’est présente par la suite).
      • S’il n’existe aucune session de modification, attendez la première modification effectuée par l’utilisateur ou l’utilisatrice (voir ci-dessous).

    • Vérifiez si le fragment de contenu est déjà référencé sur une page et affichez les informations appropriées si tel est le cas.

  • Modifier le contenu

    • Chaque fois que l’utilisateur modifie le contenu en l’absence de session de modification, une session de modification est créée (consultez Démarrage d’une session).
  • Sortie d’une page

    • Si une session de modification est présente, et si les modifications n’ont pas été conservées, une boîte de dialogue de confirmation modale s’affiche pour avertir l’utilisateur de la perte potentielle de contenu et pour lui permettre de rester sur la page.

Exemples

Exemple : accès à un fragment de contenu existant

Pour ce faire, vous pouvez adapter la ressource qui représente l’API à :

com.adobe.cq.dam.cfm.ContentFragment

Par exemple :

// first, get the resource
Resource fragmentResource = resourceResolver.getResource("/content/dam/fragments/my-fragment");
// then adapt it
if (fragmentResource != null) {
    ContentFragment fragment = fragmentResource.adaptTo(ContentFragment.class);
    // the resource is now accessible through the API
}

Exemple : création d’un fragment de contenu

Pour créer un fragment de contenu par programmation, vous devez utiliser :

com.adobe.cq.dam.cfm.ContentFragmentManager#create

Par exemple :

Resource templateOrModelRsc = resourceResolver.getResource("...");
FragmentTemplate tpl = templateOrModelRsc.adaptTo(FragmentTemplate.class);
ContentFragment newFragment = tpl.createFragment(parentRsc, "A fragment name", "A fragment description.");

Exemple : spécification de l’intervalle d’enregistrement automatique

L’intervalle d’enregistrement automatique (exprimé en secondes) peut être défini à l’aide de Configuration Manager (ConfMgr) :

  • Nœud : <*conf-root*>/settings/dam/cfm/jcr:content

  • Nom de la propriété : autoSaveInterval

  • Type : Long

  • Valeur par défaut : 600 (10 minutes) ; cette valeur est définie sur /libs/settings/dam/cfm/jcr:content

Si vous souhaitez définir un intervalle d’enregistrement automatique de 5 minutes, vous devez définir la propriété sur le nœud, par exemple :

  • Nœud : /conf/global/settings/dam/cfm/jcr:content

  • Nom de la propriété : autoSaveInterval

  • Type : Long

  • Valeur : 300 (5 minutes correspondent à 300 secondes).

Modèles de fragment de contenu

Voir Modèles de fragment de contenu pour plus d’informations.

Composants pour la création de page

Pour plus d’informations, voir :

Sur cette page