内容片段模型

上次更新： 2023-11-30

主题：

创建对象：

AEM中的内容片段模型为您的定义了内容结构内容片段，作为Headless内容的基础。

要使用内容片段模型，您可以：

为您的实例启用内容片段模型功能
创建和配置，内容片段模型
启用您的内容片段模型，以便在创建内容片段时使用
通过配置策略，允许在所需的 Assets 文件夹上创建内容片段模型。

创建内容片段模型

导航到“工具”、“常规”，然后打开“内容片段模型”。
导航到适合您的配置或子配置的文件夹。
使用“创建”打开向导。

注意

如果未启用内容片段模型，则**“创建”**选项将不可用。
指定模型标题。您还可以定义各种属性；例如，添加标记， a 描述，并选择 启用模型 到启用模型如有必要。

注意

欲知关于 默认预览URL模式 请参阅内容片段模型 — 属性.
使用“创建”以保存空模型。将显示一条消息，指示操作是否成功，您可以选择“打开”来立即编辑模型，或“完成”以返回到控制台。

定义内容片段模型

内容片段模型通过选择“数据类型”，有效地定义了结果内容片段的结构。使用模型编辑器，您可以添加数据类型的实例，然后对其进行配置以创建必填字段：

注意

编辑现有内容片段模型可能会影响从属片段。

导航到“工具”、“常规”，然后打开“内容片段模型”。
导航到包含内容片段模型的文件夹。
打开所需的模型进行“编辑”；使用快速操作或选择模型，然后从工具栏中选择操作。

打开模型编辑器后，会显示：
- 左：字段已定义
- 右侧：可用于创建字段的数据类型（可在创建字段后使用的属性）
注意

当字段为必填时，左侧窗格中指示的标记会标有星号 (*)。

添加字段
- 将字段的必需数据类型拖到所需位置：
- 将字段添加到模型后，右侧面板将显示可以为该特定数据类型定义的属性。您可以在此定义该字段的必需内容。
  - 许多属性的含义一目了然，有关更多详细信息，请参阅属性。
  - 键入字段标签将自动完成属性名称；如果为空，则以后可手动更新。
    
    注意
    
    当为数据类型手动更新某个属性名称时，请注意，名称必须仅包含 A – Z、a – z、0 – 9 和下划线“_”作为特殊字符。
    
    如果在 AEM 早期版本中创建的模型包含非法字符，请移除或更新这些字符。
  例如：
移除字段

选择必填字段，然后选择垃圾桶图标。系统会要求您确认该操作。
添加所有必填字段，并根据需要定义相关属性。例如：
选择“保存”来保留定义。

数据类型

有一批数据类型可用于定义您的模型：

单行文本
- 添加单行文本的一个或多个字段；可以定义最大长度
多行文本
- 可以是富文本、纯文本或 Markdown 文本区域
数字
- 添加一个或多个数字字段
布尔型
- 添加布尔复选框
日期和时间
- 添加日期和/或时间
枚举
- 添加一组复选框、单选按钮或下拉列表字段
标记
- 允许片段作者访问和选择标记区域
内容引用
- 引用任何类型的其他内容；可用于创建嵌套内容
- 如果图像被引用，您可以选择显示缩略图
片段引用
- 引用其他内容片段；可用于创建嵌套内容
- 数据类型可配置为允许片段作者执行以下操作：
  - 直接编辑引用的片段。
  - 根据相应的模型创建新内容片段
JSON 对象
- 允许内容片段作者在片段的相应元素中输入 JSON 语法。
  - 使 AEM 可存储您从另一服务复制/粘贴的直接 JSON。
  - JSON 将被传递，并在 GraphQL 中作为 JSON 输出。
  - 内容片段编辑器中包括 JSON 语法高亮显示、自动完成和错误高亮显示。
制表符占位符
- 允许引入选项卡，以在编辑内容片段内容时使用。
  这会在模型编辑器中显示为分隔符，用于分隔内容数据类型列表的各个部分。每个实例表示新选项卡的开头。
  在片段编辑器中，每个实例都将显示为一个选项卡。
  
  注意
  
  此数据类型仅用于格式设置，因此 AEM GraphQL 架构会忽略此数据类型。

属性

许多属性含义一目了然，对于某些属性，其他详细信息如下：

属性名称

手动更新数据类型的此属性时，请注意名称必须仅包含** A – Z、a – z、0 – 9 和下划线“_”作为特殊字符。

注意

如果在 AEM 早期版本中创建的模型包含非法字符，请移除或更新这些字符。
呈现为
用于在片段中实现/呈现字段的各种选项。通常，此属性允许您定义作者是看到字段的单个实例，还是允许作者创建多个实例。时间 多个字段 用于定义项目的最小和最大数量 — 请参阅验证以了解更多详细信息。
字段标签
输入 字段标签 将自动生成 属性名称，如有必要，可以手动更新。
验证
基本验证可由以下机制提供：必需属性。某些数据类型具有附加的验证字段。请参阅验证，了解更多详细信息。
对于数据类型多行文本，可将默认类型定义为以下任一类型：
- 富文本
- Markdown
- 纯文本
如果未指定，则默认值富文本用于此字段。

更改内容片段模型中的默认类型仅会对在编辑器中打开并保存的现有相关内容片段生效。
独特
对于从当前模型创建的所有内容片段，内容（适用于特定字段）必须是唯一的。

用于确保内容作者不能重复已添加到同一模型的另一个片段中的内容。

例如，内容片段模型中名为 Country 的单行文本字段在两个相关内容片段中不能具有值Japan。尝试第二个实例时会发出警告。

注意

确保每个语言根的唯一性。

注意

变体可以具有与同一片段变体相同的唯一值，但与其他片段变体中使用的值不同。

注意

如果您想使用 MSM（创建内容片段的副本），则应从各个内容片段模型中使用的任何数据类型中删除任何独特的约束。
有关特定数据类型及其属性的更多详细信息，请参阅内容参考。
有关特定数据类型及其属性的更多详细信息，请参阅片段引用（嵌套片段）。
可翻译

选中内容片段模型编辑器中字段上的可翻译复选框将：
- 如果属性名称尚不存在，请确保字段的属性名称已添加到翻译配置上下文/content/dam/<sites-configuration>。
- 对于 GraphQL：请将 <translatable>Content Fragment 字段上的属性设置为 yes，以允许 GraphQL 查询过滤仅包含可翻译内容的 JSON 输出。

验证

现在，各种数据类型都可以定义在结果片段中输入内容时的验证要求：

单行文本
- 与预定义正则表达式进行比较。
数字
- 检查特定值。
内容引用
- 测试特定类型的内容。
- 只能引用指定文件大小或更小的资源。
- 只能引用预定义的宽度和/或高度范围（以像素为单位）内的图像。
片段引用
- 测试特定内容片段模型。
最小项目数 / 项目的最大数量

已定义为 多个字段 (设置 呈现为)提供了以下选项：
- 项目的最小数量
- 项目的最大数量
已验证以下各项：
- 最大值需在原始内容片段编辑器.
- 两者均已在中验证内容片段编辑器.

使用引用表单嵌套内容

内容片段可以使用以下任一数据类型形成嵌套内容：

内容引用
- 提供对其他内容的简单引用；任何类型的。
- 可以为一个或多个引用（在生成的片段中）配置。
片段引用（嵌套片段）
- 引用其他片段，具体取决于指定的特定模型。
- 让您包含/检索结构化数据。
  
  注意
  
  此方法与使用 GraphQL 内容片段的 Headless 内容投放特别相关。
  
  * 可以为一个或多个引用（在生成的片段中）配置。

注意

AEM 具有以下重复保护：

内容引用
这会阻止用户添加对当前片段的引用。这可能导致出现空的片段引用选取器对话框。
GraphQL 中的片段引用
如果创建一个深层查询，且该查询返回多个相互引用的内容片段，则该查询在第一次出现时将返回空值。

内容引用

内容引用让您呈现来自其他源的内容，例如，图像或内容片段。

除了标准属性之外，您还可以指定：

任何引用内容的根路径
可引用的内容类型
文件大小限制
如果引用了图像：
- 显示缩略图
- 图像高度和宽度的限制

内容引用

片段引用（嵌套片段）

“片段引用”会引用一个或多个内容片段。在检索应用程序中使用的内容时，此功能特别有意义，因为它让您检索具有多个层的结构化数据。

例如：

定义员工详细信息的模型；这包括：
- 对定义雇主（公司）的模型的引用

type EmployeeModel {
    name: String
    firstName: String
    company: CompanyModel
}

type CompanyModel {
    name: String
    street: String
    city: String
}

注意

这与通过 GraphQL 使用内容片段投放 Headless 内容特别相关。

除了标准属性之外，您还可以定义：

呈现为:
- 多字段 – 片段作者可以创建多个单个引用
- 片段 – 允许片段作者选择对片段的单个引用
模型类型
可以选择多个模型。在创作内容片段时，必须使用这些模型创建任何引用的片段。
根路径
这会为引用的任何片段指定根路径。
允许创建片段

这将允许片段作者根据相应的模型创建片段。
- 片段引用组合 – 允许片段作者通过选择多个片段来构建复合

注意

已建立重复保护机制。它禁止用户在片段引用中选择当前内容片段。这可能导致出现空的片段引用选取器对话框。

GraphQL 还对片段引用提供了定期保护。如果在两个相互引用的内容片段之间创建深层查询，则将返回空值。