社区组件指南

最近更新： 2024年7月15日

创建对象：

  • 管理员

社区组件指南是社交组件框架(SCF)的交互式开发工具。 它提供了可用Adobe Experience Manager (AEM) Communities组件的列表，或由多个组件构建的更复杂功能的列表。

除了每个组件的基本信息外，本指南还允许试验SCF组件/功能的工作方式以及配置或自定义它们的方法。

有关与每个组件相关的开发必需项的信息，请参阅功能和组件必需项。

快速入门

本指南适用于创作实例(localhost：4502)和发布实例(localhost：4503)的开发安装。

通过浏览到，可访问社区组件站点

与社区组件的交互方式因以下因素而异：

  • 服务器（创作或发布）。
  • 网站访客是否已登录。
  • 如果登录，则为成员分配权限。
  • 是否正在使用默认SRP JSRP。

在作者上，要进入编辑模式，请在服务器名称后插入editor.html或cf#作为第一个路径段：

NOTE
在编辑模式下进行创作时，页面上的链接无效。
要导航到组件页面，请首先选择预览模式以激活链接。
在浏览器中显示组件页面后，返回到编辑模式以打开组件的编辑对话框。
有关一般创作信息，请查看页面创作快速指南。
如果不熟悉AEM，请查看有关基本处理的文档。

主页

该指南在页面左侧提供了可用于预览和原型制作的SCF组件列表。

在编辑模式下在创作实例上查看的组件指南：

community-component1

组件页面

从页面上左侧的列表中选择一个组件。

社区组件页面

此时将显示指南的主体：

  1. 标题：所选组件的名称

  2. 客户端库：包含一个或多个所需类别的列表

  3. 可包含：如果组件可以动态包含，则可以在创作编辑模式下切换状态：

    • 如果添加，则显示文本为：“此组件通过其par节点包括在内。”
    • 如果包括，则显示的文本为：“此组件是动态包括的。”
    • 如果不可包含，则不会显示任何文本

  4. 示例元件或特征：元件或特征的活动实例。 如果是一个组件，则它可能会随对选项卡部分中提供的模板、CSS和数据所做的更改而发生更改。

NOTE
从左侧进行选择后，如果浏览器窗口太窄，组件将显示在组件列表的下方，而不是旁边。

作者交互

在创作实例上使用指南时，可以通过打开组件对话框来体验配置组件的过程。 在文档的组件和Feature Essentials部分中为开发人员提供了信息，而对话框设置则在供作者使用的社区组件部分中进行了说明。

对于社区组件指南，某些组件对话框设置使用Inclustable切换状态覆盖。 要在使用现有资源或动态包含的资源之间进行切换，请在编辑模式下同时选择组件和可包含的文本，然后双击以打开编辑对话框：

社区组件3

在​ 模板 ​选项卡下：

community-component4

  • 包含具有sling：include ​的子组件

    如果未选中，《组件指南》将使用存储库中的现有资源（一个jcr节点，它是par节点的子节点）。

    • 显示的文本为：“此组件通过其par节点包括在内。”

    如果选中，组件指南会使用sling动态包含子节点的resourceType（非现有资源）的组件。

    • 显示的文本为：“此组件是动态包含的。”

    默认值为未选中。

Publish交互

在发布实例上使用本指南时，能够以网站访客（未登录）以及登录时具有各种权限的成员身份体验组件和功能。

NOTE
请注意，如果SRP默认为JSRP，则发布实例上输入的UGC将仅在发布中可见，并且​ 不会 ​在创作实例上的审核控制台中可见。

客户端库

为每个组件列出的客户端库(clientlibs)是将组件放置到页面上时要引用的​ 必需。 clientlibs提供了一种方法，用于管理和优化在浏览器中呈现组件的JavaScript和CSS的下载。

有关详细信息，请访问社区组件的Clientlibs。

模拟

在作者实例（通常以管理员或开发人员身份登录）上，要以其他用户身份体验组件登录，请使用​ 模拟 ​按钮左侧的文本框键入用户名或从下拉列表中选择，然后单击该按钮。 单击还原以注销并结束模拟。

无需模拟发布实例。 只需使用“登录/注销”链接来模拟各种用户，如演示用户。

自定义

启用后，每个SCF组件都可通过暂时修改组件的模板、CSS和数据来构建可能自定义项的原型。

启用自定义

NOTE
此工具是只读的。 对模板、CSS或数据所做的任何编辑都不会保存到存储库中。

要快速试验自定义项，必须将scg:showIde属性添加到组件页面的内容JCR节点并设置为true。

以注释组件为例，在创作或发布实例上使用管理员权限登录：

  1. 浏览CRXDE Lite

    例如，http://localhost:4503/crx/de

  2. 选择组件的jcr:content节点

    例如，/content/community-components/en/comments/jcr:content

  3. 添加属性

    • 名称 scg:showIde
    • 类型 String
    • 值 true

  4. 选择​ 全部保存

  5. 重新加载指南中的“评论”页面

    http://localhost:4503/content/community-components/en/comments.html

  6. 请注意，现在有三个选项卡：“模板”、“CSS”和“数据”。

社区组件5

社区组件6