AEM Tagging Framework

要标记内容并利用AEM Tagging基础结构:

标记: cq:标记节点类型

标记的声明在存储库中的类型节点中捕获 cq:Tag.

标记可以是简单的单词(如sky)或表示分级分类(如果/苹果,即通用水果和更具体的苹果)。

标记由唯一的TagID标识。

标记具有可选的元信息,如标题、本地化标题和说明。 标题应在用户界面中显示,而不是TagID(如果存在)。

标记框架还允许限制作者和站点访客仅使用特定的预定义标记。

标签特性

  • 节点类型为 cq:Tag

  • 节点名称是 TagID

  • TagID 是包含 命名空间

  • 可选 jcr:title 属性(要在UI中显示的标题)

  • 可选属 jcr:description

  • 包含子节点时,称为 容器标记

  • 存储在名为分类根节点的基路径 下的存储库中

标记 ID

TagID标识解析到存储库中的标记节点的路径。

通常,TagID是以命名空间开头的短格式TagID,也可以是从分类根节点开始的 绝对TagID

标记内容时,如果内容尚不存在,则 cq:tags 将属性添加到内容节点,并将TagID添加到属性的String数组值。

TagID由命名空间 本地TagID组成。 容器标 签具有子标签,这些子标签表示分类中的分层顺序。 子标记可用于引用与任何本地TagID相同的标记。 例如,允许用“水果”标记内容,即使它是带有子标签的容器标签,如“水果/苹果”和“水果/香蕉”。

分类根节点

分类根节点是存储库中所有标记的基本路径。 分类根节点不 是类型的节点 cq :Tag

在AEM中,基路径 /content/ cq :tags 为,根节点为类型 cq :Folder

标记命名空间

命名空间允许将事物分组。 最典型的用例是每个(网站)或每个较大的应用程序(如WCM、资产、社区)都有命名空间(例如,公共、内部和门户),但命名空间可用于其他各种需求。 命名空间用于用户界面中,以仅显示适用于当前内容的标记子集(即特定命名空间的标记)。

标记的命名空间是分类子树中的第一级,该子树是紧挨分类根节点 的节点。 命名空间是父代不是节 cq:Tag 点类型的节 cq:Tag点类型。

所有标记均具有命名空间。 如果未指定命名空间,则标记将分配给默认命名空间,即TagID(标 default 题是 Standard Tags), /content/cq:tags/default.

容器标记

容器标签是包含任意数 cq:Tag 量和子节点类型的节点,它使用自定义元数据增强标签模型成为可能。

此外,分类中的容器标签(或超级标签)用作所有子标签的子总和: 例如,用水果/苹果标记的内容也被视为用水果标记,即搜索仅用水果标记的内容也会找到用水果/苹果标记的内容。

解析标记ID

如果标记ID包含冒号“:”,冒号将命名空间与标记或子分类分开,然后用正斜杠“/”分开。 如果标记ID没有冒号,则默示默认命名空间。

标记的标准位置和唯一位置在/content/cq:tags下。

引用不指向cq:Tag节点的非现有路径或路径的标记被视为无效并被忽略。

下表显示了一些示例TagID、其元素,以及TagID如何解析为存储库中的绝对路径:

下表显示了一些示例TagID、其元素,以及TagID如何解析为存储库中的绝对路径:
下表显示了一些示例TagID、其元素,以及TagID如何解析为存储库中的绝对路径:

标记 ID
命名空间 本地ID 容器标签 Leaf标签 存储库
“绝对”标记路径
dam:fruit/apple/braeburn 水果/苹果/布雷本 水果,苹果 braburn /content/cq:tags/dam/fruit/apple/braeburn
color/red 默认 color/red 颜色 /content/cq:tags/default/color/red
天空 默认 天空 (无) 天空 /content/cq:tags/default/sky
dam: (无) (无) (无,命名空间) /content/cq:tags/dam
/content/cq:tags/类别/car 类别 汽车 汽车 汽车 /content/cq:tags/类别/car

标记标题本地化

当标记包含可选的标题字符串() jcr:title时,可以通过添加属性来本地化要显示的标题 jcr:title.<locale>

有关详细信息,请参阅

访问控制

标记作为节点存在于分类根节 点下的存储库中。 允许或拒绝作者和站点访客在给定命名空间中创建标记,可以通过在存储库中设置适当的ACL。

此外,拒绝某些标记或命名空间的读取权限将控制将标记应用于特定内容的能力。

典型做法包括:

  • 允许对 tag-administrators 所有命名空间(在下添加/修改)进行组/角色写入 /content/cq:tags访问。 这个组随附AEM即装即用。

  • 允许用户/作者读取应可读的所有命名空间(大多数)。

  • 允许用户/作者对用户/作者可自由定义标记的命名空间进行写入访问(在下面添加节点 /content/cq:tags/some_namespace)

可标记内容: cq:Taggable Mixin

为了使应用程序开发人员将标记附加到内容类型,节点的注册(CND)必须包含 cq:Taggable 混合或混 cq:OwnerTaggable 合。

继承 cq:OwnerTaggable 自的混音旨在 cq:Taggable指示内容可由所有者/作者进行分类。 在AEM中,它只是节点的属 cq:PageContent 性。 标 cq:OwnerTaggable 记框架不需要混合。

注意

建议仅在聚集内容项的顶级节点(或其jcr:content节点)上启用标记。 示例包括:

  • 页面( cq:Page)其中节 jcr:content点的类型 cq:PageContent 包括混 cq:Taggable 合。

  • 资产( cq:Asset)节点始 jcr:content/metadata 终具有混合的 cq:Taggable 位置。

节点类型表示法(CND)

节点类型定义作为CND文件存在在存储库中。 CND记号在此定义为JCR文档的一 部分

AEM中包含的节点类型的基本定义如下:

[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:tags属性

该属 cq:tags 性是一个字符串数组,当作者或站点访客将一个或多个TagID应用于内容时,它们用于存储这些TagID。 仅当添加到使用mixin定义的节点时,该属性才具有 cq:Taggable 意义。

注意

要利用AEM标记功能,自定义开发的应用程序不应定义标记属性 cq:tags

移动和合并标记

以下是使用标记控制台移动或合并标记时存储库中效果 的说明:

  • 当标记A被移动或合并到标记B下时 /content/cq:tags:

    • 标记A未被删除,并获取属 cq:movedTo 性。
    • 将创建标记B(在移动时)并获取属 cq:backlinks 性。
  • cq:movedTo 指向标记B。

    此属性表示标记A已被移动或合并到标记B中。移动标记B将相应地更新此属性。 因此,标记A是隐藏的,它仅保存在存储库中以解析指向标记A的内容节点中的标记ID。标记垃圾收集器会删除标记A等标记,而不再有其他内容节点指向它们。

    该属性的特殊 cq:movedTo 值是 nirvana: 在删除标记但无法从存储库中删除该标记时应用该标记,因为存在必须 cq:movedTo 保留的子标记。

    注意

    仅当 cq:movedTo 满足以下任一条件时,属性才会添加到已移动或合并的标记:

    1. 标记用于内容(即它有引用)或
    2. 标记包含已移动的子项。
  • cq:backlinks 使引用保持在另一个方向,即保留已移动到标记B或与标记B合并的所有标记的列表。这通常要求在移动/合并/删除标记B以及激活标记B时使属性保持最新,在这种情况下,必须同时激活其所有背景标记。 cq:movedTo

注意

仅当 cq:backlinks 满足以下任一条件时,属性才会添加到已移动或合并的标记:

  1. 标记用于内容(即它有引用)或
  2. 标记包含已移动的子项。
  • 读取内 cq:tags 容节点的属性涉及以下解决:

    1. 如果下面没有匹配项, /content/cq:tags则不返回任何标记。

    2. 如果标记设置了 cq:movedTo 属性,则引用的标记ID会随后显示。

      只要后跟的标记具有属性,则重复此 cq:movedTo 步骤。

    3. 如果后面的标记没有属 cq:movedTo 性,则会读取标记。

  • 要在标记被移动或合并后发布更改,必须 cq:Tag 复制节点及其所有反向链接: 在标记管理控制台中激活标记时,会自动执行此操作。

  • 稍后对页面属性的更 cq:tags 新会自动清除“旧”引用。 这是由于通过API解析移动的标记会返回目标标记,从而提供目标标记ID而触发的。

标记迁移

Experience Manager6.4之后的标签存储在 /content/cq:tags下面,之前存储在下面 /etc/tags。 但是,在Adobe Experience Manager已从先前版本升级的情况下,标签仍在旧位置下 /etc/tags。 在升级的系统中,需要在下迁移标记 /content/cq:tags

注意

在标记页面的“页面属性”中,建议使用标记ID(例 geometrixx-outdoors:activity/biking如),而不是对标记基本路径进行硬编码(例如 /etc/tags/geometrixx-outdoors/activity/biking)。

要列表标 com.day.cq.tagging.servlets.TagListServlet 记,可使用。

注意

建议将标签管理器API用作资源。

如果升级的AEM实例支持TagManager API

  1. 在组件开始,TagManager API会检测它是否是升级的AEM实例。 在升级的系统中,标记存储在下 /etc/tags

  2. 然后,TagManager API以向后兼容模式运行,这意味着API /etc/tags 用作基本路径。 否则,将使用新位置 /content/cq:tags

  3. 更新标记位置。

  4. 将标记迁移到新位置后,运行以下脚本:

import org.apache.sling.api.resource.*
import javax.jcr.*

ResourceResolverFactory resourceResolverFactory = osgi.getService(ResourceResolverFactory.class);
ResourceResolver resolver = resourceResolverFactory.getAdministrativeResourceResolver(null);
Session session = resolver.adaptTo(Session.class);

def queryManager = session.workspace.queryManager;
def statement = "/jcr:root/content/cq:tags//element(*, cq:Tag)[jcr:contains(@cq:movedTo,\'/etc/tags\') or jcr:contains(@cq:backlinks,\'/etc/tags\')]";
def query = queryManager.createQuery(statement, "xpath");

println "query = ${query.statement}\n";

def tags = query.execute().getNodes();


tags.each { node ->
        def tagPath = node.path;
        println "tag = ${tagPath}";

        if(node.hasProperty("cq:movedTo") && node.getProperty("cq:movedTo").getValue().toString().startsWith("/etc/tags")){

                def movedTo = node.getProperty("cq:movedTo").getValue().toString();

                println "cq:movedTo = ${movedTo} \n";

                movedTo = movedTo.replace("/etc/tags","/content/cq:tags");
                node.setProperty("cq:movedTo",movedTo);
        } else if(node.hasProperty("cq:backlinks")){

               String[] backLinks = node.getProperty("cq:backlinks").getValues();
               int count = 0;

               backLinks.each { value ->
                       if(value.startsWith("/etc/tags")){
                               println "cq:backlinks = ${value}\n";
                               backLinks[count] = value.replace("/etc/tags","/content/cq:tags");
    }
                       count++;
               }

               node.setProperty("cq:backlinks",backLinks);
  }
}
session.save();

println "---------------------------------Success-------------------------------------"

脚本将获取属性值中 /etc/tags 包含的所有标 cq:movedTo/cq:backLinks 记。 然后,它重新迭代获取的结果集,并 cq:movedTocq:backlinks 和属性值解析 /content/cq:tags 为路径(在值中检测到 /etc/tags 的情况下)。

如果升级的AEM实例在Clasic UI上运行

注意

经典UI不符合零停机时间要求,并且不支持新的标签基础路径。 如果要使用经典UI,则需 /etc/tags 要创建经典UI,然后重新启 cq-tagging 动组件。

如果TagManager API支持并在经典UI中运行升级的AEM实例:

  1. 使用tagId或新标记位置替 /etc/tags 换对旧标记基本路径的引用后, /content/cq:tags您可以在CRX中将标记迁移到新 /content/cq:tags 位置,然后重新启动组件。

  2. 将标记迁移到新位置后,运行上述脚本。

在此页面上