DokumentationAEM as a Cloud ServiceAnvändarhandbok

Innehållsfragment Konfigurera komponenter för återgivning content-fragments-configuring-components-for-rendering

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Skapat för:

  • Administratör
  • Utvecklare

Det finns flera avancerade tjänster som är relaterade till återgivningen av innehållsfragment. För att kunna använda dessa tjänster måste resurstyperna för sådana komponenter göra sig kända för innehållsfragmentets ramverk.

Detta görs genom att konfigurera OSGi-tjänsten - komponentkonfigurationen för innehållsfragment.

Denna information krävs när

  • Du måste implementera en egen innehållsfragmentbaserad komponent,
  • Och måste använda de avancerade tjänsterna.

Adobe rekommenderar att du använder kärnkomponenterna.

CAUTION

  • Om du inte behöver de avancerade tjänster som beskrivs nedan kan du ignorera den här konfigurationen.

  • När du utökar eller använder körklara komponenter bör du inte ändra OSGi-konfigurationen.

  • Du kan skriva en helt ny komponent som endast använder API:t för innehållsfragment, utan några avancerade tjänster. I så fall måste du dock utveckla komponenten så att den hanterar lämplig bearbetning.

Därför bör du använda kärnkomponenterna.

Definition av avancerade tjänster som behöver konfigureras definition-of-advanced-services-that-need-configuration

De tjänster som kräver registrering av en komponent är:

  • Kontrollera beroenden korrekt under publiceringen (d.v.s. se till att fragment och modeller kan publiceras automatiskt med en sida om de har ändrats sedan den senaste publiceringen).
  • Stöd för innehållsfragment vid fulltextsökning.
  • Hantering/hantering av mellanliggande innehåll.
  • Hantering/hantering av blandade medieresurser.
  • Dispatcher rensar för refererade fragment (om en sida som innehåller ett fragment publiceras om).
  • Använda styckebaserad återgivning.

Om du behöver en eller flera av de här funktionerna är det (oftast) enklare att använda de avancerade tjänsterna som är färdiga i stället för att utveckla dem från grunden.

OSGi-tjänst - Konfiguration av komponent för innehållsfragment osgi-service-content-fragment-component-configuration

Konfigurationen måste vara bunden till OSGi-tjänsten Konfiguration av komponent för innehållsfragment:

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

NOTE
Mer information finns i OSGi-konfiguration.

Till exempel:

Konfiguration av komponent för OSGi-konfigurationsfragment

OSGi-konfigurationen är:

Etikett
OSGi-konfiguration
Beskrivning
Resurstyp
dam.cfm.component.resourceType

Resurstypen som ska registreras, till exempel

core/wcm/components/contentfragment/v1/contentfragment

Referensegenskap
dam.cfm.component.fileReferenceProp
Namnet på egenskapen som innehåller referensen till fragmentet, till exempel fragmentPath eller fileReference
Elementegenskap(er)
dam.cfm.component.elementsProp
Namnet på den egenskap som innehåller namnen på elementen som ska återges, till exempelelementName
Variationsegenskap
dam.cfm.component.variationProp
Namnet på den egenskap som innehåller namnet på variationen som ska återges, till exempelvariationName

För vissa funktioner måste komponenten följa fördefinierade konventioner. Följande tabell visar vilka egenskaper som måste definieras, av komponenten, för varje stycke (det vill säga jcr:paragraph för varje komponentinstans) så att tjänsterna kan identifiera och bearbeta dem korrekt.

Egenskapsnamn
Beskrivning
paragraphScope

En strängegenskap som definierar hur stycken ska skrivas ut i renderingsläget för ett element.

Värden:

  • all : för att återge alla stycken
  • range : för att återge styckeintervallet från paragraphRange
paragraphRange

En strängegenskap som definierar det intervall med stycken som ska skrivas ut i renderingsläget för ett element.

Format:

  • 1 eller 1-3 eller 1-3;6;7-8 eller *-3;5-*

    • - intervallindikator
    • ; listavgränsare
    • * jokertecken

  • endast utvärderat om paragraphScope är inställt på range

paragraphHeadings
En boolesk egenskap som definierar om rubriker (till exempel h1, h2, h3) räknas som stycken (true) eller inte (false)

Exempel example

Se följande (i en AEM som inte finns i kartongen):

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

Detta innehåller:

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
fbcff2a9-b6fe-4574-b04a-21e75df764ab