layouts.xmlは、個別アプリケーション内で使用するレイアウトを設定します。
レイアウトは、表示するHTMLを共通で表示する部分(例えば、ヘッダ/フッタ)と個別で表示する部分(コンテンツ)に分割することにより、
共通表示部分の修正を1ファイルにできたり、個別画面追加時は個別部分のみ追加できるようにする機能です。
フィルタを使用するには、事前に routers.xml を定義してください。routers.xml の router 要素の layoutName 属性と layouts.xml の layout 要素の name 属性が一致する必要があります。
<?xml version="1.0" encoding="UTF-8" ?> <syl-layouts xmlns="http://syl.jp/schema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://syl.jp/schema syl-layouts.xsd"> </syl-layouts>
※ インストール初期状態ではレイアウトは設定されていません。
タグ名 | 親タグ名 | 属性 | 必須 | 説明 |
---|---|---|---|---|
syl-layouts | - | - | - | layouts.xmlのTOPレベルノード |
タグ名 | 親タグ名 | 属性 | 必須 | 説明 |
---|---|---|---|---|
layout | syl-layouts | - | - | nameで指定されたレイアウトに対して使用するタグ。 |
name | ○ | レイアウト名。アクション設定ファイル(actions.xml)の layoutName と合わせる | ||
file | ○ | レイアウトの基本となるファイル名。基本構成要素。 | ||
enable | - | レイアウトを使用するフラグ true … 使用する(デフォルト) false … 使用しない |
タグ名 | 親タグ名 | 属性 | 必須 | 説明 |
---|---|---|---|---|
template | layout | - | - | 基本構成要素に対応するテンプレートタグ |
name | ○ | 基本構成要素で使用するテンプレートの変数名 | ||
file | ○ | 基本構成要素で使用するテンプレートのファイルパス。テンプレートルートから記述。パーツ要素。 |
タグ名 | 親タグ名 | 属性 | 必須 | 説明 |
---|---|---|---|---|
content | layout | - | - | 基本構成要素に対応するテンプレートタグ |
name | ○ | ビューに対応する変数名 |
タグ名 | 親タグ名 | 属性 | 必須 | 説明 |
---|---|---|---|---|
params | layout | - | - | 変数を設定するタグ |
タグ名 | 親タグ名 | 属性 | 必須 | 説明 |
---|---|---|---|---|
action | params | - | - | 変数に対する適用アクションを設定するタグ |
path | ○ | 適用アクションファイル。正規表現使用可能。 |
タグ名 | 親タグ名 | 属性 | 必須 | 説明 |
---|---|---|---|---|
param | action | - | - | 変数値を設定するタグ |
name | ○ | 変数名 | ||
value | ○ | 変数値 |
<?xml version="1.0" encoding="UTF-8" ?> <syl-layouts xmlns="http://syl.jp/schema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://syl.jp/schema syl-layouts.xsd"> <layout name="default" file="/_Layouts/default.html" enable="true"> <template name="_HEADER_" file="/common/header.html" /> <template name="_MENU_" file="/common/menu.html" /> <content name="_CONTENTS_" /> <template name="_FOOTER_" file="/common/footer.html" /> </layout> </syl-layouts>