readme

はじめに

このバージョンから、plumのドキュメントはHTML (Hyper Text Markup Language)で書くことにしました。これは主に文字コードの問題を回避するためです。 OSを問わないplumでは様々な環境で実行することができますが、ドキュメントはそれぞれの環境で異なった文字コードで書かないといけません。 readme.sj、readme.euc、readme.jisのように同じ内容の複数のファイルを用意してもいいのですが、管理するのも大変なのでやめました。

HTMLなので、当然ながらブラウザで見ることになると思いますが、中には、いちいちブラウザなんて使ってられない、という人も多いと思います。そのため、すべてのドキュメントはHTMLを直接見てもなるべく読むことができるように書いてあります。ただし、漢字コードはJIS、改行コードはLFのみとなっています。これが表示できない場合はsupportディレクトリの cnvcodeというプログラムを使って変換して下さい。

モジュールのドキュメントはそれぞれのモジュール自体に書かれています。モジュールのドキュメントもHTMLで、モジュール自体をブラウザで表示するとモジュールに書かれたドキュメントだけが表示されるようになっています。ただしモジュールの拡張子は「.plm」なので、そのままではブラウザから HTMLと認識されません。

Windowsを使っているなら、このディレクトリにあるplum.regというファイルか html.regというファイルをダブルクリックして下さい。そうすると「.plm」という拡張子がHTMLとして認識されるようになります。 plum.regでは「.plm」をPLUMモジュールとして、 html.regでは「.plm」をHTMLドキュメントとして関連付けます。

また、UNIXではこのディレクトリにある.mime.typesというファイルをホームディレクトリにコピー(すでに.mime.typesが存在する場合はそれに追加) して下さい。これで少なくともNetscape Navigatorでは「.plm」がHTML として認識されるようになります。