社群元件指南 community-components-guide

社群元件指南是互動式開發工具,適用於社交元件架構(SCF)。 它提供可用的Adobe Experience Manager (AEM) Communities元件清單,或由多個元件建置的更複雜功能。

除了每個元件的基本資訊外,本指南還允許實驗SCF元件/功能的工作方式,以及如何對其進行設定或自訂。

如需與每個元件相關的開發基本資訊,請參閱功能和元件基本資訊

快速入門 getting-started

本指南適用於製作執行個體(localhost:4502)和發佈執行個體(localhost:4503)的開發安裝。

社群元件網站可透過瀏覽存取:

與Communities元件的互動會依據以下因素而有所不同:

  • 伺服器(製作或發佈)。
  • 網站訪客是否已登入。
  • 如果登入,則為成員指派許可權。
  • 是否使用預設SRP JSRP

在作者上,若要進入編輯模式,請在伺服器名稱后面插入editor.htmlcf#作為第一個路徑區段:

NOTE
在編輯模式下的作者上,頁面上的連結非作用中。
若要導覽至元件頁面,請先選取預覽模式以啟動連結。
在瀏覽器中顯示元件頁面後,返回「編輯」模式以開啟元件的編輯對話方塊。
如需一般編寫資訊,請檢視編寫頁面的快速指南
如果不熟悉AEM,請檢視有關基本處理的檔案。

首頁 home-page

本指南提供可在頁面左側預覽及建立原型的SCF元件清單。

在編輯模式中的作者執行個體所檢視的元件指南:

社群元件1

元件頁面 component-pages

從頁面左側的清單中選取元件。

社群元件頁面

指南的主體隨即顯示:

  1. 標題:所選元件的名稱

  2. 使用者端資料庫:一或多個必要類別的清單

  3. Inclustable:如果元件可動態納入,則可在作者編輯模式中切換狀態:

    • 如果新增,顯示的文字為:「此元件透過其par節點包含。」
    • 如果包含,顯示的文字會是:「此元件是以動態方式包含。」
    • 如果不可包含,則不會顯示任何文字
  4. 範例元件或特徵:元件或特徵的活動例證。 如果元件,可能會隨著對索引標籤區段中提供的範本、CSS和資料所做的變更而變更。

NOTE
從左側進行選取後,當瀏覽器視窗太窄時,元件會顯示在元件清單的下方,而不是旁邊。

作者互動 author-interactions

在製作例項上使用指南時,可以透過開啟對話方塊來體驗設定元件的方式。 開發人員的資訊在檔案的元件和功能要點區段中提供,而對話方塊設定則說明在作者的社群元件區段中。

在社群元件指南中,某些元件對話方塊設定會以包含的切換狀態覆寫。 若要在使用現有資源或動態包含的資源之間切換,請在編輯模式中選取元件和可包含的文字,然後按兩下以開啟編輯對話方塊:

社群元件3

在​ 範本 ​標籤下:

社群元件4

  • 包含具有sling:include ​的子元件

    如果取消勾選,「元件指南」會使用存放庫中的現有資源(jcr節點,是par節點的子節點)。

    • 文字顯示為:「透過其par節點包含此元件」。

    如果勾選,「元件指南」會使用Sling來動態包含子節點的resourceType (非現有資源)的元件。

    • 文字顯示為:「此元件為動態包含。」

    預設為未勾選。

Publish互動 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。

以comments元件為例,在作者或發佈執行個體上,以管理員許可權登入:

  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

範本標籤 templates-tab

選取範本標籤以檢視與元件相關聯的範本。

範本編輯器可以編譯本機編輯,並將其套用至頁面頂端的範例元件例項,而不會影響存放庫中的元件。

在本機編輯時執行編譯,將透過在排水槽中放置點並將文字標示為紅色來反白顯示任何錯誤。

CSS索引標籤 css-tab

選取CSS標籤以檢視與元件相關聯的CSS。

如果元件是由多個元件組成的複合專案,則某些CSS可能會列在其他某個元件下。

CSS編輯器可以修改CSS,並將其套用至頁面頂端的範例元件例項。

您可以按一下溝渠中規則旁的按鈕,選取規則來反白使用該規則的DOM部分。

資料標籤 data-tab

選取「資料」標籤,以顯示.social.json端點資料。 此資料可編輯,並套用至範例元件例項。

語法錯誤可能會在Gutter中標示並在編輯器中反白顯示。

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