ページテンプレート - 編集可能

編集可能テンプレートが導入された目的は次のとおりです。

• 専門的な作成者が、テンプレートを作成および編集できるようにする。

  • このような専門的な作成者は、テンプレート作成者​と呼ばれます。
  • テンプレート作成者は、template-authors グループのメンバーである必要があります。

• テンプレートから作成された任意のページに動的な接続を保持するテンプレートを提供する。これにより、テンプレートに対する変更がページに反映されます。

• ページコンポーネントを汎用化し、核となるページコンポーネントをカスタマイズなしで使用できるようにする。

編集可能テンプレートを使用すると、ページの構成要素がコンポーネント内で分離されます。コンポーネントの必要な組み合わせを UI で設定できるので、ページのバリエーションごとに新しいページコンポーネントを開発する必要がなくなります。

このドキュメントでは、

• 編集可能テンプレートの作成の概要を説明します

  • 詳しくは、ページテンプレートの作成を参照してください。

• 編集可能テンプレートの作成に必要な管理者や開発者のタスクについて説明します

• 編集可能テンプレートの技術的基礎について説明します

このドキュメントでは、テンプレートの作成と編集について既に理解していることを前提としています。オーサリングに関するドキュメントページテンプレートの作成を参照してください。ここでは、テンプレート作成者に公開されている編集可能テンプレートの機能について詳しく説明されています。

新しいテンプレートの作成

編集可能テンプレートの作成は、主にテンプレート作成者が、テンプレートコンソールとテンプレートエディターを使用して行います。ここでは、そのプロセスの概要を示し、技術的なレベルでどのような処理が行われるかを説明します。

AEM プロジェクトで編集可能テンプレートを使用する方法について詳しくは、「Lazybones を使用した AEM プロジェクトの作成」を参照してください。

編集可能テンプレートを作成する場合は、次の操作を実行します。

1. テンプレート用フォルダーを作成します。このフォルダーは必須ではありませんが、ベストプラクティスとして推奨されます。

2. テンプレートタイプを選択します。このタイプがコピーされ、テンプレート定義が作成されます。

   メモ

   すぐに利用できるテンプレートタイプが用意されています。必要に応じて、独自のサイト固有のテンプレートタイプを作成することもできます。

3. 新しいテンプレートの構造、コンテンツポリシー、初期コンテンツおよびレイアウトを設定します。

   構造

   • 構造では、テンプレートのコンポーネントとコンテンツを定義できます。

   • テンプレート構造で定義されたコンポーネントは、結果ページに移動することも、結果ページから削除することもできません。

     • We.Retail サンプルコンテンツ外のカスタムフォルダーにテンプレートを作成する場合は、基盤コンポーネントを選択するか、コアコンポーネントを使用できます。

   • ページ作成者がコンポーネントを追加または削除するには、テンプレートに段落システムを追加する必要があります。

   • コンポーネントのロックを解除（再度ロックできます）して、初期コンテンツを定義できます。

   テンプレート作成者が構造を定義する方法について詳しくは、ページテンプレートの作成を参照してください。

   構造の技術的な詳細については、このドキュメントの構造を参照してください。

   ポリシー

   • コンテンツポリシーでは、コンポーネントのデザインプロパティを定義します。

     • 例えば、使用できるコンポーネントや最小／最大サイズを定義できます。

   • これらのポリシーは、テンプレート（およびテンプレートを使用して作成されたページ）に適用できます。

   テンプレート作成者がポリシーを定義する方法について詳しくは、ページテンプレートの作成を参照してください。

   ポリシーの技術的な詳細については、このドキュメントのコンテンツポリシーを参照してください。

   初期コンテンツ

   • 初期コンテンツは、テンプレートに基づいてページが最初に作成されるときに表示されるコンテンツを定義します。
   • その後、ページ作成者が初期コンテンツを編集できます。

   テンプレート作成者が構造を定義する方法について詳しくは、ページテンプレートの作成を参照してください。

   初期コンテンツの技術的な詳細については、このドキュメントの初期コンテンツを参照してください。

   レイアウト

   • デバイスの形式に合わせてテンプレートのレイアウトを定義できます。
   • テンプレートがページオーサリングと同じように動作するには、レスポンシブレイアウトを使用します。

   テンプレート作成者がテンプレートレイアウトを定義する方法について詳しくは、ページテンプレートの作成を参照してください。

   テンプレートレイアウトの技術的な詳細については、このドキュメントのレイアウトを参照してください。

4. テンプレートを有効にし、特定のコンテンツツリーに対して許可します。

   • テンプレートを有効または無効にして、ページ作成者が使用できるようにしたり、使用できなくしたりできます。
   • テンプレートは、特定のページブランチに対して使用可能または使用不可にすることができます。

   テンプレート作成者がテンプレートを有効にする方法について詳しくは、ページテンプレートの作成を参照してください。

   テンプレートの有効化の技術的な詳細については、このドキュメントの使用するテンプレートの有効化と許可を参照してください。

5. テンプレートを使用してコンテンツページを作成します。

   • テンプレートを使用してページを作成した場合、静的テンプレートと編集可能テンプレートの見た目に違いはなく、どちらが使用されたかはわかりません。
   • ページの作成者にとって、この処理は透過的です。

   ページ作成者がテンプレートを使用してページを作成する方法について詳しくは、ページの作成と整理を参照してください。

   編集可能テンプレートを使用したページ作成の技術的な詳細については、このドキュメントの作成されるコンテンツページを参照してください。

テンプレートフォルダー

以下のフォルダーを使用すると、テンプレートを整理できます。

• global
• サイト固有
  テンプレートを整理するためのサイト固有のフォルダーは、管理者権限を保持しているアカウントによって作成されます。

標準の AEM インスタンスでは、テンプレートコンソールに​グローバル​フォルダーが既に存在します。このフォルダーにデフォルトのテンプレートが格納されており、現在のフォルダーにポリシーやテンプレートタイプがない場合にはフォールバックとして機能します。このフォルダーに独自のデフォルトのテンプレートを追加することも、新しいフォルダーを作成すること（推奨）もできます。

テンプレートのタイプやポリシーは、次の優先順位に従ってすべてのフォルダーに継承されます。

1. 現在のフォルダー。
2. 現在のフォルダーの親の親。
3. /conf/global
4. /apps
5. /libs

許可されたすべてのエントリのリストが表示されます。オーバーラップする設定がある場合（path／label）、現在のフォルダーに最も近いインスタンスがユーザーに表示されます。

フォルダーを作成するには、次の手順を実行します。

• プログラムで自動的に、または CRXDE Lite を使用して作成
• 設定ブラウザーの使用

CRXDE Lite の使用

1. インスタンスの新しいフォルダー（/conf の下）は、プログラムで自動的にまたは CRXDE Lite を使用して作成できます。

   次の構造を使用する必要があります。

   /conf
       <your-folder-name> [sling:Folder]
           settings [sling:Folder]
               wcm [cq:Page]
                   templates [cq:Page]
                   policies [cq:Page]
   

2. その後、フォルダーのルートノードに次のプロパティを定義できます。

   <your-folder-name> [sling:Folder]

   名前：jcr:title

   • 型：String

   • 値：テンプレート​コンソールに表示される（フォルダーの）タイトルです。

3. 作成者が新しいフォルダーにテンプレートを作成できるようにするには、標準のオーサリング権限と特権（content-authors など）に加え、グループを割り当てて作成者に必要なアクセス権限（ACL）を定義する必要があります。

   割り当てる必要があるデフォルトのグループは、template-authors グループです。詳しくは、次の節ACL とグループを参照してください。

   アクセス権限の管理および割り当てについて詳しくは、アクセス権限の管理を参照してください。

設定ブラウザーの使用

1. に移動します。 グローバルナビゲーション > ツール > 設定ブラウザー.

   グローバル​フォルダーを含めた既存のフォルダーは左側に一覧表示されます。

2. 「作成」をクリックします。

3. 設定を作成​ダイアログで、以下のフィールドを設定する必要があります。

   • タイトル：設定フォルダーのタイトルを指定します
   • 編集可能テンプレート：このフォルダー内で編集可能なテンプレートを許可する場合に選択します

4. 「作成」をクリックします。

ACL とグループ

CRXDE または設定ブラウザーを使用してテンプレートフォルダーを作成した後、セキュリティを確保するために、テンプレートフォルダーの適切なグループに ACL を定義する必要があります。

例として、We.Retail 参照実装のテンプレートフォルダーを使用できます。

template-authors グループ

template-authors グループは、テンプレートへのアクセスを管理するために使用されるグループで、AEM に標準で付属していますが空です。ユーザーは、プロジェクト／サイトのグループに追加する必要があります。

次の表に、テンプレートの編集に必要な権限を示します。

デフォルトの template-authors グループは、プロジェクト設定のみに対応しています。この場合、template-authors のすべてのメンバーは、すべてのテンプレートへのアクセスとそれらの作成が許可されています。より複雑な設定では、テンプレートに個別にアクセスするためにテンプレート作成者グループが複数必要になるので、さらに多くのカスタムテンプレート作成者グループを作成する必要があります。ただし、テンプレート作成者グループの権限は変わりません。

/conf/global の下の従来のテンプレート

テンプレートを /conf/global に保存しないでください。ただし、従来のインストールでは、まだこの場所にテンプレートが存在する場合があります。このような従来の場合​のみ、次の /conf/global パスを明示的に設定する必要があります。

テンプレートタイプ

テンプレートの作成時には、テンプレートタイプを指定します。

• テンプレートタイプは、テンプレートのためのテンプレートとなるものです。テンプレート作成時に選択したテンプレートタイプの構造と初期コンテンツに基づいて、テンプレートが作成されます。

  • テンプレートタイプがコピーされて、テンプレートが作成されます。
  • コピー後のテンプレートとテンプレートタイプとの関連付けは、情報を取得するだけの静的参照のみとなります。

• テンプレートタイプを使用して、次の項目を定義できます。

  • ページコンポーネントのリソースタイプ。
  • ルートノードのポリシー。テンプレートエディターで許可されるコンポーネントを定義します。
  • そのテンプレートタイプで、モバイルエミュレーターのレスポンシブグリッドと設定のブレークポイントを定義することをお勧めします。設定は個々のテンプレートで定義することもできるので（テンプレートタイプとモバイルデバイスグループを参照）、これはオプションです。

• AEM には、既製のテンプレートタイプがいくつか用意されています（HTML 5 ページ、アダプティブフォームページなど）。

  • その他の例は、We.Retail サンプルコンテンツの一部として提供されています。

• テンプレートタイプは通常、開発者が定義します。

既製のテンプレートタイプは次のフォルダーに保存されています。

• /libs/settings/wcm/template-types

サイト固有のテンプレートタイプは、以下に相当する場所に保存してください。

• /apps/settings/wcm/template-types

カスタマイズしたテンプレートタイプの定義は、ユーザー定義フォルダー（推奨）または global フォルダーに保存してください。次に例を示します。

• /conf/<my-folder-01>/<my-folder-02>/settings/wcm/template-types
• /conf/<my-folder>/settings/wcm/template-types
• /conf/global/settings/wcm/template-types

テンプレートタイプとモバイルデバイスグループ

編集可能テンプレートで使用されるデバイスグループ（プロパティ cq:deviceGroups の相対パスとして設定）によって、ページオーサリングのレイアウトモードのエミュレーターとして利用できるモバイルデバイスが決まります。この値は次の 2 つの場所で設定できます。

• 編集可能テンプレートのタイプ
• 編集可能テンプレート

編集可能テンプレートを作成する際、値はテンプレートタイプから個々のテンプレートにコピーされます。 値がタイプで設定されていない場合は、テンプレートで設定できます。テンプレートの作成後に、タイプからテンプレートに継承されることはありません。

テンプレートタイプの作成

他のテンプレートの基盤となるテンプレートを作成した場合、このテンプレートをテンプレートタイプとしてコピーできます。

1. こちらのドキュメントで説明されているように編集可能テンプレートと同じようにテンプレートを作成します。これは、テンプレートタイプの基盤となります。
2. CRXDE Lite を使用している場合は、新しく作成したテンプレートを templates ノードからテンプレートフォルダーの下の template-types ノードにコピーします。
3. このテンプレートをテンプレートフォルダーの下の templates ノードから削除します。
4. template-types ノードの下にあるテンプレートのコピーで、すべての jcr:content ノードから cq:template および cq:templateType プロパティをすべて削除します。

また、GitHub で入手できる、編集可能テンプレートのサンプルを基盤として使用し、独自のテンプレートタイプを作成することもできます。

GitHub のコード

このページのコードは GitHub にあります

• GitHub の aem-sites-example-custom-template-type プロジェクトを開きます
• プロジェクトを ZIP ファイルとしてダウンロードします

テンプレート定義

編集可能テンプレートの定義は、ユーザー定義フォルダー（推奨）または global フォルダーに格納されます。次に例を示します。

• /conf/<my-folder>/settings/wcm/templates
• /conf/<my-folder-01>/<my-folder-02>/settings/wcm/templates
• /conf/global/settings/wcm/templates

テンプレートのルートノードは、以下のスケルトン構造を持つ cq:Template タイプです。

<template-name>
  initial
    jcr:content
      root
        <component>
        ...
        <component>
  jcr:content
    @property status
  policies
    jcr:content
      root
        @property cq:policy
        <component>
          @property cq:policy
        ...
        <component>
          @property cq:policy
  structure
    jcr:content
      root
        <component>
        ...
        <component>
      cq:responsive
        breakpoints
  thumbnail.png

主な要素は以下のとおりです。

• <template-name>

  • [initial](#initial-content)
  • jcr:content
  • [structure](#structure)
  • [policies](#policies)
  • thumbnail.png

jcr:content

このノードは、テンプレートのプロパティを保持します。

• 名前：jcr:title

• 名前：status

  • 型：String

  • 値：draft、enabled または disabled

構造

作成されるページの構造を定義します。

• ページの作成時に初期コンテンツ（/initial）と統合されます。

• 構造に加えた変更は、そのテンプレートを使用して作成されたすべてのページに反映されます。

• root（structure/jcr:content/root）ノードは、作成されたページで使用できるコンポーネントのリストを定義します。

  • テンプレート構造で定義されたコンポーネントは、作成されたページで移動することも、作成されたページから削除することもできません。

  • コンポーネントをロック解除すると、editable プロパティが true に設定されます。

  • 既にコンテンツを含むコンポーネントをロック解除すると、このコンテンツは initial ブランチに移動されます。

• cq:responsive ノードは、レスポンシブレイアウトの定義を保持します。

初期コンテンツ

新しいページが作成されたときに、最初に表示されるコンテンツを定義します。

• すべての新しいページにコピーされる jcr:content ノードが含まれます。
• ページ作成時に構造（/structure）と統合されます。
• 作成後に初期コンテンツが変更された場合は、既存のページもすべて更新されます。
• root ノードにはコンポーネントのリストが格納され、結果として得られるページで使用できるコンポーネントを定義します。
• コンテンツが構造モードでコンポーネントに追加された後、そのコンポーネントがアンロックされた場合（またはその逆の場合）、このコンテンツは初期コンテンツとして使用されます。

レイアウト

テンプレートの編集時にレイアウトを定義できます。レイアウトは標準のレスポンシブレイアウトを使用し、必要に応じて設定することもできます。

コンテンツポリシー

コンテンツ（またはデザイン）ポリシーは、コンポーネントの可用性や最小／最大寸法など、コンポーネントのデザインプロパティを定義します。これらのポリシーは、テンプレート（およびテンプレートを使用して作成されたページ）に適用できます。コンテンツポリシーは、テンプレートエディターで作成および選択できます。

• root ノード上の cq:policy プロパティ
  /conf/<your-folder>/settings/wcm/templates/<your-template>/policies/jcr:content/root
  ページの段落システムのコンテンツポリシーに対する相対参照を提供します。

• root の下のコンポーネントを明示的に示すノードの cq:policy プロパティは、個々のコンポーネントのポリシーへのリンクを提供します。

• 実際のポリシー定義は、次の場所に保存されます。
  /conf/<your-folder>/settings/wcm/policies/wcm/foundation/components

ページポリシー

ページポリシーを使用すると、 コンテンツポリシー （メイン parsys）ページの場合は、テンプレートまたは結果ページのいずれかで使用します。

使用するテンプレートの有効化と許可

1. テンプレートの有効化

   テンプレートを使用する前に、次のいずれかの方法で有効にする必要があります。

   • テンプレート​コンソールからテンプレートを有効化する。

   • jcr:content ノードの status プロパティを設定する。

     • 例：

       /conf/<your-folder>/settings/wcm/templates/<your-template>/jcr:content

     • 次のプロパティを定義します。

       • 名前：ステータス
       • タイプ：String
       • 値：enabled

2. 許可されたテンプレート

   • サブブランチの該当するページまたはルートページの​ページプロパティ​で、許可されたテンプレートのパスを定義します。

   • プロパティを設定します。

     cq:allowedTemplates
     次の日： jcr:content 必要なブランチのノードに設定します。

   例えば、次の値を使用します。

   /conf/<your-folder>/settings/wcm/templates/.*

作成されるコンテンツページ

編集可能テンプレートから作成されるページには、次の特徴があります。

• テンプレートの structure と initial を統合したサブツリーを使用して作成されます。

• テンプレートおよびテンプレートタイプに保持されている情報への参照を保持します。この機能は、次のプロパティを持つ jcr:content ノードで実現できます。

  • cq:template
    実際のテンプレートへの動的参照を提供します。テンプレートへの変更を実際のページに反映させることができます。

  • cq:templateType
    テンプレートタイプへの参照を提供します。

上の図は、テンプレート、コンテンツおよびコンポーネントの相関関係を示したものです。

• コントローラー - /content/<my-site>/<my-page>
  テンプレートを参照した結果のページ。コンテンツがプロセス全体を制御します。定義に従って、適切なテンプレートとコンポーネントにアクセスします。

• 設定 - /conf/<my-folder>/settings/wcm/templates/<my-template>
  テンプレートおよび関連するコンテンツポリシーがページ設定を定義します。

• モデル - OSGi バンドル
  OSGi バンドルが機能を実装します。

• 表示 - /apps/<my-site>/components
  オーサー環境とパブリッシュ環境の両方で、コンテンツがコンポーネントによってレンダリングされます。

ページのレンダリング時：

• テンプレート:

  • jcr:content ノードの cq:template プロパティが、そのページに対応するテンプレートにアクセスするために参照されます。

• コンポーネント:

  • ページコンポーネントは、テンプレートの structure/jcr:content ツリーとページの jcr:content ツリーを統合します。

  • 作成者は、ページコンポーネントを使用して、編集可能のフラグが設定されているテンプレート構造のノード（およびいずれかの子）を編集できるだけです。

  • ページ上にコンポーネントをレンダリングする場合、そのコンポーネントの相対パスが jcr:content ノードから取得されます。その後、テンプレートの policies/jcr:content ノードの下の同じパスが検索されます。

    • このノードの cq:policy プロパティは、実際のコンテンツポリシーを指します（すなわち、このプロパティは、そのコンポーネントのデザイン設定を保持しています）。

    • この機能を使用すると、同じコンテンツポリシー設定を再利用する複数のテンプレートを持つことができます。