文件AEM 6.5使用手冊

轉譯專用內容片段設定元件 content-fragments-configuring-components-for-rendering

Last update: Sun Jul 14 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

建立對象：

  • 開發人員

有數個進階服務與轉譯內容片段相關。 若要使用這些服務，這類元件的資源型別必須在內容片段框架中讓使用者知道這些元件。

這可透過設定OSGi服務 — 內容片段元件設定來完成。

CAUTION
如果您不需要下述的進階服務，您可以忽略此設定。
CAUTION
當您擴充或使用現成元件時，不建議變更組態。
CAUTION
您可以從頭開始撰寫只使用內容片段API （不含進階服務）的元件。 但是，在這種情況下，您必須開發元件，以便處理適當的處理。
因此，建議使用核心元件。

需要設定的進階服務定義 definition-of-advanced-services-that-need-configuration

需要註冊元件的服務包括：

  • 在發佈期間正確判斷相依性（也就是說，如果片段和模型自上次發佈後有所變更，請確定片段和模型可以隨頁面自動發佈）。
  • 支援全文檢索搜尋的內容片段。
  • 中間內容的管理/處理。
  • 管理/處理​ 混合媒體資產。
  • 參考片段的Dispatcher flush （如果重新發佈包含片段的頁面）。
  • 使用段落式演算。

如果您需要這些功能中的一或多個，則（通常）會更易於使用現成功能，而不是從頭開始開發。

OSGi服務 — 內容片段元件設定 osgi-service-content-fragment-component-configuration

設定需要繫結到OSGi服務​ 內容片段元件設定：

com.adobe.cq.dam.cfm.impl.component.ComponentConfigImpl

NOTE
如需詳細資訊，請參閱設定OSGi。

例如：

cfm-01

OSGi設定是：

標籤
OSGi設定
說明
資源類型
dam.cfm.component.resourceType

要登入的資源型別；例如，

core/wcm/components/contentfragment/v1/contentfragment

參考屬性
dam.cfm.component.fileReferenceProp
包含片段參考的屬性名稱；例如fragmentPath或 fileReference
元素屬性
dam.cfm.component.elementsProp
包含要呈現之元素名稱的屬性名稱；例如，elementName
變數屬性
dam.cfm.component.variationProp
包含要呈現之變數名稱的屬性名稱；例如，variationName

對於某些功能（例如，僅呈現段落範圍），您必須遵循某些慣例：

屬性名稱
說明
paragraphRange

字串屬性，定義在 單一元素轉譯模式 中要輸出的段落範圍。

格式：

  • 1 或1-3或1-3;6;7-8或 *-3;5-*
  • 僅在paragraphScope設定為時評估 range
paragraphScope

字串屬性，定義在 單一元素轉譯模式 下段落的輸出方式。

值：

  • all ：呈現所有段落
  • range ：呈現以下專案提供的段落範圍： paragraphRange
paragraphHeadings
定義標題（例如h1、h2、h3）是否計為段落(true)的布林屬性(false)
CAUTION
這可能在6.5之後的里程碑中改變。

範例 example

如需範例，請參閱以下內容(在現成可用的AEM例項上)：

/apps/core/wcm/config/com.adobe.cq.dam.cfm.impl.component.ComponentConfigImpl-core-comp-v1.config

這包含：

dam.cfm.component.resourceType="core/wcm/components/contentfragment/v1/contentfragment"
dam.cfm.component.fileReferenceProp="fragmentPath"
dam.cfm.component.elementsProp="elementName"
dam.cfm.component.variationProp="variationName"
recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2