======================================================================
                             wdic-fpw1.3a
                  FreePWING 版「通信用語の基礎知識」
======================================================================

                               Copyright (C) 2000-2002, <rei@wdic.org>

■ 概要

  wdic-fpw は、おかの☆まりも氏を中心として編纂されている「通信用語の
  基礎知識」を、笠原基之氏による FreePWING スクリプトを使用して JIS X
  4081 形式の書籍データに変換するための Perl スクリプト群です。このス
  クリプトの実行には、FreePWING 1.4.2 以降と Jcode.pm が必要です。

  変換済みデータだけを入手された方は、このファイルの内容を理解する必要
  はありません。FreePWING 版の概要については、readme.txt または変換済
  みの辞書に含まれるメニューをお読みください。

■ 収録ファイル

* 変換済み辞書 wdic-fpw1.3a.zip

  + wdic/
    - readme.1st            このファイル
    - readme.txt            Readme ファイル (メニューとして収録したもの)
    - catalogs              Catalogs ファイル
    - wdic/data/honmon      本文データ
    - wdic/gaiji/gai16h     外字データ

* ソース コード (wdic-fpw1.3a-src.tar.gz)

  + wdic-fpw1.3
    - readme.1st            このファイル
    - readme.txt            辞書に収録される Readme ファイル
    - Makefile              GNU make 用 Makefile
    - COPYING               GNU General Public License
    + src/
      - detlang.pl          Makefile で使用するスクリプト
      - bmpdepth.pl         Makefile で使用するスクリプト
      - wdic-fpw.pl         メイン スクリプト
      - wdic-body.pl        本文の処理
      - wdic-menu.pl        メニューの構築
      - Wdic.pm             元データの操作
      - catalogs1.txt       catalogs.txt のソース
      - catalogs2.txt       catalogs.txt のソース
      - halfchar1.txt       半角外字定義ファイル
      - halfchar2.txt       半角外字定義ファイル
    + gaiji/
      + 1/
        - *.xbm             外字ビットマップ (発音記号)
        - *.bmp             外字ビットマップ (発音記号)
      + 2/
        - *.xbm             外字ビットマップ (一部の 1 バイト文字)
        - *.bmp             外字ビットマップ (一部の 1 バイト文字)

  wdic-fpw は、Free Software Foundation が公表した GNU General
  Public License (GNU 一般公有使用許諾) バージョン 2 以降のいずれかを
  選択し、そのバージョンが定める条項に従って、このプログラムを再頒布ま
  たは変更することができます。頒布にあたっては、市場性及び特定目的適合
  性についての暗黙の保証を含めて、いかなる保証も行いません。

  wdic-fpw1.1 以降ではなるべく環境依存しないように留意しているもりです
  が、基本的に Win32 環境以外での動作確認は行っていません。他のプラッ
  トフォームでの動作については、openlab/edict ML
  <http://openlab.ring.gr.jp/edict/> にてご報告をいただいています。興
  味のある方はご参加ください。

  wdic-fpw.pl は「通信用語の基礎知識 2002 年後期版」専用です。それ以外
  のバージョンでの動作は保証できません (付近のバージョンであれば動作す
  る可能性もありますが、未確認です)。

■ 依存ファイルの入手先

* 必須のファイル/ツール (プラットフォーム非依存)

  通信用語の基礎知識 -- http://www.wdic.org/
  FreePWING -- http://www.sra.co.jp/people/m-kasahr/freepwing/
  Jcode.pm -- http://openlab.ring.gr.jp/Jcode/

* 開発環境で使用したツール

  ActivePerl -- http://www.activestate.com/Products/ActivePerl/
  djpeg -- http://www.ijg.org/
  png2bmp -- http://hp.vector.co.jp/authors/VA010446/b2p-home/
  yPadie -- http://member.nifty.ne.jp/~satomii/software/ypadie/
  Cygwin -- http://sources.redhat.com/cygwin/

■ FreePWING 版の仕様 (収録されているファイル)

* 辞書ファイル (*.DIC)

  - 変換時に指定したディレクトリに存在する辞書ファイルだけが収録されま
    す。

  - 見出し語、読み、英語表記が検索語として登録されます。

  - 以下の用語が存在すれば、検索条件キーワードとして登録されます。ただ
    し、FreePWING 辞書の条件検索は、多くの辞書検索ソフトウェアでは正し
    く機能しません。期待どおりに検索できるソフトウェアは、最新の EB ラ
    イブラリを使用したもの (eblook など) と DDwin あたりに限られると思
    います。

      1. 所属するグループ名、辞書名 (拡張子を除いたファイル名部分)
      2. 読みに含まれる各単語 (単語区切りが見つかった場合)
      3. 英語名に含まれる各単語
      4. ディレクトリ名 (/TECH/ORG/... など)
      5. 関連語 (→◆★)

  - 用語の定義部分は適当に整形されます。一部の 2 バイト (全角) 文字は
    1 バイト (半角) に変換され、日本語/英単語間の空白も調整されます。
    整形ルーチンはそれほど検証していないので、不適切な部分がありました
    らご指摘いただければと思います。

  - 用例、コラムは原文のまま書き込まれます。改行位置も保持されます。

  - 参照語については、参照先の用語が変換対象になっていれば、クロスリ
    ファレンスとして書き込まれます。それ以外の用語や URL、プラグインは、
    通常のテキストとして書き込まれます。

  - 変換時に指定されていれば、画像と一部のテキスト形式のプラグインが収
    録されます。

* ドキュメント類

  - FreePWING 版のドキュメントとして、このパッケージに含まれている
    readme.txt がそのままメニューに収録されます。

  - オリジナルのドキュメントとして、WDIC.MAN もメニューに書き込まれます。
    WDIC.MAN の本文部分は適当に整形されます。また、WDIC.MAN の一部のセ
    クションから著作権エントリが作成されます。

  - QUESTION.TXT が存在すれば、そのままメニューに追加されます。

* タグ ジャンプ テーブル (*.TAG)

  - タグ ジャンプ テーブル ファイルが存在すると、それらを元にメニュー
    に索引 (グループ別収録語一覧) が作成されます。

■ 辞書の生成方法

1. FreePWING 1.4.2 (以降) が動作可能で、かつ Jcode.pm がインストールさ
   れていることが前提です。それ以前の FreePWING での動作は確認していま
   せん。Windows 環境の方は、UNIX と同等の基本コマンド群が必要になりま
   す (FreePWING のインストールができていれば大丈夫でしょう... 多分)。
   その他、Perl モジュールが足りないなどと言われた場合は適宜インストー
   ルしてください。

2. オリジナルの辞書データを入手し、適当な場所に展開します。既定では、
   ./wdic022 ディレクトリから辞書を読み込むように Makefile が記述され
   ています。このディレクトリは Makefile 中の WDICDIR で変更可能です。

3. 必要であれば Makefile を編集し、お使いの環境や好みに合わせて変数を
   定義/変更してください。コマンド ラインから指定してもかまいません。
   カスタマイズ可能な変数については、次のセクションを参照してください。

   プラグインを収録する場合は、Unicode で記述されているファイル (現時
   点では yoshigyu.txt) の漢字コードを SJIS に変換しておいてください。
   Unicode のままの場合は Unicode::Japanese を使用して Unicode から
   SJIS への変換を試みますが、このモジュールは Win32 環境にインストー
   ルするのが面倒なため、書いてみただけでテストしていません。
   Unicode::Japanese がインストールされていないと、判読不能なテキスト
   が辞書に書き込まれます。

4. GNU make を使って make します。かなりの時間がかかりますので覚悟して
   ください。

  wdic-fpw.pl のオプションの詳細は、pod2man などで参照できます。

  オリジナルの辞書ファイルのいずれかが欠けている場合、存在しない辞書は
  無視されます。ただし、readme.txt およびオリジナルの WDIC.MAN は必須
  です。readme.txt はカレント ディレクトリに、WDIC.MAN は元ファイルの
  あるディレクトリ (WDICDIR) に置いてください。

  変換中、対象となる元ファイル群は移動、削除、編集しないようにしてくだ
  さい。特にロックなどはかけていないため、途中でファイルが変更されると
  変換に失敗するはずです。

■ カスタマイズ可能な Makefile 変数

WDICDIR

  オリジナルの辞書ファイルのあるディレクトリ。wdic-fpw は、ここで指定
  されたディレクトリからソース ファイルを探します。

PLUGINDIR

  オリジナルのプラグイン ファイルのあるディレクトリ。このディレクトリ
  から、画像 (.jpg および .png ファイル) および一部のテキスト形式のプ
  ラグインを検索します。BMPDIR、JPG2BMP、PNG2BMP も定義されていれば、
  オリジナルの画像形式から DIB への変換が行われます。

  注 : パフォーマンスの問題から、生成済みの DIB ファイルと元の画像ファ
       イルの比較は、cgraphs.txt の作成時にのみ行われます。DIB ファイ
       ルを再作成するには、cgraphs.txt を削除してください。

  この変数を未定義にすると、テキスト形式のプラグインは収録されなくなり
  ますが、画像の収録が無効になるとは限りません。画像を収録しないように
  するには、BMPDIR を未定義にしてください。

BMPDIR

  DIB に変換されたプラグイン ファイルを格納するディレクトリ。この変数
  が定義されていない場合、プラグイン画像の収録は行われません。
  PLUGINDIR、JPG2BMP、PNG2BMP が未定義で BMPDIR が定義されている場合は、
  BMPDIR 内の DIB ファイルが直接使用され、PLUGINDIR の画像は参照されな
  くなります。この場合、各 DIB ファイルには、<拡張子を含む元ファイル名
  >.bmp (foo.jpg.bmp、bar.png.bmp など) という名前を付けておく必要があ
  ります。

JPG2BMP、JPG2BMP_FLAGS、JPG2BMP_OUTPUT_FLAG

  JPEG 形式のプラグイン ファイルを DIB に変換するためのコマンド名およ
  びオプション スイッチ。JPG2BMP が定義されていない場合は、JPEG ファイ
  ルの変換を行いません。出力ファイル名をオプション スイッチとして指定
  する必要がある場合は、JPEG2BMP_OUTPUT_FLAG を定義してください。それ
  以外のスイッチは JPG2BMP_FLAGS に定義します。実際のコマンドは、
  JPG2BMP_OUTPUT_FLAG が定義されているかどうかによって、次のいずれかの
  形式で実行されます。

    ${JPG2BMP} ${JPG2BMP_FLAGS} INPUT.jpg OUTPUT.jpg.bmp
    - または -
    ${JPG2BMP} ${JPG2BMP_FLAGS} \
               ${JPG2BMP_OUTPUT_FLAG} OUTPUT.jpg.bmp INPUT.jpg

PNG2BMP、PNG2BMP_FLAGS、PNG2BMP_OUTPUT_FLAG

  PNG 形式のプラグイン ファイルを DIB に変換するためのコマンド名および
  オプション スイッチ。指定方法は JPG2BMP と同じです。PNG2BMP が定義さ
  れていない場合は、PNG ファイルの変換を行いません。

BMPQUANT、BMPQUANT_FLAGS、BMPQUANT_OUTPUT_FLAG

  変換された DIB ファイルを減色するためのコマンド名およびオプション ス
  イッチ。指定方法は JPG2BMP と同じです。BMPQUANT が定義されていない場
  合は、減色用のコマンドを実行しません。

CHARSET

  メッセージの出力や catalogs.txt の生成に使われる漢字コードを指定しま
  す。未定義の場合、環境変数 LANG から自動判定を試みます。判定できなけ
  れば未定義のままになります。

BULLET

  各エントリの説明文の先頭に追加する文字 (列) を指定します。オリジナル
  の辞書では '・' に相当します。デフォルトは '◇' です。デフォルト値を
  変更する場合、漢字コードは意識せずに文字 (列) そのものを指定してくだ
  さい。エスケープ シーケンスは解釈されません。

GAIJI

  半角外字を使用するかどうかを指定します。オリジナルの辞書の特性を尊重
  するため、既定で外字を使用するようになっています。

    0 : 外字を一切使用しません。いわゆる半角カタカナと '\' は 2 バイト
        文字に変換されます。
    1 : 発音記号を外字で表現します。
    2 : 発音記号と半角カタカナ、および '\' を外字で表現します (既定値)。

DIRINFO

  ディレクトリ情報を本文に含めるかどうかを指定します。この値を 1 に設
  定すると、ディレクトリ情報があれば解説行の直前に追加されます。既定値
  は 1 です。

■ 既知の問題

* UNIX (FreeBSD?) 版 LHA のバージョンによっては、オリジナルの辞書ファ
  イル名を (デフォルトで、または強制的に) 小文字に変換してしまうものが
  あるようです。wdic-fpw1.2 以降ではこのようなケースも考慮したつもりで
  すが、なにぶん私の環境ではテストできないため、辞書ファイル群の解凍時
  には元のファイル名 (大文字) を保持するオプションを使用することをお勧
  めします。万一この仕様が原因で期待どおりに変換されない場合は、*.DIC、
  *.TAG、WDIC.MAN ファイルの名前をすべて大文字に変更してください。

* 少なくとも ActivePerl build 522 では、CORE::glob および
  File::DosGlob::glob で既存のファイルが見つからない場合があることが確
  認されています (書き方が悪いだけかもしれませんが)。一部は -f を併用
  して対処しましたが、ほかの箇所でも同様の問題が発生する可能性が残って
  います。これが原因でファイルが見つからないと思われる場合は、ファイル
  名の大文字/小文字がオリジナルと同一であることをご確認の上、作者まで
  ご連絡ください。

■ 開発環境

  Windows NT 4.0, Windows 2000 Professional/Advanced Server
  ActivePerl Build 522/633
  FreePWING 1.4.2
  Jcode 0.64
  djpeg version 6b
  png2bmp 1.52
  yPadie 1.0.1
  Cygwin 1.3

■ 更新履歴

2002-08-15

   * wdic-fpw1.3a 公開。
   * ディレクトリ情報を追加するかどうかをオプションで制御できるように
     変更。

2002-08-01

   * wdic-fpw1.3 公開。
   * プラグインの埋め込みをサポート。
   * 各単語エントリにディレクトリ情報を収録、条件検索キーワードとして
     も登録。
   * 前バージョンでメニューが正しく整形されていなかったのを修正。
   * ソート時に濁音、半濁音、促音、拗音を清音として扱い、「・」を無視
     するように変更。

2001-12-17

   * wdic-fpw1.2b-2002-1 (変換済みの書籍のみ) 作成。変換元データとして
     2002 年前期版を使用し、スクリプトには変更なし。

2001-07-26

   * wdic-fpw1.2b 作成。変換元データを 2001 年後期版に変更。
   * src/wdic-fpw.pl: processing-instruction に相当する文字列の扱いを
     修正。
   * src/wdic-body.pl: 見出し語が記号の場合の処理を改善。
   * src/Wdic.pm: 行の連結方法を改善。

2001-01-28

   * wdic-fpw1.2a 公開。Perl 5.6.0 の機能を使用していた点を修正、5.005
     でも動作するようにした。
   * Makefile: CHARSET、NKF の調整。PERLINCFLAGS の追加。
   * src/wdic-fpw.pl: @INC の直接操作を中止。
   * src/wdic-fpw.pl: テキスト整形に関する微調整。発音記号の変換時のバ
     グ取り。

2000-12-02

   * wdic-fpw1.2 公開。コミケ版。2001 年前期版専用のはず。
   * 膨大になりすぎたのでソースを分割。Wdic.pm、wdic-body.pl、
     wdic-menu.pl を追加、ディレクトリ構造を変更。
   * 辞書グループに対応。といっても情報表示と条件検索キーワードの追加
     程度。
   * 用語定義部の整形。文字種の統一とスペースの調整。
   * 発音記号を外字で表現するように拡張。
   * 条件検索キーワードを追加。ただし FreePWING 側に制限あり。
   * メニュー構成の変更と著作権エントリの追加。メニューには収録語一覧
     を追加。
   * 外部ソート コマンドの使用を廃止。
   * その他たくさん山ほどいっぱい。

2000-07-17

   * wdic-fpw1.1b 公開。
   * Makefile: ${GAIJI} の参照を修正。
   * wdic-fpw.pl: 外字を使わない場合にテキストが出力されないバグを修正。

2000-07-17

   * wdic-fpw1.1a 公開。
   * Makefile: catalogs.txt を Makefile で生成するように変更。その他外
     字の採用に伴う変更。
   * wdic-fpw.pl: -h 指定時や初期化失敗時には FreePWING を初期化せずに
     終了するように変更。
   * wdic-fpw.pl: Pod::Usage の使用を中止。
   * wdic-fpw.pl: chomp の使用を中止、正規表現で CR/LF を削除。
   * wdic-fpw.pl: QUESTION.TXT がなくても動作するように変更 (コミケ対
     応)。

2000-06-24

   * wdic-fpw1.1 公開。
   * 2000 年後期版専用として全面的に書き直し。
   * 環境依存部分を極力少なくしたつもり。

2000-03-14

   * 最初のバージョン。かなり Windows 依存。

-- readme.1st ends here --

;;; Local Variables: ***
;;; coding: japanese-shift-jis-dos ***
;;; fill-column: 70 ***
;;; End: ***
