アプリケーションコンフィグファイル作成ガイド

アプリケーションコンフィグファイル
作成ガイド
※ご注意
・製品仕様および本書の内容は予告なしに変更される場合があります。
・本製品および本書のご使用によりお客様ならびに他の第三者に何らかの損害が発生した
場合、当社は一切の責を負わないものとします。
・本書の記載内容を弊社の許可なく転載することを禁じます。
・商標について
PALROは、富士ソフト株式会社の登録商標です。
Microsoft Windows は米国 Microsoft Corporation の米国、日本およびその他の国におけ
る登録商標または商標です。
その他記載されている会社名、製品名などは、各社の商標または登録商標です。
2012 年 2 月 1 日 Version 3.0.0
Copyright © 2010-2012 FUJISOFT Inc. All rights reserved.
1
目次
１．はじめに
…
3
…
3
…
4
2-1 アプリケーションコンフィグファイル構成
…
4
2-2 アプリケーションコンフィグファイル項目一覧
…
8
1-1 事前準備
２．コンフィグファイル作成手順
2
１．はじめに
アプリケーションコンフィグファイルとは、アプリケーションをインストールする際に必要な登録情報や、
アプリケーションの動作上必要な設定値を定義した XML 形式のファイルです。ここで定義した設定
値は、ユーザがコントロールパネルのアプリケーション管理画面で設定変更を行うことができます。
1-1 事前準備
1-1-1 開発環境を構築する
開発環境の構築方法については、
PALRO Garden（http://www.palrogarden.net ）の[デベロッパー]-[開発者向
けドキュメント]の【アプリケーション開発環境構築ガイド（SPC 編）】または【アプリケー
ション開発環境構築ガイド（PAPPS 編）】を参照してください。
1-1-2 アプリケーションを開発する
アプリケーション開発手順については、
PALRO Garden（http://www.palrogarden.net ）の[デベロッパー]-[開発者向
けドキュメント]の【アプリケーション開発ガイド（SPC 編）】または【アプリケーション開
発ガイド（PAPPS 編）】を参照してください。
3
２．コンフィグファイル作成手順
ここではアプリケーション開発環境 (PAPPS)に含まれる「PALRO Count Sheep」を例にアプリケーショ
ンの作成について説明します。
※「PALRO Count Sheep」は、/usr/local/src/papps/CountSheepApp/ に格納されています。
2-1 アプリケーションコンフィグファイル構成
アプリケーションコンフィグファイルのファイル名は[ (アプリケーション名 ).conf.xml]とな
ります。
例えば｢PALRO Count Sheep ｣については、アプリケーション名が CountSheepApp であるた
め、アプリケーションコンフィグファイル名は[CountSheepApp.conf.xml]となります。
<?xml version="1.0" encoding="UTF -8"?>
<palro_application name="CountSheepApp" version="1.0.0" rele
asedate="2012/02/01" type="PAPPS" mode="transient" languag
e="ja">
<title>PALRO Count Sheep</title>
…2-1-1
…2-1-2
<description>PAPPSでアプリケーションコンフィグファイルを読み込むサンプ
ルアプリケーションです。</description>
<section order="1" name="common">
<title>動作設定 </title>
<description></description>
…2-1-3
…2-1-4
…2-1-5
…2-1-6
<configuration order="1" name="speak" display="yes" modi
fy="yes" conftype="text" formtype="text">
<title>数え上げ数 </title>
…2-1-7
…2-1-8
<description>幾つまで数え上げるかを設定します。（1～10）</descr
iption>
<value>10</value>
…2-1-9
…2-1-10
<defaultvalue>10</defaultvalue>
</configuration>
<configuration order="2" name="kind" display="yes" modif
y="yes" conftype="text" formtype="text">
<title>数え上げ対象 </title>
<description>0:ひつじ 1:しつじ</description>
<value>0</value>
<defaultvalue>0</defaultvalue>
</configuration>
</section>
</palro_application>
4
アプリケーションコンフィグファイルで定義した項目は、コントロールパネル・アプリケーション管理
画面に設定項目として表示されます
図 1：コントロールパネル・アプリケーション管理画面
図 2：コントロールパネル・「PALRO Hello World」設定画面
5
2-1-1 palro_application タグ
・name 属性
アプリケーション名を定義します。
※半角英数・記号を使用してください。
・version 属性
アプリケーションのバージョンを定義します。
※“メジャーバージョン”、“マイナーバージョン”、“リリース”のピリオド区切りとなります。
・releasedate 属性
公開日を設定します。
※西暦を使用してください。
※ PALRO Garden に実際に公開される日と自動的に連動することはありません。
・type 属性
アプリケーションのタイプを設定します。
”SPC”、“PAPPS”から選択してください。
※”SPC”とは、"SPCBase"基底クラスを用いた SPC インタフェースで作成したアプリケ
ーションであり、“PAPPS”とは、SAPI( Sapie API )や PAPI( PALRO API )を使用し
たアプリケーションです。
・mode 属性
アプリケーションの常駐 (resident)、非常駐（transient）を定義します。
※常駐 (resident)を指定した場合、インストールされた時点で起動されます。ま
た、PALRO を起動した時点で自動的に起動されます。非常駐（transient）を指
定した場合は、ユーザ発話ファイルで定義された音声入力があった場合に起動さ
れます。
2-1-2 title タグ
PALRO Garden やコントロールパネル・アプリケーション管理画面に表示されるアプ
リケーションのタイトルを定義します。
2-1-3 description タグ
コントロールパネル・アプリケーション管理画面に表示されるアプリケーションの概要を
定義します。
2-1-4 section タグ
コンフィグファイルからアプリケーションに与える設定値の区分を定義します。
※複数の区分を定義することができます。
・order 属性
表示順序を定義します。省略した場合は、表示順序が不定となります。
※半角数字を使用してください。
・name 属性
区分の名前を定義します。
※半角英数・記号を使用してください。
2-1-5 title タグ
コントロールパネル・アプリケーション管理・アプリケーション毎の設定画面に表示され
6
るタイトルを定義します。
2-1-6 description タグ
コントロールパネル・アプリケーション管理・アプリケーション毎の設定画面に表示され
る設定値の説明を定義します。
2-1-7 configuration タグ
アプリケーションの設定値を定義します。
※複数の区分を定義することができます。
・order 属性
表示順序を定義します。省略した場合は、表示順序が不定となります。
※半角数字を使用してください。
・name 属性
設定項目の項目名を定義します。
※半角英数・記号を使用してください。
・display 属性
表示（yes）・非表示（no）を定義します。
・modify 属性
設定値変更可否を定義します。
※現在は変更可能（yes）のみ対応しています。
・conftype 属性
設定値の型を定義します。省略した場合は、テキスト（text）となります。
※現在はテキスト（text）のみ対応しています。
・formattype 属性
設定値の入力形式を定義します。省略した場合は、テキスト（ text）となります。
※現在はテキスト（text）のみ対応しています。
2-1-8 title タグ
コントロールパネル・アプリケーション管理・アプリケーション毎の設定画面に表示され
る設定項目名を定義します。
2-1-9 description タグ
コントロールパネル・アプリケーション管理・アプリケーション毎の設定画面に表示され
る設定項目の説明文を定義します。
2-1-10 value タグ
コントロールパネル・アプリケーション管理・アプリケーション毎の設定画面から入力さ
れた設定値の値が入ります。
7
2-2 アプリケーションコンフィグファイル項目一覧
表 1：アプリケーションコンフィグファイル項目一覧表
タグ／属性必須
<palro_application>
繰返し
説明
設定値
タグ
○
×
アプリケーション定義
－
name=
属性
○
－
アプリケーション名
任意（半角英数・記号）
version=
属性
○
－
バージョン
半角数字
releasedate=
属性
○
－
リリース日
西暦表示
（YYYY/MM/DD）
type=
属性
○
－
アプリケーション区分
「PAPPS」「SPC」
mode=
属性
○
－
常駐・非常駐区分
常駐：resident
非常駐：transient
<title>
タグ
○
×
タイトル
任意
<description>
タグ
－
×
説明
任意
<section>
タグ
－
○
セクション定義
－
order=
属性
－
－
表示順序
半角数字
name=
属性
○
－
セクション名
任意（半角英数・記号）
<title>
タグ
－
×
タイトル
任意
<description>
タグ
－
－
説明
任意
<configraton>
タグ
○
○
設定定義
－
order=
属性
－
－
表示順序
半角数字
name=
属性
－
－
設定名
任意（半角英数･記号）
display=
属性
－
－
設定画面への表示・非表示
表示する：yes
表示しない：no
modify=
属性
－
－
設定画面での変更可否
変更可：yes
conftype=
属性
△
－
設定値のタイプ
text
formtype=
属性
△
－
設定値の入力形式
text
<title>
タグ
－
×
タイトル
任意
<description>
タグ
－
×
説明
任意
<value>
タグ
●
－
設定値
コントロールパネル・アプリ
ケーション管理画面から
入力された値
8

Download Report