页面模板 page-templates

创建页面时,您需要选择模板。 页面模板用作新页面的基础。 模板定义生成页面的结构、任何初始内容以及可以使用的组件(设计属性)。 这有几个优点:

  • 页面模板允许专业作者创建和编辑模板

    • 此类专用作者称为​ 模板作者
    • 模板作者必须是template-authors组的成员。
  • 页面模板会保留与从中创建的任何页面的动态连接。 这可确保对模板所做的任何更改都会反映在页面本身中。

  • 页面模板使页面组件变得更通用,以便无需自定义即可使用核心页面组件。

使用页面模板,构成页面的片段被隔离在组件中。 您可以在UI中配置必要的组件组合,从而无需为每个页面变体开发新的页面组件。

本文档:

  • 提供了创建页面模板的概述
  • 描述创建可编辑模板所需的管理员/开发人员任务
  • 描述可编辑模板的技术基础
  • 描述AEM如何评估模板的可用性
NOTE
本文档假设您已熟悉创建和编辑模板。 请参阅创作文档创建页面模板,其中详细说明了向模板作者公开的可编辑模板的功能。
TIP
WKND教程通过实施示例深入了解如何使用页面模板,对于了解如何在新项目中设置模板非常有用

创建新模板 creating-a-new-template

创建页面模板主要由模板作者使用模板控制台和模板编辑器完成。 本节概述了此过程,并在后面描述了技术级别所发生的情况。

创建可编辑模板时,您可以:

  1. 为模板🔗创建一个文件夹。 这并非强制要求,但建议采用最佳实践。

  2. 选择模板类型。 复制该模板以创建模板定义

    note note
    NOTE
    现成提供模板类型选择。 如有必要,您还可以创建您自己的站点特定的模板类型
  3. 配置新模板的结构、内容策略、初始内容和布局。

    结构

    • 利用结构,可为模板定义组件和内容。
    • 不能在生成页面上移动在模板结构中定义的组件,也不能从任何生成页面中删除这些组件。
    • 如果要使页面作者能够添加和删除组件,请在模板中添加段落系统。
    • 可以解锁组件,然后再将其锁定,以便定义初始内容。

    有关模板作者如何定义结构的详细信息,请参阅创建页面模板

    有关结构的技术详细信息,请参阅本文档中的结构

    策略

    • 内容策略定义组件的设计属性。

      • 例如,可用的元件或最小/最大尺寸。
    • 这些属性适用于模板(和使用模板创建的页面)。

    有关模板作者如何定义策略的详细信息,请参阅创建页面模板

    有关策略的技术详细信息,请参阅本文档中的内容策略

    初始内容

    • 初始内容定义首次根据模板创建页面时将显示的内容。
    • 随后,页面作者可以编辑初始内容。

    有关模板作者如何定义结构的详细信息,请参阅创建页面模板

    有关初始内容的技术详细信息,请参阅本文档中的初始内容

    布局

    • 您可以为各种设备定义模板布局。
    • 模板的响应式布局与页面创作时的响应式布局功能相同。

    有关模板作者如何定义模板布局的详细信息,请参阅创建页面模板

    有关模板布局的技术详细信息,请参阅本文档中的布局

  4. 启用模板,然后为特定内容树允许该模板。

    • 可以启用或禁用模板,使其对页面作者可用或不可用。
    • 可以使模板可用于或不可用于某些页面分支。

    有关模板作者如何启用模板的详细信息,请参阅创建页面模板

    有关启用模板的技术详细信息,请参阅本文档中的为我们启用和允许模板e

  5. 使用它创建内容页面。

    • 使用模板创建页面时,静态模板与可编辑模板之间没有可见的区别和指示。
    • 对于页面作者,该过程是透明的。

    有关页面作者如何使用模板创建页面的详细信息,请参阅创建和组织页面

    有关使用可编辑模板创建页面的技术详细信息,请参阅本文档中的生成内容页面

TIP
切勿在模板中输入任何必须国际化的信息。 出于内部化的目的,建议使用核心组件🔗的本地化功能。
NOTE
模板是简化页面创建工作流的强大工具。不过,太多的模板会让作者不知所措,并使页面创建变得混乱。一个好的经验法则是将模板的数量保持在 100 个以内。
由于潜在的性能影响,Adobe 建议不要使用超过 1000 个模板。
NOTE
编辑器客户端库假定内容页面中存在cq.shared命名空间,如果该名称不存在,将导致JavaScript错误Uncaught TypeError: Cannot read property 'shared' of undefined
所有示例内容页面都包含cq.shared,因此任何基于它们的内容都会自动包含cq.shared。 但是,如果您决定从头开始创建自己的内容页面,而不基于示例内容,则必须确保包含cq.shared命名空间。
有关详细信息,请参阅使用客户端库

模板文件夹 template-folders

要组织模板,您可以使用以下文件夹:

  • global
  • 站点特定
NOTE
即使您可以嵌套文件夹,但当用户在​ 模板 ​控制台中查看文件夹时,它们将显示为平面结构。

在标准AEM实例中,global文件夹已存在于模板控制台中。 该文件夹会保存默认模板,如果在当前文件夹中未找到策略和/或模板类型,则该文件夹会充当备用。 您可以将默认模板添加到此文件夹或创建文件夹(推荐)。

NOTE
最佳做法是创建一个文件夹来存放自定义模板,而不是使用global文件夹。
CAUTION
文件夹必须由具有admin权限的用户创建。

模板类型和策略将按照以下优先级顺序跨所有文件夹继承:

  1. 当前文件夹
  2. 当前文件夹的父文件夹
  3. /conf/global
  4. /apps
  5. /libs

将创建所有允许条目的列表。 如果任何配置重叠(path/ label),则只向用户显示最接近当前文件夹的实例。

要创建文件夹,您可以执行以下操作:

使用 CRXDE Lite using-crxde-lite

  1. 可以通过编程方式或使用CRXDE Lite为实例创建新文件夹(位于/conf下)。

    必须使用以下结构:

    code language-xml
    /conf
        <your-folder-name> [sling:Folder]
            settings [sling:Folder]
                wcm [cq:Page]
                    templates [cq:Page]
                    policies [cq:Page]
    
  2. 然后,您可以在文件夹根节点上定义以下属性:

    <your-folder-name> [sling:Folder]

    • 名称:jcr:title
    • 类型:String
    • 值:您希望在​ 模板 ​控制台中显示的标题(针对文件夹)。
  3. 除了标准创作权限和特权(例如content-authors)之外,您现在需要分配组并定义作者所需的访问权限(ACL),以便能够在新文件夹中创建模板。

    template-authors组是必须分配的默认组。 有关详细信息,请参阅ACL和组部分。

使用配置浏览器 using-the-configuration-browser

  1. 转到​ 全局导航 > 工具 > 配置浏览器

    现有文件夹在左侧列出,包括global文件夹。

  2. 单击​ 创建

  3. 在​ 创建配置 ​对话框中,需要配置以下字段:

    • 标题:提供配置文件夹的标题
    • 可编辑模板:勾选以允许在此文件夹中编辑模板
  4. 单击​ 创建

NOTE
配置浏览器中,如果想要在此文件夹中创建模板,可以编辑全局文件夹并激活​ 可编辑模板 ​选项,但这不是建议的最佳做法。

ACL和组 acls-and-groups

创建模板文件夹(通过CRXDE或使用配置浏览器)后,必须为模板文件夹的相应组定义ACL,以确保适当的安全性。

WKND教程的模板文件夹可以用作示例。

模板作者组 the-template-authors-group

template-authors组是用于管理对模板的访问权限的组,它是AEM的标准组,但为空。 必须将用户添加到项目/站点的组中。

CAUTION
template-authors组仅适用于必须能够创建新模板的用户。
编辑模板的功能非常强大,如果不正确编辑模板,现有模板可能会受损。 因此,此角色应重点明确,仅包含符合条件的用户。

下表详细列出了模板编辑所需的权限。

路径
角色/组
权限
描述
/conf/<your-folder>/settings/wcm/templates
模板作者
读取、写入、复制
在站点特定的/conf空间中创建、读取、更新、删除和复制模板的模板作者
匿名Web用户
读取
匿名Web用户在呈现页面时必须读取模板
内容作者
复制
复制激活页面时,内容作者需要激活页面的模板
/conf/<your-folder>/settings/wcm/policies
Template Author
读取、写入、复制
在站点特定的/conf空间中创建、读取、更新、删除和复制模板的模板作者
匿名Web用户
读取
匿名Web用户在呈现页面时必须读取策略
内容作者
复制
内容作者在激活页面时需要激活页面模板的策略
/conf/<site>/settings/template-types
模板作者
读取
模板作者根据预定义的模板类型之一创建新模板。
匿名Web用户
匿名Web用户不得访问模板类型

此默认template-authors组仅涵盖项目设置,其中所有template-authors成员都有权访问和创作所有模板。 对于更复杂的设置,需要多个模板作者组来分隔对模板的访问,则必须创建更多自定义模板作者组。 但是,模板作者组的权限将仍然相同。

模板类型 template-type

创建模板时,您需要指定模板类型:

  • 模板类型可以有效地为模板提供模板。 创建模板时,使用所选模板类型的结构和初始内容创建新模板。

    • 将复制模板类型以创建模板。
    • 复制完成后,模板和模板类型之间的唯一连接是用作信息的静态引用。
  • 模板类型允许您定义:

    • 页面组件的资源类型。
    • 根节点的策略,用于定义模板编辑器中允许的组件。
    • 建议为响应式网格定义断点,并在模板类型上设置移动设备模拟器。
  • AEM提供了少量的现成模板类型,如“HTML5页面”和“自适应表单页面”。

    • 其他示例作为WKND教程的一部分提供。
  • 模板类型通常由开发人员定义。

现成的模板类型存储在下:

  • /libs/settings/wcm/template-types
CAUTION
您不得更改/libs路径中的任何内容。 这是因为/libs的内容可以随时由AEM更新覆盖。

特定于站点的模板类型应存储在类似位置:

  • /apps/settings/wcm/template-types

自定义模板类型的定义应存储在用户定义的文件夹中(推荐)或存储在global中。 例如:

  • /conf/<my-folder-01>/<my-folder-02>/settings/wcm/template-types
  • /conf/<my-folder>/settings/wcm/template-types
  • /conf/global/settings/wcm/template-types
CAUTION
模板类型必须遵循正确的文件夹结构(即/settings/wcm/...),否则将无法找到模板类型。

创建模板类型 creating-template-types

如果您已创建可作为其他模板基础的模板,则可以将此模板作为模板类型复制。

  1. 创建模板,就像创建此处🔗记录的任意页面模板一样,该模板将用作模板类型的基础。
  2. 使用CRXDE Lite,将创建的模板从templates节点复制到模板文件夹下的template-types节点。
  3. 模板文件夹下的templates节点中删除模板。
  4. template-types节点下的模板副本中,从所有jcr:content节点中删除所有cq:templatecq:templateType属性。

您还可以在GitHub上使用示例可编辑模板作为基础来开发自己的模板类型。

GITHUB上的代码

您可以在GitHub上找到此页面的代码

模板定义 template-definitions

可编辑模板的定义存储在用户定义文件夹(推荐)或global中。 例如:

  • /conf/<my-folder>/settings/wcm/templates
  • /conf/<my-folder-01>/<my-folder-02>/settings/wcm/templates
  • /conf/global/settings/wcm/templates

模板的根节点为cq:Template类型,骨架结构为:

<template-name>
  initial
    jcr:content
      root
        <component>
        ...
        <component>
  jcr:content
    @property status
  policies
    jcr:content
      root
        @property cq:policy
        <component>
          @property cq:policy
        ...
        <component>
          @property cq:policy
  structure
    jcr:content
      root
        <component>
        ...
        <component>
      cq:responsive
        breakpoints
  thumbnail.png

主要内容包括:

  • <template-name>

    • [initial](#initial-content)
    • jcr:content
    • [structure](#structure)
    • [policies](#policies)
    • thumbnail.png

jcr:content jcr-content

此节点保存模板的属性:

  • 名称jcr:title

  • 名称status

    • ''类型String
    • draftenableddisabled

结构 structure

定义生成页面的结构:

  • 在创建页面时与初始内容(/initial)合并。

  • 对结构所做的更改会反映在使用模板创建的任何页面中。

  • root (structure/jcr:content/root)节点定义了结果页面中可用的组件列表。

    • 无法在任何生成页面上移动或删除在模板结构中定义的组件。
    • 解锁组件后,editable属性将设置为true
    • 解锁已包含内容的组件后,此内容将移至initial分支。
  • cq:responsive节点包含响应布局的定义。

初始内容 initial-content

定义新页面在创建时将具有的初始内容:

  • 包含已复制到任何新页面的jcr:content节点。
  • 在创建页面时与结构(/structure)合并。
  • 如果在创建后更改了初始内容,则不会更新任何现有页面。
  • root节点保存组件列表,以定义结果页面中可用的组件。
  • 如果在结构模式下将内容添加到组件且随后解锁该组件(或反之),则此内容将用作初始内容。

布局 layout

编辑模板时,您可以定义布局,这会使用标准响应布局

内容策略 content-policies

内容策略定义组件的设计属性。 例如,可用的组件或最小/最大尺寸。这些选项适用于模板(以及使用该模板创建的页面)。 可以在模板编辑器中创建和选择内容策略。

  • root节点上的属性cq:policy
    /conf/<your-folder>/settings/wcm/templates/<your-template>/policies/jcr:content/root
    为页面的段落系统提供内容策略的相对引用。

  • 属性cq:policy位于root下的组件显式节点上,提供指向各个组件策略的链接。

  • 实际的策略定义存储在以下位置:
    /conf/<your-folder>/settings/wcm/policies/wcm/foundation/components

NOTE
策略定义的路径取决于组件的路径。 cq:policy保留对配置本身的相对引用。

页面策略 page-policies

页面策略允许您在模板或生成页面中为页面(主parsys)定义内容策略

启用和允许使用模板 enabling-and-allowing-a-template-for-use

  1. 启用模板

    在使用模板之前,必须通过以下任一方式启用模板:

    • 从​ 模板 ​控制台启用模板

    • 正在设置jcr:content节点上的状态属性。

      • 例如,在:

        /conf/<your-folder>/settings/wcm/templates/<your-template>/jcr:content

      • 定义属性:

        • 名称:状态
        • 类型:字符串
        • 值: enabled
  2. 允许的模板

    例如,其值为:

    /conf/<your-folder>/settings/wcm/templates/.*

生成内容页面 resultant-content-pages

从可编辑模板创建的页面:

  • 使用模板中从structureinitial合并的子树创建

  • 具有对模板和模板类型中包含的信息的引用。 这可以通过具有以下属性的jcr:content节点实现:

    • cq:template — 提供对实际模板的动态引用;使对模板的更改能够反映在实际页面上。

    • cq:templateType — 提供对模板类型的引用。

模板、内容和组件如何相互关联

上图显示了模板、内容和组件如何相互关联:

  • 控制器 — /content/<my-site>/<my-page> — 引用模板的结果页面。 内容控制着整个过程。 根据定义,访问相应的模板和组件。
  • 配置 — /conf/<my-folder>/settings/wcm/templates/<my-template> - 模板和相关内容策略定义页面配置。
  • 模型 — OSGi包 — OSGI包实现该功能。
  • 视图 — /apps/<my-site>/components — 在创作和发布环境中,内容由组件渲染。

呈现页面时:

  • 模板

    • 引用其jcr:content节点的cq:template属性以访问与该页面对应的模板。
  • 组件

    • 页面组件会将模板的structure/jcr:content树与页面的jcr:content树合并。

      • 页面组件将仅允许作者编辑已标记为可编辑的模板结构的节点(以及任何子节点)。
      • 在页面上呈现组件时,将从jcr:content节点中获取该组件的相对路径;随后将搜索模板的policies/jcr:content节点下的相同路径。
        • 此节点的cq:policy属性指向实际内容策略(即保存该组件的设计配置)。
          • 这样,您就可以拥有多个重复使用相同内容策略配置的模板。

模板可用性 template-availability

在站点管理界面中创建页面时,可用模板的列表取决于新页面的位置以及在每个模板中指定的版面限制。

以下属性确定是否允许将模板T用于要作为页面P的子页面放置的新页面。 以下每个属性都是一个多值字符串,其中包含零个或多个用于与路径匹配的正则表达式:

  • Pjcr:content子节点或P的上级的cq:allowedTemplates属性。

  • TallowedPaths属性。

  • TallowedParents属性。

  • P模板的allowedChildren属性。

评估工作如下:

  • P开头的页面层次结构升序时找到的第一个非空cq:allowedTemplates属性与T的路径匹配。 如果没有任何匹配的值,则会拒绝T

  • 如果T具有非空的allowedPaths属性,但没有值与P的路径匹配,则T被拒绝。

  • 如果上述两个属性都为空或不存在,T将被拒绝,除非它与P属于同一应用程序。 当且仅当T路径的第二级名称与P路径的第二级名称相同时,TP属于同一应用程序。 例如,模板/apps/wknd/templates/foo与页面/content/wknd属于同一应用程序。

  • 如果T具有非空的allowedParents属性,但没有值与P的路径匹配,则T被拒绝。

  • 如果P的模板具有非空的allowedChildren属性,但没有值与T的路径匹配,则T被拒绝。

  • 在所有其他情况下,允许T

下图描述了模板评估流程:

模板评估流程

CAUTION
AEM提供了多个属性以控制​ 站点 ​下允许的模板。 但是,将它们组合在一起可能会导致非常复杂的规则,这些规则难以跟踪和管理。
因此,Adobe建议您从定义以下内容开始:
  • cq:allowedTemplates属性

  • 仅在站点根目录上

有关示例,请参阅WKND教程内容: /content/wknd/jcr:content
属性allowedPathsallowedParentsallowedChildren也可以放在模板上以定义更复杂的规则。 但是,如果可能,如果需要进一步限制允许的模板,在网站的子区域上定义其他cq:allowedTemplates属性会更简单​ 许多
另一个优点是cq:allowedTemplates属性可由作者在​ 页面属性 ​的​ 高级 ​选项卡中更新。 无法使用(标准)UI更新其他模板属性,因此需要开发人员维护规则和每次更改的代码部署。

限制子页面中使用的模板 limiting-templates-used-in-child-pages

要限制哪些模板可用于在给定页面下创建子页面,请使用页面jcr:content节点的cq:allowedTemplates属性指定允许作为子页面的模板列表。 列表中的每个值都必须是允许的子页面的模板的绝对路径,例如/apps/wknd/templates/page-content

您可以在模板的jcr:content节点上使用cq:allowedTemplates属性,将此配置应用于使用此模板的所有已创建页面。

如果要添加更多约束(例如,关于模板层次结构),可以在模板上使用allowedParents/allowedChildren属性。 然后,您可以明确指定从模板T创建的页面必须是从模板T创建的页面的父项/子项。

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab