裝飾標籤

當轉譯網頁中的元件時，可產生HTML元素，並將轉譯的元件包裝在其中。 這主要有兩個目的：

  • 元件只有在用HTML元素包住時才能編輯。

  • 包裝元素用於套用HTML類別，提供：

    • 版面資訊
    • 樣式資訊

對於開發人員，AEM提供清晰簡單的邏輯，來控制包含元件的裝飾標籤。 裝飾標籤的呈現方式和呈現方式是由兩個因素的組合所定義，本頁將深入探討：

  • 元件本身可以使用一組屬性來設定其裝飾標籤。
  • 包含元件（HTL、JSP、dispatcher等）的指令碼可以定義包含參數的裝飾標籤。

建議

以下是一些一般建議，說明何時加入包裝函式元素，以協助避免遇到非預期問題：

  • WCMModes（編輯或預覽模式）、例項（作者或發佈）或環境（測試或生產）之間包裝函式元素的存在不應有所不同，因此頁面的CSS和JavaScripts在所有情況下都會運作相同。
  • 應將包裝函式元素新增至所有可編輯的元件，讓頁面編輯器能夠正確初始化和更新這些元件。
  • 對於不可編輯的元件，如果包裝器元素不提供特定函式，則可以避免它，因此產生的標籤不會不必要地膨脹。

元件控制

下列屬性和節點可套用至元件，以控制其裝飾標籤的行為：

  • cq:noDecoration {boolean}: 此屬性可新增至元件，而true值會強制AEM不在元件上產生任何包裝函式元素。

  • cq:htmlTagnode ：此 節點可以添加到元件下，並具有以下屬性：

    • cq:tagName {String}: This can be used to specify a custom HTML tag to be used for wranking the components而非default DIV element.
    • class {String}: 這可用來指定要新增至包裝函式的css類別名稱。
    • 其他屬性名稱將會新增為HTML屬性，其字串值與提供的相同。

指令碼控制項

但是，包裝函式行為會因使用HTL或JSP來包含元素而有所不同。

HTL

一般而言，HTL中的包裝函式行為可歸納為：

  • 預設情況下不會呈現包裝函式DIV（僅執行data-sly-resource="foo"操作時）。
  • 所有wcm模式（停用、預覽、編輯作者和發佈）的演算都相同。

包裝函式的行為也可以完全控制。

  • HTL指令碼可完全控制包裝函式標籤的產生行為。
  • 元件屬性（如cq:noDecoration和cq:tagName）也可以定義包裝函式標籤。

您可以完全控制來自HTL指令碼的包裝函式標籤及其相關邏輯的行為。

有關在HTL中開發的詳細資訊，請參閱HTL檔案。

決策樹

此決策樹匯總了決定包裝函式標籤行為的邏輯。

chlimage_1-75

使用案例

以下三個使用案例提供如何處理包裝函式標籤的範例，並說明控制包裝函式標籤的所需行為有多簡單。

以下所有範例都採用下列內容結構和元件：

/content/test/
  @resourceType = "test/components/one"
  child/
    @resourceType = "test/components/two"

/apps/test/components/
  one/
    one.html
  two/
    two.html
    cq:htmlTag/
      @cq:tagName = "article"
      @class = "component-two"

使用案例1:包含用於代碼重用的元件

最典型的使用案例是，元件由於程式碼重複使用的原因而包含其他元件。 在這種情況下，所包含的元件不需要使用其自己的工具欄和對話框進行編輯，因此不需要包裝函式，並且將忽略元件的cq:htmlTag。 這可視為預設行為。

one.html: <sly data-sly-resource="child"></sly>

two.html: Hello World!

產生於/content/test.html的輸出：

Hello World!

例如，一個元件包括用於顯示影像的核心影像元件，通常在這種情況下，該元件使用合成資源，該合成資源包括通過將表示元件將擁有的所有屬性的Map對象傳遞到資料透明資源來包括虛擬子元件。

使用案例2:包含可編輯的元件

另一個常見使用案例是容器元件包含可編輯的子元件時，例如「版面容器」。 在這種情況下，每個包含的子代都必須有一個包裝函式，才能使編輯器工作（除非使用cq:noDecoration屬性明確禁用）。

由於內含的元件在此範例中為獨立元件，因此需要有包裝函式元素讓編輯器運作，並定義其版面配置和樣式以套用。 要觸發此行為，有decoration=true選項。

one.html: <sly data-sly-resource="${'child' @ decoration=true}"></sly>

two.html: Hello World!

產生於/content/test.html的輸出：

<article class="component-two">Hello World!</article>

使用案例3:自訂行為

HTL可以明確提供以下資訊，因此可以很容易地實現任意數量的複雜情況：

  • decorationTagName='ELEMENT_NAME' 定義包裝函式的元素名稱。
  • cssClassName='CLASS_NAME' 要定義要在其上設定的CSS類名。

one.html: <sly data-sly-resource="${'child' @ decorationTagName='aside', cssClassName='child'}"></sly>

two.html: Hello World!

結果輸出/content/test.html:

<aside class="child">Hello World!</aside>

JSP

當使用cq:include或sling:include加入元件時，AEM的預設行為是使用DIV來包覆元素。 不過，此包裝可透過兩種方式自訂：

  • 明確告訴AEM不要使用cq:noDecoration包住元件。
  • 使用自訂HTML標籤，使用cq:htmlTag/ cq:tagName或decorationTagName包住元件。

決策樹

以下決策樹說明cq:noDecoration、cq:htmlTag、cq:tagName和decorationTagName如何影響包裝函式行為。

chlimage_1-3

本頁內容