Marco de trabajo de etiquetado de AEM

Última actualización: 2023-11-08
  • Temas:
  • Tagging
    Ver más sobre este tema

El etiquetado permite clasificar y organizar el contenido. Las etiquetas se pueden clasificar por un área de nombres y una taxonomía. Para obtener información detallada sobre el uso de etiquetas:

  • Ver el documento Uso de etiquetas para obtener información sobre cómo etiquetar contenido como autor de contenido.
  • Ver el documento Administración de etiquetas para conocer la perspectiva de un administrador sobre la creación y administración de etiquetas, y a qué etiquetas de contenido se han aplicado.

AEM Este artículo se centra en el marco de trabajo subyacente que admite el etiquetado en los entornos de y en cómo utilizarlo como desarrollador.

Introducción

AEM Para etiquetar contenido y utilizar la infraestructura de etiquetado de:

  • La etiqueta debe existir como nodo de tipo [cq:Tag](#tags-cq-tag-node-type) en el nodo raíz de taxonomía.

  • El nodo de contenido etiquetado es NodeType debe incluir el cq:Taggable mixin.

  • El TagID se añade al nodo de contenido cq:tags y se resuelve en un nodo de tipo [cq:Tag](#tags-cq-tag-node-type).

Etiquetas : cq:Tipo de nodo de etiqueta

La declaración de una etiqueta se captura en el repositorio en un nodo de tipo cq:Tag.

Una etiqueta puede ser una palabra simple (por ejemplo, sky) o representan una taxonomía jerárquica (por ejemplo, fruit/apple, es decir, tanto el genérico fruit y los más específicos apple).

Las etiquetas se identifican con un TagID único.

Una etiqueta tiene información meta opcional, como un título, títulos localizados y una descripción. El título debe mostrarse en las interfaces de usuario en lugar del TagID, cuando esté presente.

El marco de etiquetado también permite restringir la capacidad de los autores y visitantes del sitio para utilizar solo etiquetas específicas predefinidas.

Características de etiquetas

  • El tipo de nodo es cq:Tagn
  • El nombre del nodo es un componente del TagID.
  • El TagID siempre incluye un namespace.
  • El jcr:title (el título que se mostrará en la interfaz de usuario) es opcional.
  • El jcr:description La propiedad es opcional.
  • Cuando contiene nodos secundarios, la etiqueta se denomina etiqueta contenedora.
  • La etiqueta se almacena en el repositorio bajo una ruta base denominada nodo raíz de taxonomía.

Dado que las etiquetas son simplemente nodos JCR, los nombres de nodo deben cumplir con las Convenciones de nomenclatura JCR.

ID de etiqueta

TagID identifica una ruta que se resuelve en un nodo de etiqueta del repositorio.

Normalmente, TagID es un TagID abreviado que comienza con el área de nombres o puede ser un TagID absoluto que comience por nodo raíz de taxonomía.

Cuando se etiqueta contenido, si aún no existe, la variable [cq:tags](#tagged-content-cq-tags-property) La propiedad se agrega al nodo de contenido y el TagID se agrega al de la propiedad String valor de matriz.

TagID consta de un namespace seguido del TagID local. Etiquetas de contenedor tienen subetiquetas que representan un orden jerárquico en la taxonomía. Las subetiquetas se pueden utilizar para hacer referencia a las etiquetas del mismo modo que cualquier TagID local. Por ejemplo, al etiquetar contenido con fruit se permite, incluso si es una etiqueta contenedora con subetiquetas, como fruit/apple y fruit/banana.

Nodo raíz de taxonomía

El nodo raíz de taxonomía es la ruta base para todas las etiquetas del repositorio. El nodo raíz de taxonomía no debe ser un nodo de tipo cq:Tag.

AEM En el caso de los usuarios, la ruta base es /content/cq:tags y el nodo raíz es del tipo cq:Folder.

Área de nombres de etiqueta

Las áreas de nombres permiten agrupar cosas. El caso de uso más habitual es un área de nombres por sitio (por ejemplo, público, interno y portal) o por aplicación más grande (por ejemplo, WCM, Assets, Communities). Sin embargo, las áreas de nombres se pueden utilizar para otras necesidades. Los espacios de nombres se utilizan en la interfaz de usuario de para mostrar únicamente el subconjunto de etiquetas (es decir, las etiquetas de un determinado espacio de nombres) que se aplica al contenido actual.

El área de nombres de la etiqueta es el primer nivel del subárbol de taxonomía, que es el nodo situado inmediatamente debajo de nodo raíz de taxonomía. Un área de nombres es un nodo de tipo cq:Tag cuyo elemento principal no es un cq:Tag tipo de nodo.

Todas las etiquetas tienen un área de nombres. Si no se especifica ningún área de nombres, la etiqueta se asigna al área de nombres predeterminada, que es TagID default con el título Standard Tags, es decir, /content/cq:tags/default.

Etiquetas de contenedor

Una etiqueta contenedora es un nodo de tipo cq:Tag que contenga cualquier número y tipo de nodos secundarios, lo que permite mejorar el modelo de etiquetas con metadatos personalizados.

Además, las etiquetas de contenedor (o superetiquetas) en una taxonomía sirven como subsuma de todas las subetiquetas. Por ejemplo, contenido etiquetado con fruit/apple se considera etiquetado con fruit y también. Es decir, buscar contenido etiquetado con fruit también encontraría el contenido etiquetado con fruit/apple.

Resolver TagID

Si TagID contiene dos puntos (:), los dos puntos separan el área de nombres de la etiqueta o subtaxonomía, que se separa aún más con barras oblicuas (/). Si TagID no tiene dos puntos, el área de nombres predeterminada es implícita.

A continuación, se muestra la ubicación estándar y exclusiva de las etiquetas /content/cq:tags.

Etiqueta que hace referencia a rutas no existentes o que no apuntan a una cq:Tag Los nodos de se consideran no válidos y se ignoran.

En la tabla siguiente se muestran algunos ejemplos de TagID, sus elementos y cómo TagID se resuelve en una ruta absoluta en el repositorio:

ID de etiqueta Espacio de nombres ID local Etiquetas de contenedor Etiqueta de hoja Ruta de etiqueta absoluta del repositorio
dam:fruit/apple/braeburn dam fruit/apple/braeburn fruit, apple braeburn /content/cq:tags/dam/fruit/apple/braeburn
color/red default color/red color red /content/cq:tags/default/color/red
sky default sky Ninguno sky /content/cq:tags/default/sky
dam: dam Ninguno Ninguno Ninguno, el área de nombres /content/cq:tags/dam
/content/cq:tags/category/car category car car car /content/cq:tags/category/car

Localización del título de la etiqueta

Cuando la etiqueta incluye la cadena de título opcional ( jcr:title), es posible localizar el título para mostrarlo añadiendo la propiedad jcr:title.<locale>.

Para obtener más información, consulte los siguientes documentos:

Control de acceso

Las etiquetas existen como nodos en el repositorio en la variable nodo raíz de taxonomía. Permitir o denegar a los autores y visitantes del sitio la creación de etiquetas en un área de nombres determinada se puede lograr estableciendo ACL adecuados en el repositorio.

Además, la denegación de permisos de lectura para determinadas etiquetas o áreas de nombres controla la capacidad de aplicar etiquetas a contenido específico.

Una práctica típica incluye:

  • Permitir el tag-administrators acceso de escritura de grupo/función a todas las áreas de nombres (agregar/modificar en /content/cq:tags). AEM Este grupo incluye a los usuarios que ya están preparados para su uso en el momento de la compra.
  • Permite a los usuarios/autores acceder a todas las áreas de nombres que deben poder leerlas (principalmente todas).
  • Permitir a usuarios/autores escribir en aquellas áreas de nombres en las que los usuarios/autores deben poder definir libremente las etiquetas (añada un nodo en /content/cq:tags/some_namespace)

Contenido etiquetable : cq:Taggable Mixin

Para que los desarrolladores de aplicaciones adjunten el etiquetado a un tipo de contenido, el registro del nodo (CND) debe incluir el cq:Taggable mixin o el cq:OwnerTaggable mixin.

El cq:OwnerTaggable mixin, que hereda de cq:Taggable, tiene la intención de indicar que el propietario/autor puede clasificar el contenido. AEM En el caso de los informes, solo es un atributo de la variable cq:PageContent nodo. El cq:OwnerTaggable El marco de etiquetado no requiere el mixin.

NOTA

Se recomienda habilitar solo las etiquetas en el nodo de nivel superior de un elemento de contenido agregado (o en su jcr:content node). Algunos ejemplos son:

  • Páginas (cq:Page) donde la variable jcr:contentel nodo es del tipo cq:PageContent que incluye el cq:Taggable mixin
  • Recursos ( cq:Asset) donde la variable jcr:content/metadata El nodo siempre tiene el cq:Taggable mixin

Notación de tipo de nodo (CND)

Las definiciones de tipo de nodo existen en el repositorio como archivos CDN. La notación CDN se define como parte de la documentación JCR aquí.

AEM Las definiciones esenciales para los tipos de nodo incluidos en la lista de nombres de dominio son las siguientes:

[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

Contenido etiquetado: cq:tags (propiedad)

El cq:tags La propiedad es un String Matriz utilizada para almacenar uno o más TagID cuando los autores o visitantes del sitio los aplican al contenido. La propiedad solo tiene significado cuando se agrega a un nodo que se define con la variable [cq:Taggable](#taggable-content-cq-taggable-mixin) mixin.

NOTA

AEM Para utilizar la funcionalidad de etiquetado de etiquetas, las aplicaciones desarrolladas personalizadas no deben definir propiedades de etiquetas distintas de cq:tags.

Mover y combinar etiquetas

A continuación se describen los efectos del repositorio al mover o combinar etiquetas utilizando consola de etiquetado:

  • Cuando una etiqueta A se mueve o se combina con la etiqueta B en /content/cq:tags:

    • La etiqueta A no se elimina y obtiene un cq:movedTo propiedad.
    • La etiqueta B se crea (si se ha producido un movimiento) y obtiene un cq:backlinks propiedad.
  • cq:movedTo apunta a la etiqueta B.

    • Esta propiedad significa que la etiqueta A se ha movido o combinado en la etiqueta B. Al mover la etiqueta B, se actualiza esta propiedad en consecuencia. Por lo tanto, la etiqueta A está oculta y solo se mantiene en el repositorio para resolver los ID de etiqueta en los nodos de contenido que apuntan a la etiqueta A. El recolector de elementos no utilizados de etiquetas elimina las etiquetas como la etiqueta A una vez que los nodos de contenido no las señalan.

    • Un valor especial para cq:movedTo la propiedad es nirvana. Se aplica cuando se elimina la etiqueta, pero no se puede eliminar del repositorio porque hay subetiquetas con un cq:movedTo eso debe mantenerse.

    NOTA

    El cq:movedTo La propiedad solo se añade a la etiqueta movida o combinada si se cumple cualquiera de estas condiciones:

    1. La etiqueta se utiliza en el contenido (lo que significa que tiene una referencia) o
    2. La etiqueta tiene elementos secundarios que ya se han movido.
  • cq:backlinks mantiene las referencias en la otra dirección. Es decir, mantiene una lista de todas las etiquetas que se han movido o combinado con la etiqueta B. Esto es necesario principalmente para mantener cq:movedTo propiedades actualizadas cuando la etiqueta B se mueve, combina o elimina, o cuando la etiqueta B está activada, en cuyo caso todas sus etiquetas de backlinks deben activarse también.

    NOTA

    El cq:backlinks La propiedad solo se añade a la etiqueta movida o combinada si se cumple cualquiera de estas condiciones:

    1. La etiqueta se utiliza en el contenido (lo que significa que tiene una referencia) O
    2. La etiqueta tiene elementos secundarios que ya se han movido.
  • Leer un cq:tags La propiedad de un nodo de contenido implica la siguiente resolución:

    1. Si no hay ninguna coincidencia en /content/cq:tags, no se devuelve ninguna etiqueta.

    2. Si la etiqueta tiene un cq:movedTo establecida, se sigue el ID de etiqueta al que se hace referencia.

      • Este paso se repite siempre que la etiqueta seguida tenga un cq:movedTo propiedad.
    3. Si la etiqueta seguida no tiene un cq:movedTo propiedad, se lee la etiqueta.

  • Para publicar el cambio cuando se haya movido o combinado una etiqueta, la variable cq:Tag nodo y todos sus backlinks deben ser replicados. Esto se realiza automáticamente cuando la etiqueta se activa en la consola de administración de etiquetas.

  • Actualizaciones posteriores en la página cq:tags limpie automáticamente las referencias antiguas. Esto se activa porque la resolución de una etiqueta desplazada a través de la API devuelve la etiqueta de destino, proporcionando así el ID de etiqueta de destino.

NOTA

El movimiento de etiquetas es diferente de la migración de etiquetas.

Migración de etiquetas

A partir de Adobe Experience Manager 6.4, las etiquetas se almacenan en /content/cq:tags mientras que las versiones anteriores almacenaban etiquetas en /etc/tags.

AEM Siempre que se actualice un sistema de la versión anterior a la versión 6.4, las etiquetas deben migrarse a /content/cq:tags. Consulte AEM Reestructuración común de repositorios en 6.5 para obtener más información.

En esta página