页面模板 — 可编辑的

已为以下对象引入了可编辑的模板:

  • 允许专门的作者创建和编辑模板

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

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

使用可编辑的模板,可在组件中分隔出用于创建页面的片段。 您可以在UI中配置组件的必要组合,从而无需为每个页面变体开发新的页面组件。

注意

静态 模板也可用。

本文档:

  • 概述如何创建可编辑的模板

  • 描述创建可编辑模板所需的管理员/开发人员任务

  • 描述可编辑模板的技术基础

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

注意

在新项目中设置可编辑的页面模板时,以下教程可能也很有意义:
AEM Sites第2部分入门 — 创建基页和模板

创建新模板

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

有关如何在AEM项目中使用可编辑模板的信息,请参阅使用Lazybones创建AEM项目。

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

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

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

    注意

    提供了一系列现成的模板类型。 如果需要,您还可以创建您自己的特定于站点的模板类型

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

    结构

    • 利用结构,可为模板定义组件和内容。

    • 不能在生成页面上移动在模板结构中定义的组件,也不能从任何生成页面中删除这些组件。

      • 如果您在We.Retail示例内容以外的自定义文件夹中创建模板,则可以选择基础组件或使用核心组件
    • 如果要使页面作者能够添加和删除组件,请在模板中添加段落系统。

    • 可以解锁组件,然后再将其锁定,以便定义初始内容。

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

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

    策略

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

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

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

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

    初始内容

    • 初始内容定义在首次基于模板创建页面时显示的内容。
    • 然后,页面作者可以编辑初始内容。

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

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

    布局

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

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

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

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

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

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

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

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

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

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

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

小贴士

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

注意

模板是简化页面创建工作流程的强大工具。 但是,太多的模板可能会使作者不堪重负,并使页面创建令人困惑。 经验法则是将模板数量保持在100以下。

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

注意

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

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

有关更多信息,请参阅使用客户端库

模板文件夹

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

  • 全局
  • 特定于网站
    您为组织模板而创建的特定于站点的文件夹,其帐户具有管理员权限。
注意

即使可以嵌套文件夹,当用户在​模板​控制台中查看文件夹时,文件夹仍会显示为平面结构。

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

注意

最佳做法是创建新文件夹来保存自定义模板,而不使用全局文件夹。

注意

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

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

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

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

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

  • 以编程方式或使用CRXDE Lite
  • 使用配置浏览器

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

    • 值:要显示在​模板​控制台中的标题(文件夹的标题)。

  3. 在​中,将​添加到标准创作权限和权限(例如,content-authors)您现在需要分配组并定义所需的访问权限(ACL),以便作者能够在新文件夹中创建模板。

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

    有关管理和分配访问权限的完整详细信息,请参阅访问权限管理

使用配置浏览器

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

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

  2. 单击​创建

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

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

注意

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

有关更多信息,请参阅配置浏览器文档。

ACL和组

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

We.Retail引用实施的模板文件夹可以用作示例。

模板作者组

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成员都可以访问和创作所有模板。 对于更复杂的设置,在设置中需要多个模板作者组来分隔对模板的访问权限,必须创建更多自定义模板作者组。 但是,模板作者组的权限将保持不变。

/conf/global下的旧版模板

模板不应再存储在/conf/global中,但是,对于某些旧版安装,此位置中可能仍有模板。 只有在此类旧版情况下,才应明确配置以下/conf/global路径。

路径 角色/组 权限
描述
/conf/global/settings/wcm/templates 模板作者 读、写、复制 在中创建、读取、更新、删除和复制模板的模板作者 /conf/global
匿名Web用户 读取 匿名Web用户在渲染页面时必须读取模板
内容作者 复制 内容作者在激活页面时需要激活页面的模板
/conf/global/settings/wcm/policies Template Author 读、写、复制 在中创建、读取、更新、删除和复制模板的模板作者 /conf/global
匿名Web用户 读取 匿名Web用户在渲染页面时必须读取策略
内容作者 复制 内容作者在激活页面时需要激活页面模板的策略
/conf/global/settings/wcm/template-types 模板作者 读取 模板作者基于其中一种预定义的模板类型创建新模板
匿名Web用户 匿名Web用户不得访问模板类型

模板类型

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

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

    • 将复制模板类型以创建模板。
    • 复制后,模板与模板类型之间的唯一连接便是用于获取信息的静态引用。
  • 模板类型允许您定义:

    • 页面组件的资源类型。
    • 根节点的策略,用于定义模板编辑器中允许的组件。
    • 建议为响应式网格定义断点,并在模板类型上的设置移动模拟器。 这是可选的,因为配置也可以在单个模板上定义(请参阅模板类型和移动设备组)。
  • AEM提供了一小部分现成的模板类型,如HTML5页面和自适应表单页面。

    • We.Retail示例内容中提供了其他示例。
  • 模板类型通常由开发人员定义。

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

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

不得更改/libs路径中的任何内容。 这是因为下次升级实例时,/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/...),否则将找不到模板类型。

模板类型和移动设备组

设备组用于可编辑的模板(设置为属性cq:deviceGroups的相对路径)定义在页面创作的布局模式中,哪些移动设备可用作模拟器。 此值可设置为两个位置:

  • 在可编辑的模板类型上
  • 在可编辑的模板上

创建新的可编辑模板时,该值会从模板类型复制到单个模板。 如果未在类型上设置值,则可以在模板上设置该值。 创建模板后,类型对模板的继承就不存在。

注意

cq:deviceGroups必须设置为mobile/groups/responsive等相对路径,而不是设置为/etc/mobile/groups/responsive等绝对路径。

注意

使用静态模板时,可以在站点的根位置设置cq:deviceGroups的值。

使用可编辑的模板,此值现在存储在模板级别,而在页面根级别不受支持。

创建模板类型

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

  1. 创建模板,就像您对任何可编辑的模板执行操作一样,如此处所述,该模板将用作模板类型的基础。
  2. 使用CRXDE Lite,将新创建的模板从templates节点复制到模板文件夹下的template-types节点。
  3. template文件夹下的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下的组件显式节点上,可提供指向各个组件策略的链接。

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

注意

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

注意

从可编辑模板创建的页面在页面编辑器中不提供设计模式。

可编辑模板的policies树的层次结构与静态模板的设计模式配置在以下位置相同:

/etc/designs/<my-site>/jcr:content/<component-name>

为每个页面组件定义了静态模板的设计模式配置。

页面策略

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

启用和允许模板以用于

  1. 启用模板

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

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

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

      • 例如,在:

        /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
      提供对模板类型的引用。

chlimage_1-71

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

  • 控制器 — /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属性指向实际的内容策略(即,它包含该组件的设计配置)。

      • 这样,您就可以拥有多个重复使用相同内容策略配置的模板。

在此页面上