AEM Taggning Framework aem-tagging-framework

Taggning gör att innehållet kan kategoriseras och struktureras. Taggar kan klassificeras med ett namnutrymme och en taxonomi. Mer information om hur du använder taggar:

Den här artikeln fokuserar på det underliggande ramverket som stöder taggning i AEM och hur det används som utvecklare.

Introduktion introduction

Så här taggar du innehåll och använder infrastrukturen för AEM taggar:

cq:Tag Node Type cq-tag-node-type

Deklarationen för en tagg hämtas i databasen i en nod av typen cq:Tag.

Ramverket för taggning begränsar också författare och besökare till att endast använda specifika, fördefinierade taggar.

Märkordsegenskaper tag-characteristics

TaggID tagid

En TagID identifierar en sökväg som tolkas till en taggnod i databasen.

Vanligtvis är TagID en förkortning TagID som börjar med namnutrymmet eller så kan det vara en absolut TagID som börjar med taxonomirotnoden.

Om innehållet är taggat och inte finns ännu, läggs egenskapen cq:tags till i innehållsnoden och TagID läggs till i egenskapens String-arrayvärde.

TagID består av ett namnutrymme följt av det lokala TagID. Behållartaggar har undertaggar som representerar en hierarkisk ordning i taxonomin. Undertaggar kan användas för att referera till taggar som är samma som alla lokala TagID. Du kan till exempel tagga innehåll med fruit, även om det är en behållartagg med undertaggar, till exempel fruit/apple och fruit/banana.

Taxonomirotnod taxonomy-root-node

Taxonomirotnoden är grundsökvägen för alla taggar i databasen. Taxonomirotnoden får inte vara en nod av typen cq:Tag.

I AEM är bassökvägen /content/cq:tags och rotnoden är av typen cq:Folder.

Namnutrymme för tagg tag-namespace

Med namnutrymmen kan du gruppera saker. Det vanligaste är att ha ett namnutrymme per plats (till exempel public kontra internal) eller per större program (till exempel Sites eller Assets), men namnutrymmen kan användas för olika andra behov. Namnutrymmen används i användargränssnittet för att endast visa deluppsättningen med taggar (d.v.s. taggar för ett visst namnutrymme) som kan användas för det aktuella innehållet.

Taggens namnområde är den första nivån i taxonomiunderträdet, som är noden direkt under taxonomirotnoden. Ett namnområde är en nod av typen cq:Tag vars överordnade nod inte är en cq:Tag-nodtyp.

Alla taggar har ett namnutrymme. Om inget namnutrymme anges tilldelas taggen standardnamnutrymmet, som är TagID default, d.v.s. /content/cq:tags/default. Titeln är som standard Standard Tags.

Behållartaggar container-tags

En behållartagg är en nod av typen cq:Tag som innehåller valfritt antal och valfri typ av underordnade noder, vilket gör det möjligt att förbättra taggmodellen med anpassade metadata.

Dessutom fungerar behållartaggar (eller supertaggar) i en taxonomi som delsummering av alla undertaggar. Innehåll som taggats med fruit/apple betraktas till exempel också som taggat med fruit. Det innebär att om du söker efter innehåll som är taggat med fruit så hittas även innehållet som är taggat med fruit/apple.

Lösa tagg-ID:n resolving-tagids

Om tagg-ID:t innehåller ett kolon (:) separerar kolon namnutrymmet från taggen eller subtaxonomin, som sedan avgränsas med normala snedstreck (/). Om tagg-ID:t inte har ett kolon används standardnamnutrymmet.

Standardplatsen och den enda platsen för taggar är under /content/cq:tags.

Taggar som refererar till icke-befintliga sökvägar eller sökvägar som inte pekar på en cq:Tag-nod betraktas som ogiltiga och ignoreras.

I följande tabell visas några exempel på TagID, deras element och hur TagID tolkas till en absolut sökväg i databasen:

Lokalisering av taggtitel localization-of-tag-title

När taggen innehåller den valfria titelsträngen jcr:title går det att lokalisera titeln för visning genom att lägga till egenskapen jcr:title.<locale>.

Mer information finns i följande:

Åtkomstkontroll access-control

Taggar finns som noder i databasen under taxonomirotnoden. Du kan skapa taggar i ett givet namnutrymme genom att ange lämpliga åtkomstkontrollistor i databasen, så att författare och besökare kan neka eller neka åtkomst.

Genom att neka läsbehörighet för vissa taggar eller namnutrymmen kan du styra möjligheten att använda taggar för visst innehåll.

Ett typiskt exempel är:

Taggbart innehåll : cq:Taggable Mixin taggable-content-cq-taggable-mixin

För att programutvecklare ska kunna bifoga taggning till en innehållstyp måste nodens registrering (CND) innehålla cq:Taggable mixin eller cq:OwnerTaggable mixin.

cq:OwnerTaggable-blandningen, som ärver från cq:Taggable, är avsedd att indikera att innehållet kan klassificeras av ägaren/författaren. I AEM är det bara ett attribut för noden cq:PageContent. cq:OwnerTaggable-blandningen krävs inte av taggningsramverket.

Nodtypsnotation (CND) node-type-notation-cnd

Det finns nodtypsdefinitioner i databasen som CND-filer. CND-notationen definieras som en del av JCR-dokumentationen.

De viktigaste definitionerna för nodtyperna i AEM är följande:

[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

cq:tagg, egenskap cq-tags-property

Egenskapen cq:tags är en String-matris som används för att lagra en eller flera TagID när de tillämpas på innehåll av författare eller webbplatsbesökare. Egenskapen har bara betydelse när den läggs till i en nod som har definierats med cq:Taggable-mixinen.

Flytta och sammanfoga taggar moving-and-merging-tags

Nedan följer en beskrivning av effekterna i databasen när du flyttar eller sammanfogar taggar med hjälp av taggningskonsolen.

När tagg A flyttas eller sammanfogas till tagg B under /content/cq:tags:

Följande upplösning krävs när du läser en cq:tags-egenskap för en innehållsnod:

Om du vill publicera ändringen när en tagg har flyttats eller sammanfogats måste noden cq:Tag och alla dess bakgrunder replikeras. Denna replikering utförs automatiskt när taggen aktiveras i taggens administrationskonsol.

Senare uppdateringar av sidans cq:tags-egenskap rensar automatiskt de gamla referenserna. Rensningen utlöses eftersom en flyttad tagg som löses via API returnerar måltaggen och därmed anger måltaggens ID.