Liferay 7.3のマスターページテンプレート機能の紹介 - Liferay 7.3のマスターページテンプレート機能の紹介 - aegif Labo Blog Liferay
null Liferay 7.3のマスターページテンプレート機能の紹介
こんにちは。おおたにです。
今回はLiferay 7.3の新機能であるマスターページテンプレート機能について紹介したいと思います。
これまでWebページのヘッダやフッタなどの共通部分はテーマを利用して定義する必要がありました。テーマは開発者が作成/デプロイする必要があるため、サイト管理者レベルでは事前に作成されたテーマを適用する(複数のテーマがデプロイされている場合はその中のいずれかを選んで適用する)ことしかできませんでした。
Liferay 7.3ではマスターページテンプレートを使うことで、サイト管理者が各ページの共通要素を自分で定義して適用することができるようになりました。たとえば、サイトのヘッダやフッタといった共通部品をサイト管理者レベルでデザインすることができます。
ではマスターページテンプレート機能の使い方を見ていきましょう。
マスターページテンプレートを作成する
マスターページテンプレートはサイト単位で定義/管理することができます。目的のサイトの画面左上の「メニュー」アイコン->「デザイン」->「ページテンプレート」をクリックします。
「マスター」タブに表示されているものがマスターページテンプレートです。デフォルトで「空白」という名前のマスターページテンプレートが存在し、青いチェックマークが付いています。これは、表示に影響を与えない空のマスターページテンプレートで、このマスターページテンプレートがデフォルトで適用されることを意味しています。
では、画面右上の「追加」アイコンをクリックし、名前に「サンプルマスターページ1」と入力して保存してみましょう。新しい空のマスターページテンプレートが作成され、編集状態で表示されます。
続いて、コンテンツページと同じ要領でマスターページテンプレートを編集していきます。ドロップゾーンはページ編集時にページ編集者が自由にフラグメントを配置できるスペースのことです。この上下にヘッダとフッタを設定していくのが基本的なユースケースになるかと思います。
最後に、「許可されたフラグメントを設定」をクリックします。ここでは、マスターページテンプレートを適用したページのドロップゾーンにどのフラグメントを追加できるかを設定します。デフォルトでは全てのフラグメントにチェックが入っているので、ページ作成者に利用させたくないフラグメントがある場合はチェックを外します。設定がおわったら「保存」ボタンを押します。
マスターページテンプレートの編集が終わったら、「マスターを公開」をクリックします。マスターページテンプレート一覧に新しいテンプレートが表示されていれば公開成功です。
マスターページテンプレートを適用する
マスターページテンプレートが作成できたら、次はそれを実際のページに適用してみましょう。マスターページテンプレートを適用したいページの画面右上の 編集アイコンをクリックし、 ページデザインオプションアイコンをクリックします。マスタータブでマスターページテンプレートを選択できるので、先ほど作ったマスターページテンプレートを選択します。
なお、これだけだとテーマ由来のヘッダやフッタと二重に表示されてしまうので、そのような場合は「詳細」をクリックします。ページのルック&フィールの設定画面が表示されるので、「このページ向けのルック&フィールを定義する」を選択して「保存」をクリックします。
これでこのページにテーマが適用されなくなり、マスターページテンプレートのヘッダ&フッタのみが表示されるようになります。あとは「公開」ボタンをクリックしてページ編集を保存します。
これでマスターページテンプレートがページに適用され、サイト独自のページデザインに変更されます。
マスターページテンプレートを管理する
マスターページテンプレートの管理はマスターページテンプレート一覧画面で行います。アクションメニューにはいくつかの便利な機能が用意されています。
- 編集 : マスターページテンプレートを編集します
- サムネイルを変更 : マスターページテンプレートのサムネイルを変更します
- 名前を変更する : マスターページテンプレートの名前を変更します
- コピーを作成 : マスターページテンプレートのコピーを作成します。既存のマスターページテンプレートをベースにして新たなテンプレートを作成することができます
- エクスポート : マスターページテンプレートをzipファイルとしてエクスポートします。ページテンプレート画面のアクションメニューの「インポート」からインポートすることができます
- 権限の設定 : マスターページテンプレートの権限を設定します
- デフォルトにする : デフォルトで適用されるマスターページテンプレートにします。現在デフォルトになっているマスターページテンプレートには青色のチェックアイコンが表示されます
- 削除 : マスターページテンプレートを削除します
今回の記事は以上となります。マスターページテンプレートを利用することで、サイト管理者レベルでのサイトデザインの自由度が一気に広がりますので、皆さんも是非お試しください。