自訂和擴充內容片段

內容片段會延伸標準資產；請參閱：

• 使用內容片段建 立和管 理內容片段和頁 面編寫，以取得內容片段的詳細資訊。

• 管理 資產 和自訂和擴充 資產，以取得標準資產的詳細資訊。

架構

內容片段的基本組成部分為：

• A 內容片段，
• 由一個或多個​內容元素 s組成，
• 且可以有一或多個​內容變化 s。

視片段類型而定，也會使用模型或範本：

• 內容片段模型:

  • 用於定義包含結構化內容的內容片段。
  • 內容片段模型會在建立內容片段時定義其結構。
  • 片段會參照模型；因此，模型的變更可能會/將影響任何相依片段。
  • 模型是資料類型的組建。
  • 新增變異等的函式必須據以更新片段。
  注意

  對現有內容片段模型的任何變更都可能影響相依片段；這可能會導致這些片段中的孤立屬性。

• 內容片段範本：

  • 用於定義簡單內容片段。
  • 範本會在建立內容片段時，定義內容片段的（基本、僅限文字）結構。
  • 範本建立時會複製到片段；因此，範本的進一步變更將不會反映在現有片段中。
  • 新增變異等的函式必須據以更新片段。
  • 內容片 段範本的運作方式與AEM生態系統內其他範本機制（例如頁面範本等）的運作方式不同。因此，應單獨考慮這些問題。
  • 根據模板管理內容的MIME類型時，根據實際內容進行管理；這表示每個元素和變異都可以有不同的MIME類型。

與資產整合

內容片段管理(CFM)是AEM Assets的一部分，如下所示：

• 內容片段是資產。
• 它們使用現有的Assets功能。
• 它們已與資產（管理控制台等）完全整合。

將結構化內容片段對應至資產

具有結構化內容的內容片段（即以內容片段模型為基礎）會對應至單一資產：

• 所有內容都儲存在資產的jcr:content/data節點下：

  • 元素資料儲存在主子節點下：

    jcr:content/data/master

  • 變數儲存在帶有變數名稱的子節點下：
    例如jcr:content/data/myvariation

  • 每個元素的資料作為具有元素名稱的屬性儲存在相應的子節點中：
    例如，元素text的內容儲存為jcr:content/data/master上的屬性text

• 元資料和相關內容儲存在jcr:content/metadata下
  除了標題和說明，這些內容不被視為傳統中繼資料並儲存在
  jcr:content

將簡單內容片段對應至資產

簡單內容片段（以範本為基礎）會對應至由主要資產和（選用）子資產組成的複合資產：

• 片段的所有非內容資訊（例如標題、說明、中繼資料、結構）都專門在主資產上管理。

• 片段的第一個元素的內容對應至主要資產的原始轉譯。

  • 第一個元素的變體（如果有的話）會對應至主要資產的其他轉譯。

• 其他元素（如果有）會對應至主要資產的子資產。

  • 這些額外元素的主要內容對應至個別子資產的原始轉譯。
  • 任何其他元素的其他變數（若適用）會對應至個別子資產的其他轉譯。

資產位置

與標準資產一樣，內容片段位於：

/content/dam

資產權限

如需詳細資訊，請參閱內容片段 — 刪除考量事項。

功能整合

• 內容片段管理(CFM)功能以資產核心為基礎，但應盡可能獨立於此功能。
• CFM針對卡片/欄/清單檢視中的項目提供自己的實作；這些外掛程式會插入現有的Assets內容呈現實作。
• 數個Assets元件已擴充，以符合內容片段。

在頁面中使用內容片段

可從AEM頁面參照內容片段，如同任何其他資產類型。 AEM提供​內容片段​核心元件 - 元件，可讓您在頁面上包含內容片段。 您也可以延伸此​內容片段​核心元件。

• 元件使用fragmentPath屬性來參考實際內容片段。 fragmentPath屬性的處理方式與其他資產類型的類似屬性相同；例如，內容片段移至其他位置時。

• 元件可讓您選取要顯示的變數。

• 此外，可以選擇一系列段落來限制輸出；例如，這可用於多欄輸出。

• 元件允許內容之間：

  • 此元件可讓您放置其他資產（影像等） 在所參考片段的段落之間。

  • 針對中間內容，您需要：

    • 注意不穩定的參考資料的可能性；中間內容（製作頁面時新增）與它位於旁邊的段落沒有固定關係，在中間內容的位置之前插入新段落（在內容片段編輯器中）可能會丟失相對位置
    • 請考慮其他參數（例如變異和段落篩選），以避免搜尋結果中出現誤判

使用OSGi控制台進行配置

例如，內容片段的後端實作負責讓頁面上使用的片段例項可供搜尋，或管理混合媒體內容。 此實作需要知道用於轉譯片段的元件，以及轉譯的參數化方式。

可在Web控制台中為OSGi套件組合​內容片段元件配置​配置此參數的參數。

• 資源
  類型清單
  sling:resourceTypes 可提供來定義用於轉譯內容片段的元件，以及應套用背景處理的位置。

• 參
  考屬性可以配置一個屬性清單，以指定為各個元件儲存片段的參考的位置。

您仍需遵循一些准則，以確保元件與內容片段背景處理相容：

• 要呈現的元素在其中定義的屬性名稱必須為element或elementNames。

• 要呈現的變數所在的屬性名稱必須為variation或variationName。

• 如果支援多個元素的輸出（通過使用elementNames來指定多個元素），則實際顯示模式由屬性displayMode定義：

  • 如果值為singleText（且僅設定一個元素），則元素會轉譯為文字，內容、版面支援等介於其中。 這是只轉譯一個元素之片段的預設值。
  • 否則，會使用更簡單的方法（可稱為「表單檢視」），其中不支援中間內容，且片段內容會「依原樣」呈現。

• 如果為displayMode == singleText（隱式或顯式）呈現片段，則以下附加屬性將開始起作用：

  • paragraphScope 定義是否應呈現所有段落或僅呈現一系列段落(值： all vs. range)

  • 如果paragraphScope == range ，則屬性paragraphRange定義要呈現的段落範圍

與其他框架整合

內容片段可與：

• 翻譯

  內容片段已與AEM翻譯工作流程完全整合。 在架構層面，這表示：

  • 內容片段的個別翻譯實際上是個別片段；例如：

    • 它們位於不同的語言根下：

      /content/dam/<path>/en/<to>/<fragment>

      vs.

      /content/dam/<path>/de/<to>/<fragment>

    • 但它們在語言根底下的相對路徑完全相同：

      /content/dam/<path>/en/<to>/<fragment>

      vs.

      /content/dam/<path>/de/<to>/<fragment>

  • 除了基於規則的路徑外，內容片段的不同語言版本之間沒有進一步的連接；雖然UI提供在語言變體之間導覽的方式，但這些片段會以兩個不同片段的形式處理。

  注意

  AEM翻譯工作流程可搭配/content使用：

  • 由於內容片段模型位於/conf中，因此這些轉譯中不包含這些模型。 您可以國際化UI字串。

  • 範本會複製以建立片段，因此會是隱式的。

• 中繼資料結構

  • 內容片段(re)使用中繼資料結構，這可以用標準資產定義。

  • CFM提供其專屬的結構：

    /libs/dam/content/schemaeditors/forms/contentfragment

    如有需要，可加以擴充。

  • 各個架構表單與片段編輯器整合。

內容片段管理API — 伺服器端

您可以使用伺服器端API來存取您的內容片段；請參閱：

com.adobe.cq.dam.cfm

密鑰介面

以下三個介面可作為入口點：

• 片段範本 (FragmentTemplate)

  使用FragmentTemplate.createFragment()建立新片段。

  Resource templateOrModelRsc = resourceResolver.getResource("...");
  FragmentTemplate tpl = templateOrModelRsc.adaptTo(FragmentTemplate.class);
  ContentFragment newFragment = tpl.createFragment(parentRsc, "A fragment name", "A fragment description.");
  

  此介面代表：

  • 要從中建立內容片段的內容片段模型或內容片段範本，
  • 及（建立後）該片段的結構資訊

  此資訊可包括：

  • 存取基本資料（標題、說明）

  • 存取片段元素的範本/模型：

    • 清單元素範本
    • 獲取給定元素的結構資訊
    • 存取元素範本（請參閱ElementTemplate）

  • 片段變異的存取範本：

    • 清單變異範本
    • 獲取給定變數的結構資訊
    • 存取變異範本（請參閱VariationTemplate）

  • 取得初始相關內容

  表示重要資訊的介面：

  • ElementTemplate

    • 取得基本資料（名稱、標題）
    • 取得初始元素內容

  • VariationTemplate

    • 取得基本資料（名稱、標題、說明）

• 內容片段 (ContentFragment)

  此介面可讓您以抽象方式處理內容片段。

  注意

  強烈建議透過此介面存取片段。 應避免直接變更內容結構。

  該介面提供您以下方法：

  • 管理基本資料(例如取得名稱；get/set title/description)

  • 存取中繼資料

  • 存取元素：

    • 清單元素

    • 依名稱取得元素

    • 建立新元素（請參閱警告）

    • 存取元素資料（請參閱ContentElement）

  • 為片段定義的清單變化

  • 全域建立新變體

  • 管理相關內容：

    • 清單集合
    • 新增集合
    • 移除集合

  • 存取片段的模型或範本

  代表片段主要元素的介面包括：

  • 內容元素 (ContentElement)

    • 取得基本資料（名稱、標題、說明）

    • 取得/設定內容

    • 元素的存取變化：

      • 清單變數
      • 依名稱取得變體
      • 建立新變體（請參閱警告）
      • 移除變數（請參閱警告）
      • 存取變異資料（請參閱ContentVariation）

    • 解決變異的捷徑（如果指定的變異不適用於元素，則套用一些其他的實作專用備援邏輯）

  • 內容變異 (ContentVariation)

    • 取得基本資料（名稱、標題、說明）
    • 取得/設定內容
    • 基於上次修改資訊的簡單同步

  所有三個介面(ContentFragment、ContentElement、ContentVariation)都擴展了Versionable介面，該介面添加了內容片段所需的版本控制功能：

  • 建立新版本的元素
  • 元素的清單版本
  • 取得版本化元素的特定版本的內容

適應 — 使用adapTo()

可調整下列項目：

• ContentFragment 可調整為：

  • Resource — 基礎Sling資源；請注意，直接更新基 Resource 礎物件需要重新建 ContentFragment 立物件。

  • Asset — 代表內 Asset 容片段的DAM抽象化；請注意，直 Asset 接更新需要重建物 ContentFragment 件。

• ContentElement 可調整為：

  • ElementTemplate — 存取元素的結構資訊。

• FragmentTemplate 可調整為：

  • Resource — 確 Resource 定被引用的模型或複製的原始模板；

    • 透過Resource所做的變更不會自動反映在FragmentTemplate中。

• Resource 可調整為：

  • ContentFragment
  • FragmentTemplate

警告

應當指出：

• 實作API是為了提供UI支援的功能。

• 整個API的設計目的是自動​not​保留變更（除非API JavaDoc中另有說明）。 因此，您必須一律提交個別請求的資源解析器（或您實際使用的解析器）。

• 可能需要付出額外努力的任務：

  • 建立/移除新元素時，不會更新簡單片段的資料結構（根據片段範本）。

  • 從ContentElement建立新變數不會更新資料結構（但從ContentFragment全域建立變數則會更新）。

  • 移除現有變數不會更新資料結構。

內容片段管理API — 用戶端

其他資訊

請參閱下列內容：

• filter.xml

  內容片段管理的filter.xml已設定，使其與「資產」核心內容套件不重疊。

編輯會話

當使用者在其中一個編輯器頁面中開啟內容片段時，就會啟動編輯工作階段。 當使用者借由選取​Save​或​Cancel​來離開編輯器時，編輯工作階段會完成。

需求

控制編輯工作階段的需求為：

• 編輯內容片段(可跨越多個檢視（= HTML頁面）)應該是原子。
• 編輯也應該是​transactional;編輯工作階段結束時，必須提交（儲存）或復原（取消）變更。
• 邊緣案件應妥善處理；這些情況包括使用者手動輸入URL或使用全域導覽離開頁面的情況。
• 應可定期自動儲存（每x分鐘），以防止資料遺失。
• 如果兩個使用者同時編輯內容片段，他們不應覆寫彼此的變更。

程序

涉及的流程包括：

• 開始工作階段

  • 內容片段的新版本隨即建立。
  • 自動儲存已啟動。
  • Cookie已設定；這些定義了目前編輯的片段，並且有一個編輯工作階段開啟。

• 完成工作階段

  • 自動儲存已停止。

  • 提交時：

    • 更新上次修改的資訊。
    • 會移除Cookie。

  • 回滾時：

    • 系統會還原在編輯工作階段啟動時建立的內容片段版本。
    • 會移除Cookie。

• 編輯

  • 所有變更（包括自動儲存）都會在作用中內容片段上完成，不會在分隔的受保護區域中完成。
  • 因此，這些變更會立即反映在參考個別內容片段的AEM頁面上

動作

可能的動作包括：

• 輸入頁面

  • 檢查編輯工作階段是否已存在；檢查個別Cookie即可。

    • 如果存在，請確認已針對目前正在編輯的內容片段啟動編輯工作階段

      • 如果目前片段，請重新建立工作階段。
      • 如果沒有，請嘗試取消對先前編輯的內容片段進行編輯並移除Cookie（之後未出現編輯工作階段）。

    • 如果不存在編輯工作階段，請等待使用者進行的第一次變更（請參閱下方）。

  • 檢查頁面上是否已參考內容片段，若已參考則顯示適當資訊。

• 內容變更

  • 每當用戶更改內容且沒有編輯會話時，就會建立新的編輯會話（請參閱啟動會話）。

• 離開頁面

  • 如果編輯工作階段存在，且變更未持續存在，則會顯示強制回應確認對話方塊，以通知使用者可能遺失的內容，並允許他們停留在頁面上。

範例

範例：存取現有內容片段

若要達成此目標，您可以調整代表API的資源，以：

com.adobe.cq.dam.cfm.ContentFragment

例如：

// first, get the resource
Resource fragmentResource = resourceResolver.getResource("/content/dam/fragments/my-fragment");
// then adapt it
if (fragmentResource != null) {
    ContentFragment fragment = fragmentResource.adaptTo(ContentFragment.class);
    // the resource is now accessible through the API
}

範例：建立新內容片段

若要以程式設計方式建立新內容片段，您需要使用：

com.adobe.cq.dam.cfm.ContentFragmentManager#create

例如：

Resource templateOrModelRsc = resourceResolver.getResource("...");
FragmentTemplate tpl = templateOrModelRsc.adaptTo(FragmentTemplate.class);
ContentFragment newFragment = tpl.createFragment(parentRsc, "A fragment name", "A fragment description.");

範例：指定自動保存間隔

可使用配置管理器(ConfMgr)定義自動儲存間隔（以秒為單位）:

• 節點：<*conf-root*>/settings/dam/cfm/jcr:content

• 屬性名稱: autoSaveInterval

• 類型: Long

• 預設值：600（10分鐘）;在/libs/settings/dam/cfm/jcr:content上定義

如果要設定5分鐘的自動儲存間隔，則需要在節點上定義屬性；例如：

• 節點：/conf/global/settings/dam/cfm/jcr:content

• 屬性名稱: autoSaveInterval

• 類型: Long

• 值：300（5分鐘等於300秒）

內容片段範本

如需完整資訊，請參閱內容片段範本 。

頁面編寫元件

如需詳細資訊，請參閱

• 核心元件 — 內容片段元件 （建議）
• 內容片段元件 — 頁面製作元件