自定义和扩展内容片段 customizing-and-extending-content-fragments

创建和管理内容片段 和 使用内容片段进行页面创作 有关内容片段的更多信息。

管理资产 和 自定义和扩展资产 以进一步了解标准资产。

内容片段模型:

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

内容片段模板：

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

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

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

  jcr:content/data/master

• 变体存储在带有变体名称的子节点下：

  例如 jcr:content/data/myvariation

• 每个元素的数据作为具有元素名称的属性存储在相应的子节点中：

  例如，元素的内容 text 存储为属性 text on jcr:content/data/master

元数据和关联内容存储在下面 jcr:content/metadata

除标题和描述之外，这些标题和描述不被视为传统元数据并存储在 jcr:content

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

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

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

其他元素（如果现有）会映射到主资产的子资产。

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

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

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

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

组件允许 中间内容:

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

  • 对于中间内容，您需要：

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

资源类型

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

引用属性

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

定义要呈现的元素的属性名称必须是 element 或 elementNames.

定义要呈现的变体的属性名称必须是 variation 或 variationName.

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

• 如果值为 singleText （只配置了一个元素），则该元素将呈现为具有中间内容、布局支持等的文本。 对于仅渲染一个元素的片段，这是默认设置。
• 否则，将使用更简单的方法（可称为“表单视图”），其中不支持中间内容，并且片段内容将“原样”呈现。

如果片段是为 displayMode == singleText （隐式或显式）起作用的其他属性如下：

• paragraphScope 定义是否应渲染所有段落或仅渲染一段段落(值： all 与 range)
• if 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提供了在语言变体之间导航的方法，但它们将作为两个单独的片段进行处理。

元数据架构

• 内容片段（重用）使用 元数据架构，可使用标准资产定义。

CFM提供了自己的特定架构：

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

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

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

片段模板

片段模板

使用 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

  • 获取基本数据（名称、标题、描述）

内容片段

内容片段

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

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

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

• 访问元数据

• 访问元素：

  • 列表元素
  • 按名称获取元素
  • 创建新元素(请参阅 注意事项)
  • 访问元素数据(请参阅 ContentElement)

• 为片段定义的列表变量

• 全局创建新变量

• 管理关联内容：

  • 列出集合
  • 添加收藏集
  • 删除收藏集

• 访问片段的模型或模板

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

• 内容元素

  ContentElement
  

  • 获取基本数据（名称、标题、描述）

  • 获取/设置内容

  • 访问元素的变体：

    • 列表变体
    • 按名称获取变体
    • 创建新变量(请参阅 注意事项)
    • 删除变量(请参阅 注意事项)
    • 访问变量数据(请参阅 ContentVariation)

  • 解析变量的快捷方式（如果指定的变量不适用于元素，则应用一些其他特定于实施的回退逻辑）

• 内容变体

  ContentVariation
  

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

所有三个界面( ContentFragment, ContentElement, ContentVariation)扩展 Versionable 界面，它添加了内容片段所需的版本控制功能：

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

ContentFragment 可适用于：

• Resource — 基础Sling资源；请注意，更新基础 Resource 直接需要重建 ContentFragment 对象。
• Asset - DAM Asset 表示内容片段的抽象；请注意， Asset 直接需要重建 ContentFragment 对象。

ContentElement 可适用于：

• ElementTemplate — 访问元素的结构信息。

FragmentTemplate 可适用于：

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

  • 通过 Resource 不会自动反映在 FragmentTemplate.

Resource 可适用于：

• ContentFragment
• FragmentTemplate

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

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

可能需要额外努力的任务：

• 创建/删除新元素将不会更新简单片段的数据结构（基于片段模板）。
• 从创建新变体 ContentElement 不会更新数据结构(但会从 ContentFragment )。
• 删除现有变量不会更新数据结构。

filter.xml

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

启动会话

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

完成会话

• 自动保存已停止。

• 提交后：

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

• 回滚时：

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

编辑

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

输入页面

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

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

    • 如果当前片段，则重新建立会话。
    • 如果没有，请尝试取消对之前编辑的内容片段的编辑，并删除Cookie（之后不会出现编辑会话）。

  • 如果不存在编辑会话，请等待用户进行的首次更改（请参阅下文）。

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

内容更改

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

离开页面

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

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

属性名称: autoSaveInterval

类型: Long

默认： 600 （10分钟）；这是在 /libs/settings/dam/cfm/jcr:content

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

属性名称: autoSaveInterval

类型: Long

值： 300 （5分钟等于300秒）