Show Menu
主题×

页面模板——可编辑

可编辑模板已引入:
  • 允许专业作者创 建和编辑模板
    • 此类专业作者称为模 板作者
    • 模板作者必须是组的成 template-authors 员。
  • 提供模板,它们可以保留与从它们创建的任何页面的动态连接。 这可确保模板的任何更改都反映在页面本身中。
  • 使页面组件更加通用,这样无需自定义即可使用核心页面组件。
借助可编辑的模板,可在组件中隔离制作页面的片段。 您可以在UI中配置组件的必要组合,从而无需为每个页面变体开发新的页面组件。
静态模板 也可用。
本文档:
  • 概述了如何创建可编辑的模板
  • 描述创建可编辑模板所需的管理员/开发人员任务
  • 描述可编辑模板的技术基础
此文档假定您已经熟悉创建和编辑模板。 请参阅创作文档 创建页面模板 ,该模板详细介绍了模板作者可编辑模板的功能。
以下教程可能也会对在新项目中设置可编辑的页面模板感兴趣: AEM Sites第2部分入门——创建基页和模板

Creating a New Template

创建可编辑的模板主要由模 板作者使用模板控制台 和模板编辑器完成。 本节概述了此过程,并随后介绍了在技术层面发生的情况。
有关如何在AEM项目中使用可编辑模板的信息,请 参阅使用Lazybones创建AEM项目
创建新的可编辑模板时,您需要执行以下步骤:
  1. 为模 板创建文件夹 。 这不是强制性的,但建议采用最佳实践。
  2. 选择模 板类型 。 复制此模板以创建 模板定义
    现成提供模板类型选项。 您还可以根 据需要创建自己的站点特定模板类 型。
  3. 配置新模板的结构、内容策略、初始内容和布局。
    结构
    • 该结构允许您为模板定义组件和内容。
    • 不能在生成页面上移动在模板结构中定义的组件,也不能从任何生成页面中删除这些组件。
      • 如果要在We.Retail示例内容之外的自定义文件夹中创建模板,则可以选择基础组件或使用核 心组件
    • 如果要使页面作者能够添加和删除组件,请在模板中添加段落系统。
    • 可以解锁组件,然后再将其锁定,以便定义初始内容。
    有关模板作者如何定义结构的详细信息,请参阅 创建页面模板
    有关结构的技术详细信息,请参 阅此文档 中的“结构”。
    策略
    • 内容策略定义组件的设计属性。
      • 例如,可用的组件或最小/最大尺寸。
    • 这些属性适用于模板(和使用模板创建的页面)。
    有关模板作者如何定义策略的详细信息,请参 阅创建页面模板
    有关策略的技术详细信息,请参 阅此文档 中的内容策略。
    初始内容
    • 初始内容定义首次根据模板创建页面时将显示的内容。
    • 初始内容随后可由页面作者编辑。
    有关模板作者如何定义结构的详细信息,请参阅 创建页面模板
    有关初始内容的技术详细信息,请 参阅此文档 中的初始内容。
    布局
    • 您可以为各种设备定义模板布局。
    • 模板的响应式布局与页面创作时的响应式布局功能相同。
    有关模板作者如何定义模板布局的详细信息,请参阅 创建页面模板
    有关模板布局的技术详细信息,请参 阅此文档 中的布局。
  4. 启用模板,然后为特定内容树允许它。
    • 可以启用或禁用模板,以使其对页面作者可用或不可用。
    • 可以使模板可用于或不可用于某些页面分支。
    有关模板作者如何启用模板的详细信息,请参阅创 建页面模板
    有关启用模板的技术详细信息,请 参阅启用和允许在此文档 中使用模板
  5. 使用它创建内容页面。
    • 使用静态模板和可编辑的模板创建新页面的过程没有明显的区别,也没有孰优孰劣之分。
    • 对于页面作者而言,该创建过程一目了然。
    有关页面作者如何使用模板创建页面的详细信息,请参 阅创建和组织页面
    有关使用可编辑模板创建页面的技术详细信息,请 参阅此文档中的 “生成内容页面”。
编辑器客户端库假定内容页 cq.shared 面中存在命名空间,如果不存在,则将 Uncaught TypeError: Cannot read property 'shared' of undefined 导致JavaScript错误。
所有示例内容页面都 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. 转到“全 局导航 ”-> “工具 >“配 ​置浏览器”。
    现有文件夹将列在左侧,包括全 ​局文件夹。
  2. 单击​ 创建
  3. 在创 建配置 对话框中,需要配置以下字段:
    • 标题 : 提供配置文件夹的标题
    • 可编辑模板 : 勾号,允许在此文件夹内创建可编辑的模板
  4. Click Create
在配置浏览器中,如果您希望在该文件夹内创建模板,可以编辑 全局文件夹 ,并激活“可编辑模板”选项,但建议不要这样做。

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用户不能访问模板类型

Template Type

创建新模板时,您需要指定模板类型:
  • 模板类型有效地为模板提供模板。 创建新模板时,将使用所选模板类型的结构和初始内容创建新模板。
    • 将复制模板类型以创建模板。
    • 复制完成后,模板与模板类型之间的唯一连接就是静态引用,供参考。
  • 模板类型允许您定义:
    • 页面组件的资源类型。
    • 根节点的策略,它定义模板编辑器中允许的组件。
    • 建议在模板类型上为响应式网格和移动模拟器的设置定义断点。 这是可选的,因为配置也可以在单个模板上定义(请参 阅模板类型和移动设备组 )。
  • AEM提供一些现成的模板类型选项,如HTML5页面和自适应表单页面。
  • 模板类型通常由开发人员定义。
现成模板类型存储在以下位置:
  • /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. 从模板文件夹下 templates 的节点中 删除模板
  4. 在节点下的模板副本中,删 template-types 除所有属 cq:template cq: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
    • : draft , enabled or disabled

结构

定义生成页面的结构:
  • 在创建新页面时,与 /initial 初始内容()合并。
  • 对结构所做的更改将反映在使用模板创建的任何页面中。
  • ( root )节 structure/jcr:content/root 点定义将在生成页面中可用的组件的列表。
    • 在模板结构中定义的组件不能移动到任何生成页面或从任何生成页面中删除。
    • 解锁组件后, editable 属性将设置为 true
    • 解锁已包含内容的组件后,此内容将移到分 initial 支。
  • 该节 cq:responsive 点保存响应式布局的定义。

初始内容

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

Content Policies

内容(或设计)策略可定义组件的设计属性。例如,可用的组件或最小/最大尺寸。这些属性适用于模板(和使用模板创建的页面)。可以在模板编辑器中创建和选择内容策略。
  • 节点 cq:policy 上的属 root /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 属性。
      • 例如,在:
        /conf/<your-folder>/settings/wcm/templates/<your-template>/jcr:content
      • 定义属性:
        • 名称: 状态
        • 类型: 字符串
        • 值: enabled
  2. 允许的模板
    /conf/<your-folder>/settings/wcm/templates/.*

生成内容页面

从可编辑模板创建的页面:
  • 是使用从模板中合并的子 structure initial 创建的
  • 具有对模板和模板类型中信息的引用。 这是通过具有以下属 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 在创作环境和发布上,内容由组件 呈现
呈现页面时:
  • 模板 :
    • 将引 cq:template 用其节 jcr:content 点的属性以访问与该页面对应的模板。
  • 组件 :
    • 页面组件将合并 structure/jcr:content 模板的树和页 jcr:content 面的树。
    • 页面组件将仅允许作者编辑已标记为可编辑的模板结构的节点(以及任何子节点)。
    • 在页面上渲染组件时,该组件的相对路径将从节点中取 jcr:content 出; 随后将搜索模 policies/jcr:content 板节点下的同一路径。
      • cq:policy 节点的属性指向实际的内容策略(即它包含该组件的设计配置)。
      • 这允许您拥有多个可重复使用相同内容策略配置的模板。