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

Last update: Sat Jul 13 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Ämnen:
Innehållsfragment

Skapat fö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.

CAUTION

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

CAUTION

När du utökar eller använder en eller flera komponenter som är klara att användas bör du inte ändra konfigurationen.

CAUTION

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 rekommenderas att kärnkomponenterna används.

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 färdiga funktionerna i stället för att utveckla dem från början.

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

Konfigurationen måste bindas till OSGi-tjänsten Komponentkonfiguration för innehållsfragment:

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

NOTE

Mer information finns i Konfigurera OSGi.

Till exempel:

cfm-01

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 (till exempel för att endast återge ett styckeintervall) måste du följa vissa konventioner:

Egenskapsnamn

Beskrivning

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-*
endast utvärderat om paragraphScope är inställt på range

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

paragraphHeadings

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

CAUTION

Detta kan förändras i senare 6,5 milstolpar.

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

19ffd973-7af2-44d0-84b5-d547b0dffee2