Un fragmento de contenido amplía un recurso estándar; consulte:
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.
La partes constitutivas de un fragmento de contenido son:
Según el tipo de fragmento, también se utilizan modelos o plantillas:
Modelos de fragmento de contenido para crear todos los fragmentos nuevos.
Los modelos de fragmento de contenido se utilizan en todos los ejemplos de WKND.
Antes de AEM 6.3, los fragmentos de contenido se creaban en función de plantillas en lugar de modelos.
Las plantillas de fragmento de contenido ya no se utilizan. Pueden seguir utilizándose para crear fragmentos, pero se recomienda utilizar modelos de fragmento de contenido en su lugar. No se agregarán nuevas funciones a las plantillas de fragmento y se eliminarán en una versión futura.
Modelos de fragmento de contenido:
Cualquier cambio en un modelo de fragmento de contenido existente puede afectar a los fragmentos dependientes; esto puede llevar a propiedades huérfanas en esos fragmentos.
Plantillas de fragmento de contenido:
La administración de fragmentos de contenido (CFM) forma parte de AEM Assets como:
Los fragmentos de contenido con contenido estructurado (es decir, basados en un modelo de fragmento de contenido) se asignan a un único recurso:
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
Los fragmentos de contenido simples (basados en una plantilla) se asignan a una composición compuesta que consta de un recurso principal y subrecursos (opcionales):
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.
Los elementos adicionales (si existen) se asignan a subrecursos del recurso principal.
Al igual que con los recursos estándar, un fragmento de contenido se mantiene en:
/content/dam
Para obtener más información, consulte Fragmento de contenido: Eliminar consideraciones.
La variable Componente principal del fragmento de contenido ahora se recomienda. Consulte Desarrollo de componentes principales para obtener más información.
Se puede hacer referencia a los fragmentos de contenido desde AEM páginas, igual que a cualquier otro tipo de recurso. AEM proporciona la variable Fragmento de contenido componente principal - componente que permite incluir fragmentos de contenido en las páginas. También puede ampliar, esto Fragmento de contenido componente principal.
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:
Modelo de fragmento de contenido:
Cuando se utiliza un fragmento de contenido basado en un modelo de fragmento de contenido en una página, se hace referencia al modelo. 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.
Plantilla de fragmento de contenido:
Cuando se utiliza un fragmento de contenido basado en una plantilla de fragmento de contenido en una página, no hay referencia ya que la plantilla se copió al crear el fragmento.
La implementación back-end de los fragmentos de contenido es, por ejemplo, responsable de hacer que las instancias de un fragmento se utilicen en una página en la que se pueda buscar, o de administrar el contenido de medios mixtos. Esta implementación debe saber qué componentes se utilizan para procesar fragmentos y cómo se parametriza la renderización.
Los parámetros para esto se pueden configurar en la variable Consola web, para el paquete OSGi Configuración del componente de fragmento de contenido.
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.
No hay asignación directa entre propiedad y tipo de componente.
AEM simplemente toma la primera propiedad que se puede encontrar en un párrafo. Por lo tanto, debe elegir las propiedades con cuidado.
Todavía hay algunas directrices que debe seguir para asegurarse de que el componente sea compatible con el procesamiento de fondo del fragmento de contenido:
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
:
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.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
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 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.
El flujo de trabajo de traducción AEM funciona con /content
:
Como los modelos de fragmentos de contenido residen en /conf
, no se incluyen en dichas traducciones. Puede internacionalizar las cadenas de la interfaz de usuario.
Las plantillas se copian para crear el fragmento, por lo que está implícito.
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.
Puede utilizar la API del lado del servidor para acceder a los fragmentos de contenido; consulte:
Se recomienda utilizar la API del lado del servidor en lugar de acceder directamente a la estructura de contenido.
Las tres interfaces siguientes pueden servir como puntos de entrada:
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:
Esta información puede incluir:
Acceso a datos básicos (título, descripción)
Acceda a plantillas/modelos para los elementos del fragmento:
ElementTemplate
)Acceso a plantillas para las variaciones del fragmento:
VariationTemplate
)Obtener contenido inicial asociado
Interfaces que representan información importante:
ElementTemplate
VariationTemplate
Fragmento de contenido (Fragmento de contenido)
Esta interfaz le permite trabajar con un fragmento de contenido de forma abstracta.
Se recomienda acceder a un fragmento a través de esta interfaz. Se debe evitar cambiar la estructura de contenido directamente.
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:
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:
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)
Las tres interfaces ( ContentFragment
, ContentElement
, ContentVariation
) amplíe el Versionable
interfaz, que añade funciones de versiones, necesarias para los fragmentos de contenido:
Se puede adaptar lo siguiente:
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ó;
Resource
no se reflejan automáticamente en la variable FragmentTemplate
.Resource
puede adaptarse a:
ContentFragment
FragmentTemplate
Cabe señalar que:
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.
Para AEM 6.5, la API del lado del cliente es interna.
Consulte lo siguiente:
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.
Una sesión de edición se inicia cuando el usuario abre un fragmento de contenido en una de las páginas del editor. La sesión de edición finaliza cuando el usuario abandona el editor seleccionando una de las opciones siguientes: Guardar o Cancelar.
Los requisitos para controlar una sesión de edición son:
Los procesos involucrados son:
Inicio de una sesión
Finalización de una sesión
Se ha detenido el guardado automático.
Tras la confirmación:
Tras la reversión:
Edición
Las posibles acciones son:
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 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
Dejar una página
Para conseguirlo, 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
}
Para crear un nuevo fragmento de contenido mediante programación, debe utilizar:
com.adobe.cq.dam.cfm.ContentFragmentManager#create
Por ejemplo:
Resource templateOrModelRsc = resourceResolver.getResource("...");
FragmentTemplate tpl = templateOrModelRsc.adaptTo(FragmentTemplate.class);
ContentFragment newFragment = tpl.createFragment(parentRsc, "A fragment name", "A fragment description.");
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); esto se define en /libs/settings/dam/cfm/jcr:content
Si desea establecer un intervalo de guardado automático de 5 minutos, debe definir 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 equivale a 300 segundos)
Consulte Plantillas de fragmento de contenido para obtener más información.
Para obtener más información, consulte