Content Fragments – konfigurera komponenter för återgivning

Det finns flera avancerade tjänster relaterade till återgivning 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.

FÖRSIKTIGHET

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

FÖRSIKTIGHET

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

FÖRSIKTIGHET

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 konfiguration

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.
  • Skickar rensning för refererade fragment (om en sida som innehåller ett fragment publiceras igen).
  • 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

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

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

OBSERVERA

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. t.ex.

core/wcm/components/contentfragment/v1/contentfragment

Referensegenskap dam.cfm.component.fileReferenceProp Namnet på den egenskap som innehåller referensen till fragmentet. t.ex. fragmentPath eller fileReference
Elementegenskap(er) dam.cfm.component.elementsProp Namnet på den egenskap som innehåller namnen på de element som ska återges. t.ex.elementName
Variationsegenskap
dam.cfm.component.variationProp Namnet på den egenskap som innehåller namnet på variationen som ska återges. t.ex.variationName

För vissa funktioner (t.ex. för att endast återge ett styckeintervall) måste du följa vissa konventioner:

Egenskapsnamn Beskrivning
paragraphRange

En strängegenskap som definierar det styckeintervall som ska skrivas ut om det i renderingsläget för ett element är .

Format:

  • 1 eller 1-3 eller 1-3;6;7-8 eller *-3;5-*
  • utvärderas bara om paragraphScope är inställt på range
paragraphScope

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

Värden:

  • all : återge alla stycken
  • range : för att återge styckeintervallet som tillhandahålls av paragraphRange
paragraphHeadings En boolesk egenskap som definierar om rubriker (till exempel h1, h2, h3) räknas som stycken (true) eller inte (false)
FÖRSIKTIGHET

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

Exempel

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"

På denna sida