自定义和扩展内容片段

内容片段扩展了标准资产;请参阅:

架构

内容片段的基本组成部分包括:

  • A 内容片段,
  • 由一个或多个​内容元素 s组成,
  • 和可以具有一个或多个​内容变体 s。

根据片段类型,还会使用模型或模板:

注意

现在,建议 使用内容片段模型来创建所有片段。

内容片段模型用于We.Retail中的所有示例。

  • 内容片段模型:

    • 用于定义包含结构化内容的内容片段。
    • 内容片段模型在创建内容片段时定义其结构。
    • 片段引用模型;因此,对模型所做的更改可能会/将会影响任何依赖的片段。
    • 模型是数据类型的构建。
    • 用于添加新变量等的函数必须相应地更新片段。
    注意

    对现有内容片段模型所做的任何更改都可能影响依赖的片段;这可能会导致这些片段中的孤立属性。

  • 内容片段模板:

    • 用于定义简单内容片段。
    • 模板可定义内容片段在创建时的(基本、仅文本)结构。
    • 模板在创建时会复制到片段中;因此,对模板的进一步更改将不会反映在现有片段中。
    • 用于添加新变量等的函数必须相应地更新片段。
    • 内容片 段模板以不同于AEM生态系统中其他模板机制(例如页面模板等)的方式运行。因此,应单独考虑这些问题。
    • 基于模板时,根据实际内容管理内容的MIME类型;这意味着每个元素和变量可以具有不同的MIME类型。

与资产集成

内容片段管理(CFM)是AEM Assets的一部分,其格式为:

  • 内容片段是资产。
  • 它们使用现有的资产功能。
  • 它们与资产(管理控制台等)完全集成。

将结构化内容片段映射到资产

片段到资产结构

具有结构化内容的内容片段(即,基于内容片段模型)会映射到单个资产:

  • 所有内容都存储在资产的jcr:content/data节点下:

    • 元素数据存储在主控子节点下:

      jcr:content/data/master

    • 变体存储在带有变体名称的子节点下:
      例如jcr:content/data/myvariation

    • 每个元素的数据作为具有元素名称的属性存储在相应的子节点中:
      例如,元素text的内容将作为属性text存储在jcr:content/data/master

  • 元数据和关联内容存储在jcr:content/metadata
    除标题和描述之外,这些标题和描述不被视为传统元数据并存储在
    jcr:content

将简单内容片段映射到资产

chlimage_1-90

简单内容片段(基于模板)会映射到由主资产和(可选)子资产组成的组合:

  • 片段的所有非内容信息(如标题、描述、元数据、结构)都仅在主资产上进行管理。

  • 片段第一个元素的内容会映射到主资产的原始演绎版。

    • 第一个元素的变体(如果有)会映射到主资产的其他演绎版。
  • 其他元素(如果现有)会映射到主资产的子资产。

    • 这些附加元素的主要内容映射到相应子资产的原始演绎版。
    • 任何其他元素的其他变体(如果适用)都映射到相应子资产的其他演绎版。

资产位置

与标准资产一样,内容片段位于以下位置:

/content/dam

资产权限

有关更多详细信息,请参阅内容片段 — 删除注意事项

功能集成

  • 内容片段管理(CFM)功能以资产核心为基础,但应当尽可能独立于该功能。
  • CFM为卡片/列/列表视图中的项目提供了自己的实施;这些插件可插入现有资产内容渲染实施。
  • 已扩展多个资产组件,以满足内容片段的需求。

在页面中使用内容片段

注意

现在建议使用内容片段核心组件。 有关更多详细信息,请参阅开发核心组件

可以像任何其他资产类型一样,从AEM页面引用内容片段。 AEM提供了​内容片段​核心组件 - a 组件,该组件允许您在页面上包含内容片段。 您还可以扩展此​内容片段​核心组件。

  • 组件使用fragmentPath属性引用实际的内容片段。 fragmentPath属性的处理方式与其他资产类型的类似属性相同;例如,当内容片段被移动到其他位置时。

  • 组件允许您选择要显示的变量。

  • 此外,还可以选择一系列段落以限制输出;例如,它可用于多列输出。

  • 组件允许中间内容:

    • 在此,组件允许您放置其他资产(图像等) 在引用片段的段落之间。

    • 对于中间内容,您需要:

      • 注意可能出现不稳定的引用;中间内容(在创作页面时添加)与它位于旁边的段落没有固定的关系,在中间内容的位置可能丢失相对位置之前插入新段落(在内容片段编辑器中)
      • 请考虑其他参数(如变量和段落过滤器),以避免搜索结果出现误报
注意

内容片段模型:

在页面上使用基于内容片段模型的内容片段时,会引用模型。 这意味着,如果发布页面时尚未发布模型,则会标记该模型,并将模型添加到要随页面一起发布的资源中。

内容片段模板:

在页面上使用基于内容片段模板的内容片段时,没有引用,因为创建片段时复制了模板。

使用OSGi控制台进行配置

例如,内容片段的后端实施负责使页面上使用的片段的实例可搜索,或管理混合媒体内容。 此实施需要了解用于渲染片段的组件以及如何对渲染进行参数化。

可以在Web控制台中为OSGi包​内容片段组件配置​配置此配置的参数。

  • 资源
    类型列表
    sling:resourceTypes 可用于定义用于渲染内容片段的组件,以及应将后台处理应用于的位置。


  • 用属性属性列表可以配置为指定对片段的引用存储在相应组件的位置。

注意

属性和组件类型之间没有直接映射。

AEM只会获取可在段落中找到的第一个属性。 因此,您应该仔细选择这些资产。

screenshot_2019-03-18at100941

您仍必须遵循一些准则,以确保组件与内容片段后台处理兼容:

  • 定义要呈现的元素的属性名称必须为elementelementNames

  • 定义要呈现的变体的属性名称必须为variationvariationName

  • 如果支持多个元素的输出(通过使用elementNames指定多个元素),则实际显示模式由属性displayMode定义:

    • 如果值为singleText(只配置了一个元素),则该元素将呈现为包含中间内容、布局支持等的文本。 对于仅渲染一个元素的片段,这是默认设置。
    • 否则,将使用更简单的方法(可称为“表单视图”),其中不支持中间内容,并且片段内容将“原样”呈现。
  • 如果片段是为displayMode == singleText(隐式或显式)呈现的,则会发挥以下附加属性:

    • paragraphScope 定义是否应渲染所有段落或仅渲染一段段落(值: allrange)

    • 如果paragraphScope == range,则属性paragraphRange定义要呈现的段落范围

与其他框架集成

内容片段可以与以下内容集成:

  • 翻译

    内容片段与AEM翻译工作流完全集成。 在建筑层面,这意味着:

    • 内容片段的个别翻译实际上是单独的片段;例如:

      • 它们位于不同的语言根下:

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

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

      • 但它们在语言根下完全相同的相对路径:

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

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

    • 除了基于规则的路径之外,内容片段的不同语言版本之间没有进一步的连接;虽然UI提供了在语言变体之间导航的方法,但它们将作为两个单独的片段进行处理。

    注意

    AEM翻译工作流可与/content配合使用:

    • 由于内容片段模型位于/conf中,因此此类转换中不包含这些模型。 您可以国际化UI字符串

    • 模板将被复制以创建片段,因此这是隐式的。

  • 元数据架构

    • 内容片段(重新)使用元数据架构,该架构可以使用标准资产进行定义。

    • CFM提供了自己的特定架构:

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

      如果需要,可以扩展此功能。

    • 相应的架构表单与片段编辑器集成。

内容片段管理API — 服务器端

您可以使用服务器端API访问您的内容片段;请参阅:

com.adobe.cq.dam.cfm

注意

强烈建议使用服务器端API,而不是直接访问内容结构。

关键接口

以下三个界面可用作入口点:

  • 片段模板 (片段模板)

    使用FragmentTemplate.createFragment()创建新片段。

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

    此界面表示:

    • 从中创建内容片段的内容片段模型或内容片段模板,
    • 和(创建后)该片段的结构信息

    此信息可包括:

    • 访问基本数据(标题、描述)

    • 访问片段元素的模板/模型:

      • 列表元素模板
      • 获取给定元素的结构信息
      • 访问元素模板(请参阅ElementTemplate
    • 片段变体的访问模板:

      • 列表变体模板
      • 获取给定变体的结构信息
      • 访问变体模板(请参阅VariationTemplate
    • 获取初始关联内容

    表示重要信息的界面:

    • ElementTemplate

      • 获取基本数据(名称、标题)
      • 获取初始元素内容
    • VariationTemplate

      • 获取基本数据(名称、标题、描述)
  • 内容片段 (ContentFragment)

    此界面允许您以抽象方式处理内容片段。

    注意

    强烈建议通过此界面访问片段。 应避免直接更改内容结构。

    该界面为您提供了以下方法:

    • 管理基本数据(例如,获取名称;get/set title/description)

    • 访问元数据

    • 访问元素:

      • 列表元素

      • 按名称获取元素

      • 创建新元素(请参阅注意事项

      • 访问元素数据(请参阅ContentElement

    • 为片段定义的列表变量

    • 全局创建新变量

    • 管理关联内容:

      • 列出集合
      • 添加收藏集
      • 删除收藏集
    • 访问片段的模型或模板

    表示片段主要元素的界面包括:

    • 内容元素 (ContentElement)

      • 获取基本数据(名称、标题、描述)

      • 获取/设置内容

      • 访问元素的变体:

        • 列表变体
        • 按名称获取变体
        • 创建新变体(请参阅注意事项
        • 删除变体(请参阅注意事项
        • 访问变量数据(请参阅ContentVariation
      • 解析变量的快捷方式(如果指定的变量不适用于元素,则应用一些其他特定于实施的回退逻辑)

    • 内容变体 (ContentVariation)

      • 获取基本数据(名称、标题、描述)
      • 获取/设置内容
      • 简单同步,基于上次修改的信息

    所有三个接口(ContentFragmentContentElementContentVariation)都扩展了Versionable接口,该接口可添加内容片段所需的版本控制功能:

    • 创建元素的新版本
    • 元素的列表版本
    • 获取版本控制元素的特定版本的内容

调整 — 使用adaptTo()

可以修改以下内容:

  • ContentFragment 可适用于:

    • Resource — 基础Sling资源;请注意,直接更新基 Resource 础,需要重建对 ContentFragment 象。

    • Asset — 表示内 Asset 容片段的DAM抽象;请注意,直接 Asset 更新需要重建对 ContentFragment 象。

  • ContentElement 可适用于:

    • ElementTemplate — 访问元素的结构信息。
  • FragmentTemplate 可适用于:

    • Resource — 确 Resource 定被引用的模型或复制的原始模板;

      • 通过Resource所做的更改不会自动反映在FragmentTemplate中。
  • Resource 可适用于:

    • ContentFragment
    • FragmentTemplate

注意事项

应当指出:

  • 实施API是为了提供UI支持的功能。

  • 整个API设计为​​自动保留更改(除非API JavaDoc中另有说明)。 因此,您将始终必须提交相应请求的资源解析程序(或您实际使用的解析程序)。

  • 可能需要额外努力的任务:

    • 创建/删除新元素将不会更新简单片段的数据结构(基于片段模板)。

    • ContentElement创建新变量不会更新数据结构(但从ContentFragment全局创建变量会更新)。

    • 删除现有变量不会更新数据结构。

内容片段管理API — 客户端

注意

对于AEM 6.5,客户端API是内部API。

附加信息

请参阅以下内容:

  • filter.xml

    内容片段管理的filter.xml已进行配置,以便它不会与资产核心内容包重叠。

编辑会话

当用户在其中一个编辑器页面中打开内容片段时,将启动编辑会话。 当用户通过选择​Save​或​Cancel​离开编辑器时,编辑会话即告结束。

要求

控制编辑会话的要求包括:

  • 编辑可跨多个视图(= HTML页面)的内容片段应该是原子的。
  • 编辑还应该是​transactional;在编辑会话结束时,必须提交(保存)或回滚(取消)更改。
  • 应妥善处理边缘案件;这些情况包括用户手动输入URL或使用全局导航离开页面的情况。
  • 应提供定期自动保存(每x分钟)功能,以防止数据丢失。
  • 如果两个用户同时编辑内容片段,则他们不应覆盖彼此的更改。

进程

涉及的流程包括:

  • 启动会话

    • 将创建内容片段的新版本。
    • 自动保存已启动。
    • 设置Cookie;这些定义了当前编辑的片段,并且打开了编辑会话。
  • 完成会话

    • 自动保存已停止。

    • 提交后:

      • 最后修改的信息会更新。
      • Cookie已删除。
    • 回滚时:

      • 将还原在启动编辑会话时创建的内容片段的版本。
      • Cookie已删除。
  • 编辑

    • 所有更改(包括自动保存)都在活动内容片段上完成,而不是在分隔的受保护区域内完成。
    • 因此,这些更改会立即反映在引用相应内容片段的AEM页面上

操作

可能的操作包括:

  • 输入页面

    • 检查编辑会话是否已存在;检查相应的Cookie。

      • 如果存在,请验证是否已为当前正在编辑的内容片段启动编辑会话

        • 如果当前片段,则重新建立会话。
        • 如果没有,请尝试取消对之前编辑的内容片段的编辑,并删除Cookie(之后不会出现编辑会话)。
      • 如果不存在编辑会话,请等待用户进行的首次更改(请参阅下文)。

    • 检查页面上是否已引用内容片段,如果已引用,则显示相应的信息。

  • 内容更改

    • 每当用户更改内容并且不存在编辑会话时,都会创建一个新的编辑会话(请参阅启动会话)。
  • 离开页面

    • 如果存在编辑会话且更改未持久,则会显示一个模式确认对话框,告知用户可能丢失的内容并允许他们停留在页面上。

示例

示例:访问现有内容片段

要实现此目的,您可以调整表示API的资源以:

com.adobe.cq.dam.cfm.ContentFragment

例如:

// first, get the resource
Resource fragmentResource = resourceResolver.getResource("/content/dam/fragments/my-fragment");
// then adapt it
if (fragmentResource != null) {
    ContentFragment fragment = fragmentResource.adaptTo(ContentFragment.class);
    // the resource is now accessible through the API
}

示例:创建新内容片段

要以编程方式创建新内容片段,您需要使用:

com.adobe.cq.dam.cfm.ContentFragmentManager#create

例如:

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

示例:指定自动保存间隔

使用配置管理器(ConfMgr)可以定义自动保存间隔(以秒为单位):

  • 节点:<*conf-root*>/settings/dam/cfm/jcr:content

  • 属性名称: autoSaveInterval

  • 类型: Long

  • 默认:600(10分钟);这在/libs/settings/dam/cfm/jcr:content上定义

如果要设置5分钟的自动保存间隔,则需要在节点上定义属性;例如:

  • 节点:/conf/global/settings/dam/cfm/jcr:content

  • 属性名称: autoSaveInterval

  • 类型: Long

  • 值:300(5分钟等于300秒)

内容片段模板

有关完整信息,请参阅内容片段模板

用于创作页面的组件

有关详细信息,请参阅

在此页面上