Anpassen und Erweitern von Inhaltsfragmenten customizing-and-extending-content-fragments

Erstellen und Verwalten von Inhaltsfragmenten und Seitenbearbeitung mit Inhaltsfragmenten.

Verwalten von Assets und Anpassen und Erweitern von Assets für weitere Informationen zu Standard-Assets.

Inhaltsfragmentmodelle:

• Dient zum Definieren von Inhaltsfragmenten, die strukturierte Inhalte enthalten.
• Inhaltsfragmentmodelle definieren die Struktur eines Inhaltsfragments, wenn dieses erstellt wird.
• Ein Fragment verweist auf das Modell. Änderungen am Modell können sich daher auf alle abhängigen Fragmente auswirken.
• Modelle werden anhand von Datentypen erstellt.
• Funktionen zum Hinzufügen neuer Varianten und dergleichen müssen das Fragment entsprechend aktualisieren.

Inhaltsfragmentvorlagen:

• wird zum Definieren von einfachen Inhaltsfragmenten verwendet.
• Vorlagen definieren die (einfache, schreibgeschützte) Struktur eines Inhaltsfragments bei seiner Erstellung.
• Die Vorlage wird beim Erstellen in das Fragment kopiert. sodass weitere Änderungen an der Vorlage nicht in vorhandenen Fragmenten übernommen werden.
• Funktionen zum Hinzufügen neuer Varianten und dergleichen müssen das Fragment entsprechend aktualisieren.
• Inhaltsfragmentvorlagen arbeiten anders als die anderen Vorlagen in der AEM-Umgebung (z. B. Seitenvorlagen usw.). Daher sollten sie getrennt betrachtet werden.
• Wenn der MIME-Typ des Inhalts auf einer Vorlage basiert, wird er anhand des tatsächlichen Inhalts verwaltet. Dies bedeutet, dass jedes Element und jede Variante einen anderen MIME-Typ haben kann.

Alle Inhalte werden im Knoten jcr:content/data des Assets gespeichert:

• Die Elementdaten werden im primären Unterknoten gespeichert:

  jcr:content/data/master

• Varianten werden unter einem Unterknoten gespeichert, der den Namen der Variante trägt:

  z. B. jcr:content/data/myvariation

• Die Daten der einzelnen Elemente werden im entsprechenden Unterknoten als Eigenschaft mit dem Elementnamen gespeichert:

  z. B. Inhalt des Elements text wird als Eigenschaft gespeichert text on jcr:content/data/master

Metadaten und verknüpfte Inhalte werden unten gespeichert jcr:content/metadata

Mit Ausnahme des Titels und der Beschreibung, die nicht als Metadaten im herkömmlichen Sinne gelten und in gespeichert werden jcr:content

Alle nicht inhaltsbezogenen Informationen eines Fragments (wie Titel, Beschreibung, Metadaten, Struktur) werden ausschließlich für das Haupt-Asset verwaltet.

Der Inhalt des ersten Elements eines Fragments wird der ursprünglichen Ausgabe des Haupt-Assets zugeordnet.

• Die Varianten (sofern vorhanden) des ersten Elements werden anderen Ausgabeformaten des Haupt-Assets zugeordnet.

Zusätzliche Elemente (sofern vorhanden) werden Teil-Assets des Haupt-Assets zugeordnet.

• Der Hauptinhalt dieser zusätzlichen Elemente wird dem ursprünglichen Ausgabeformat des jeweiligen Unter-Assets zugeordnet.
• Andere Varianten (falls zutreffend) zusätzlicher Elemente werden anderen Ausgabeformaten der jeweiligen Unter-Assets zugeordnet.

Die Komponente verwendet die fragmentPath-Eigenschaft für Verweise auf das tatsächliche Inhaltsfragment. Die fragmentPath-Eigenschaft wird wie ähnliche Eigenschaften anderer Asset-Typen gehandhabt, beispielsweise wenn das Inhaltsfragment zu einem anderen Speicherort verschoben wird.

Mit der Komponente können Sie die Variante auswählen, die angezeigt werden soll.

Außerdem kann eine Reihe von Absätzen ausgewählt werden, um die Ausgabe zu beschränken, z. B. für die Ausgabe in mehreren Spalten.

Die Komponente ermöglicht Zwischeninhalt:

• Die Komponente ermöglicht es Ihnen, andere Assets (Bilder usw.) zwischen den Absätzen des Fragments zu platzieren, auf das verwiesen wird.

  • Bei Zwischeninhalten müssen Sie:

    • beachten, dass Verweise möglicherweise instabil sind. Bei der Seitenbearbeitung hinzugefügte Zwischeninhalte haben keine feste Beziehung zu dem Absatz, neben dem sie platziert werden; es wird ein neuer Absatz (im Inhaltsfragment-Editor) eingefügt, bevor der Zwischeninhalt die relative Position verlieren kann.
      • die zusätzlichen Parameter (z. B. Varianten und Absatzfilter) berücksichtigen, um falsche Positivwerte in Suchergebnissen zu vermeiden

Ressourcentypen

Eine Liste von sling:resourceTypes kann bereitgestellt werden, um Komponenten zu definieren, die für die Wiedergabe von Inhaltsfragmenten verwendet werden und auf die die Hintergrundverarbeitung angewendet werden soll.

Referenzeigenschaften

Eine Liste von Eigenschaften kann konfiguriert werden, um anzugeben, wo der Verweis auf das Fragment für die jeweilige Komponente gespeichert wird.

Der Name der Eigenschaft, die das Rendern der Elemente definiert, muss element oder elementNames lauten.

Der Name der Eigenschaft, die das Rendern der Variante definiert, muss variation oder variationName lauten.

Falls die Ausgabe mehrerer Elemente (durch Verwendung von elementNames zur Angabe mehrerer Elemente) unterstützt wird, wird der tatsächliche Anzeigemodus durch die displayMode-Eigenschaft definiert:

• Falls der Wert singleText lautet (und nur ein Element konfiguriert ist), wird das Element als Text mit Zwischeninhalt, Layout-Unterstützung usw. gerendert. Dies ist die Standardeinstellung für Fragmente, in denen nur ein einzelnes Element gerendert wird.
• Andernfalls wird ein viel einfacherer Ansatz verwendet (könnte als "Formularansicht"bezeichnet werden), bei dem kein Zwischeninhalt unterstützt wird und der Fragmentinhalt unverändert wiedergegeben wird.

Falls das Fragment für displayMode == singleText (implizit oder explizit) gerendert wird, müssen auch folgende zusätzlichen Eigenschaften berücksichtigt werden:

• paragraphScope definiert, ob alle Absätze oder nur ein Absatzbereich gerendert werden sollen (Werte: all oder range).
• Falls paragraphScope == range, definiert die paragraphRange-Eigenschaft den Absatzbereich, der gerendert werden soll.

Übersetzungen

Inhaltsfragmente sind vollständig mit dem AEM-Übersetzungs-Workflow integriert. Auf Architekturebene bedeutet dies:

• Die einzelnen Übersetzungen eines Inhaltsfragments sind separate Fragmente, z. B.:

  • sie befinden sich unter verschiedenen Sprachstämmen:

    /content/dam/<path>/en/<to>/<fragment>

    im Vergleich zu

    /content/dam/<path>/de/<to>/<fragment>

  • sie verwenden jedoch genau denselben relativen Pfad unterhalb des Sprachstamms:

    /content/dam/<path>/en/<to>/<fragment>

    im Vergleich zu

    /content/dam/<path>/de/<to>/<fragment>

• Außer den regelbasierten Pfaden besteht keinerlei Verbindung zwischen den unterschiedlichen Sprachversionen von Inhaltsfragmenten. Sie werden als zwei separate Fragmente behandelt, obwohl die Benutzeroberfläche Funktionen zum Navigieren zwischen den Sprachvarianten beinhaltet.

Metadatenschemata

• Inhaltsfragmente verwenden Metadatenschemata (wieder), die mit Standard-Assets definiert werden können.

CFM bietet ein eigenes, spezifisches Schema:

/libs/dam/content/schemaeditors/forms/contentfragment

dieses kann bei Bedarf erweitert werden.

Das entsprechende Schemaformular ist mit dem Fragmenteditor integriert.

Fragmentvorlage

FragmentTemplate

Verwenden Sie FragmentTemplate.createFragment() zum Erstellen eines neuen Fragments.

Resource templateOrModelRsc = resourceResolver.getResource("...");
FragmentTemplate tpl = templateOrModelRsc.adaptTo(FragmentTemplate.class);
ContentFragment newFragment = tpl.createFragment(parentRsc, "A fragment name", "A fragment description.");

Diese Schnittstelle steht für:

• ein Inhaltsfragmentmodell oder eine Inhaltsfragmentvorlage, aus dem bzw. der Sie ein Inhaltsfragment erstellen können,
• und (nach dem Erstellen) die Strukturdaten des Fragments.

Diese Daten können Folgendes beinhalten:

• Zugriff auf grundlegende Daten (Titel, Beschreibung)

• Zugriff auf Vorlagen/Modelle für die Elemente des Fragments:

  • Listenelementvorlagen
  • Abrufen von Strukturinformationen für ein bestimmtes Element
  • Zugriff auf die Elementvorlage (siehe ElementTemplate)

• Zugriff auf Vorlagen für Varianten des Fragments:

  • Variantenvorlagen auflisten
  • Abrufen von Strukturdaten für eine bestimmte Variante
  • Zugriff auf die Variantenvorlage (siehe VariationTemplate)

• Erste verknüpfte Inhalte abrufen

Schnittstellen, die wichtige Informationen darstellen:

• ElementTemplate

  • Abrufen grundlegender Daten (Name, Titel)
  • Abrufen des anfänglichen Elementinhalts

• VariationTemplate

  • Abrufen grundlegender Daten (Name, Titel, Beschreibung)

Inhaltsfragment

ContentFragment

In dieser Schnittstelle können Sie abstrakt mit einem Inhaltsfragment arbeiten.

Die Schnittstelle bietet folgende Möglichkeiten:

• Verwalten grundlegender Daten (z. B. Abrufen von Namen, Abrufen/Festlegen von Titel, Beschreibung)

• Zugriff auf Metadaten

• Zugriff auf Elemente:

  • Auflisten von Elementen
  • Abrufen von Elementen nach Name
  • Erstellen neuer Elemente (siehe Einschränkungen)
  • Zugriff auf Elementdaten (siehe ContentElement)

• Auflisten der für das Fragment definierten Varianten

• Globales Erstellen neuer Varianten

• Verwalten zugeordneter Inhalte:

  • Auflisten von Sammlungen
  • Hinzufügen von Sammlungen
  • Entfernen von Sammlungen

• Zugreifen auf das Fragmentmodell oder Vorlage

Folgende Schnittstellen stehen für die Hauptelemente eines Fragments:

• Inhaltselement

  ContentElement
  

  • Abrufen grundlegender Daten (Name, Titel, Beschreibung)

  • Abrufen/Festlegen von Inhalten

  • Zugriff auf Varianten eines Elements:

    • Auflisten von Varianten
    • Abrufen von Varianten nach Name
    • Erstellen neuer Varianten (siehe Einschränkungen)
    • Entfernen von Varianten (siehe Einschränkungen)
    • Zugriff auf Variantendaten (siehe ContentVariation)

  • Tastaturbefehl zum Auflösen von Varianten (Anwenden zusätzlicher implementierungsspezifischer Ausweich-Logik, falls die angegebene Variante für ein Element nicht verfügbar ist)

• Inhaltsvariante

  ContentVariation
  

  • Abrufen grundlegender Daten (Name, Titel, Beschreibung)
  • Abrufen/Festlegen von Inhalten
  • Einfache Synchronisierung basierend auf den zuletzt geänderten Informationen

Alle drei Schnittstellen (ContentFragment, ContentElement, ContentVariation) erweitern die Versionable-Schnittstelle durch zusätzliche, für Inhaltsfragmente erforderliche Versionierungsfunktionen:

• Erstellen neuer Versionen des Elements
• Auflisten der Versionen des Elements
• Abrufen des Inhalts einer spezifischen Version des versionierten Elements

ContentFragment kann angepasst werden an:

• Resource – die zugrunde liegende Sling-Ressource. Beachten Sie, dass beim direkten Aktualisieren der zugrunde liegenden Resource das ContentFragment-Objekt neu erstellt werden muss.
• Asset – die DAM-Asset-Abstrahierung, die für das Inhaltsfragment steht. Beachten Sie, dass beim direkten Aktualisieren des Asset das ContentFragment-Objekt neu erstellt werden muss.

ContentElement kann angepasst werden an:

• ElementTemplate – für den Zugriff auf die Strukturdaten des Elements.

FragmentTemplate kann angepasst werden an:

• Resource – die Resource, die das Modell, auf das verwiesen wird, oder die ursprüngliche Vorlage, die kopiert wurde, bestimmt.

  • An der Resource vorgenommene Änderungen werden nicht automatisch für die FragmentTemplate übernommen.

Resource kann angepasst werden an:

• ContentFragment
• FragmentTemplate

Die API ist implementiert, um Funktionen bereitzustellen, die von der Benutzeroberfläche unterstützt werden.

Die gesamte API ist so konzipiert, dass Änderungen nicht automatisch persistent gespeichert werden (es sei denn, dies ist anders in der Java-Dokumentation der API angegeben). Daher müssen Sie immer den Ressourcenkonfliktlöser der entsprechenden Anfrage (oder den tatsächlich verwendeten Konfliktlöser) festlegen.

Aufgaben, für die möglicherweise zusätzliche Arbeitsschritte erforderlich sind:

• Durch das Erstellen/Entfernen neuer Elemente wird die Datenstruktur einfacher Fragmente (basierend auf einer Fragmentvorlage) nicht aktualisiert.
• Beim Erstellen neuer Varianten auf Basis von ContentElement wird die Datenstruktur nicht aktualisiert (beim globalen Erstellen auf Basis von ContentFragment wird sie jedoch aktualisiert).
• Durch das Entfernen vorhandener Varianten wird die Datenstruktur nicht aktualisiert.

filter.xml

filter.xml für die Inhaltsfragmentverwaltung ist so konfiguriert, dass es sich nicht mit dem Hauptinhaltspaket für Assets überschneidet.

Starten einer Sitzung

• Eine neue Version des Inhaltsfragments wird erstellt.
• Das automatische Speichern wird gestartet.
• Cookies werden festgelegt. Diese definieren das derzeit bearbeitete Fragment und den Status „offene Bearbeitungssitzung“.

Beenden einer Sitzung

• Die automatische Speicherung wird angehalten.

• Beim Speichern:

  • Die zuletzt geänderten Informationen werden aktualisiert.
  • Cookies werden entfernt.

• Beim Rollback:

  • Die Version des Inhaltsfragments, die beim Starten der Bearbeitungssitzung erstellt wurde, wird wiederhergestellt.
  • Cookies werden entfernt.

Bearbeiten

• Alle Änderungen (automatisches Speichern eingeschlossen) werden im aktiven Inhaltsfragment vorgenommen, nicht in einem separaten, geschützten Bereich.
• Daher werden diese Änderungen sofort auf AEM Seiten angezeigt, die auf das entsprechende Inhaltsfragment verweisen

Einstieg in eine Seite

• Überprüfen Sie, ob bereits eine Bearbeitungssitzung vorhanden ist. durch Überprüfung des entsprechenden Cookies.

  • Wenn eine existiert, überprüfen Sie, ob die Bearbeitungssitzung für das Inhaltsfragment gestartet wurde, das derzeit bearbeitet wird.

    • Wenn das aktuelle Fragment vorhanden ist, stellen Sie die Sitzung wieder her.
    • Wenn nicht, versuchen Sie, die Bearbeitung für das zuvor bearbeitete Inhaltsfragment abzubrechen und Cookies zu entfernen (danach ist keine Bearbeitungssitzung mehr vorhanden).

  • Wenn keine Bearbeitungssitzung vorhanden ist, warten Sie auf die erste vom Benutzer vorgenommene Änderung (siehe unten).

• Überprüfen Sie, ob das Inhaltsfragment bereits auf einer Seite referenziert ist, und zeigen Sie entsprechende Informationen an, falls dies der Fall ist.

Inhaltsänderung

• Jedes Mal, wenn ein Benutzer Inhalte ändert und keine Bearbeitungssitzung vorhanden ist, wird eine Bearbeitungssitzung erstellt (siehe Starten einer Sitzung).

Verlassen einer Seite

• Falls eine Bearbeitungssitzung vorhanden ist und die Änderungen nicht persistent gespeichert wurden, wird ein Modal-Bestätigungsdialogfeld angezeigt, um den Benutzer über potenziell verloren gegangene Daten zu benachrichtigen und es ihm zu ermöglichen, auf der Seite zu bleiben.

Knoten: <conf-root>/settings/dam/cfm/jcr:content

Eigenschaftsname: autoSaveInterval

Typ: Long

Standard: 600 (10 Minuten); wird definiert in /libs/settings/dam/cfm/jcr:content

Knoten: /conf/global/settings/dam/cfm/jcr:content

Eigenschaftsname: autoSaveInterval

Typ: Long

Wert: 300 (5 Minuten entsprechen 300 Sekunden)