Framework de balisage AEM aem-tagging-framework

Le balisage permet de catégoriser et d’organiser le contenu. Les balises peuvent être classées par un espace de noms et par une taxonomie. Pour obtenir des informations détaillées sur l’utilisation des balises :

Cet article se concentre sur le cadre sous-jacent qui prend en charge le balisage dans AEM et explique comment l’utiliser en tant que développeur ou développeuse.

Présentation introduction

Pour baliser le contenu et utiliser l’infrastructure de balisage AEM, procédez comme suit :

Balises : type de nœud cq:Tag tags-cq-tag-node-type

La déclaration d’une balise est capturée dans le référentiel dans un nœud de type cq:Tag.

Une balise peut être un mot simple (par exemple, sky) ou représentent une taxonomie hiérarchique (par exemple, fruit/apple, c’est-à-dire que le fruit et plus spécifique apple).

Les balises sont identifiées par un TagID unique.

Une balise comprend des méta-informations facultatives, telles qu’un titre, des titres localisés et une description. Le titre doit être affiché dans les interfaces utilisateur au lieu de l’ID de balise, le cas échéant.

Le framework de balisage offre également la possibilité de contraindre les auteurs et les visiteurs du site à n’utiliser que des balises prédéfinies spécifiques.

Caractéristiques de la balise tag-characteristics

Les balises étant simplement des nœuds JCR, les noms de nœud doivent respecter la Convention de nommage JCR.

TagID (ID de balise) tagid

Un ID de balise identifie un chemin d’accès qui est résolu sur un nœud de balise dans le référentiel.

En règle générale, le TagID est un identifiant abrégé commençant par l’espace de noms ; il peut également s’agir d’un TagID absolu commençant au niveau du nœud racine de taxonomie.

Lorsque le contenu est balisé, la propriété [cq:tags](#tagged-content-cq-tags-property) est ajoutée, si elle n’existe pas déjà, au nœud de contenu et le TagID est ajouté à la valeur de tableau String de la propriété.

L’ID de balise se compose d’un espace de noms, suivi du TagID local. Les balises conteneurs contiennent des sous-balises qui représentent un ordre hiérarchique dans la taxonomie. Des sous-balises peuvent être utilisées pour référencer des balises identiques à tout TagID local. Par exemple, baliser du contenu avec fruit est autorisé, même s’il s’agit d’une balise conteneur avec des sous-balises, comme fruit/apple et fruit/banana.

Nœud racine de taxonomie taxonomy-root-node

Le nœud racine de taxonomie est le chemin d’accès de base pour toutes les balises du référentiel. Le nœud racine de taxonomie ne peut pas être un nœud de type cq:Tag.

Dans AEM, le chemin d’accès de base est /content/cq:tags et le nœud racine est de type cq:Folder.

Espace de noms des balises tag-namespace

Les espaces de noms vous permettent de regrouper des éléments. Le cas d’utilisation le plus courant est un espace de noms par site (par exemple, public, interne et portail) ou par application plus grande (par exemple, WCM, Assets, Communities). Mais les espaces de noms peuvent être utilisés pour d’autres besoins. Les espaces de noms sont utilisés dans l’interface utilisateur pour afficher uniquement le sous-ensemble de balises (c’est-à-dire les balises d’un certain espace de noms) applicable au contenu actuel.

L’espace de noms de la balise est le premier niveau de la sous-arborescence de taxonomie, à savoir le nœud situé juste en dessous du nœud racine de taxonomie. Un espace de noms est un nœud de type cq:Tag dont le parent n’est pas de type cq:Tag.

Toutes les balises possèdent un espace de noms. Si aucun espace de noms n’est spécifié, la balise est affectée à l’espace de noms par défaut, qui est l’ID de balise (TagID) par default (le titre est Standard Tags ce qui donnera /content/cq:tags/default).

Balises conteneurs container-tags

Une balise conteneur est un nœud de type cq:Tag contenant le nombre et le type des nœuds enfants, ce qui permet d’enrichir le modèle de balise avec des métadonnées personnalisées.

En outre, les balises conteneurs (ou super-balises) d’une taxonomie servent de sous-combinaison de toutes les sous-balises. Par exemple, du contenu balisé avec fruit/apple est considéré comme balisé avec fruit, également. Autrement dit, la recherche de contenu balisé avec fruit trouve également le contenu balisé avec fruit/apple.

Résolution d’identifiants de balise resolving-tagids

Si l’ID de balise contient le signe deux-points (:), celui-ci sépare l’espace de noms de la balise ou de la sous-taxonomie, qui sont alors séparées par des barres obliques (/). En l’absence de signe deux-points dans le TagID, l’espace de noms par défaut est sous-entendu.

/content/cq:tags constitue l’emplacement standard des balises, mais aussi le seul.

Les balises qui référencent des chemins d’accès inexistants ou qui ne pointent pas vers un nœud cq:Tag sont considérées comme non valides et sont ignorées.

Le tableau ci-dessous présente quelques exemples d’ID de balise, les éléments associés et la manière dont l’ID de balise est résolu sur un chemin d’accès absolu dans le référentiel :

Localisation du titre de balise localization-of-tag-title

Lorsque la balise comprend une chaîne de titre facultative (jcr:title), il est possible de localiser le titre à afficher en ajoutant la propriété jcr:title.<locale>.

Pour plus d’informations, voir les documents suivants :

Contrôle d’accès access-control

Les balises existent sous la forme de nœud dans le répertoire sous le nœud racine de taxonomie. Il est possible d’accorder ou de refuser aux auteurs et autrices et aux visiteurs et visiteuses du site le droit de créer des balises dans un espace de noms donné en définissant des listes de contrôle d’accès (ACL) appropriées dans le référentiel.

Refuser les autorisations de lecture sur certains espaces de noms et balises détermine la possibilité d’appliquer des balises à du contenu spécifique.

Une pratique habituelle est la suivante :

Contenu pouvant être balisé : mixin cq:Taggable taggable-content-cq-taggable-mixin

Pour que les développeurs et développeuses d’application associent le balisage à un type de contenu, l’enregistrement du nœud (CND) doit inclure le mixin cq:Taggable ou cq:OwnerTaggable.

Le mixin cq:OwnerTaggable, qui hérite de cq:Taggable, sert à indiquer que le contenu peut être classé par propriétaire/auteur. Dans AEM, il s’agit uniquement d’un attribut du nœud cq:PageContent. Le mixin cq:OwnerTaggable n’est pas requis par le cadre de balisage.

Notation de type de nœud (CND) node-type-notation-cnd

Les définitions de type de nœud existent dans le référentiel sous la forme de fichiers CND. La notation CND est définie dans le cadre de la documentation JCR ici.

Les définitions essentielles relatives aux types de nœud inclus dans AEM sont les suivantes :

[cq:Tag] > mix:title, nt:base
    orderable
    - * (undefined) multiple
    - * (undefined)
    + * (nt:base) = cq:Tag version

[cq:Taggable]
    mixin
    - cq:tags (string) multiple

[cq:OwnerTaggable] > cq:Taggable
    mixin

Contenu balisé : propriété cq:tags tagged-content-cq-tags-property

La propriété cq:tags est un tableau de String utilisé pour stocker un ou plusieurs ID de balise lorsque les auteurs et autrices ou les visiteurs et visiteuses du site les appliquent au contenu. La propriété n’a de sens que lorsqu’elle est ajoutée à un nœud qui est défini avec le mixin [cq:Taggable](#taggable-content-cq-taggable-mixin).

Déplacer et fusionner des balises moving-and-merging-tags

Vous trouverez, ci-après, la description des effets dans le référentiel lors du déplacement ou de la fusion de balises à l’aide de la console de balisage :

Migration de balises tags-migration

Depuis Adobe Experience Manager 6.4, les balises sont stockées sous /content/cq:tags tandis que les versions précédentes stockaient des balises sous /etc/tags.

Lorsque vous mettez à niveau un système AEM à partir d’une version antérieure à 6.4, les balises doivent être migrées vers /content/cq:tags. Pour plus d’informations, consultez Restructuration du référentiel commun dans AEM 6.5.