Bearbeitbare Vorlagen editable-templates

Erfahren Sie, wie bearbeitbare Vorlagen beim Erstellen einer Seite, beim Definieren des anfänglichen Inhalts, des strukturierten Inhalts, der Authoring-Richtlinien und des Layouts verwendet werden.

Überblick overview

Beim Erstellen einer Seite müssen Sie eine Vorlage auswählen. Die Seitenvorlage wird als Basis für die neue Seite genutzt. Die Vorlage kann die Struktur der resultierenden Seite, jeden anfänglichen Inhalt und die Komponenten definieren, die verwendet werden können (Designeigenschaften).

Seitenvorlagen zum Erstellen von Seiten, die mit dem universellen Editor bearbeitbar sind, verwenden eine begrenzte Untergruppe bearbeitbarer Vorlagenfunktionen. Daher konzentriert sich der Rest dieses Dokuments auf bearbeitbare Vorlagen, die zum Erstellen von Seiten verwendet werden, die mit dem Seiteneditor bearbeitet werden können.

Bearbeitbare Vorlagen und Seiten, die mit dem Seiten-Editor bearbeitet wurden page-editor

Beim Erstellen von Vorlagen zum Erstellen von Seiten, die mit dem Seiteneditor bearbeitet werden können, werden normalerweise spezialisierte Autoren identifiziert.

Mit bearbeitbaren Vorlagen werden die Aspekte, die eine Seite bilden, innerhalb von Komponenten isoliert. Sie können die erforderlichen Komponentenkombinationen über eine Benutzeroberfläche konfigurieren. Damit entfällt die Notwendigkeit, für jede Seitenvariante eine neue Seitenkomponente zu entwickeln.

Dieses Dokument:

Erstellen einer neuen bearbeitbaren Vorlage creating-a-new-template

Bearbeitbare Vorlagen werden von Vorlagenautoren in erster Linie mit der Vorlagenkonsole und dem Vorlagen-Editor erstellt. In diesem Abschnitt finden Sie einen Überblick über diesen Prozess, der anschließend aus technischer Perspektive beleuchtet wird.

Gehen Sie wie folgt vor, um eine bearbeitbare Vorlage zu erstellen:

Vorlagenordner template-folders

Zum Organisieren Ihrer Vorlagen können Sie die folgenden Ordner verwenden:

In einer Standard-AEM-Instanz ist der Ordner global bereits in der Vorlagenkonsole vorhanden. Er enthält Standardvorlagen und dient als Ausweichlösung, wenn keine Richtlinien und/oder Vorlagentypen im aktuellen Ordner gefunden werden. Sie können Ihre Standardvorlagen entweder zu diesem Ordner hinzufügen oder aber einen Ordner erstellen (empfohlen).

Arten von Vorlagen und Richtlinien werden gemäß der folgenden Rangordnung in allen Ordnern übernommen:

Eine Liste aller zulässigen Einträge wird erstellt. Wenn sich Konfigurationen (path/label) überschneiden, wird den Benutzern nur die Instanz angezeigt, die dem aktuellen Ordner am nächsten ist.

Zum Erstellen eines Ordners stehen Ihnen die folgenden Optionen zur Auswahl:

Verwenden von CRXDE Lite using-crxde-lite

Verwenden des Konfigurations-Browsers using-the-configuration-browser

ACLs und Gruppen acls-and-groups

Sobald Ihre Vorlagenordner erstellt sind (entweder über CRXDE oder den Konfigurations-Browser), müssen ACLs für die entsprechenden Gruppen für die Vorlagenordner definiert werden, um ein angemessenes Maß an Sicherheit zu gewährleisten.

Die Vorlagenordner für das WKND-Tutorial können als Beispiel herangezogen werden.

Die Gruppe „template-authors“ the-template-authors-group

Die Gruppe template-authors ist die Gruppe zum Verwalten des Zugriffs auf Vorlagen und standardmäßig in AEM integriert. Sie ist aber leer. Benutzer müssen der Gruppe für das Projekt bzw. die Site hinzugefügt werden.

In der folgenden Tabelle sind die erforderlichen Berechtigungen für die Bearbeitung von Vorlagen aufgeführt.

Diese standardmäßige template-authors-Gruppe umfasst nur die Projekteinstellungen, bei denen alle Mitglieder von template-authors auf alle Vorlagen zugreifen und diese erstellen dürfen. Für komplexere Setups, bei denen mehrere Vorlagenautorengruppen benötigt werden, um einen getrennten Zugriff auf Vorlagen zu ermöglichen, müssen weitere benutzerdefinierte Vorlagenautorengruppen erstellt werden. Die Berechtigungen für die Vorlagenautorengruppen bleiben dabei jedoch dieselben.

Vorlagentyp template-type

Beim Erstellen einer Vorlage müssen Sie einen Vorlagentyp angeben:

Die vordefinierten Vorlagentypen werden unter folgendem Pfad gespeichert:

Ihre Site-spezifischen Vorlagentypen sollten an einer mit dem folgenden Pfad vergleichbaren Stelle gespeichert werden:

Definitionen für Ihre benutzerdefinierten Vorlagentypen sollten in benutzerdefinierten Ordnern (empfohlen) oder alternativ im Ordner global gespeichert werden. Zum Beispiel:

Erstellen von Vorlagentypen creating-template-types

Wenn Sie eine Vorlage erstellt haben, die als Grundlage für andere Vorlagen dienen kann, können Sie diese Vorlage als Vorlagentyp kopieren.

Sie können auch Ihren eigenen Vorlagentyp entwickeln, indem Sie eine bearbeitbare Beispielvorlage von GitHub als Grundlage verwenden.

CODE AUF GITHUB

Den Code dieser Seite finden Sie auf GitHub.

Vorlagendefinitionen template-definitions

Definitionen für bearbeitbare Vorlagen werden in benutzerdefinierten Ordnern (empfohlen) oder alternativ im Ordner global gespeichert. Zum Beispiel:

Der Stammknoten der Vorlage weist den Typ cq:Template und das folgende Strukturgerüst auf:

<template-name>
  initial
    jcr:content
      root
        <component>
        ...
        <component>
  jcr:content
    @property status
  policies
    jcr:content
      root
        @property cq:policy
        <component>
          @property cq:policy
        ...
        <component>
          @property cq:policy
  structure
    jcr:content
      root
        <component>
        ...
        <component>
      cq:responsive
        breakpoints
  thumbnail.png

Die Hauptelemente sind:

jcr:content jcr-content

Dieser Knoten enthält Eigenschaften für die Vorlage:

Struktur structure

Definiert die Struktur der resultierenden Seite:

Anfänglicher Inhalt initial-content

Definiert den anfänglichen Inhalt, den eine neue Seite bei Erstellung enthält:

Layout layout

Beim Bearbeiten einer Vorlage können Sie das Layoutdefinieren. Dabei wird das standardmäßige responsive Layout verwendet, dasverwendet und vom Inhaltsautor auf der Seite konfiguriert werden kann.

Inhaltsrichtlinien content-policies

Die Richtlinien für Inhalte definieren die Design-Eigenschaften einer Komponente. Zum Beispiel die verfügbaren Komponenten oder minimale/maximale Abmessungen. Diese sind auf die Vorlage anwendbar (und auf Seiten, die mit der Vorlage erstellt wurden). Inhaltsrichtlinien können mit dem Vorlageneditor erstellt und ausgewählt werden.

Seitenrichtlinien page-policies

Seitenrichtlinien ermöglichen es, die Inhaltsrichtlinie für die Seite (Hauptabsatzsystem) entweder in der Vorlage oder den resultierenden Seiten zu definieren.

Aktivieren und Zulassen einer Vorlage enabling-and-allowing-a-template-for-use

Resultierende Inhaltsseiten resultant-content-pages

Für Seiten, die anhand bearbeitbarer Vorlagen erstellt wurden, gilt Folgendes:

Das obige Diagramm veranschaulicht, wie Vorlagen, Inhalte und Komponenten zusammenhängen:

Beim Rendern einer Seite:

Verfügbarkeit von Vorlagen template-availability

Beim Erstellen einer neuen Seite in der Site-Admin-Oberfläche hängt die Liste der verfügbaren Vorlagen vom Speicherort der neuen Seite und den in den einzelnen Vorlagen angegebenen Platzierungsbeschränkungen ab.

Die folgenden Eigenschaften bestimmen, ob eine Vorlage T für eine neue Seite verwendet werden darf, die der Seite P untergeordnet platziert werden kann. Jede dieser Eigenschaften ist eine mehrwertige Zeichenfolge, welche null oder mehrere reguläre Ausdrücke enthält, die für die Übereinstimmung mit Pfaden verwendet werden:

Die Bewertung funktioniert wie folgt:

Das folgende Diagramm zeigt den Vorlagenauswertungsprozess:

Einschränkende Vorlagen in untergeordneten Seiten limiting-templates-used-in-child-pages

Um zu begrenzen, welche Vorlagen zum Erstellen von untergeordneten Seiten unter einer bestimmten Seite verwendet werden können, verwenden Sie die Eigenschaft cq:allowedTemplates des Knotens jcr:content auf der Seite. Damit lässt sich die Liste der Vorlagen angeben, die als untergeordnete Seiten zulässig sein sollen. Jeder Wert in der Liste muss ein absoluter Pfad zu einer Vorlage für eine zulässige untergeordnete Seite sein, zum Beispiel /apps/wknd/templates/page-content.

Sie können die Eigenschaft cq:allowedTemplates im Knoten jcr:content der Vorlage verwenden, damit diese Konfiguration auf alle erstellten Seiten angewendet wird, die diese Vorlage nutzen.

Wenn Sie mehrere Einschränkungen hinzufügen möchten, z. B. bezüglich der Vorlagenhierarchie, können Sie die Eigenschaften allowedParents/allowedChildren der Vorlage verwenden. Sie können dann explizit angeben, dass Seiten, die aus einer Vorlage T erstellt wurden, übergeordnet/untergeordnet von Seiten sein müssen, die aus einer Vorlage T erstellt wurden.