Componenti di configurazione dei frammenti di contenuto per il rendering

Ultimo aggiornamento: 2023-12-05

Ce ne sono diversi servizi avanzati relative al rendering dei frammenti di contenuto. Per utilizzare questi servizi, i tipi di risorse di tali componenti devono farsi conoscere nel framework dei frammenti di contenuto.

Questa operazione viene eseguita configurando Servizio OSGi - Configurazione del componente Frammento di contenuto.

Queste informazioni sono necessarie quando:

  • È necessario implementare un componente basato su frammenti di contenuto personalizzato,
  • E devono utilizzare i servizi avanzati.

L’Adobe consiglia di utilizzare i Componenti core.

ATTENZIONE
  • Se non è necessario servizi avanzati come descritto di seguito, puoi ignorare questa configurazione.

  • Quando estendi o utilizzi i componenti predefiniti, si sconsiglia di modificare la configurazione OSGi.

  • Puoi scrivere da zero un componente che utilizza solo l’API Frammenti di contenuto, senza servizi avanzati. Tuttavia, in questo caso, dovrai sviluppare il componente in modo che gestisca l’elaborazione appropriata.

Pertanto, si consiglia di utilizzare i Componenti core.

Definizione dei servizi avanzati che richiedono la configurazione

I servizi che richiedono la registrazione di un componente sono:

  • Determinare correttamente le dipendenze durante la pubblicazione (ovvero, assicurarsi che frammenti e modelli possano essere pubblicati automaticamente con una pagina se sono stati modificati dopo l’ultima pubblicazione).
  • Supporto per frammenti di contenuto nella ricerca full-text.
  • La gestione/gestione di contenuto intermedio.
  • La gestione/gestione di risorse multimediali diverse.
  • Svuotamento del Dispatcher per i frammenti di riferimento (se viene ripubblicata una pagina contenente un frammento).
  • Utilizzo del rendering basato su paragrafi.

Se hai bisogno di una o più di queste funzioni, in genere è più facile utilizzare i servizi avanzati preconfigurati, anziché svilupparli da zero.

Servizio OSGi - Configurazione del componente Frammento di contenuto

La configurazione deve essere associata al servizio OSGi Configurazione del componente Frammento di contenuto:

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

NOTA

Consulta Configurazione OSGi per ulteriori dettagli.

Ad esempio:

Configurazione OSGi: configurazione del componente Frammento di contenuto

La configurazione OSGi è:

Etichetta Configurazione OSGi
Descrizione
Tipo risorsa dam.cfm.component.resourceType Tipo di risorsa da registrare, ad esempio

core/wcm/components/contentfragment/v1/contentfragment

Proprietà di riferimento dam.cfm.component.fileReferenceProp Nome della proprietà che contiene il riferimento al frammento; ad esempio, fragmentPath o fileReference
Proprietà elemento/i dam.cfm.component.elementsProp Il nome della proprietà che contiene i nomi degli elementi da riprodurre; ad esempio,elementName
Proprietà variante
dam.cfm.component.variationProp Il nome della proprietà che contiene il nome della variante da riprodurre; ad esempio,variationName

Per alcune funzionalità il componente dovrà rispettare convenzioni predefinite. La tabella seguente descrive le proprietà che devono essere definite dal componente per ciascun paragrafo (ovvero jcr:paragraph per ogni istanza di componente) in modo che i servizi possano rilevarli ed elaborarli correttamente.

Nome proprietà Descrizione
paragraphScope

Una proprietà stringa che definisce come devono essere generati i paragrafi se in modalità di rendering di un singolo elemento.

Valori:

  • all : per eseguire il rendering di tutti i paragrafi
  • range : per riprodurre l’intervallo di paragrafi fornito da paragraphRange
paragraphRange

Una proprietà stringa che definisce l’intervallo di paragrafi da restituire se in modalità di rendering di un singolo elemento.

Formato:

  • 1 o 1-3 o 1-3;6;7-8 o *-3;5-*
    • - indicatore di intervallo
    • ; separatore di elenco
    • * carattere jolly
  • valutato solo se paragraphScope è impostato su range
paragraphHeadings Una proprietà booleana che definisce se le intestazioni (ad esempio, h1, h2, h3) vengono conteggiati come paragrafi (true) o meno (false)

Esempio

Ad esempio, consulta quanto segue (su un’istanza di AEM preconfigurata):

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

In questa pagina