[ruby-list:16129] Re: rd2html

Toshです。ひさしぶりに英作文してへろへろ。

>   RD(Ruby Document)はRubyのスクリプト中に埋め込む事ができるドキュメントの
>   形式です。RDはPerlのPODと役割は似ていますが、インデントやシンプルな記号
>   を使った可読性の高いフォーマットなので、そのままでも違和感無くドキュメント
>   として読め、またドキュメントを整備しなくてはならないプログラマにとっても
>   手軽に書けるものとなっています(-- つまりRubyと同じように「楽しく書ける」
>   ように設計されているのです。(たぶん^^;) --)。
> 
> という部分など、書いてもいないのに私の意図を良く読みとってく
> ださったものだと感涙ものです。

あ、じゃあ「たぶん」は外せますね。(^^)
ToshはRDtoolの製作過程でRubyの書きやすさもRDの書きやすさも堪能できて感涙です。

> せっかくですから rd の仕様はどうあるべきかいろいろ話しましょ
> うよ。まとまった結果を英語化するのはなんでしたら私が引き受け
> ても良いです。

んでは、Toshが優先度の高いと思うものから。
# 国際化、とかはToshの手に余るのでパス。
: メタ文字列のエスケープか実体参照のような機能。
  # RDについてのドキュメント書く人にしか用は無いかも知れませんが。
: ラベルと参照。
  SEE [ruby-dev:3070] etc.
: Indexをどうするか。
  Latexが出力するような作業用のファイルのフォーマットを決めてしまうといろいろ
  と便利かも?
  # RDtoolではここらへんが未実装になってます。
: 強制的な改行の機能
  [ruby-list:16123]でAkihiro Yamauchiさんは「改行したときに<br>」と書いていら
  っしゃいますが、それだと困る事もあるでしょうから、指定した場所で強制的に
  改行するための機能が必要かも知れません。
: スクリプトに埋め込まないRDの決まり事
  スクリプトがなければ=begin, =endは省略してもよさそう。それとファイル名に
  つけるサフィックスが決まっていた方が良いかと。
: 用語とかの定義・統一
  BlockElementとかInlineElementとか勝手に名前つけちゃいましたが、正直Tosh
  自身がこういう用語はHTMLくさくて気に入ってなかったりします。(^^;

あと、ちょっと思い付いただけのものですが、
 {script-name: hogehoge.rb}
 {author: Tosh}
 {auther-mail-addr: [e-mail]}
 {last-mod: 1999/08/13 23:41:00 JST}
 {descript: ......}
のような感じで付加的な情報を与える機能があるとおもしろいかも。
RAAのためにここからスクリプトの情報を集めたり、
同じものをrd2htmlではHTMLのTITLEとかに使ったり、とか。

以上です。

---
Tosh