Modèles de fragment de contenu

Les modèles de fragment de contenu d’AEM définissent la structure du contenu de vos fragments de contenu et servent de base à votre contenu découplé.

Pour utiliser des modèles de fragments de contenu, procédez comme suit :

1. Activez la fonctionnalité Modèle de fragment de contenu pour votre instance.
2. Créez et configurez vos modèles de fragments de contenu.
3. Activez les modèles de fragments de contenu à utiliser pour la création de fragments de contenu.
4. Autorisez vos modèles de fragments de contenu sur les dossiers de ressources en configurant des stratégies.

Création d’un modèle de fragment de contenu

1. Accédez à Outils, Ressources, puis ouvrez les modèles de fragment de contenu.

2. Accédez au fichier adapté votre configuration.

3. Utilisez le bouton Créer pour ouvrir l’assistant.

   ATTENTION

   Si l’utilisation des modèles de contenu du fragment n’a pas été activée, l’option Créer n’est pas disponible.

4. Spécifiez le Titre du modèle. Vous pouvez également ajouter des balises, une description et sélectionner Activer le modèle pour activer le modèle, si nécessaire.

   

5. Utilisez le bouton Créer pour enregistrer le modèle vide. Un message indique que l’action a réussi. Vous pouvez alors sélectionner Ouvrir pour publier immédiatement le modèle ou Terminé pour revenir à la console.

Définition de votre modèle de fragment de contenu

Le modèle de fragment de contenu définit effectivement la structure des fragments de contenu résultants à l’aide d’une sélection de Types de données. Grâce à l’éditeur de modèles, vous pouvez ajouter des instances de types de données, puis les configurer pour créer les champs requis :

1. Accédez à Outils, Ressources, puis ouvrez les modèles de fragment de contenu.

2. Accédez au dossier contenant votre modèle de fragment de contenu.

3. Ouvrez le modèle requis pour l’édition. Utilisez l’action rapide ou sélectionnez le modèle puis l’action dans la barre d’outils.

   Une fois ouvert, l’éditeur de modèles affiche :

   • à gauche : les champs déjà définis
   • à droite : les types de données disponibles pour la création des champs (et les propriétés à utiliser une fois les champs créés).
   REMARQUE

   Lorsqu’un champ est obligatoire, le libellé indiqué dans le volet de gauche est signalé par un astérisque (​*).

1. Pour ajouter un champ

   • Faites glisser un type de données à l’emplacement souhaité pour un champ :

     

   • Une fois qu’un champ a été ajouté au modèle, le panneau de droite affiche les propriétés qui peuvent être définies pour ce type de données spécifique. Vous pouvez définir ce qui est obligatoire pour ce champ.

     • De nombreuses propriétés s’expliquent d’elles-mêmes. Pour plus d’informations, voir Propriétés.

     • Si vous entrez un libellé de champ, le nom de propriété est automatiquement renseigné. S’il est vide, il peut être mis à jour manuellement par la suite.

       ATTENTION

       Lors de la mise à jour manuelle de la propriété Nom de la propriété pour un type de données, notez que les noms ne doivent contenir que des caractères latins, des chiffres et un trait de soulignement "_" comme caractère spécial.
       Si les modèles créés dans des versions antérieures d’AEM contiennent des caractères interdits, supprimez ou mettez à jour ces caractères.

     Par exemple :

     

2. Pour supprimer un champ

   Sélectionnez le champ, puis cliquez/appuyez sur l’icône représentant une corbeille. Vous serez alors invité à confirmer l’opération.

   

3. Ajoutez tous les champs obligatoires et définissez les propriétés connexes, le cas échéant. Par exemple :

   

4. Sélectionnez Enregistrer pour conserver la définition.

Types de données

Une sélection de types de données est disponible pour la définition de votre modèle :

• Une seule ligne de texte
  • Ajoutez un ou plusieurs champs d’une seule ligne de texte ; il est possible de définir la longueur maximale.
• Plusieurs lignes de texte
  • Zone de texte pouvant contenir du texte enrichi, du texte brut ou du texte Markdown.
• Nombre
  • Ajoutez un ou plusieurs champs numériques
• Booléen
  • Ajoutez une case à cocher booléenne
• Date et heure
  • Ajoutez une date et/ou une heure
• Énumération
  • Ajoutez un ensemble de cases à cocher, de boutons radio ou de champs déroulants
• Balises
  • Permet aux auteurs de fragments d’accéder à des zones de balises et de les sélectionner.
• Référence de contenu
  • Fait référence à d’autres contenus, tous types confondus ; peut être utilisée pour créer du contenu imbriqué.
  • Si une image est référencée, vous pouvez choisir d’afficher une miniature.
• Référence du fragment
  • Fait référence à d’autres fragments de contenu, tous types confondus ; peut être utilisée pour créer du contenu imbriqué.
  • Le type de données peut être configuré pour permettre aux auteurs de fragments de procéder aux opérations suivantes :
    • Modifier directement le fragment référencé.
    • Créer un fragment de contenu, en fonction du modèle approprié.
• Objet JSON
  • Permet à l’auteur du fragment de contenu de saisir la syntaxe JSON dans les éléments correspondants d’un fragment.
    • Permettre à AEM de stocker directement JSON que vous avez copié/collé à partir d’un autre service.
    • Le fichier JSON est transmis et généré sous la forme JSON dans GraphQL.
    • Inclut la mise en surbrillance de la syntaxe JSON, la saisie semi-automatique et la mise en surbrillance des erreurs dans l’éditeur de fragments de contenu.
• Espace réservé pour tabulation

  • Permet l’introduction d’onglets à utiliser lors de la modification du contenu du fragment de contenu.
    Il s’affiche sous forme de séparateur dans l’éditeur de modèles et permet de séparer les sections de la liste des types de données de contenu. Chaque instance représente le début d’un nouvel onglet.
    Dans l’éditeur de fragments, chaque instance s’affiche sous la forme d’un onglet.

    REMARQUE

    Ce type de données est uniquement utilisé à des fins de mise en forme. Il est ignoré par le schéma GraphQL AEM.

Propriétés

De nombreuses propriétés s’expliquent d’elles-mêmes. Pour certaines propriétés, les détails supplémentaires sont les suivants :

• Nom de la propriété

  Lors de la mise à jour manuelle de cette propriété pour un type de données, notez que les noms must contain only Caractères latins, chiffres et trait de soulignement "_" comme caractère spécial.

  ATTENTION

  Si les modèles créés dans des versions antérieures d’AEM contiennent des caractères interdits, supprimez ou mettez à jour ces caractères.

• Rendu comme
  Les différentes options permettant de réaliser/rendre le champ dans un fragment. Il est ainsi souvent possible de définir si l’auteur verra une seule instance du champ ou s’il sera autorisé à créer plusieurs instances.

• Libellé du champ
  La saisie d’un
  libellé de champ génère automatiquement un nom de propriété, qui peut ensuite être mis à jour manuellement, si nécessaire.

• Validation
  La validation de base est disponible par le biais de mécanismes tels que la propriété Requis. Certains types de données comportent des champs de validation supplémentaires. Voir Validation pour plus de détails.

• Pour le type données texte multiligne, il est possible de définir le type par défaut en tant que :

  • Texte enrichi
  • Texte (Markdown)
  • Texte brut

  Si elle n’est pas spécifiée, la valeur par défaut Texte enrichi est utilisée pour ce champ.

  La modification du type par défaut dans un modèle de fragment de contenu prend effet uniquement sur un fragment de contenu existant et lié après l’ouverture et l’enregistrement du fragment dans l’éditeur.

• Unique
  Le contenu (du champ spécifique) doit être unique dans tous les fragments de contenu créés à l’aide du modèle actuel.

  Cette propriété permet de s’assurer que les auteurs de contenu ne peuvent pas répéter le contenu déjà ajouté dans un autre fragment du même modèle.

  Par exemple, un champ Une seule ligne de texte appelé Country dans le modèle de fragment de contenu ne peut pas avoir la valeur Japan dans deux fragments de contenu dépendants. Un avertissement sera émis en cas de tentative concernant la deuxième instance.

  REMARQUE

  L’unicité est assurée par la racine de langue.

  REMARQUE

  Les variations peuvent avoir la même valeur unique que les variations du même fragment, mais pas la même valeur que celle utilisée dans une variation d’autres fragments.

• Consultez la section Référence de contenu pour plus d’informations sur ce type de données spécifique et ses propriétés.

• Voir la section Référence du fragment (Fragments imbriqués) pour plus d’informations sur ce type de données spécifique et ses propriétés.

Validation

Différents types de données incluent désormais la possibilité de définir les exigences de validation lorsque le contenu est saisi dans le fragment résultant :

• Une seule ligne de texte
  • Comparaison avec une expression régulière prédéfinie (regex).
• Nombre
  • Vérification de valeurs spécifiques.
• Référence de contenu
  • Test de types de contenu spécifiques.
  • Seuls peuvent être référencés des fichiers de taille de fichier spécifiée ou inférieure.
  • Seules peuvent être référencées les images d’une plage prédéfinie de largeur et/ou de hauteur (en pixels).
• Référence du fragment
  • Test d’un modèle de fragment de contenu spécifique.

Utilisation de références pour former un contenu imbriqué

Les fragments de contenu peuvent former du contenu imbriqué à l’aide de l’un des types de données suivants :

• Référence de contenu

  • Fournit une référence simple à un autre contenu, quel que soit son type.
  • Peut être configurée pour une ou plusieurs références (dans le fragment résultant).

• Référence du fragment (fragments imbriqués)

  • Fait référence à d’autres fragments, en fonction des modèles spécifiques spécifiés.

  • Permet d’inclure/récupérer des données structurées.

    REMARQUE

    Cette méthode présente un intérêt particulier en conjonction avec la Diffusion de contenu découplé utilisant des fragments de contenu à l’aide de GraphQL.

  • Peut être configurée pour une ou plusieurs références (dans le fragment résultant).

Référence de contenu

La référence de contenu permet de générer du contenu à partir d’une autre source, par exemple, une image ou un fragment de contenu.

Outre les propriétés standard, vous pouvez spécifier les éléments suivants :

• Le chemin racine pour tout contenu référencé
• Types de contenu pouvant être référencés
• Limites relatives aux tailles de fichier
• Si une image est référencée :
  • Afficher la miniature
  • Limites de hauteur et de largeur pour l’image

Référence du fragment (fragments imbriqués)

La référence du fragment fait référence à un ou plusieurs fragments de contenu. Cette fonctionnalité présente un intérêt particulier lors de la récupération de contenu pour une utilisation dans votre application, car elle permet de récupérer des données structurées comportant plusieurs calques.

Par exemple :

• Un modèle définissant les détails d’un employé. Il s’agit notamment des éléments suivants :
  • Référence au modèle qui définit l’employeur (entreprise)

type EmployeeModel {
    name: String
    firstName: String
    company: CompanyModel
}

type CompanyModel {
    name: String
    street: String
    city: String
}

Outre les propriétés standard, vous pouvez définir les éléments suivants :

• Afficher comme :

  • multifield : l’auteur du fragment peut créer plusieurs références individuelles

  • fragmentreference : permet à l’auteur du fragment de sélectionner une référence unique à un fragment.

• Type de modèle
  Il est possible de sélectionner plusieurs modèles. Lors de la création du fragment de contenu, tous les fragments référencés doivent avoir été créés à l’aide de ces modèles.

• Chemin racine
  Indique un chemin racine pour tout fragment référencé.

• Autoriser la création de fragments

  Cette propriété permet à l’auteur du fragment de créer un nouveau fragment en fonction du modèle approprié.

  • fragmentreferencecomposite : permet à l’auteur du fragment de créer un composite en sélectionnant plusieurs fragments.

  

Modèle de fragment de contenu – Propriétés

Vous pouvez modifier les propriétés d’un modèle de fragment de contenu :

• De base
  • Titre du modèle
  • Balises
  • Description
  • Télécharger l’image

Activation ou désactivation d’un modèle de fragment de contenu

Pour un contrôle total de l’utilisation de vos modèles de fragments de contenu, ils contiennent un état que vous pouvez définir.

Activation d’un modèle de fragment de contenu

Une fois qu’un modèle a été créé, il doit être activé pour :

• Être disponible afin d’être sélectionné lors de la création d’un fragment de contenu.
• Pouvoir être référencé à partir d’un modèle de fragment de contenu.
• Être disponible pour GraphQL ; le schéma est ensuite généré.

Pour activer un modèle marqué comme :

• Brouillon : nouveau (jamais activé).
• Désactivé : a été spécifiquement désactivé.

Vous utilisez l’option Activer de l’une des manières suivantes :

• La barre d’outils supérieure, lorsque le modèle concerné est sélectionné.
• L’action rapide correspondante (placez le pointeur de la souris sur le modèle concerné).

Désactivation d’un modèle de fragment de contenu

Un modèle peut également être désactivé afin que :

• Le modèle ne soit plus disponible comme base pour la création de nouveaux fragments de contenu.
• Toutefois :
  • Le schéma GraphQL continue à être généré et peut toujours être interrogé (pour éviter tout impact sur l’API JSON).
  • Tout fragment de contenu basé sur le modèle peut toujours être interrogé et renvoyé à partir du point d’entrée GraphQL.
• Le modèle ne peut plus être référencé, mais les références existantes sont conservées intactes et peuvent toujours être interrogées et renvoyées à partir du point d’entrée GraphQL.

Pour désactiver un modèle marqué comme Activé, utilisez l’option Désactiver de l’une des deux manières suivantes :

• La barre d’outils supérieure, lorsque le modèle concerné est sélectionné.
• L’action rapide correspondante (placez le pointeur de la souris sur le modèle concerné).

Autorisation de modèles de fragments de contenu dans votre dossier de ressources

Pour mettre en œuvre une gouvernance du contenu, vous pouvez configurer des Stratégies sur le dossier de ressources pour contrôler les modèles de fragment de contenu autorisés pour la création de fragments dans ce dossier.

Pour configurer les stratégies des modèles de fragments de contenu autorisés :

1. Recherchez et ouvrez les Propriétés pour le dossier de ressources requis.

2. Ouvrez l’onglet Stratégies pour configurer les éléments suivants :

   • Hérité de<folder>

     Les stratégies sont automatiquement héritées lors de la création de dossiers enfants ; il peut se produire une reconfiguration de la stratégie (et une rupture de l’héritage) si des sous-dossiers doivent autoriser des modèles différents du dossier parent.

   • Modèles de fragments de contenu autorisés par chemin

     Il est possible d’autoriser plusieurs modèles.

   • Modèles de fragments de contenu autorisés par balise

     Il est possible d’autoriser plusieurs modèles.
     

3. Enregistrez les modifications.

Les modèles de fragment de contenu autorisés pour un dossier sont résolus comme suit :

• Stratégies pour les modèles de fragments de contenu autorisés.
• Si elles sont absentes, essayez de déterminer la stratégie à l’aide des règles d’héritage.
• Si la chaîne d’héritage ne produit pas de résultat, examinez la configuration Cloud Services pour ce dossier (directement dans un premier temps, puis par héritage).
• Si aucun des éléments ci-dessus ne donne de résultats, il n’existe aucun modèle autorisé pour ce dossier.

Suppression d’un modèle de fragment de contenu

Pour supprimer un modèle de fragment de contenu :

1. Accédez à Outils, Ressources, puis ouvrez les modèles de fragment de contenu.

2. Accédez au dossier contenant votre modèle de fragment de contenu.

3. Sélectionnez votre modèle, puis utilisez l’option de suppression de la barre d’outils.

   REMARQUE

   Si le modèle est référencé, un avertissement s’affiche. Prenez alors les mesures qui s’imposent.

Publication d’un modèle de fragment de contenu

Les modèles de fragment de contenu doivent être publiés avant ou pendant la publication des fragments de contenu dépendants.

Pour publier un modèle de fragment de contenu :

1. Accédez à Outils, Ressources, puis ouvrez les modèles de fragment de contenu.

2. Accédez au dossier contenant votre modèle de fragment de contenu.

3. Sélectionnez votre modèle, puis l’option de publication dans la barre d’outils.
   L’état publié sera indiqué dans la console.

   REMARQUE

   Si vous publiez un fragment de contenu pour lequel le modèle n’a pas encore été publié, une liste de sélection indique cela, ainsi que le fait que le modèle sera publié avec le fragment.

Annulation de la publication d’un modèle de fragment de contenu

Les modèles de fragment de contenu peuvent être annulés s’ils ne sont référencés par aucun fragment.

Pour annuler la publication d’un modèle de fragment de contenu :

1. Accédez à Outils, Ressources, puis ouvrez les modèles de fragment de contenu.

2. Accédez au dossier contenant votre modèle de fragment de contenu.

3. Sélectionnez votre modèle, puis l’option Annuler la publication dans la barre d’outils.
   L’état publié sera indiqué dans la console.

Si vous essayez d’annuler la publication d’un modèle actuellement utilisé par un ou plusieurs fragments, un avertissement d’erreur vous en informe :

Le message vous invite à vérifier la variable Références pour en savoir plus :

Modèles de fragment de contenu verrouillés (publiés)

Cette fonctionnalité fournit une gouvernance pour les modèles de fragment de contenu qui ont été publiés.

Le défi

• Les modèles de fragment de contenu déterminent le schéma des requêtes GraphQL dans AEM.

  • AEM les schémas GraphQL sont créés dès qu’un modèle de fragment de contenu est créé. Ils peuvent exister dans les environnements de création et de publication.

  • Les schémas lors de la publication sont les plus critiques, car ils fournissent les bases de la diffusion en direct du contenu de fragment de contenu au format JSON.

• Des problèmes peuvent survenir lorsque des modèles de fragment de contenu sont modifiés ou, en d’autres termes, modifiés. Cela signifie que le schéma change, ce qui peut à son tour affecter les requêtes GraphQL existantes.

• L’ajout de nouveaux champs à un modèle de fragment de contenu ne doit (généralement) avoir aucun effet négatif. Toutefois, la modification de champs de données existants (par exemple, leur nom) ou la suppression de définitions de champ rompt les requêtes GraphQL existantes lorsqu’elles demandent ces champs.

Les exigences

• Pour sensibiliser les utilisateurs aux risques lors de la modification de modèles déjà utilisés pour la diffusion de contenu en direct, c’est-à-dire des modèles qui ont été publiés).

• En outre, pour éviter des modifications imprévues.

L’un ou l’autre de ces modèles peut interrompre les requêtes si les modèles modifiés sont republiés.

La solution

Pour résoudre ces problèmes, les modèles de fragment de contenu sont les suivants : verrouillé en mode LECTURE SEULE sur l’auteur - dès qu’ils ont été publiés. Ceci est indiqué par Verrouillé:

Lorsque le modèle est Verrouillé (en mode LECTURE SEULE ), vous pouvez voir le contenu et la structure des modèles, mais vous ne pouvez pas les modifier.

Vous pouvez gérer Verrouillé modèles de la console ou de l’éditeur de modèles :

• Console

  Dans la console, vous pouvez gérer le mode LECTURE SEULE avec le Déverrouiller et Verrouiller actions dans la barre d’outils :

  

  • Vous pouvez Déverrouiller un modèle pour activer les modifications.

    Si vous sélectionnez Déverrouiller un avertissement s’affiche et vous devez confirmer que la variable Déverrouiller action :
    

    Vous pouvez ensuite ouvrir le modèle pour le modifier.

  • Vous pouvez également Verrouiller le modèle par la suite.

  • La republication du modèle le réinitialise immédiatement. Verrouillé Mode (LECTURE SEULE).

• Éditeur de modèles

  • Lorsque vous ouvrez un modèle verrouillé, trois actions s’affichent : Annuler, Afficher en lecture seule, Modifier:

    

  • Si vous sélectionnez Afficher en lecture seule vous pouvez voir le contenu et la structure du modèle :

    

  • Si vous sélectionnez Modifier vous pouvez modifier et enregistrer vos mises à jour :

    

    REMARQUE

    Un avertissement peut toujours s’afficher en haut de l’écran, mais c’est le cas lorsque le modèle est déjà utilisé par les fragments de contenu existants.

  • Annuler vous renvoie à la console.