Estrutura de marcação do AEM aem-tagging-framework

A marcação permite que o conteúdo seja categorizado e organizado. As tags podem ser classificadas por um namespace e uma taxonomia. Para obter informações detalhadas sobre o uso de tags:

Este artigo se concentra na estrutura subjacente que oferece suporte à marcação no AEM e em como usá-lo como desenvolvedor.

Introdução introduction

Para marcar conteúdo e usar a infraestrutura de marcação AEM:

Tags : cq:Tag Node Type tags-cq-tag-node-type

A declaração de uma marca é capturada no repositório em um nó do tipo cq:Tag.

Uma marca pode ser uma palavra simples (por exemplo, sky) ou representar uma taxonomia hierárquica (por exemplo, fruit/apple, significando tanto o fruit genérico quanto o apple mais específico).

As tags são identificadas por uma TagID exclusiva.

Uma tag tem informações meta opcionais, como um título, títulos localizados e uma descrição. O título deve ser exibido nas interfaces do usuário, em vez da TagID, quando presente.

A estrutura de marcação também fornece a capacidade de restringir autores e visitantes do site a usar somente tags específicas e predefinidas.

Características da tag tag-characteristics

Como as marcas são simplesmente nós JCR, os nomes dos nós devem obedecer à convenção de nomenclatura JCR.

TagID tagid

Uma TagID identifica um caminho que é resolvido para um nó de tag no repositório.

Normalmente, a TagID é uma TagID abreviada que começa com o namespace ou pode ser uma TagID absoluta que começa no nó raiz de taxonomia.

Quando o conteúdo é marcado, se ainda não existir, a propriedade [cq:tags](#tagged-content-cq-tags-property) é adicionada ao nó de conteúdo e o TagID é adicionado ao valor da matriz String da propriedade.

A TagID consiste em um namespace seguido pela TagID local. Marcas de contêiner têm submarcas que representam uma ordem hierárquica na taxonomia. Subtags podem ser usadas para fazer referência a tags como qualquer TagID local. Por exemplo, a marcação de conteúdo com fruit é permitida, mesmo que seja uma marca de contêiner com submarcas, como fruit/apple e fruit/banana.

Nó raiz da taxonomia taxonomy-root-node

O nó raiz da taxonomia é o caminho base para todas as tags no repositório. O nó raiz da taxonomia não deve ser um nó do tipo cq:Tag.

No AEM, o caminho base é /content/cq:tags e o nó raiz é do tipo cq:Folder.

Namespace da tag tag-namespace

Os namespaces permitem agrupar itens. O caso de uso mais típico é um namespace por site (por exemplo, público, interno e portal) ou por aplicativo maior (por exemplo, WCM, Assets, Communities). Mas os namespaces podem ser usados para várias outras necessidades. Os namespaces são usados na interface do usuário para mostrar apenas o subconjunto de tags (ou seja, tags de um determinado namespace) que é aplicável ao conteúdo atual.

O namespace da marca é o primeiro nível na subárvore de taxonomia, que é o nó imediatamente abaixo do nó raiz de taxonomia. Um namespace é um nó do tipo cq:Tag cujo pai não é um tipo de nó cq:Tag.

Todas as tags têm um namespace. Se nenhum namespace for especificado, a marca será atribuída ao namespace padrão, que é TagID default com o título Standard Tags, ou seja, /content/cq:tags/default.

Tags de contêiner container-tags

Uma marca de contêiner é um nó do tipo cq:Tag que contém qualquer número e tipo de nós filhos, o que permite aprimorar o modelo de marca com metadados personalizados.

Além disso, tags container (ou supertags) em uma taxonomia servem como subsoma de todas as subtags. Por exemplo, o conteúdo marcado com fruit/apple também é considerado marcado com fruit. Ou seja, pesquisar conteúdo marcado com fruit também localizaria o conteúdo marcado com fruit/apple.

Resolvendo TagIDs resolving-tagids

Se a TagID contiver dois pontos (:), os dois pontos separarão o namespace da marca ou subtaxonomia, que é separada ainda mais com barras (/). Se TagID não tiver dois pontos, o namespace padrão será considerado.

O local padrão e único das marcas está abaixo de /content/cq:tags.

A marca que faz referência a caminhos ou caminhos não existentes que não apontam para um nó cq:Tag é considerada inválida e é ignorada.

A tabela a seguir mostra algumas amostras de TagIDs, seus elementos e como a TagID é resolvida para um caminho absoluto no repositório:

Localização do título da tag localization-of-tag-title

Quando a marca inclui a cadeia de caracteres de título opcional ( jcr:title), é possível localizar o título para exibição adicionando a propriedade jcr:title.<locale>.

Para obter mais detalhes, consulte os seguintes documentos:

Controle de acesso access-control

As marcas existem como nós no repositório no nó raiz de taxonomia. Permitir ou negar que autores e visitantes do site criem tags em um determinado namespace pode ser obtido definindo ACLs apropriadas no repositório.

Além disso, negar permissões de leitura para determinadas tags ou namespaces controla a capacidade de aplicar tags a um conteúdo específico.

Uma prática típica inclui:

Conteúdo Marcável : cq:Taggable Mixin taggable-content-cq-taggable-mixin

Para que os desenvolvedores de aplicativos anexem a marcação a um tipo de conteúdo, o registro do nó (CND) deve incluir o mixin cq:Taggable ou cq:OwnerTaggable.

O mixin cq:OwnerTaggable, que herda de cq:Taggable, destina-se a indicar que o conteúdo pode ser classificado pelo proprietário/autor. No AEM, é apenas um atributo do nó cq:PageContent. O mixin cq:OwnerTaggable não é exigido pela estrutura de marcação.

Notação de tipo de nó (CND) node-type-notation-cnd

As definições de tipo de nó existem no repositório como arquivos CND. A notação CND é definida como parte da documentação JCR aqui.

As definições essenciais para os Tipos de nós incluídos no AEM são as seguintes:

[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

Conteúdo marcado: cq:tags Propriedade tagged-content-cq-tags-property

A propriedade cq:tags é uma matriz String usada para armazenar uma ou mais TagIDs quando elas são aplicadas ao conteúdo por autores ou visitantes do site. A propriedade só tem significado quando adicionada a um nó definido com o mixin [cq:Taggable](#taggable-content-cq-taggable-mixin).

Mover e mesclar tags moving-and-merging-tags

Esta é uma descrição dos efeitos no repositório ao mover ou mesclar marcas usando o console de marcação:

Migração de tags tags-migration

A partir do Adobe Experience Manager 6.4, as tags são armazenadas em /content/cq:tags, enquanto as versões anteriores armazenavam tags em /etc/tags.

Sempre que atualizar um sistema AEM de uma versão anterior à 6.4, as tags devem ser migradas para o /content/cq:tags. Consulte Reestruturação do repositório comum no AEM 6.5 para obter mais informações.