レンダリングコンポーネントのコンテンツフラグメントの設定 content-fragments-configuring-components-for-rendering

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

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

この情報は、次の場合に必要です。

  • 独自のコンテンツフラグメントベースのコンポーネントを実装する必要がある。
  • アドバンスドサービスを利用する必要がある。

代わりに、コアコンポーネントを利用することをお勧めします。

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

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

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

コアコンポーネントの使用をお勧めします。

設定が必要なアドバンスドサービスの定義 definition-of-advanced-services-that-need-configuration

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

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

これらの機能を 1 つ以上使用する必要がある場合は(通常)、標準搭載のアドバンスドサービスを使用するほうが、一から開発するよりも簡単です。

OSGi サービス - コンテンツフラグメントコンポーネントの設定 osgi-service-content-fragment-component-configuration

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

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

NOTE
詳しくは、OSGi の設定を参照してください。

次に例を示します。

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

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

一部の機能については、コンポーネントは定義済みの規則に従う必要があります。次の表に、サービスが適切に検出して処理できるよう、各段落に対してコンポーネントごとに定義する必要があるプロパティ(各コンポーネントインスタンスに対する jcr:paragraph)の詳細を示します。

プロパティ名
説明
paragraphScope

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

値:

  • all :すべての段落をレンダリング
  • range :次によって提供される段落の範囲をレンダリング paragraphRange
paragraphRange

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

形式:

  • 1 または 1-3 または 1-3;6;7-8 または *-3;5-*

    • - 範囲指標
    • ; リスト区切り記号
    • * ワイルドカード
  • paragraphScope が次のように設定されている場合のみ利用可能 range

paragraphHeadings
見出し(例えば、h1h2h3 など)を段落としてカウントするか(true)、カウントしないか(false)を定義する boolean プロパティ。

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
fbcff2a9-b6fe-4574-b04a-21e75df764ab