Componenti di configurazione dei frammenti di contenuto per il rendering

Ce ne sono diversi servizi avanzati relativo al rendering di frammenti di contenuto. Per utilizzare questi servizi, i tipi di risorse di tali componenti devono diventare noti al framework dei frammenti di contenuto.

Questa operazione viene eseguita configurando il Servizio OSGi - Configurazione del 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 hai bisogno del servizi avanzati come descritto di seguito, puoi ignorare questa configurazione.

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

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

Pertanto, si consiglia di utilizzare i componenti core .

Definizione di servizi avanzati che richiedono la configurazione

I servizi che richiedono la registrazione di un componente sono:

  • Determinare correttamente le dipendenze durante la pubblicazione (ad esempio, verificare che frammenti e modelli possano essere pubblicati automaticamente con una pagina se sono cambiati dopo l’ultima pubblicazione).
  • Supporto dei frammenti di contenuto nella ricerca full-text.
  • Gestione/gestione delle contenuto intermedio.
  • Gestione/gestione delle risorse multimediali diverse.
  • Svuotamento del dispatcher per i frammenti a cui si fa riferimento (se una pagina contenente un frammento viene pubblicata nuovamente).
  • Utilizzo del rendering basato su paragrafi.

Se hai bisogno di una o più di queste funzioni, in genere è più semplice 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

Vedi Configurazione OSGi per ulteriori dettagli.

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à di riferimento dam.cfm.component.fileReferenceProp Nome della proprietà contenente il riferimento al frammento; ad esempio, fragmentPath o fileReference
Proprietà elemento/i dam.cfm.component.elementsProp 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 di cui eseguire il rendering; ad esempio,variationName

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

Nome proprietà Descrizione
paragraphScope

Proprietà stringa che definisce la modalità di output dei paragrafi in modalità di rendering di un singolo elemento.

Valori:

  • all : rendering di tutti i paragrafi
  • range : per rendere l'intervallo di paragrafi fornito da paragraphRange
paragraphRange

Proprietà stringa che definisce l'intervallo di paragrafi da visualizzare 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 gamma
    • ; separatore di elenco
    • * carattere jolly
  • solo se paragraphScope è impostato su range
paragraphHeadings Una proprietà booleana che definisce se le intestazioni (ad esempio, h1, h2, h3) sono conteggiati come paragrafi (true) o no (false)

Esempio

Ad esempio, consulta quanto segue (in 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