Personalizar y ampliar fragmentos de contenido

Última actualización: 2024-02-26

Dentro de Adobe Experience Manager as a Cloud Service, un fragmento de contenido amplía un recurso estándar; consulte:

Arquitectura

Lo básico partes constitutivas de un fragmento de contenido son los siguientes:

  • A Fragmento de contenido mismo
  • Consiste en uno o más Elementos de contenido
  • Puede tener uno o más Variaciones de contenido

Los fragmentos de contenido individuales se basan en modelos de fragmentos de contenido:

  • Los modelos de fragmento de contenido definen la estructura de un fragmento de contenido cuando se crea.

  • Un fragmento hace referencia al modelo, por lo que los cambios realizados en el modelo pueden afectar a cualquier fragmento dependiente o no.

  • Los modelos son una compilación de tipos de datos.

  • Las funciones para agregar nuevas variaciones, etc., deben actualizar el fragmento en consecuencia.

    NOTA

    Para que pueda mostrar/procesar un fragmento de contenido, su cuenta debe tener read permisos para el modelo.

    PRECAUCIÓN

    Cualquier cambio en un modelo de fragmento de contenido existente puede afectar a los fragmentos dependientes, lo que puede generar propiedades huérfanas en esos fragmentos.

Integración de Sites con Assets

La administración de fragmentos de contenido (CFM) forma parte de Adobe Experience Manager AEM () Assets como:

  • Los fragmentos de contenido son recursos.
  • Utilizan la funcionalidad existente de Assets.
  • Están totalmente integrados con Assets (Admin Consoles, etc.).

Los fragmentos de contenido se consideran una función de AEM Sites como:

  • Se utilizan para crear páginas.

Asignación de fragmentos de contenido a los recursos

fragmento de contenido a recursos

Los fragmentos de contenido, basados en un modelo de fragmento de contenido, se asignan a un único recurso:

  • Todo el contenido se almacena en jcr:content/data nodo del recurso:

    • Los datos del elemento se almacenan en el subnodo maestro:

      jcr:content/data/master

    • Las variaciones se almacenan en un subnodo que lleva el nombre de la variación: por ejemplo, jcr:content/data/myvariation

    • Los datos de cada elemento se almacenan en el subnodo respectivo como una propiedad con el nombre del elemento: por ejemplo, el contenido del elemento text se almacena como propiedad text el jcr:content/data/master

  • Los metadatos y el contenido asociado se almacenan a continuación jcr:content/metadata
    Excepto el título y la descripción, que no se consideran metadatos tradicionales y se almacenan en jcr:content

Ubicación del recurso

Al igual que con los recursos estándar, un fragmento de contenido se encuentra en:

/content/dam

Permisos de recursos

Consulte Fragmento de contenido: Eliminar consideraciones.

Integración de funciones

Para integrar con el núcleo de Assets:

  • La función Administración de fragmentos de contenido (CFM) se basa en el núcleo Recursos.

  • CFM proporciona sus propias implementaciones para elementos en las vistas de tarjeta, columna o lista; estos se conectan a las implementaciones de representación de contenido de Assets existentes.

  • Se han ampliado varios componentes de Assets para adaptarse a los fragmentos de contenido.

Uso de fragmentos de contenido en páginas

AEM Se puede hacer referencia a los fragmentos de contenido desde páginas de recursos de la misma manera que desde cualquier otro tipo de recurso. AEM proporciona el Componente principal del fragmento de contenido - a componente que permite incluir fragmentos de contenido en las páginas. También puede ampliar esta Fragmento de contenido componente principal.

  • El componente utiliza el fragmentPath para hacer referencia al fragmento de contenido real. El fragmentPath La propiedad de se gestiona de la misma manera que propiedades similares de otros tipos de recursos; por ejemplo, cuando el fragmento de contenido se mueve a otra ubicación.

  • El componente permite seleccionar la variación que se desea mostrar.

  • Además, se puede seleccionar un rango de párrafos para restringir la salida; por ejemplo, esto se puede utilizar para la salida de varias columnas.

  • El componente permite contenido intermedio:

    • En este caso, el componente le permite colocar otros recursos (imágenes, etc.) entre los párrafos del fragmento al que se hace referencia.

    • Para contenido intermedio:

      • Tenga en cuenta la posibilidad de referencias inestables. El contenido intermedio (añadido al crear una página) no tiene relación fija con el párrafo situado junto a él. La inserción de un nuevo párrafo (en el editor de fragmentos de contenido) antes de la posición del contenido intermedio puede perder la posición relativa.

      • Tenga en cuenta los parámetros adicionales (como los filtros de variación y de párrafo) para configurar lo que se procesa en la página.

NOTA

Modelo de fragmento de contenido:

Cuando se utiliza un fragmento de contenido en una página, se hace referencia al modelo de fragmento de contenido en el que se basa.

Esto significa que si el modelo no se ha publicado en el momento de publicar la página, se marcará y el modelo se añadirá a los recursos que se publicarán con la página.

Integración con otros marcos

Los fragmentos de contenido se pueden integrar con:

  • Traducciones

    Los fragmentos de contenido están totalmente integrados con el AEM Flujo de trabajo de traducción. A nivel arquitectónico, esto significa:

    • Las traducciones individuales de un fragmento de contenido son fragmentos independientes; por ejemplo:

      • se encuentran en diferentes raíces de idioma, pero comparten la ruta relativa debajo de la raíz de idioma correspondiente:

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

        frente a

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

    • Además de las rutas basadas en reglas, no hay otra conexión entre las diferentes versiones de idioma de un fragmento de contenido. Se gestionan como dos fragmentos independientes, aunque la interfaz de usuario proporciona los medios para navegar entre las variantes de idioma.

    NOTA

    AEM El flujo de trabajo de traducción de funciona con /content:

    • Como residen los modelos de fragmento de contenido en /conf, no se incluyen en dichas traducciones. Puede internacionalizar las cadenas de interfaz de usuario.
  • Esquemas de metadatos

    • Los fragmentos de contenido utilizan y reutilizan esquemas de metadatos que se puede definir con recursos estándar.

    • CFM proporciona su propio esquema específico:

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

      esto se puede ampliar, si es necesario.

    • El formulario de esquema respectivo se integra con el editor de fragmentos.

La API de administración de fragmentos de contenido: del lado del servidor

Puede utilizar la API del lado del servidor para acceder a sus fragmentos de contenido; consulte:

com.adobe.cq.dam.cfm

PRECAUCIÓN

El Adobe recomienda utilizar la API del lado del servidor en lugar de acceder directamente a la estructura de contenido.

Interfaces clave

Las tres interfaces siguientes pueden servir como puntos de entrada:

  • Fragmento de contenido (FragmentoDeContenido)

    Esta interfaz permite trabajar con un fragmento de contenido de forma abstracta.

    La interfaz de le proporciona los medios para lo siguiente:

    • Administrar datos básicos (por ejemplo, obtener nombre; obtener/establecer título/descripción)

    • Acceso a metadatos

    • Elementos de acceso:

      • Lista de elementos

      • Obtener elementos por nombre

      • Creación de elementos (consulte Advertencias)

      • Acceder a datos de elementos (consulte ContentElement)

    • Variaciones de lista definidas para el fragmento

    • Crear variaciones globalmente

    • Administrar contenido asociado:

      • Enumerar colecciones
      • Agregar colecciones
      • Quitar colecciones
    • Acceso al modelo del fragmento

    Las interfaces que representan los elementos principales de un fragmento son:

    • Elemento de contenido (ContentElement)

      • Obtener datos básicos (nombre, título, descripción)

      • Obtener/establecer contenido

      • Variaciones de acceso de un elemento:

        • Variaciones de lista
        • Obtener variaciones por nombre
        • Crear variaciones (consulte Advertencias)
        • Eliminar variaciones (consulte Advertencias)
        • Acceso a datos de variación (consulte ContentVariation)
      • Método abreviado para resolver variaciones (aplicar alguna lógica de reserva adicional específica de la implementación si la variación especificada no está disponible para un elemento)

    • Variación de contenido (ContentVariation)

      • Obtener datos básicos (nombre, título, descripción)
      • Obtener/establecer contenido
      • Sincronización simple, basada en la información de la última modificación

    Las tres interfaces ( ContentFragment, ContentElement, ContentVariation) ampliar el Versionable La interfaz de, que agrega funcionalidades de versiones, necesarias para los fragmentos de contenido:

    • Crear una versión del elemento
    • Enumerar versiones del elemento
    • Obtener el contenido de una versión específica del elemento con versión

Adaptación: uso de adaptTo()

Se pueden adaptar las siguientes opciones:

  • ContentFragment se puede adaptar a:

    • Resource : el recurso de Sling subyacente; actualizar el recurso de Sling subyacente Resource requiere directamente la reconstrucción de ContentFragment objeto.

    • Asset - el DAM Asset abstracción que representa el fragmento de contenido; actualizar el fragmento de contenido Asset requiere directamente la reconstrucción de ContentFragment objeto.

  • ContentElement se puede adaptar a:

    • ElementTemplate - para acceder a la información estructural del elemento.
  • FragmentTemplate

  • Resource se puede adaptar a:

    • ContentFragment

Advertencias

Cabe señalar que:

  • Toda la API está diseñada para no mantener los cambios automáticamente (a menos que se indique lo contrario en el JavaDoc de la API). Por lo tanto, asigne siempre el solucionador de recursos de la solicitud correspondiente (o el solucionador que esté utilizando).

  • Tareas que pueden requerir un esfuerzo adicional:

    • El Adobe recomienda crear variaciones de ContentFragment. Esto garantiza que todos los elementos compartan esta variación y que las estructuras de datos globales adecuadas se actualicen según sea necesario para reflejar la nueva variación en la estructura de contenido.

    • Eliminación de variaciones existentes mediante un elemento, utilizando ContentElement.removeVariation(), no actualiza las estructuras de datos globales asignadas a la variación. Para asegurarse de que estas estructuras de datos se mantienen sincronizadas, utilice ContentFragment.removeVariation() en su lugar, elimina una variación de forma global.

La API de administración de fragmentos de contenido: del lado del cliente

PRECAUCIÓN

La API del lado del cliente es interna.

Información adicional

Consulte lo siguiente:

  • filter.xml

    El filter.xml para la administración de fragmentos de contenido está configurada para que no se superponga con el paquete de contenido principal de Assets.

Editar sesiones

PRECAUCIÓN

Tenga en cuenta esta información básica. Se supone que no debe cambiar nada aquí (ya que está marcado como zona privada en el repositorio), pero a veces puede ser útil comprender cómo funcionan las cosas bajo el capó.

La edición de un fragmento de contenido, que puede abarcar varias vistas (= páginas de HTML), es atómica. AEM Como estas funciones atómicas de edición de varias vistas no son un concepto típico de los fragmentos de contenido, utilizan lo que se denomina un elemento de edición de vista múltiple sesión de edición.

Se inicia una sesión de edición cuando el usuario abre un fragmento de contenido en el editor. La sesión de edición finaliza cuando el usuario abandona el editor seleccionando una de las siguientes opciones Guardar o Cancelar.

Técnicamente, todas las ediciones se realizan en live AEM contenido, al igual que con el resto de ediciones de la. Cuando se inicia la sesión de edición, se crea una versión del estado actual sin editar. Si un usuario cancela una edición, se restaura esa versión. Si el usuario hace clic en Guardar, no se realiza ninguna acción específica, ya que la edición se ejecutó en live contenido, por lo tanto todos los cambios ya se han mantenido. Además, haga clic en Guardar déclencheur algunos procesos en segundo plano, como la creación de información de búsqueda de texto completo o la administración de recursos de medios mixtos, o ambos.

Existen algunas medidas de seguridad para los casos extremos; por ejemplo, si el usuario intenta salir del editor sin guardar o cancelar la sesión de edición. Además, hay disponible un guardado automático periódico para evitar la pérdida de datos.
Dos usuarios pueden editar el mismo fragmento de contenido simultáneamente y, por lo tanto, sobrescribir los cambios de los demás. Para evitarlo, el fragmento de contenido debe bloquearse aplicando el de la administración DAM Finalizar compra acción en el fragmento.

Ejemplos

Ejemplo: Acceso a un fragmento de contenido existente

Para lograrlo, puede adaptar el recurso que representa la API a:

com.adobe.cq.dam.cfm.ContentFragment

Por ejemplo:

// 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
}

Ejemplo: Creación de un fragmento de contenido

Para crear un fragmento de contenido mediante programación, utilice un FragmentTemplate adaptado de un recurso de modelo.

Por ejemplo:

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

Ejemplo: Especificación del intervalo de guardado automático

El intervalo de guardado automático (medido en segundos) se puede definir mediante el administrador de configuración (ConfMgr):

  • Nodo: <conf-root>/settings/dam/cfm/jcr:content

  • Nombre de propiedad: autoSaveInterval

  • Tipo: Long

  • Predeterminado: 600 (10 minutos); se define en /libs/settings/dam/cfm/jcr:content

Si desea establecer un intervalo de guardado automático de 5 minutos, defina la propiedad en el nodo.

Por ejemplo:

  • Nodo: /conf/global/settings/dam/cfm/jcr:content

  • Nombre de propiedad: autoSaveInterval

  • Tipo: Long

  • Valor: 300 (5 minutos equivalen a 300 segundos)

Componentes para la creación de páginas

Para obtener más información, consulte

En esta página