マニュアル文章に図や表を挿入する方法
著者: 森 洋久 / joshua＠globalbase.org ※
* 概要
* この作業の前提となるシステム用件
* [ステップ1] オリジナルイメージの準備
* [ステップ2] オリジナルデータがピクセルデータの場合
* [ステップ3] オリジナルデータがEPSデータなどベクタデータの場合
* [ステップ4] 新しいファイルのCVSへの登録
* [ステップ5] マニュアルデータからの参照
* [ステップ6] コンパイル
概要
マニュアルに表を挿入する方法は、HTMLのタグを知っていれば至って簡単です。tableタグに、titleやcodeをつけて、表の題名を指定したり、外部参照可能とすることが出来ること以外はHTMLのタグと同じです。 XML要素(table)を参照してください。
ここでは特に注意が必要な図の挿入方法を説明します。
▲ページトップへ戻る
この作業の前提となるシステム用件
まず、必要なツールとして、Adobeイラストレータやフォトショップなどイメージのデータ変換が可能なツールを持っていることが重要です。
▲ページトップへ戻る
[ステップ1] オリジナルイメージの準備
まず、図として挿入したいイメージを準備します。これを今後オリジナルイメージと呼びます。このイメージのデータ形式は特に何でも良いですが、 最終的に、EPSファイルとPNGなどのピクセルデータの２種類のデータに変換する ことを念頭に置いてください。これは、マニュアルのPDFデータを出力するためにEPSファイルが必要であり、HTML形式を出力するためにピクセルデータが必要だからです。
マニュアル環境では参照するイメージの保存場所がほぼ決まっています。オリジナルイメージデータはディレクトリgbs/doc/xml/src/imagesの下へコピーしてください。このディレクトリの中には、おおまかに分類されたマニュアルごとのディレクトリがあります。対応するディレクトリがあればその中にコピーしてください。新しくマニュアルを作った場合等は、新たにディレクトリを作り保存してください。
保存を行ったら、CVSへ登録します。
% cd gbs/doc/xml/src/images/**
% cvs add -kb xx.ai
この例では、gbs/doc/xml/src/images/**というディレクトリの中に、xx.aiというオリジナルイメージファイルをコピーしたという想定です。ディレクトリを作成した場合は、そのディレクトリをCVSに追加してから上記を行う必要があります。
|
[注意]
cvsにバイナリファイルを登録する場合は、-kbオプションをつけてください。 |
▲ページトップへ戻る
[ステップ2] オリジナルデータがピクセルデータの場合
オリジナルがピクセルデータでない場合は次のステップへ進んでください。ピクセルデータの場合、たいがいはWEBで読み込めるデータである可能性が高いです。従って、のこりはPDF用のEPSデータを用意するのみとなります。EPSデータへの変換例としては、AdobePhotoshopをでピクセルデータを読み込み、これを、ファイルメニューからPhotoshopEPS形式で保存することで作ることができます。そのときのオリジナルデータを消さないようにしてください。
|
[メモ]
おこでオリジナルデータはそのままピクセルデータとして使えるので、今後そのままピクセルデータと呼びます。新しく生成されたEPSデータをEPSデータと呼ぶことにします。 |
▲ページトップへ戻る
[ステップ3] オリジナルデータがEPSデータなどベクタデータの場合
この場合は、illustratorでそのファイルを読み込みます。そして、「別名で保存」において、EPSデータを指定し保存します。このときにフォントデータも一緒に含むようにして保存してください。でないと後のTeXなどのプロセッサがフォントデータを認識出来ずエラーを起こします。
一方、ピクセルデータも作る必要があります。ピクセルデータはillustratorの「書き出し」を選択肢、PNGなどのピクセルデータ形式を選んで保存してください。
|
[メモ]
ここでピクセルデータとEPSデータが出来上がりました。 |
▲ページトップへ戻る
[ステップ4] 新しいファイルのCVSへの登録
でき上がったピクセルデータとEPSデータをCVSへ登録してください。
|
[注意]
cvsにバイナリファイルを登録する場合は、-kbオプションをつけてください。 |
▲ページトップへ戻る
[ステップ5] マニュアルデータからの参照
マニュアルの文書ファイルからは imgタグ を使って参照します。
<img src.pix="[ピクセルファイル]"
src.eps="[EPSファイル]"
title="[図のタイトル]"
code="[参照用コード]"/>
たとえば、
<img src.pix="/manual/environment.png"
src.eps="images//manual/environment.eps"
title="マニュアル環境"
code="fig-manual-environment"/>
ここで、注意が必要なのは、パスをどこからのパスにするかです。上記のようにピクセルファイルは、gbs/doc/xml/src/imagesからの参照になります。しかも最初に"/"が必要です。一方、PDFは、gbs/doc/xml/srcからの参照となります。
▲ページトップへ戻る
[ステップ6] コンパイル
実際に mmake を使いコンパイルし、図が挿入されていることを確認します。
▲ページトップへ戻る
|
