社区组件指南 community-components-guide

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

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

有关与每个组件相关的开发必需项的信息,请参阅 功能和组件要点.

快速入门 getting-started

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

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

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

  • 服务器(创作或发布)。
  • 网站访客是否已登录。
  • 如果登录,则为成员分配权限。
  • 无论是默认SRP、 JSRP,正在使用中。

在创作时,要进入编辑模式,请插入以下任一选项 editor.htmlcf# 作为服务器名称后的第一个路径段:

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

主页 home-page

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

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

community-component1

组件页面 component-pages

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

community-component-page

此时将显示指南的主体:

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

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

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

    • 如果添加,则显示文本为:“此组件通过其par节点包括在内。”
    • 如果包括,则显示的文本为:“此组件是动态包括的。”
    • 如果不可包含,则不会显示任何文本
  4. 示例元件或特征:元件或特征的活动实例。 如果是一个组件,则它可能会随对选项卡部分中提供的模板、CSS和数据所做的更改而发生更改。

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

作者交互 author-interactions

在创作实例上使用指南时,可以通过打开组件对话框来体验配置组件的过程。 有关开发人员的信息,请参见 组件和功能要点 一节,而中介绍了对话框设置 Communities组件 部分。

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

community-component3

模板 选项卡:

community-component4

  • 通过sling:include包含子组件

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

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

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

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

    默认值为未选中。

发布交互 publish-interactions

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

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

客户端库 client-side-libraries

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

有关详细信息,请访问 适用于社区组件的Clientlibs.

模拟 impersonation

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

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

自定义 customization

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

启用自定义 enabling-customization

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”和“数据”。

community-component5

community-component6

“模板”选项卡 templates-tab

选择模板选项卡可查看与组件关联的模板。

使用模板编辑器,可以编译本地编辑并将其应用于页面顶部的示例组件实例,而不会影响存储库中的组件。

在本地编辑时运行编译将突出显示任何错误,方法是将圆点放在沟渠中并将文本标记为红色。

CSS选项卡 css-tab

选择CSS选项卡可查看与组件关联的CSS。

如果某个组件是由多个组件组成的组合,则某些CSS可能会列在其他组件之一下。

CSS编辑器允许修改CSS并将其应用于页面顶部的示例组件实例。

可以通过单击沟渠中的规则旁边来选择一个规则,以突出显示使用该规则的DOM部分。

“数据”选项卡 data-tab

选择“数据”选项卡以显示.social.json端点数据。 此数据可编辑,并应用于示例组件实例。

语法错误可能会在gutter中标记并在编辑器中突出显示。

recommendation-more-help
81e2cd9d-0789-409d-b87c-2a8ce4f28791