プラグイン設定ファイルは、以下のフォーマットで記述します。
一言で言えばWindowsで使用されるiniファイルと同じ形式です。
プラグイン設定ファイルは、だいたい以下のような感じで記述されます。
| コメント |
| [セクション名1] キー1 = 値1 キー2 = 値2 |
| [セクション名2] キー1 = 値1 キー3 = 値3 ; コメント |
| [セクション名3] キー2 = 値2 キー4 = 値4 |
プラグイン設定ファイルには、「セクション」と「キー」と「値」という三つの概念があります。各「セクション」の中には「キー」と「値」のペアが格納されます。そして、「キー」と「値」は”=”によって対応づけられます。
同じ「セクション」内に同じ「キー」は複数個存在してはいけません。しかし、「セクション」が異なるのであれば、「キー」の重複は許されます。
現在使用しているロケールにあっている文字コードであれば、「セクション名」や「キー名」「値」に全角文字を使用することができます。ただし、”=”は必ず半角にしてください。
一番最初に出てくる有効な「セクション名」までに記述されている内容は全てコメントと見なされます。また、行の(空白でない)最初の文字が”;”で始まる行もコメントと見なされます。
セクション名は、半角の”[”と”]”で囲まれた任意の文字列です。ただし、セクション名は必ず一行で記述してください。改行コードを含みたい場合は、後述のエスケープシーケンスを使用してください。
有効なセクション名の例
| 記述 | セクション名 |
|---|---|
| [Section1] | Section1 |
| [Section2] | Section2 |
| [Sec\ntion3] | Sec tion3 |
無効なセクション名の例
| 記述 | 理由 |
|---|---|
| [Section1 | ”]”で終わってない |
| [Secti on2] |
改行を含むことはできない。 |
なお、「セクション名」以降に記述されている文字列は全てコメントと見なされます。
キー及び値を記述した行は、以下のように解釈されます。
なお、「キー名」中に含まれるセミコロンはキー名の一部として見なされますが、「値」の文字列中にセミコロンが出現した場合は、それ以降はコメントと見なされます。
例
| 記述 | キー | 値 |
|---|---|---|
| key = val | key | val |
| key = val a | key | val a |
| \ key\n\ key=val ; val | key key |
val |
セクション名やキー名、値に空白や改行、セミコロンなどを含めるためには、以下のエスケープシーケンスを用います。
| 記述 | 意味 |
|---|---|
| \; | 文字としてのセミコロン |
| \= | 文字としての= |
| \ (\と半角空白) | 文字としての半角空白 |
| \\ | 文字としての円記号 |
| \[ | 文字としての左大括弧 |
| \] | 文字としての右大括弧 |
| \n | 文字としての改行コード |
| \ (\の後で改行) |
文字としての改行コード |
| \t | 文字としてのタブ |