Fragmentos de contenido Configurar componentes para procesamiento

Existen varios servicios avanzados relacionados con la representación de fragmentos de contenido. Para utilizar estos servicios, los tipos de recursos de dichos componentes deben darse a conocer al marco de fragmentos de contenido.

Esto se lleva a cabo configurando la Configuración del componente de fragmento de contenido del servicio OSGi.

Esta información es necesaria cuando:

  • Debe implementar su propio componente basado en fragmentos de contenido,
  • Y necesita hacer uso de los servicios avanzados.

Se recomienda utilizar los componentes principales.

PRECAUCIÓN

  • Si no necesita los servicios avanzados descritos a continuación, puede omitir esta configuración.

  • Al ampliar o utilizar los componentes listos para usar, no se recomienda cambiar la configuración de OSGi.

  • Puede escribir un componente desde cero que utilice únicamente la API de fragmentos de contenido, sin servicios avanzados. Sin embargo, en este caso, tendrá que desarrollar el componente para que gestione el procesamiento adecuado.

Por lo tanto, se recomienda utilizar los componentes principales.

Definición de los servicios avanzados que necesitan configuración

Los servicios que requieren el registro de un componente son:

  • Determinar las dependencias correctamente durante la publicación (es decir, asegurarse de que los fragmentos y modelos se pueden publicar automáticamente con una página si han cambiado desde la última publicación).
  • Compatibilidad con fragmentos de contenido en la búsqueda de texto completo.
  • Administración/administración de contenido intermedio.
  • Administración/administración de recursos de medios mixtos.
  • Despegue del despachante para fragmentos a los que se hace referencia (si se vuelve a publicar una página que contiene un fragmento).
  • Mediante el procesamiento basado en párrafos.

Si necesita una o más de estas funciones, entonces (normalmente) es más fácil usar los servicios avanzados predeterminados, en lugar de desarrollarlos desde cero.

Servicio OSGi - Configuración del componente de fragmento de contenido

La configuración debe enlazarse al servicio OSGi Configuración del componente de fragmento de contenido:

com.adobe.cq.dam.cfm.impl.component.ComponentConfigImpl

NOTA

Consulte Configuración de OSGi para obtener más detalles.

Por ejemplo:

Configuración del componente de fragmento de contenido de configuración OSGi

La configuración OSGi es:

Etiqueta Configuración de OSGi
 Descripción
Tipo de medio dam.cfm.component.resourceType El tipo de recurso que se va a registrar; p. ej.

core/wcm/components/contentfragment/v1/contentfragment
Propiedad Reference dam.cfm.component.fileReferenceProp El nombre de la propiedad que contiene la referencia al fragmento; p. ej. fragmentPath o fileReference
Propiedad Element(s) dam.cfm.component.elementsProp El nombre de la propiedad que contiene los nombres de los elementos que se van a procesar; p. ej.elementName
Propiedad de variación
 dam.cfm.component.variationProp El nombre de la propiedad que contiene el nombre de la variación que se va a procesar; p. ej.variationName

Para algunas funciones, el componente tendrá que cumplir las convenciones predefinidas. En la tabla siguiente se detallan las propiedades que el componente debe definir para cada párrafo (p. ej. jcr:paragraph para cada instancia de componente) para que los servicios puedan detectarlos y procesarlos correctamente.

Nombre de propiedad Descripción
paragraphScope

Una propiedad de cadena que define cómo se van a generar los párrafos si se encuentra en modo de procesamiento de un solo elemento.

Valores:

  • all :: para procesar todos los párrafos
  • range :: para representar el rango de párrafos proporcionado por paragraphRange
paragraphRange

Una propiedad de cadena que define el rango de párrafos que se van a generar si se encuentra en modo de procesamiento de un solo elemento.

Formato:

  • 1 o 1-3 o 1-3;6;7-8 o *-3;5-*
    • - indicador de intervalo
    • ; Separador de lista
    • * comodín
  • solo se evalúa si paragraphScope está establecido en range
paragraphHeadings Una propiedad booleana que define si los encabezados (por ejemplo, h1, h2, h3) se cuentan como párrafos (true) o no (false)

Ejemplo

Como ejemplo, consulte lo siguiente (en una instancia de AEM lista para usar):

/apps/core/wcm/config/com.adobe.cq.dam.cfm.impl.component.ComponentConfigImpl-core-comp-v1.config

Contiene:

dam.cfm.component.resourceType="core/wcm/components/contentfragment/v1/contentfragment"
dam.cfm.component.fileReferenceProp="fragmentPath"
dam.cfm.component.elementsProp="elementName"
dam.cfm.component.variationProp="variationName"

En esta página