页面模板

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

  • 页面模板允许专业作者创建和编辑模板
    • 此类专用作者称为​模板作者
    • 模板作者必须是template-authors组的成员。
  • 页面模板可保留与通过它们创建的任何页面的动态连接。 这可确保模板的任何更改都反映在页面本身中。
  • 页面模板使页面组件更加通用,因此无需自定义即可使用核心页面组件。

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

本文档:

  • 概述创建页面模板
  • 描述创建可编辑模板所需的管理员/开发人员任务
  • 描述可编辑模板的技术基础
  • 描述AEM如何评估模板的可用性
注意

此文档假定您已经熟悉创建和编辑模板。 请参阅创作文档创建页面模板,其中详细介绍了模板作者可编辑模板的功能。

小贴士

WKND教程 通过实施示例深入介绍如何使用页面模板,对于了解如何在新项目中设置模板非常有用

创建新模板

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

创建新的可编辑模板时,您需要执行以下步骤:

  1. 为模板🔗创建文件夹。 这不是强制性的,但建议采用最佳实践。

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

    注意

    现成提供模板类型选项。 如果需要,还可以创建您自己的站点特定模板类型

  3. 配置新模板的结构、内容策略、初始内容和布局。

    结构

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

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

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

    策略

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

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

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

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

    初始内容

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

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

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

    布局

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

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

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

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

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

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

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

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

    • 使用静态模板和可编辑的模板创建新页面的过程没有明显的区别,也没有孰优孰劣之分。
    • 对于页面作者而言,该创建过程一目了然。

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

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

小贴士

切勿在模板中输入任何需要国际化的信息。出于内部化目的,建议使用核心组件🔗的本地化功能。

注意

模板是简化页面创建工作流程的强大工具。 但是,过多的模板可能会使作者不堪重负,并使页面创建变得混乱。 一个不错的经验法则是将模板数量保持在100以下。

Adobe不建议具有1000个以上的模板,因为这可能会影响性能。

注意

编辑器客户端库假定内容页面中存在cq.shared命名空间,如果不存在,则将导致JavaScript错误Uncaught TypeError: Cannot read property 'shared' of undefined

所有示例内容页面都包含cq.shared,因此基于这些页面的任何内容都会自动包含cq.shared。 但是,如果您决定从头开始创建您自己的内容页面而不基于示例内容,则必须确保包含cq.shared命名空间。

有关详细信息,请参阅使用客户端库

模板文件夹

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

  • global
  • 站点特定
注意

即使您可以嵌套文件夹,当用户在​模板​控制台中视图文件夹时,这些文件夹也会显示为平面结构。

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

注意

最好创建一个新文件夹来保存您的自定义模板,而不使用global文件夹。

注意

文件夹必须由具有admin权限的用户创建。

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

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

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

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

使用CRXDE Lite

  1. 可以通过编程或CRXDE Lite为实例创建新文件夹(在/conf下)。

    必须使用以下结构:

    /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
    • 值:要显示在​Templates​控制台中的标题(用于文件夹)。
  3. 除了标准创作权限和权限(例如,content-authors),您现在需要为作者分配组并定义所需的访问权限(ACL),以便在新文件夹中创建模板。

    template-authors组是需要分配的默认组。 有关详细信息,请参见ACL和组一节。

使用配置浏览器

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

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

  2. 单击​创建

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

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

注意

配置浏览器中,如果您希望在此文件夹中创建模板,可以编辑全局文件夹并激活​可编辑模板​选项,但建议不要这样做。

ACL和组

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

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

template-authors组

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

注意

template-authors组仅适用于必须能够创建新模板的用户。

编辑模板功能非常强大,如果不能正确编辑,现有模板就会损坏。 因此,该角色应集中并仅包括合格用户。

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

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

此默认template-authors组仅涵盖项目设置,所有template-authors成员均可访问和创作所有模板。 对于更复杂的设置,在这些设置中,需要多个模板作者组才能单独访问模板,必须创建更多自定义模板作者组。 但是,模板作者组的权限将保持不变。

模板类型

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

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

    • 将复制模板类型以创建模板。
    • 复制完成后,模板与模板类型之间的唯一连接就是静态引用,供参考。
  • 模板类型允许您定义:

    • 页面组件的资源类型。
    • 根节点的策略,它定义模板编辑器中允许的组件。
    • 建议在模板类型上为响应式网格和移动模拟器的设置定义断点。
  • AEM提供一些现成的模板类型选项,如HTML5页面和自适应表单页面。

  • 模板类型通常由开发人员定义。

现成模板类型存储在以下位置:

  • /libs/settings/wcm/template-types
注意

不得更改/libs路径中的任何内容。 这是因为对AEM的更新可以随时覆盖/libs的内容。

站点特定的模板类型应存储在以下可比位置:

  • /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
注意

模板类型必须遵循正确的文件夹结构(即/settings/wcm/...),否则将找不到模板类型。

创建模板类型

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

  1. 按照此处🔗的说明创建任何页面模板的模板,它将作为模板类型的基础。
  2. 使用CRXDE Lite,将新创建的模板从templates节点复制到template文件夹下的template-types节点。
  3. template folder下的templates节点中删除模板。
  4. template-types节点下的模板副本中,删除所有cq:templatecq:templateType jcr:content属性。

您还可以根据GitHub提供的示例可编辑模板,开发您自己的模板类型。

GITHUB上的代码

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

模板定义

可编辑模板的定义存储在用户定义的文件夹(推荐)或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:title
  • 名称: status
    • ``类型: String
    • : draftenableddisabled

结构

定义生成页面的结构:

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

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

  • root(structure/jcr:content/root)节点定义将在生成页面中可用的组件列表。

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

初始内容

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

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

布局

编辑模板时,您可以定义布局,它使用标准响应式布局🔗

内容策略

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

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

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

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

注意

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

页面策略

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

启用和允许使用模板

  1. 启用模板

    必须通过以下任一方式启用模板才能使用模板:

    • 从“模 板”控制台启 ​用模板。

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

      • 例如,在:

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

      • 定义属性:

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

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

生成内容页

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

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

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

    • cq:template -提供对实际模板的动态引用;允许在实际页面上反映对模板所做的更改。

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

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

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

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

呈现页面时:

  • 模板:

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

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

模板可用性

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

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

  • Pjcr:content子节点或P的祖代的cq:allowedTemplates属性。

  • TallowedPaths属性。

  • TallowedParents属性。

  • P模板的allowedChildren属性。

评价工作如下:

  • 对以P开头的页面层次结构进行升序时找到的第一个非空cq:allowedTemplates属性与T的路径匹配。 如果所有值均不匹配,则拒绝T

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

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

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

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

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

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

模板评估流程

注意

AEM优惠多个属性以控制​Sites​下允许的模板。 但是,将这些规则组合在一起可能会导致非常复杂的规则,难以跟踪和管理。

因此,Adobe建议您通过定义以下各项来简化开始:

  • cq:allowedTemplates属性

  • 仅在站点根目录上

有关示例,请参阅WKND教程内容:/content/wknd/jcr:content

属性allowedPathsallowedParentsallowedChildren也可以放在模板上,以定义更复杂的规则。 但是,如果可能,如果需要进一步限制允许的模板,则在站点的子部分上进一步定义cq:allowedTemplates属性会更简单。**

另一个优势是,作者可以在​页面属性​的​高级​选项卡中更新cq:allowedTemplates属性。 其他模板属性无法使用(标准)UI进行更新,因此需要开发人员为每次更改维护规则和代码部署。

限制子页面中使用的模板

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

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

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

On this page

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now