[トップ] [更新履歴] [著書] [コンピュータ] [ゲーム] [CGI配布]


Title: RubyでMeDocを使おう

1 MeDocとは

さて、palm上ではテキストファイルをDOC形式にして保存することが前の記事でわかったはずだ。 DOC形式はそのままでは普通のテキストファイルと同等の表現力でしかない。 すなわち相互変換可能ということ。

しかし、長い文章を読むには目次は必須だ。 それを実現するために考案されたDOC形式の拡張がMeDoc形式なのだ。 くMeDoc形式はDOC形式であり、特定のルールに従って書くことにより目次機能を実現させる。

もちろん、それに対応するDOCリーダーで読まないといけない。 PooK、CrsMeDoc、SimpleDocなどがある。 俺的にはPooKがおすすめ。

2 フォーマット

MeDoc形式のフォーマットはいたって簡単だ。 これについてはここに書いてある。

3 makemedoc

ここにあるMeDocラッパーmakemedocはperlなんで俺がrubyに移植しといた。 テキストファイルからMeDoc中間形式を生成するスクリプトだ。 これがあればmakedoc.rbとともにRubyでMeDocが作れるわけだし。

そして、できたブツはこれだ。

4 テキストファイル→MeDoc中間形式→DOCへの一括変換

やっぱりそういうのは一括して行いたい。 それを実現するのがtopalm.rbだ。 ここにパッケージを置いておく。

ただし、そのためには

が必要。

5 準備

テキストファイルをDOCへ変換するライブラリには本家makedocを呼び出す拙作makedoc-fast.rbとMoonWolfさんのpure rubyなmakedoc.rbがある。 makedoc-fast.rbはmakedoc.rbと完全互換であり、パッケージに同梱している。 makedoc.rbを使わないのであれば(推奨)、makedoc.rbとリネームしておこう。

5.1 使い方

makedoc(.rb)とほぼ同じだが、ちょっと拡張してある。

$ topalm.rb テキストファイル prcファイル タイトル

オプションは以下の通り。

-r

レポートする。

-n

無圧縮。(makedoc-fast.rbの場合は無意味)

-R

RubyスクリプトをMeDocに変換。クラス/メソッド定義などを目次にしてくれるぞ。

-D

RDを変換

-H

HTMLファイルをMeDocに変換。Hn要素、BR要素で区切ってくれる。

-E

EWB形式をMeDocに変換。

-L

Lispを変換

-T

Plain Textを変換

5.2 謝辞

htmltotext.rbはMoonWolfさんのdailydoc.rbから抜き出しました。 topalm.elは黒崎さん作のtopalm.rb emacsインターフェースです。 ありがとうございます。


戻る ホームページへ戻る

Valid XHTML 1.0!
rubikitch(rubikitch@ruby-lang.org)

投書箱:コメントや伝えたい情報などがあればお気軽にどうぞ
名前 メール [説明]
URL
本文