Inhaltsfragmente, die Komponenten für die Wiedergabe konfigurieren

Es gibt mehrere erweiterte Dienste zum Rendern von Inhaltsfragmenten. Um diese Dienste zu verwenden, müssen sich die Ressourcentypen dieser Komponenten dem Inhaltsfragmente-Framework bekannt machen.

Dies erfolgt durch die Konfiguration von OSGi-Dienst – Konfiguration der Inhaltsfragment-Komponente.

VORSICHT

Wenn Sie die unten beschriebenen erweiterten Dienste nicht benötigen, können Sie diese Konfiguration ignorieren.

VORSICHT

Wenn Sie die vordefinierte(n) Komponente(n) erweitern oder verwenden, wird eine Änderung der Konfiguration nicht empfohlen.

VORSICHT

Sie können eine Komponente von Grund auf neu schreiben, die nur die Inhaltsfragmente-API verwendet, ohne die erweiterten Dienste zu nutzen. In einem solchen Fall müssen Sie Ihre Komponente jedoch so entwickeln, dass sie die entsprechende Verarbeitung übernimmt.

Daher wird die Verwendung der Kernkomponenten empfohlen.

Definition erweiterter Dienste, die konfiguriert werden müssen

Die Dienste, die die Registrierung einer Komponente erfordern:

  • bestimmen Abhängigkeiten während der Veröffentlichung korrekt (d. h. stellen sicher, dass Fragmente und Modelle automatisch mit einer Seite veröffentlicht werden können, wenn sie sich seit der letzten Veröffentlichung geändert haben),
  • unterstützen Inhaltsfragmente in der Volltextsuche,
  • verwalten/bearbeiten Zwischeninhalte,
  • verwalten/bearbeiten gemischte Medien-Assets,
  • Dispatcher-Flush für referenzierte Fragmente (wenn eine Seite, die ein Fragment enthält, erneut veröffentlicht wird),
  • verwenden absatzbasiertes Rendering.

Wenn Sie eine oder mehrere dieser Funktionen benötigen, ist es (in der Regel) einfacher, die vordefinierte Funktion zu verwenden, anstatt sie von Grund auf neu zu entwickeln.

OSGi-Dienst – Konfiguration der Inhaltsfragment-Komponente

Die Konfiguration muss an den OSGi-Dienst Konfiguration der Inhaltsfragment-Komponente gebunden sein:

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

HINWEIS

Weitere Informationen finden Sie unter Konfigurieren von OSGi .

Beispiel:

cfm-01

Die OSGi-Konfiguration lautet:

Bezeichnung OSGi-Konfiguration
Beschreibung
Ressourcentyp dam.cfm.component.resourceType Der zu registrierende Ressourcentyp; z. B.

core/wcm/components/contentfragment/v1/contentfragment

Verweiseigenschaft dam.cfm.component.fileReferenceProp Der Name der Eigenschaft, die den Verweis auf das Fragment enthält; z. B. fragmentPath oder fileReference
Elementeigenschaft dam.cfm.component.elementsProp Der Name der Eigenschaft, die die Namen der Elemente enthält, die gerendert werden sollen; z. B.elementName
Varianteneigenschaft
dam.cfm.component.variationProp Der Name der Eigenschaft, die den Namen der zu rendernden Variante enthält; z. B.variationName

Für einige Funktionen (z. B. um nur einen Absatzbereich zu rendern) müssen Sie einige Konventionen einhalten:

Eigenschaftsname Beschreibung
paragraphRange

Eine Zeichenfolgeneigenschaft, die den Bereich der Absätze definiert, die ausgegeben werden sollen, wenn sie sich im Rendermodus für einzelne Elemente befinden.

Format:

  • 1 oder 1-3 oder 1-3;6;7-8 oder *-3;5-*
  • nur ausgewertet, wenn paragraphScope = range
paragraphScope

Eine Zeichenfolgeneigenschaft, die definiert, wie Absätze ausgegeben werden sollen, wenn sie sich im Rendermodus für einzelne Elemente befinden.

Werte:

  • all : zum Rendern aller Absätze
  • range : zum Rendern des Bereichs der Absätze, die hier angegeben sind: paragraphRange
paragraphHeadings Eine boolesche Eigenschaft, die definiert, ob Überschriften (z. B. h1, h2, h3) als Absätze (true) oder nicht als Absätze (false) gezählt werden sollen
VORSICHT

Dies kann sich in späteren 6,5 Meilensteinen ändern.

Beispiel

Sehen Sie sich folgendes Beispiel (in einer vordefinierten AEM-Instanz) an:

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

Es umfasst:

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"

Auf dieser Seite