Componenti di configurazione dei frammenti di contenuto per il rendering

Esistono diversi servizi avanzati correlati al rendering dei frammenti di contenuto. Per utilizzare questi servizi, i tipi di risorse di tali componenti devono essere resi noti al framework dei frammenti di contenuto.

Questa operazione viene eseguita configurando il servizio OSGi - configurazione componente frammento di contenuto.

Queste informazioni sono necessarie quando:

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

Si consiglia di utilizzare i componenti core.

ATTENZIONE
  • Se non avete bisogno dei servizi avanzati descritti di seguito, potete ignorare questa configurazione.

  • Quando si estendono o si utilizzano i componenti forniti, non è consigliabile modificare la configurazione OSGi.

  • È possibile scrivere un componente da zero che utilizza solo l'API dei frammenti di contenuto, senza servizi avanzati. Tuttavia, in tal caso, sarà necessario sviluppare il componente in modo che gestisca l’elaborazione appropriata.

Si consiglia pertanto di utilizzare i componenti core.

Definizione di servizi avanzati che richiedono la configurazione

I servizi che richiedono la registrazione di un componente sono:

  • Determinazione corretta delle dipendenze durante la pubblicazione (ad esempio, verificare che frammenti e modelli possano essere pubblicati automaticamente con una pagina se sono stati modificati dall’ultima pubblicazione).
  • Supporto per i frammenti di contenuto nella ricerca full-text.
  • Gestione/gestione di contenuti intermedi.
  • Gestione/gestione di risorse multimediali diverse.
  • Dispatcher flush per i frammenti di riferimento (se una pagina contenente un frammento viene pubblicata nuovamente).
  • Utilizzo del rendering basato su paragrafo.

Se hai bisogno di una o più di queste funzionalità, in genere è più semplice utilizzare i servizi avanzati out-of-the-box, invece di svilupparli da zero.

Servizio OSGi - Configurazione componente frammento di contenuto

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

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

NOTA

Per ulteriori informazioni, vedere Configurazione OSGi.

Esempio:

Configurazione del componente frammento di contenuto di configurazione OSGi

La configurazione OSGi è:

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

core/wcm/components/contentfragment/v1/contentfragment

Proprietà Reference dam.cfm.component.fileReferenceProp Nome della proprietà contenente il riferimento al frammento; ad esempio fragmentPath oppure fileReference
Proprietà Element(s) dam.cfm.component.elementsProp Il nome della proprietà che contiene i nomi degli elementi di cui eseguire il rendering; ad esempioelementName
Proprietà variante
dam.cfm.component.variationProp Il nome della proprietà che contiene il nome della variante da rappresentare; ad esempiovariationName

Per alcune funzionalità, il componente dovrà rispettare convenzioni predefinite. Nella tabella seguente sono illustrate le proprietà che devono essere definite dal componente per ciascun paragrafo (es. 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 la modalità di output dei paragrafi in modalità di rendering a elemento singolo.

Valori:

  • all : per eseguire il rendering di tutti i paragrafi
  • range : per eseguire il rendering dell'intervallo di paragrafi fornito da paragraphRange
paragraphRange

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

Formato:

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

Esempio

Ad esempio, vedete quanto segue (in un'istanza AEM out-of-the-box):

/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

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now