レンダリングコンポーネントのコンテンツフラグメントの設定

コンテンツフラグメントのレンダリングには、いくつかのアドバンスドサービスがあります。これらのサービスを使用するには、そのようなコンポーネントのリソースタイプが、コンテンツフラグメントフレームワークに存在を認識させる必要があります。

これは、OSGi サービス - コンテンツフラグメントコンポーネントの設定を設定しておこないます。

注意

以下に説明するアドバンスドサービスが必要ない場合、この設定は無視できます。

注意

標準搭載のコンポーネントを拡張または使用する場合、 の設定を変更しないことをお勧めします。

注意

アドバンスドサービスを使用することなく、コンテンツフラグメント API のみを使用するコンポーネントを新規に作成できます。ただし、この場合は、適切な処理をおこなうようにコンポーネントを開発する必要がありますので、

したがって、コアコンポーネントを使用することをお勧めします。

設定が必要なアドバンスドサービスの定義

コンポーネントの登録を必要とするサービスは、次のとおりです。

  • 公開中に依存関係を正しく判断する(前回の公開後に変更が加えられた場合は、フラグメントとモデルをページで自動的に公開できることを確認)。
  • フルテキスト検索でのコンテンツフラグメントのサポート。
  • 中間コンテンツ​の管理および処理。
  • 混在メディアアセット​の管理および処理。
  • Dispatcher は、参照されるフラグメントをフラッシュします(フラグメントを含むページが再度公開される場合)。
  • 段落ベースのレンダリングの使用

これらの機能の1つ以上が必要な場合は(通常)、標準搭載された機能を一から開発する代わりに(標準)使用する方が簡単です。

OSGi サービス - コンテンツフラグメントコンポーネントの設定

設定は、OSGi サービス​コンテンツフラグメントコンポーネントの設定​に結び付ける必要があります。

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

メモ

詳細は、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

単一要素のレンダリングモードの場合に出力される段落の範囲を定義する string プロパティ。

形式:

  • 1 または 1-3 または 1-3;6;7-8 または *-3;5-*
  • paragraphScope が次のように設定されている場合のみ利用可能 range
paragraphScope

単一要素のレンダリングモードで段落を出力する方法を定義する string プロパティ。

値:

  • all :すべての段落をレンダリング
  • range :次によって提供される段落の範囲をレンダリング paragraphRange
paragraphHeadings 見出し(例えば、h1h2h3 など)を段落としてカウントするか(true)、カウントしないか(false)を定義する boolean プロパティ。
注意

これは、6.5以降のマイルストーンで変更される可能性があります。

例として、次を参照してください(標準搭載の 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"

このページ