情報テンプレートの使用
7.4+で利用可能
情報テンプレートを使用すると、情報フレームワークを実装しているあらゆるアイテムタイプの FreeMarker テンプレートを作成できます。 サポートされているアイテムタイプには、ウェブコンテンツ、ドキュメント、アセット、ブログ、カテゴリー、オブジェクトがあります。 一度作成すると、フラグメントフィールドをテンプレートにマッピングして、コンテンツページと表示ページでアイテムがどのようにレンダリングされるかを決定できます。 これは、あなたのサイトに一貫したスタイルを導入するのに役立ちます。
情報テンプレートはフラグメントでのみ利用可能で、ウィジェットでは利用できません。 ウィジェットに表示されるウェブコンテンツ用のFreeMarkerテンプレートをデザインしたい場合は、 ウェブコンテンツテンプレート をご利用ください。
情報テンプレートの作成
以下の手順に従って、情報テンプレートを作成してください:
-
)を開き、 デザイン → テンプレート → 情報テンプレート に移動します。
-
追加 ボタンをクリックする ()
-
名前 を入力し、 アイテムのタイプ を選択し、(該当する場合)アイテムのサブタイプ を選択します。
-
[保存]をクリックします。 これにより、テンプレートデザインページにリダイレクトされます。
-
(オプション) インポート
.ftl
ファイルから既存の FreeMarker スクリプトをインポートします。 -
FreeMarkerを使ってテンプレートをデザインします。
エディターで
${
と入力するとオートコンプリート機能が使える。Elements サイドパネル()では、選択したアイテムタイプの構造から利用可能なフィールドに素早くアクセスすることができます。
note要素」サイドパネルには、テンプレートに基づくフィールドは含まれていません(例:ジャーナル記事テンプレート、情報テンプレート)。 これは無限ループを防ぐためである。
-
(オプション) Propertiesサイドパネルでテンプレートに description または image を追加します()。
-
終了したら、 保存 をクリックします。
一度作成された情報テンプレートは、コンテンツ表示フラグメントや、テキストやリッチテキストなど、マッピング可能な サブ要素 を持つその他のフラグメントで使用することができます。 選択すると、コンテントページと表示ページテンプレートで項目がどのようにレンダリングされるかが決定されます。
Liferay の Headless API サービスは restClient
オブジェクトを通してテンプレートエディタで利用できます。 使い方の詳細は テンプレートエディターでヘッドレスAPIを呼び出す を参照してください。
スクリプトのインポートとエクスポート
情報テンプレートを編集する際、FreeMarkerスクリプトをインポートおよびエクスポートして、他のコンテキストで再利用することができます:
-
)を開き、 デザイン → テンプレート → 情報テンプレート に移動します。
-
必要な情報テンプレートを選択します。
-
アプリケーションバーの Actions ボタン(../../images/icon-actions.png)をクリックし、 Export Script または Import Script を選択します。
エクスポートすると、現在の FreeMarker スクリプトは script.ftl
ファイルとして保存されます。
インポートする際、選択したファイルはテンプレートの現在のFreeMarkerスクリプトを置き換えます。
情報テンプレートの管理
テンプレート」アプリケーションでは、既存のすべての情報テンプレートを表示および管理できます。 それぞれの既存のテンプレートは、そのタイプ(例えば、ウェブコンテンツ記事)とサブタイプ(例えば、基本ウェブコンテンツ)と共にリストされます。 テンプレートの Actions ボタン() をクリックすると、以下のオプションにアクセスできます:
操作 | 説明 |
---|---|
編集する | テンプレートを編集する。 |
コピー | 選択したテンプレートの内容で新しいテンプレートを作成する。 |
権限の設定 | テンプレートの基本的な権限を管理します。 |
削除 | テンプレートを削除する。 |
ここでは、情報テンプレートを LAR ファイルとして エクスポート および インポート して、サイトと環境間で共有することもできます。 これを行うには、アプリケーション バーの アクション ボタンをクリックし、エクスポート/インポート を選択します。
デフォルトでは、情報テンプレートのエクスポートにはウィジェットテンプレートが含まれます。 ただし、どのテンプレートをLARファイルに含めるかは設定できます。