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

# カラー図版

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

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

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

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

>     図版名  画像ファイル名

以下は記述例です。

>     palmyra       palmyra.bmp
>     persepolis    persepolis.bmp
>     petra         petra.jpg

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

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

>     CGRAPHS = cgraphs.txt

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

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

>     ARCHIVEEXTRA = palmyra.bmp persepolis.bmp petra.jpg

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

>     ARCHIVEEXTRA = images

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

BMP 形式のカラー図版を本文中から参照するには、本文書き込み用のクラス `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` メソッドで書き込むという違い がある点に注意して下さい。

JPEG 形式のカラー図版を本文中から参照する場合、BMP とはメソッドが 異なり、`add_jpeg_graphic_start()` メソッドと `add_jpeg_graphic_end()` メソッドを使います。 使い方は、BMP 用のメソッドと変わりません。

>     $fpwtext->add_jpeg_graphic_start("persepolis");
>     $fpwtext->add_text("→図版");    # キャプション
>     $fpwtext->add_jpeg_graphic_end();

## インラインカラー図版

FreePWING バージョン 1.6 から「インラインカラー図版」が扱えるように なりました。

通常の (これまで説明してきた) カラー図版は、本文中に「→図版」のような 参照マークを埋め込み、ユーザーがそのマークを辿ると図版が表示される、と いうものでした。 本文と図版は別々に表示されるため、検索ソフトウェアでは表示の切り替え が発生します。

これに対してインラインカラー図版では、本文と図版を一緒に表示するよう、 検索ソフトウェアに指示します。 つまり、Web ページのように、テキストは図版を避けて表示されます。

とはいえ、検索ソフトウェアからみれば、インラインカラー図版と通常の カラー図版の扱い方には明確な違いがあるものの、FreePWING のように データ生成ソフトウェア側からみれば、両者の違いはごく僅かです。 通常のカラー図版の代わりにインラインカラー図版を用いるには、本文から カラー図版への参照を行う際に、呼び出すメソッドを変えるだけです。

画像形式 | 通常のカラー図版用のメソッド | インラインカラー図版用のメソッド
--- | --- | ---
BMP | add_color_graphic_start() add_color_graphic_end() | add_inline_jpeg_graphic_start() add_inline_jpeg_graphic_end()
JPEG | add_jpeg_graphic_start() add_jpeg_graphic_end() | add_inline_jpeg_graphic_start() add_inline_jpeg_graphic_end()

表の通り、通常のカラー図版と同様にインラインカラー図版でも、画像形式は BMP と JPEG に対応しています。 メソッドは異なるものの、引数や戻り値、注意点等は、通常のカラー図版と まったく同じです。 また、カラー図版定義ファイルは、通常のカラー図版と共有します。 したがってカラー図版名も、双方で共有されます。

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