rdocスタイルドキュメント変換ツール
rdocスタイル*1のテキストドキュメント変換スクリプトを作成しました。
rdocとはrubyのソースからのドキュメント生成スクリプトです。筆者はrdocの出力htmlが結構気に入っていて、通常のテキストファイルも基本的にはこのスタイルで書いています。rubyではrdtoolがありますが、これは別途インストールする必要があり、また、rdtoolを使用して、きっちりときれいに整形する必要もないので、rdocで間に合わせていました。
UNIX上で作成しているときには、README.txtを作成し、Makefileを書いて
$ make
で作成していましたが、rdocはカレントディレクトリ配下にdocディレクトリ(オプションで変えられますがデフォルトはdoc)を作成してその配下にファイルを作成し、かつ、rdocはrubyのクラスも考慮しているため、クラスリファレンスを見やすくするようframeで分割して見せようとします。テキストドキュメントにはそこまでは必要がなく、単にhtmlに変換してもらいたいだけなので、rubyでCGIを作成してWebブラウザから変換できるようにしました。
よければ、お試しください。
