社區元件指南

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

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

有關與每個元件相關的開發基本知識的資訊,請參見功能和元件基本知識

快速入門

本指南適用於作者(localhost:4502)和發佈(localhost:4503)例項的開發安裝。

瀏覽至

與Communities元件的互動會依下列各項而異:

  • 伺服器(作者或發佈)
  • 網站訪客是否登入
  • 如果登入,則指派給成員的權限
  • 是否使用預設SRP JSRP

在作者上,要進入編輯模式,請將editor.htmlcf#插入為伺服器名後的第一個路徑段:

注意

在「編輯」模式下的作者中,頁面上的連結不作用中。

若要導覽至元件頁面,請先選取「預覽模式」以啟用連結。

在瀏覽器中顯示元件頁面時,返回「編輯」模式以開啟元件的編輯對話框。

有關一般編寫資訊,請檢視編寫頁面的快速指南

如果不熟悉AEM,請檢視basic handling的說明檔案。

首頁

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

在「編輯」模式中,在作者實例上檢視的「元件指南」:

chlimage_1-404

元件頁

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

chlimage_1-405

此時將顯示指南的主體:

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

  2. 用戶端程式庫:一或多個必要類別的清單

  3. 可包含:如果元件可以動態包含,則可在作者編輯模式中切換狀態:

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

注意

從左側進行選取後,當瀏覽器視窗太窄時,元件會出現在下方,而非旁邊的元件清單。

作者互動

在作者實例上使用指南時,可以通過開啟元件對話框來體驗配置元件。 開發人員的資訊會在說明檔案的Component and Feature Essentials一節中提供,而對話方塊設定則會在作者的 Communities Components一節中說明。

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

chlimage_1-406

在​Templates​標籤下:

chlimage_1-407

  • 包含 sling:include 的子元件

    如果取消選中,「元件指南」將使用儲存庫中的現有資源(作為par節點子節點的jcr節點)。

    • 顯示的文字為:"此元件通過其par節點包含。"

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

    • 顯示的文字為:"此元件是動態包含的。"

    預設為未勾選。

發佈互動

在發佈例項上使用指南時,您可以以網站訪客(未登入)和登入時擁有各種權限的成員身分,來體驗元件和功能。

注意

請注意,如果SRP預設為JSRP,則在發佈例項上輸入的UGC只會在發佈時顯示,而且*not *be visible from the moderation console on the author instance.

用戶端資源庫

每個元件所列的用戶端程式庫(clientlibs)是當元件放在頁面上時要參考的​required。 clientlibs提供管理和最佳化下載Javascript和CSS的方式,以在瀏覽器中呈現元件。

有關詳細資訊,請訪問Clientlibs for Communities Components

模擬

在作者實例(通常以管理員或開發人員的身份登錄)上,為了體驗以其他用戶身份登錄的元件,請使用​Impersonate​按鈕左側的文本框來輸入用戶名或從下拉清單中進行選擇,然後按一下按鈕。 按一下「恢復」(Revert)以簽出並終止模擬。

發佈例項不需要模擬。 只需使用「登入/登出」連結來模擬各種使用者,例如demo使用者

自訂

啟用後,每個SCF元件都可以通過臨時修改元件的模板、CSS和資料來建立可能的定製原型。

啟用自定義

注意

此工具為唯讀。對範本、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和資料現在有3個標籤。

chlimage_1-408 chlimage_1-409

範本標籤

選擇模板頁籤可查看與元件關聯的模板。

模板編輯器允許編譯本地編輯並將其應用於頁面頂部的示例元件實例,而不影響儲存庫中的元件。

在本機編輯時執行編譯,會在欄距中放置點並將文字標示為紅色,以反白標示任何錯誤。

CSS標籤

選取「CSS」標籤,以查看與元件相關聯的CSS。

如果元件是多個元件的組合,則某些CSS可能會列在其他元件之一下。

CSS編輯器允許修改CSS並將其應用於頁面頂部的示例元件實例。

您可以按一下欄距中規則旁的規則,選取規則來反白標示使用該規則的DOM部分。

資料標籤

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

語法錯誤可能會標籤在欄距中,並在編輯器中反白顯示。

本頁內容