アプリのXML構造
アプリを作成するためのXMLタグについて説明します。
XML構造
| タグ | 内容 | 初期値 | 必須 | 繰返 | 解説 |
|---|---|---|---|---|---|
| <tool> | アプリのトップ | ○ | |||
| <define> | アプリの基本情報 | ○ | |||
| <info> | アプリの概要 | ○ | |||
| <caption> | タイトル | ○ | アプリのタイトル。管理画面の左メニューでアプリのアイコンをマウスオーバーした時の吹き出し内に表示される。 | ||
| <link> | タイトルリンク | アプリタイトルからリンクさせるURL。 | |||
| <custom> | カスタマイズされたアプリのタイトル | アプリのタイトル。設定済みアプリの編集やパネル表示の際、タイトルバーに表示される。未設定の場合は、 caption の設定値を表示する。 変数名を使用して、ユーザーの設定値を表示させることができる。 | |||
| <description> | アプリの説明文 | 左メニューのアイコンをマウスオーバーした時に表示される。 | |||
| </info> | |||||
| <cache_time> | キャッシュ有効期限 | 3600 | XMLファイルのキャッシュ有効期限（秒）。 有効値は正の整数。キャッシュを使用しない場合は、0 を設定する。 キャッシュを使用しない場合に限り、アクセス情報が取得できる。 詳細は参考:アクセス情報取得に関する仕様を参考。 |
||
| <min_width> | アプリの最小幅 | 50 | アプリの領域の最小幅（ピクセル）。 有効値は正の整数で、50〜999 |
||
| <height> | アプリの高さ | 200 | アプリの領域の高さ（ピクセル）。 有効値は正の整数で、200〜 |
||
| <scrolling> | スクロールバー使用フラグ | auto | アプリの内容が領域を超える場合、垂直・水平スクロールバーを使用するかどうかを指定する。 値は、"yes"(= 常に使用する), "no"(= 常に使用しない), "auto"(= 自動) のいずれか。 |
||
| <charset> | URLを取得する際のパラメーターの文字コード指定 | sjis | アプリのコンテンツで「URLを指定する」を選択した場合、かつ、
URLにパラメーターを付与する場合、
この項目で指定された文字コードでパラメーターをURLエンコードする。 パラメータを付与しない場合はこの項目は無視される。 値は、"sjis", "euc-jp", "utf-8" のいずれか。 |
||
| </define> | |||||
| <config> | アプリの設定項目 | ||||
| <item> | 設定項目のトップ | ○ | |||
| <name> | 変数名 | ○ ※ |
valueの値を入れる変数であり、ユニークである必要がある。 半角英数字、アンダースコアのみ使用可。最大文字数32文字。 |
||
| <caption> | 設定項目のユーザーへの表示名 | 設定項目のユーザーへの表示名 | |||
| <type> | データタイプ | ○ ※ |
設定項目のデータタイプ。値は、"string"(= text), "bool"(= check), "enum"(= select）, "hidden"(= hidden) をとる。 | ||
| <require> | 必須かどうか | false | 設定が必要かどうかを定義する。値は、"true"(= 必須）, "false"(= オプション)をとる。 データタイプがstringの時のみ有効。 |
||
| <default> | 初期値 | 設定項目の初期値。最大文字数128文字。 | |||
| <enum> | 選択肢情報 | ||||
| <option> | セレクトボックスの選択肢 | ○ | |||
| <caption> | セレクトボックスのメニュー | セレクトボックスのメニューとして表示される。指定しない場合は、value が表示される。 | |||
| <value> | セレクトボックスの値。 | ユニークである必要がある。最大文字数128文字。 | |||
| </option> | |||||
| </enum> | |||||
| </item> | |||||
| </config> | |||||
| <contents> | アプリのコンテンツ | ○ | |||
| <data> | アプリのコンテンツの記述 | アプリのコンテンツを表示するためのHTMLを直接記述する。 ここで記述されたHTMLソースがアプリとなり、iframeの中で表示される。 変数名 を使用して、ユーザーの設定した値を表示させることができる。 |
|||
| <url> | アプリのコンテンツ取得のためのURL | 変数名 を使用して、ユーザーの設定した値を表示させることができる。 | |||
| </contents> | |||||
| </tool> |
※<config>が指定されたときのみ必須タグとなる
