Personalizar y ampliar fragmentos de contenido customizing-and-extending-content-fragments

Creación y administración de fragmentos de contenido y Creación de páginas con fragmentos de contenido para obtener más información sobre los fragmentos de contenido.

Administración de recursos y Personalización y ampliación de recursos para obtener más información sobre los recursos estándar.

Modelos de fragmento de contenido:

• Se utiliza para definir fragmentos de contenido que contienen contenido estructurado.
• 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 tanto, los cambios en el modelo pueden/afectarán a cualquier fragmento dependiente.
• Los modelos son tipos de datos integrados.
• Las funciones para agregar nuevas variaciones, etc., deben actualizar el fragmento en consecuencia.

Plantillas de fragmento de contenido:

• Se utiliza para definir fragmentos de contenido simples.
• Las plantillas definen la estructura (básica, de solo texto) de un fragmento de contenido cuando se crea.
• La plantilla se copia en el fragmento cuando se crea; por lo tanto, los cambios adicionales en la plantilla no se reflejarán en los fragmentos existentes.
• Las funciones para agregar nuevas variaciones, etc., deben actualizar el fragmento en consecuencia.
• Plantillas de fragmento de contenido funcionan de manera diferente a los de otros mecanismos de creación de plantillas dentro del ecosistema de AEM (por ejemplo, plantillas de página, etc.). Por lo tanto, deben considerarse por separado.
• Cuando se basa en una plantilla, el tipo MIME del contenido se administra en el contenido real; esto significa que cada elemento y variación puede tener un tipo MIME diferente.

Todo el contenido se almacena dentro de la variable 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:

  p. ej. 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 en jcr:content/data/master

A continuación se almacenan los metadatos y el contenido asociado jcr:content/metadata

Excepto el título y la descripción, que no se consideran metadatos tradicionales y se almacenan en jcr:content

Toda la información que no sea de contenido de un fragmento (como título, descripción, metadatos, estructura) se administra exclusivamente en el recurso principal.

El contenido del primer elemento de un fragmento se asigna a la representación original del recurso principal.

• Las variaciones (si hay alguna) del primer elemento se asignan a otras representaciones del recurso principal.

Los elementos adicionales (si existen) se asignan a subrecursos del recurso principal.

• El contenido principal de estos elementos adicionales se asigna a la representación original del subactivo correspondiente.
• Otras variaciones (si procede) de cualquier elemento adicional se corresponden con otras representaciones del subactivo respectivo.

El componente utiliza la variable fragmentPath para hacer referencia al fragmento de contenido real. La variable fragmentPath la propiedad se gestiona de la misma manera que las 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 va a mostrar.

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

El componente permite contenido intermedio:

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

  • Para el contenido intermedio, debe:

    • ser conscientes de la posibilidad de referencias inestables; el contenido intermedio (añadido al crear una página) no tiene relación fija con el párrafo al que está colocado, insertando un nuevo párrafo (en el editor de fragmentos de contenido) antes de que la posición del contenido intermedio pueda perder la posición relativa
      • considere los parámetros adicionales (como los filtros de variación y párrafo) para evitar falsos positivos en los resultados de búsqueda

Tipos de recursos

Una lista de sling:resourceTypes se puede proporcionar para definir los componentes que se utilizan para procesar fragmentos de contenido y a los que se debe aplicar el procesamiento en segundo plano.

Propiedades de referencia

Se puede configurar una lista de propiedades para especificar dónde se almacena la referencia al fragmento para el componente correspondiente.

El nombre de la propiedad donde se definen los elementos que se van a procesar debe ser: element o elementNames.

El nombre de la propiedad donde se define la variación que se va a procesar debe ser variation o variationName.

Si se admite la salida de varios elementos (utilizando elementNames para especificar varios elementos), el modo de visualización real se define mediante la propiedad displayMode:

• Si el valor es singleText (y solo hay un elemento configurado), el elemento se representa como texto con contenido intermedio, compatibilidad con el diseño, etc. Este es el valor predeterminado de los fragmentos en los que solo se procesa un elemento.
• De lo contrario, se utiliza un enfoque mucho más sencillo (podría llamarse "vista de formulario"), en el que no se admite contenido intermedio y el contenido del fragmento se representa "tal cual".

Si el fragmento se procesa para displayMode == singleText (implícita o explícitamente) entran en juego las siguientes propiedades adicionales:

• paragraphScope define si se deben representar todos los párrafos, o solo un rango de párrafos (valores: all vs. range)
• if paragraphScope == range luego la propiedad paragraphRange define el rango de párrafos que se van a procesar

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 en realidad fragmentos independientes; por ejemplo:

  • se encuentran bajo diferentes raíces lingüísticas:

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

    vs.

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

  • pero comparten exactamente la misma ruta relativa debajo de la raíz del idioma:

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

    vs.

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

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

Esquemas de metadatos

• Los fragmentos de contenido (re)utilizan la variable esquemas de metadatos, que se pueden 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 correspondiente se integra con el editor de fragmentos.

Plantilla de fragmento

Plantilla de fragmento

Uso FragmentTemplate.createFragment() para crear un nuevo fragmento.

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

Esta interfaz representa:

• un modelo de fragmento de contenido o una plantilla de fragmento de contenido desde la que crear un fragmento de contenido,
• y (tras la creación) la información estructural de dicho fragmento

Esta información puede incluir:

• Acceso a datos básicos (título, descripción)

• Acceda a plantillas/modelos para los elementos del fragmento:

  • Plantillas de elementos de lista
  • Obtener información estructural de un elemento determinado
  • Acceder a la plantilla de elemento (consulte ElementTemplate)

• Acceso a plantillas para las variaciones del fragmento:

  • Enumerar plantillas de variación
  • Obtener información estructural de una variación determinada
  • Acceder a la plantilla de variación (consulte VariationTemplate)

• Obtener contenido inicial asociado

Interfaces que representan información importante:

• ElementTemplate

  • Obtener datos básicos (nombre, título)
  • Obtener contenido del elemento inicial

• VariationTemplate

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

Fragmento de contenido

Fragmento de contenido

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

La interfaz le proporciona los medios para:

• Administrar datos básicos (por ejemplo, obtener nombre; get/set title/description)

• Acceso a metadatos

• Acceder a elementos:

  • Elementos de lista
  • Obtener elementos por nombre
  • Crear nuevos elementos (consulte Advertencias)
  • Acceso a datos de elementos (consulte ContentElement)

• Variaciones de lista definidas para el fragmento

• Crear nuevas variaciones globalmente

• Administrar contenido asociado:

  • Enumerar colecciones
  • Agregar colecciones
  • Eliminar colecciones

• Acceso al modelo o la plantilla del fragmento

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

• Elemento Contenido

  ContentElement
  

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

  • Obtener/Establecer contenido

  • Variaciones de acceso de un elemento:

    • Enumerar variaciones
    • Obtener variaciones por nombre
    • Crear nuevas variaciones (consulte Advertencias)
    • Eliminar variaciones (consulte Advertencias)
    • Acceso a los datos de variación (consulte ContentVariation)

  • Método abreviado para resolver variaciones (aplicar alguna lógica adicional de reserva específica de 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 sencilla, basada en la información modificada por última vez

Las tres interfaces ( ContentFragment, ContentElement, ContentVariation) amplíe el Versionable interfaz, que añade funciones de versiones, necesarias para los fragmentos de contenido:

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

ContentFragment puede adaptarse a:

• Resource - el recurso Sling subyacente; tenga en cuenta que actualizar el subyacente Resource directamente, requiere la reconstrucción del ContentFragment objeto.
• Asset - DAM Asset abstracción que representa el fragmento de contenido; tenga en cuenta que actualizar el Asset directamente, requiere la reconstrucción del ContentFragment objeto.

ContentElement puede adaptarse a:

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

FragmentTemplate puede adaptarse a:

• Resource - el Resource determinar el modelo al que se hace referencia o la plantilla original que se copió;

  • los cambios realizados a través de Resource no se reflejan automáticamente en la variable FragmentTemplate.

Resource puede adaptarse a:

• ContentFragment
• FragmentTemplate

La API está implementada para proporcionar funciones compatibles con la interfaz de usuario de .

Toda la API está diseñada para not persista los cambios automáticamente (a menos que se indique lo contrario en el JavaDoc de API). Por lo tanto, siempre tendrá que confirmar la resolución del recurso de la solicitud correspondiente (o la resolución que esté utilizando).

Tareas que pueden requerir un esfuerzo adicional:

• La creación/eliminación de nuevos elementos no actualizará la estructura de datos de fragmentos simples (basados en una plantilla de fragmento).
• Crear nuevas variaciones desde ContentElement no actualizará la estructura de datos (pero la creación global de ContentFragment ).
• La eliminación de variaciones existentes no actualizará la estructura de datos.

filter.xml

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

Inicio de una sesión

• Se crea una nueva versión del fragmento de contenido.
• Se ha iniciado el guardado automático.
• Las cookies están configuradas; definen el fragmento editado actualmente y que hay una sesión de edición abierta.

Finalización de una sesión

• Se ha detenido el guardado automático.

• Tras la confirmación:

  • Se actualiza la última información modificada.
  • Las cookies se eliminan.

• Tras la reversión:

  • Se restaura la versión del fragmento de contenido que se creó cuando se inició la sesión de edición.
  • Las cookies se eliminan.

Edición

• Todos los cambios (guardado automático incluido) se realizan en el fragmento de contenido activo, no en un área separada y protegida.
• Por lo tanto, esos cambios se reflejan inmediatamente en AEM páginas que hacen referencia al fragmento de contenido correspondiente

Introducción de una página

• Compruebe si ya existe una sesión de edición; comprobando la cookie respectiva.

  • Si existe, compruebe que la sesión de edición se inició para el fragmento de contenido que se está editando actualmente

    • Si el fragmento actual, restablezca la sesión.
    • Si no es así, intente cancelar la edición del fragmento de contenido editado anteriormente y eliminar las cookies (sin sesión de edición posterior).

  • Si no existe ninguna sesión de edición, espere al primer cambio realizado por el usuario (consulte a continuación).

• Compruebe si ya se hace referencia al fragmento de contenido en una página y muestre la información apropiada en caso afirmativo.

Cambio de contenido

• Siempre que el usuario cambia de contenido y no hay ninguna sesión de edición presente, se crea una nueva sesión de edición (consulte Inicio de una sesión).

Dejar una página

• Si hay una sesión de edición presente y los cambios no se han mantenido, se muestra un cuadro de diálogo de confirmación modal para notificar al usuario la posible pérdida de contenido y permitirle permanecer en la página.

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

Nombre de propiedad: autoSaveInterval

Tipo: Long

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

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

Nombre de propiedad: autoSaveInterval

Tipo: Long

Valor: 300 (5 minutos equivale a 300 segundos)