DocumentatieAEM 6.5Handboek

Inhoudsfragmenten die componenten voor rendering configureren content-fragments-configuring-components-for-rendering

Last update: Sun Jul 14 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Gemaakt voor:

  • Ontwikkelaar

Er zijn verscheidene geavanceerde dienstenmet betrekking tot het teruggeven van inhoudsfragmenten. Om deze diensten te gebruiken, moeten de middeltypes van dergelijke componenten zich aan het kader van inhoudsfragmenten bekendmaken.

Dit wordt gedaan door de Dienst OSGi te vormen - de Configuratie van de Component van het Fragment van de Inhoud.

CAUTION
Als u niet de gevorderde hieronder beschreven dienstennodig hebt, kunt u deze configuratie negeren.
CAUTION
Wanneer u de uit-van-de-doos component(en) uitbreidt of gebruikt, wordt het niet aanbevolen om de configuratie te wijzigen.
CAUTION
U kunt een geheel nieuwe component schrijven die alleen de API voor inhoudsfragmenten gebruikt, zonder geavanceerde services. In een dergelijk geval moet u de component echter zodanig ontwikkelen dat deze de juiste verwerking afhandelt.
Daarom wordt aanbevolen de kerncomponenten te gebruiken.

Definitie van de Geavanceerde Diensten die Configuratie vereisen definition-of-advanced-services-that-need-configuration

De diensten die de registratie van een component vereisen zijn:

  • De afhankelijkheden correct bepalen tijdens de publicatie (dat wil zeggen dat fragmenten en modellen automatisch met een pagina kunnen worden gepubliceerd als ze zijn gewijzigd sinds de laatste publicatie).
  • Ondersteuning voor inhoudsfragmenten in volledige tekstzoekopdracht.
  • Het beheer/de behandeling van in-tussen inhoud.
  • Het beheer/de behandeling van gemengde media activa.
  • Dispatcher wordt uitgelijnd op fragmenten waarnaar wordt verwezen (als een pagina met een fragment opnieuw wordt gepubliceerd).
  • Op alinea's gebaseerde rendering gebruiken.

Als u een of meer van deze functies nodig hebt, is het (doorgaans) eenvoudiger om de functie uit de doos te gebruiken in plaats van deze vanaf nul te ontwikkelen.

OSGi Service - Configuratie van de Component van het Fragment van de Inhoud osgi-service-content-fragment-component-configuration

De configuratie moet aan de OSGi dienst Configuratie van de Component van het Fragment van de Inhoud worden gebonden:

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

NOTE
Zie Vormend OSGivoor verdere details.

Bijvoorbeeld:

cfm-01

De configuratie OSGi is:

Label
OSGi-configuratie
Beschrijving
Het type Resource
dam.cfm.component.resourceType

Het brontype dat moet worden geregistreerd, bijvoorbeeld

core/wcm/components/contentfragment/v1/contentfragment

Verwijzing, eigenschap
dam.cfm.component.fileReferenceProp
De naam van de eigenschap die de verwijzing naar het fragment bevat, bijvoorbeeld fragmentPath of fileReference
Element(en), eigenschap
dam.cfm.component.elementsProp
De naam van de eigenschap die de naam/namen bevat van het element/de elementen die moeten worden gerenderd, bijvoorbeeldelementName
bezit van de Variatie
dam.cfm.component.variationProp
De naam van de eigenschap die de naam bevat van de variatie die moet worden gerenderd, bijvoorbeeldvariationName

Voor bepaalde functionaliteit (bijvoorbeeld om alleen een alineabereik te renderen) moet u zich aan een aantal conventies houden:

Eigenschapnaam
Beschrijving
paragraphRange

Een koordbezit dat de waaier van paragrafen bepaalt om te worden uitgevoerd als in enig element wijze teruggeeft.

Indeling:

  • 1 of 1-3 of 1-3;6;7-8 of *-3;5-*
  • alleen geëvalueerd als paragraphScope is ingesteld op range
paragraphScope

Een koordbezit dat bepaalt hoe de paragrafen moeten worden uitgevoerd als in enig element wijze teruggeeft.

Waarden:

  • all : alle alinea's renderen
  • range : voor het weergeven van het bereik van alinea's die worden geleverd door paragraphRange
paragraphHeadings
Een Booleaanse eigenschap die definieert of koppen (bijvoorbeeld h1 , h2 , h3 ) worden geteld als alinea's (true) of niet (false)
CAUTION
Dit kan veranderen in latere 6,5 mijlpalen.

Voorbeeld example

Zie bijvoorbeeld het volgende (op een uit-van-de-doos AEM instantie):

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

Dit bevat:

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"
recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2