FreePWING プログラミングドキュメント

[前へ] [次へ] [目次]

# カラー図版

FreePWING では、BMP の画像をカラー図版として収録することができます。 (モノクロ図版用の画像形式が別途存在しますので、ここでは便宜上 BMP 画像のことを「カラー図版」と呼ぶことにします。 モノクロの BMP 画像であっても、区分上はカラー図版になります。)

なお、FreePWING はモノクロ図版には対応していません。 カラー図版のデータは、`honmon` ファイルの中に格納されます。

## カラー図版定義ファイルの用意

カラー図版を利用するには、カラー図版定義ファイルを用意する必要が あります。 カラー図版定義ファイルでは、1 行に 1 つのカラー図版を定義することが できます。 行の記述形式は、次の通りです。

>     図版名  BMPファイル名

以下は記述例です。

>     nutcracker  nutcracker.bmp
>     prtruska    prtruska.bmp

カラー図版名に使える文字はタグ名と同じく、アルファベット (A..Z, a..z)、 数字 (0..9)、下線 (_)、およびハイフン (-) です。

カラー図版定義ファイルを用意したら、このファイルを `Makefile` の `CGRAPHS` 変数に指定します。 たとえば、ファイル名を `cgraphs.txt` としたとすると、次の ように記述します。

>     CGRAPHS = cgraphs.txt

この例では一つしかファイルを指定していませんが、複数指定することも可能 です。

`CGRAPHS` 変数に指定したファイルは、 変換スクリプトのアーカイブ を作る際に、自動的にはアーカイブに収録されますが、ファイル中に 記されている BMP ファイルは収録されないので注意して下さい。 BMP ファイルを収録するには、`Makefile` の `ARCHIVEEXTRA` 変数で指定する必要があります。

>     ARCHIVEEXTRA = nutcracker.bmp prtruska.bmp

ファイルの数が多いときは、BMP ファイルをサブディレクトリに置き、 `ARCHIVEEXTRA` にはそのディレクトリ名を指定すると良い でしょう。

>     ARCHIVEEXTRA = images

## 本文からカラー図版の参照

カラー図版を本文中から参照するには、本文書き込み用のクラス `FreePWING::FPWUtils::Text` のオブジェクトに対して、 `add_color_graphic_start()` メソッドと `add_color_graphic_end()` メソッドを呼び出します。 これらのメソッドは 修飾指定子 の 一種ですので、修飾指定子に関する規則がすべて適用されます。

>     $fpwtext->add_color_graphic_start("prtruska");
>     $fpwtext->add_text("→図版");    # キャプション
>     $fpwtext->add_color_graphic_end();

`add_color_graphic_start()` を呼び出す際に、参照したい カラー図版名を指定しす。 カラー図版の参照は、相互参照 とよく 似ています。 ただし、相互参照では `_end` メソッドで参照先の情報を 書き込むのに対して、 カラー図版の参照では `_start` メソッドで書き込むという違い がある点に注意して下さい。

[前へ] [次へ] [目次]