AEM-Tagging-Framework aem-tagging-framework

Tagging ermöglicht die Kategorisierung und Organisation von Inhalten. Tags können anhand eines Namespace und einer Taxonomie klassifiziert werden. Ausführliche Informationen zur Verwendung von Tags:

Dieser Artikel konzentriert sich auf das zugrunde liegende Framework, das Tagging in AEM unterstützt, und darauf, wie man es als Entwicklerin bzw. Entwickler nutzen kann.

Einführung introduction

Taggen Sie Inhalte und nutzen Sie die AEM-Tagging-Infrastruktur wie folgt:

Knotentyp cq:Tag cq-tag-node-type

Die Funktion eines Tags wird im Repository in einem Knoten vom Typ cq:Tag. erfasst

Das Tagging-Framework schränkt außerdem Autorinnen bzw. Autoren sowie Site-Besucherinnen und -Besucher darauf ein, nur bestimmte, vordefinierte Tags zu verwenden.

Tag-Eigenschaften tag-characteristics

TagID (Tag-ID) tagid

Eine TagID identifiziert einen Pfad, der einen Tag-Knoten im Repository ergibt.

Normalerweise ist die TagID eine kurze TagID, die mit dem Namespace beginnt. Sie kann auch eine absolute TagID sein, die mit dem Stammknoten der Taxonomie beginnt.

Wenn Inhalte mit Tags versehen werden, aber noch nicht vorhanden sind, wird dem Inhaltsknoten die Eigenschaft cq:tags und dem String-Array-Wert der Eigenschaft die TagID hinzugefügt.

Die TagID besteht aus einem Namespace gefolgt von der lokalen TagID. Container-Tags weisen untergeordnete Tags auf, die eine hierarchische Reihenfolge in der Taxonomie darstellen. Untergeordnete Tags können dazu verwendet werden, auf Tags genau wie eine lokale TagID zu verweisen. Beispielsweise ist es erlaubt, Inhalte mit dem Tag fruit zu versehen, auch wenn es sich um ein Container-Tag mit untergeordneten Tags handelt, z. B. fruit/apple oder fruit/banana.

Stammknoten der Taxonomie taxonomy-root-node

Der Stammknoten der Taxonomie ist der Basispfad für alle Tags im Repository. Der Stammknoten der Taxonomie darf kein Knoten vom Typ cq:Tag sein.

In AEM ist der Basispfad /content/cq:tags und der Stammknoten ist vom Typ cq:Folder.

Tag-Namespace tag-namespace

Mithilfe von Namespaces können Sie Elemente gruppieren. Der häufigste Anwendungsfall besteht darin, einen Namespace pro Website (z. B. öffentlich versus intern) oder pro größerer Anwendung (z. B. Sites oder Assets) zu verwenden. Namespaces können aber auch anderweitig eingesetzt werden. Namespaces werden in der Benutzeroberfläche verwendet, um nur die Untergruppe von Tags (d. h. die Tags eines bestimmten Namespace) anzuzeigen, die auf den aktuellen Inhalt anwendbar sind.

Der Namespace des Tags ist die erste Ebene im Teilbaum der Taxonomie, der den Knoten direkt unterhalb des Stammknotens der Taxonomie darstellt. Ein Namespace ist ein Knoten vom Typ cq:Tag, dessen übergeordnetes Element nicht vom Knotentyp cq:Tag ist.

Alle Tags haben einen Namespace. Wenn kein Namespace angegeben ist, wird das Tag dem standardmäßigen Namespace zugeordnet, nämlich TagID default, d. h. /content/cq:tags/default. Der Titel wird in diesen Fällen standardmäßig auf Standard Tagsgesetzt.

Container-Tags container-tags

Container-Tags sind Knoten vom Typ cq:Tag, die eine beliebige Anzahl untergeordneter Knoten von beliebigen Typen enthalten. Das ermöglicht die Erweiterung des Tag-Modells mit benutzerdefinierten Metadaten.

Darüber hinaus dienen Container-Tags (oder Super-Tags) in einer Taxonomie als Subsummierung aller Unter-Tags. Beispielsweise werden Inhalte, die mit fruit/apple getaggt sind, auch als mit fruit getaggt erachtet. Das heißt, bei der Suche nach Inhalten, die mit fruit getaggt sind, werden auch Inhalte gefunden, die mit fruit/apple getaggt sind.

Auflösen von Tag-IDs resolving-tagids

Wenn die Tag-ID einen Doppelpunkt (:) enthält, trennt der Doppelpunkt den Namespace vom Tag oder der Untertaxonomie, die dann mit normalen Schrägstrichen (/) voneinander getrennt werden. Wenn in der Tag-ID kein Doppelpunkt vorkommt, ist der Standard-Namespace impliziert.

Der standardmäßige und einzige Speicherort von Tags befindet sich unter /content/cq:tags.

Tags, die auf nicht vorhandene Pfade oder auf Pfade verweisen, an deren Ende sich kein cq:Tag-Knoten befindet, werden als ungültig betrachtet und werden ignoriert.

Die folgende Tabelle zeigt einige TagID-Beispiele, ihre Elemente und wie die TagID einen absoluten Pfad im Repository ergibt:

Lokalisierung des Tag-Titels localization-of-tag-title

Wenn das Tag die optionale Titelzeichenfolge enthält (jcr:title), ist es möglich, den Titel zur Anzeige zu lokalisieren, indem die Eigenschaft jcr:title.<locale> hinzugefügt wird.

Weitere Informationen finden Sie unter folgenden Themen:

Zugriffssteuerung access-control

Tags bestehen als Knoten im Repository unter dem Stammknoten der Taxonomie. Sie erlauben oder verweigern Autoren und Website-Besuchern die Erstellung von Tags in einem jeweiligen Namespace, indem Sie im Repository entsprechende ACLs festlegen.

Durch das Verweigern von Leseberechtigungen für bestimmte Tags oder Namespaces wird die Möglichkeit gesteuert, Tags auf bestimmte Inhalte anzuwenden.

Eine typische Vorgehensweise umfasst Folgendes:

Tag-barer Inhalt: cq:Taggable-Mixin taggable-content-cq-taggable-mixin

Damit Anwendungsentwicklerinnen und -entwickler einen Inhaltstyp mit Tags versehen können, muss die Registrierung eines Knotens (CND) das Mixin cq:Taggable oder das Mixin cq:OwnerTaggable umfassen.

Das Mixin cq:OwnerTaggable, das von cq:Taggable übernimmt, soll anzeigen, dass der Inhalt vom Besitzer/Autor klassifiziert werden kann. In AEM handelt es sich hierbei nur um ein Attribut des Knotens cq:PageContent. Das Mixin cq:OwnerTaggable wird vom Tagging-Framework nicht benötigt.

Knotentypnotation (CND) node-type-notation-cnd

Knotentypdefinitionen sind im Repository als CND-Dateien vorhanden. Die CND-Notation wird als Teil der JCR-Dokumentation definiert.

Die wichtigsten Definitionen für die Knotentypen in AEM sind wie folgt:

[cq:Tag] > mix:title, nt:base
    orderable
    - * (undefined) multiple
    - * (undefined)
    + * (nt:base) = cq:Tag version

[cq:Taggable]
    mixin
    - cq:tags (string) multiple

[cq:OwnerTaggable] > cq:Taggable
    mixin

Eigenschaft cq:tags cq-tags-property

Die Eigenschaft cq:tags ist ein String-Array, das zum Speichern mindestens einer TagID verwendet wird, wenn diese von Autoren oder Website-Besuchern auf Inhalte angewendet werden. Die Eigenschaft hat nur dann eine Bedeutung, wenn sie einem Knoten hinzugefügt wird, der mit dem Mixin cq:Taggable definiert wird.

Verschieben und Zusammenführen von Tags moving-and-merging-tags

Im Folgenden finden Sie eine Beschreibung der Auswirkungen, die im Repository auftreten, wenn Sie Tags mit der Tagging-Konsole verschieben oder zusammenführen.

Wenn ein Tag A verschoben oder mit Tag B unter /content/cq:tags zusammengeführt wird:

Das Lesen einer cq:tags-Eigenschaft eines Inhaltsknotens umfasst die folgende Auflösung:

Um eine Änderung zu veröffentlichen, wenn ein Tag verschoben oder zusammengeführt wurde, müssen der Knoten cq:Tag und all seine Backlinks repliziert werden. Dies geschieht automatisch, wenn das Tag in der Tag-Verwaltungskonsole aktiviert wird.

Spätere Aktualisierungen der cq:tags-Eigenschaft der Seite bereinigen automatisch die alten Verweise. Diese Bereinigung wird ausgelöst, da die Auflösung eines verschobenen Tags über die API das Ziel-Tag zurückgibt und so die Ziel-Tag-ID bereitstellt.