コンテンツフラグメントのカスタマイズと拡張 customizing-and-extending-content-fragments

コンテンツフラグメントについて詳しくは、コンテンツフラグメントの作成と管理およびコンテンツフラグメントを使用したページオーサリングを参照してください。

標準アセットについて詳しくは、アセットの管理およびアセットのカスタマイズと拡張を参照してください。

コンテンツフラグメントモデル：

• 構造化コンテンツを含むコンテンツフラグメントの定義に使用します。
• コンテンツフラグメントモデルでは、コンテンツフラグメントの作成時にその構造を定義します。
• フラグメントはモデルを参照するので、モデルに対する変更は、そのモデルに関連付けられているフラグメントにも影響します。
• モデルはデータタイプで構成されています。
• 新しいバリエーションを追加するときなどは、それに合わせてフラグメントを更新する必要があります。

コンテンツフラグメントテンプレート:

• シンプルなコンテンツフラグメントの定義に使用します。
• テンプレートは、コンテンツフラグメントの作成時にその構造（基本的なテキストのみ）を定義します。
• テンプレートは作成時にフラグメントにコピーされるので、それ以降にテンプレートに行った変更は既存のフラグメントには反映されません。
• 新しいバリエーションを追加するときなどは、それに合わせてフラグメントを更新する必要があります。
• コンテンツフラグメントテンプレートは、AEM エコシステム内の他のテンプレートメカニズム（ページテンプレートなど）とは異なる方法で機能します。そのため、分けて考える必要があります。
• テンプレートを基にした場合、コンテンツの MIME タイプは実際のコンテンツに基づいて管理されます。つまり、要素およびバリエーションごとに MIME タイプが異なる場合もあります。

すべてのコンテンツはアセットの jcr:content/data ノードに格納されます。

• 要素データは次のプライマリサブノードに格納されます。
  jcr:content/data/master

• バリエーションは、そのバリエーション名のサブノードに格納されます。例：jcr:content/data/myvariation

• 各要素のデータは、その要素名のプロパティとしてそれぞれのサブノードに格納されます。例えば、text 要素のコンテンツは、text プロパティとして jcr:content/data/master に格納されます。

メタデータと関連コンテンツは、jcr:content/metadata に格納されます。
ただし、タイトルと説明は従来のメタデータと見なされないので、jcr:content に格納されます。

フラグメントのコンテンツ以外の情報（タイトル、説明、メタデータ、構造など）はすべて、メインアセットでのみ管理されます。

フラグメントの最初の要素のコンテンツは、メインアセットの元のレンディションにマッピングされます。

• 最初の要素のバリエーション（存在する場合）は、メインアセットのその他のレンディションにマッピングされます。

追加の要素（既存する場合）は、メインアセットのサブアセットにマッピングされます。

• これらの追加要素のメインコンテンツは、それぞれのサブアセットのオリジナルレンディションにマッピングされます。
• 追加の要素のその他のバリエーション（該当する場合）は、それぞれのサブアセットのその他のレンディションにマッピングされます。

このコンポーネントは、fragmentPath プロパティを使用して、実際のコンテンツフラグメントを参照します。fragmentPath プロパティは、その他のアセットタイプの類似プロパティと同じ方法で処理されます。例えば、コンテンツフラグメントが別の場所に移動された場合などです。

このコンポーネントを使用して、表示するバリエーションを選択できます。

さらに、段落の範囲を選択して出力を制限できます。例えば、複数列の出力に使用できます。

このコンポーネントは、中間コンテンツを許可します。

• ここでは、コンポーネントを使用して、参照されるフラグメントの段落の間に他のアセット（画像など）を配置できます。

• 中間コンテンツの場合は、次のことを考慮する必要があります。

  • 参照が不安定になる可能性に注意します。中間コンテンツ（ページのオーサリング時に追加）とその横にある段落の関係は、固定されていません。（コンテンツフラグメントエディター内で）中間コンテンツの位置の前に新しい段落を挿入すると、相対的な位置が失われることがあります。
  • 検索結果で誤検出を避けるために、追加のパラメーター（バリエーションや段落フィルターなど）を検討します。

リソースタイプ
sling:resourceTypes のリストを使用して、コンテンツフラグメントのレンダリングに使用するコンポーネントと、バックグラウンド処理を適用する場所を定義できます。

Reference Properties
プロパティのリストを設定し、それぞれのコンポーネントに対応するフラグメントの参照を格納する場所を指定できます。

レンダリングされる要素を定義するプロパティの名前は、element または elementNames にする必要があります。

レンダリングされるバリエーションを定義するプロパティの名前は、variation または variationName にする必要があります。

複数の要素の出力がサポートされている（elementNames で複数の要素を指定している）場合、実際の表示モードは、displayMode プロパティによって定義されます。

• 値が singleText（設定されている要素が 1 つのみ）の場合、その要素は、中間コンテンツやレイアウトサポートなどで、テキストとしてレンダリングされます。これは、1 つの要素のみがレンダリングされるフラグメントのデフォルトです。
• それ以外の場合は、よりシンプルな方法（「フォームビュー」と呼ばれます）が使用され、中間コンテンツはサポートされず、フラグメントコンテンツは「そのまま」レンダリングされます。

フラグメントが displayMode == singleText 用に（暗黙的または明示的に）レンダリングされる場合、次の追加のプロパティも有効になります。

• paragraphScope は、すべての段落をレンダリングするか、特定の範囲の段落のみをレンダリングするかを定義します（値は all または range）

• paragraphScope == range の場合は、プロパティ paragraphRange でレンダリングする段落の範囲を定義します。

翻訳

コンテンツフラグメントは、AEM の翻訳ワークフローと完全に統合されています。つまり、アーキテクチャレベルでは以下を意味します。

• コンテンツフラグメントの個々の翻訳は、実際には別々のフラグメントです。例えば、以下のようになります。

  • 様々な言語のルートの下に配置されています。

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

    上記に対して次のようになります。

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

  • ただし、言語ルートの下の相対パスはまったく同じものになります。

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

    上記に対して次のようになります。

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

• ルールベースのパスを除き、コンテンツフラグメントの様々な言語バージョンの間にそれ以上のつながりはありません。UI には言語バリアント間を移動する手段が用意されていますが、それらは 2 つの別々のフラグメントとして扱われます。

メタデータスキーマ

• コンテンツフラグメントは、標準アセットで定義できるメタデータスキーマを（再）使用します。

• CFM には、次のような独自の固有のスキーマがあります。

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

  必要に応じて拡張できます。

• 各スキーマフォームは、フラグメントエディターと統合されます。

フラグメントテンプレート（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）

このインターフェイスでは、コンテンツフラグメントを抽象化して使用できます。

このインターフェイスでは、次のことを実行できます。

• 基本データを管理する（名前の取得、タイトルまたは説明の取得／設定など）

• メタデータにアクセスする

• 要素にアクセスする

  • 要素をリスト表示する

  • 要素を名前で取得する

  • 新しい要素を作成する（注意事項を参照）

  • 要素データにアクセスする（ContentElement を参照）

• そのフラグメントに対して定義されているバリエーションをリスト表示する

• 新しいバリエーションをグローバルに作成する

• 関連コンテンツを管理する

  • コレクションをリスト表示する
  • コレクションを追加する
  • コレクションを削除する

• フラグメントのモデルまたはテンプレートにアクセスする

フラグメントの主要要素を表すインターフェイスは、次のとおりです。

• コンテンツ要素（ContentElement）

  • 基本データ（名前、タイトル、説明）を取得

  • コンテンツを取得／設定する

  • 要素のバリエーションにアクセスする

    • バリエーションをリスト表示する
    • バリエーションを名前で取得する
    • 新しいバリエーションを作成する（注意事項を参照）
    • バリエーションを削除する（注意事項を参照）
    • バリエーションデータにアクセスする（ContentVariation を参照）

  • バリエーションを解決するためのショートカット（要素に指定されたバリエーションを使用できない場合は実装固有の追加のフォールバックロジックを適用）

• コンテンツのバリエーション（ContentVariation）

  • 基本データ（名前、タイトル、説明）を取得
  • コンテンツを取得／設定する
  • 最終変更情報に基づく単純な同期

3 つのインターフェイス（ContentVariation、ContentFragment、ContentElement、）すべてによって Versionable インターフェイスを拡張し、コンテンツフラグメントに必要な次のバージョン管理機能を追加します。

• 要素の新しいバージョンを作成する
• 要素のバージョンをリスト表示する
• バージョン管理されている要素の特定のバージョンのコンテンツを取得する

ContentFragment は、次のものに適応させることができます。

• Resource - 基になる Sling リソース。基になる Resource を直接更新するには、ContentFragment オブジェクトを再構築する必要があります。

• Asset - コンテンツフラグメントを表す DAM Asset の抽象化。Asset を直接更新するには、ContentFragment オブジェクトを再構築する必要があります。

ContentElement は、次のものに適応させることができます。

• ElementTemplate - 要素の構造に関する情報にアクセスするためのものです。

FragmentTemplate は、次のものに適応させることができます。

• Resource - Resource は、参照されているモデルまたはコピーされた元のテンプレートを決定します。

  • Resource を使用した変更は、FragmentTemplate に自動的に反映されません。

Resource は、次のものに適応させることができます。

• ContentFragment
• FragmentTemplate

API は、UI がサポートする機能を提供するために実装されています。

API 全体は、は、（API JavaDoc で特に記載がない限り）変更を自動的に保持​ しない ​ように設計されています。したがって、各リクエストのリソースリゾルバー（または実際に使用しているリゾルバー）を常にコミットする必要があります。

追加の作業が必要になる可能性のあるタスクは、次のとおりです。

• 新しい要素を作成または削除しても、（フラグメントテンプレートに基づく）単純なフラグメントのデータ構造は更新されません。

• ContentElement から新しいバリエーションを作成してもデータ構造は更新されません（ただし、ContentFragment からグローバルに新しいバリエーションを作成すると更新されます）。

• 既存のバリエーションを削除しても、データ構造は更新されません。

filter.xml

コンテンツフラグメント管理のための filter.xml は、アセットのコアコンテンツパッケージと重複しないように設定されています。

セッションの開始

• コンテンツフラグメントの新しいバージョンが作成されます。
• 自動保存が開始されます。
• Cookie が設定されます。この cookie により、現在編集しているフラグメントと、オープンな編集セッションが存在していることが定義されます。

セッションの終了

• 自動保存が停止します。

• コミットする場合：

  • 最終変更日の情報が更新されます。
  • Cookie が削除されます。

• ロールバック時：

  • 編集セッションの開始時に作成されたコンテンツフラグメントのバージョンが復元されます。
  • Cookie が削除されます。

編集

• すべての変更（自動保存を含む）は、分離された保護領域ではなく、アクティブなコンテンツフラグメントに対して行われます。
• したがって、これらの変更は、それぞれのコンテンツフラグメントを参照する AEM ページに即座に反映されます。

ページの入力

• Cookie を確認して、それぞれの編集セッションが存在するかどうかを確認します。

  • 存在する場合は、現在編集中のコンテンツフラグメントに対して、編集セッションが開始されたことを確認します。

    • 現在のフラグメントの場合は、セッションを再確立します。
    • そうでない場合は、以前に編集したコンテンツフラグメントの編集をキャンセルし、Cookie の削除を行います（その後、編集セッションは存在しなくなります）。

  • 編集セッションが存在しない場合は、ユーザーが最初の変更を行うまで待機します（以下を参照）。

• コンテンツフラグメントが既にページで参照されているかどうかを確認し、参照されている場合は適切な情報を表示します。

コンテンツの変更

• ユーザーがコンテンツを変更し、編集セッションが存在しない場合は必ず、新しい編集セッションが作成されます（セッションの開始を参照）。

ページからの移動

• 編集セッションが存在していて、変更が保持されていない場合は、コンテンツが失われる可能性があることをユーザーに通知し、ページに留まるかどうかを尋ねるモーダル確認ダイアログが表示されます。

ノード：<*conf-root*>/settings/dam/cfm/jcr:content

プロパティ名：autoSaveInterval

型：Long

デフォルト：600（10 分）。/libs/settings/dam/cfm/jcr:content で定義されています

ノード：/conf/global/settings/dam/cfm/jcr:content

プロパティ名：autoSaveInterval

型：Long

値：300（5 分は 300 秒です）