概要

名称

CMS POPプラグイン

プラグインID

org.seasar.kvasir.cms.pop

説明

Webサイト上に配置可能な部品である「POP」を管理するプラグインです。

提供する拡張ポイント

org.seasar.kvasir.cms.pop.pops

POPを追加する

org.seasar.kvasir.cms.pop.pops拡張ポイント

POPを追加するための拡張ポイントです。

拡張を表す要素

pop

pop要素

追加するPOPの情報を表します。

属性

body-resource-path, body-type, description, embedded, gard-id, id, image-resource-path, name, title

子要素

form-unit (0..*)

body-resource-path属性

POPの本文を表示するためのテンプレートリソースのパスです。パスはプラグインディレクトリ相対で指定して下さい。

テンプレートリソースは国際化に対応しています。例えばbody-resource-pathとしてbody.htmlを指定した場合、例えば現在のリクエストのロケールがja_JPであるとするとbody_ja_JP.html、body_ja.html、body.htmlの順に検索されて使用されます。

デフォルト値は「pops/[POP_ID]/body.html」です。

body-type属性

POPの本文のメディアタイプです。

デフォルト値は「text/x-zpt」です。

description属性

POPの説明文です。この情報は、例えばWebサイト編集モードでPOPをダブルクリックした際に表示される設定画面の「POP情報」タブに表示されます。

embedded属性

POPが埋め込みPOPであるかどうかを表します。

埋め込みPOPとは、POPが部品としてWebサイト上に配置されるためのものではなく、主にコンテンツの本文などに埋め込まれて使われるものであることを表します。例えばWiki形式で用いる「改行タグを生成するPOP」などは埋め込みPOPです。

なお埋め込みPOPは通常インスタンス毎のプロパティによってではなく評価時の引数によって見た目や挙動が変わるように作成されます。

デフォルト値はfalseです。

gard-id属性

POPが属するGardのIDです。

指定しない場合はグローバルなPOPであるとみなされます。

id

POPのIDです。

IDと同じ名前のコンポーネントがplugin.diconに定義されている場合、POPのロジックとしてそのコンポーネントが使用されます。そうでない場合はorg.seasar.kvasir.cms.pop.pop.GenericPopが使用されます。

image-resource-path属性

Webサイト編集モードでPOPギャラリに表示する際の画像のパスです。パスはプラグインディレクトリ相対で指定して下さい。

パスに対応するリソースが存在しない場合はデフォルトの画像が使用されます。

デフォルト値は「pops/[POP_ID]/image.jpg」です。

name属性

POPの名前です。この情報は、例えばWebサイト編集モードでPOPをダブルクリックした際に表示される設定画面の「POP情報」タブに表示されます。

title属性

POPのタイトルです。

国際化しやすいよう、「%」＋キーという文字列を指定すると、キーに対応するエントリがplugin.xpropertiesから取り出されて使用されるようになっています。

デフォルト値は「%pop.[POP_ID].title」です。

form-unit要素

POPが持つプロパティを設定するためのフォームの構成要素を定義します。

属性

default, description, human-readable, id, kind, name, path, type

子要素

option (0..*)

default属性

項目のデフォルト値です。

デフォルト値を指定すると、設定値がデフォルト値と同じ場合はその項目の値が明示的に永続化されなくなります。POPの項目のデフォルト値が将来のバージョンで変わる可能性が高いものについては、なるべく指定しておいた方が良いでしょう。

description属性

項目の説明です。

国際化しやすいよう、「%」＋キーという文字列を指定すると、キーに対応するエントリがplugin.xpropertiesから取り出されて使用されるようになっています。

デフォルト値は「%pop.[POP_ID].[項目のID].description」です。

human-readable属性

項目の値が人間が読むような値であるかどうかです。

この属性がfalseの場合は、項目の値はロケール毎に変化するような値ではないとみなされます。国際化する必要がない値についてはこの属性をfalseにしておいて下さい。

デフォルト値はtrueです。

id属性

この項目のIDです。

kind属性 [必須]

この項目の種類です。指定できる種類としては以下のものがあります：

group

アクションです。（path属性の説明を参照）

group

項目のグループです。

property

POPのプロパティです。

group要素（kind="group"指定を持つform-unit要素）を指定することで項目をグルーピングすることができます。具体的には、group要素の直後の要素から次のgrup要素までの要素がグルーピングされます。

name属性

この項目の名前です。

国際化しやすいよう、「%」＋キーという文字列を指定すると、キーに対応するエントリがplugin.xpropertiesから取り出されて使用されるようになっています。

デフォルト値は「%pop.[POP_ID].[項目のID].name」です。

path属性

このform-unitがアクションを表す場合、アクションを起動するためのGard相対のパスを表します。パスの先頭に「!」をつけるとコンテキスト相対パスとみなされます。

type属性

この項目値の型です。

指定できる値としては以下のものがあります：

boolean

ブール型

select

列挙型

page

ページパス

列挙型の値はoption子要素で指定することができます。

option要素

列挙型の値を指定するための要素です。値はoption要素のボディとして指定します。

なおWebサイト編集モードのPOP設定画面では、値のラベルとしてplugin.xpropertiesの「pop.[POP_ID].[項目のID].option.[列挙型の値].name」エントリが使われます。

属性

なし

ボディ

列挙値