From: Koji Arai <JCA02266@...>
Date: 2000-01-11T02:18:04+09:00
Subject: [ruby-list:20160] Re: RD with method index (again)

新井です。

RDtoolに関するこれまでの議論をまとめます。

さらに追加で書き込みがあるので、あんまりまとめになってないか
もしれません(中間報告程度に考えてください)。

なお、.rd2rc、フィルタに関する議論は省略させて頂きました(使っ
たことないので話を理解できなかった)

= ペンディング

* メソッド用の見出し(MethodList/DeclareList ?)

   --- Class#method(arg)

       ((<Class#method>))

  * [ruby-list:19934]以降あまり進展はない(^^;
  * [ruby-list:20017]にお試しのパッチあり(rdtool-0.5.7にも適用化)
  * 出力時、メソッド名部分は自動で<CODE></CODE>で囲んでくれるとな
    お良い(と新井は思う)。

     --- Class.[](arg)

         ((<Class.[]>))...

    は、

     Class[arg]

       Class[] ...

    という出力を得られれば良い(クラスメソッドの[]の表記では"."は省略)

  * ベースラインを下げすぎるためインデントが深くなる
    (今出ているMethodListの問題点はこれだけ？)
    ベースラインを特別に
      --- Class#method
       |<- BaseLine
    とする？

  * 演算子"|"や"/"などは、RDtoolで特別扱いされる予定なので
    ((<"Array#/">)) などと""でラベルを囲む(未実装)

  * MethodListはネストしない?(実装もそうするのか?)

* 参照文字列と参照先の判定

  Toshさんの意図に反して<A NAME="label">substitute</A>の表現の案
  [ruby-list:20025]として書きます。

     : インスタンス, Instance

  の参照を
     ((<インスタンス|インスタンス, Instance>))は、...
  と書きたくはないと言うことです。

  (1) 判定を甘くする(一意である限り先頭文字が一致すればOK)
      (新井はあまり好きじゃないです。ドキュメントを書き足して
      行くうちに。一意じゃなくなるかも知れないから)

  (2) :: label substitute
       ((<label>))がリファレンス文字列になるDESCLIST

      出力-> substitute
             labelがリファレンス文字列になるDESCLIST

      というのがあると良いかも(あまり深く考えてはいない)

* 見出しにインラインを許す

  (上記「判定を甘くする案」とは別問題のように思えるので分けました)

  = ほげ((*HOGE*))
  や
  = ほげHOGE
  に対するリファレンスは、

  (1) ((<ほげ((*HOGE*))>))	# そのまま書く
  (2) ((<ほげ ((*HOGE*)) >))	# 空白は無視
  (3) ((<ほげHOGE>))		# インラインは無視(出力は見出しにあわせる?)

  (1), (2), (3), (2)+(3) のどれが良いか？

  ところで、インラインの中でも((<>)), ((--))は特殊なのでこれ
  を見出しの中に書くのは許さない方が良いように思えます。
  それ以外の(見ためを変えることを意図した)インラインは見出し
  や((<>))の中でも許すべきでしょう。

* RDのコメント
  保留。現状では、=begin XXX ... =end を使う。

* HTMLの複数ページ出力

  (1) RDtoolによる自動分割(分割の目安はユーザが指定するか？)
  (2) "=begin"..."=end"で囲まれてるところをページ(ノード)の単位に。
  (3) .rd -> .html とファイル単位に対応させる

* ruby-man.rd にあるようなクラス階層の自動生成
  (新井は必要ないと思ってます)。

= 実装されるもの、されたもの

* RDtoolのエラー出力を詳細にする
  よろしくToshさん(^^
  (一番必要なのはエラーのあった行の行番号出力だと思います)

* DESCLIST の後にWHITELINEを許す
  よろしくToshさん(^^

* パーサのチューニング
  [ruby-list:20055]

* RDの個別コンパイル[ruby-list:20068]
  rb2ro, rdld を使用する(これはまだお試し?)

* WHITELINE(空白類だけの行)は、BLANKLINE(改行のみの行)と区別
  がなくなった。(これは、かなり嬉しい。rdtool-0.5.5以降の目玉 ^^)

= 昔から議論されてるもので必要とされているもの

* リファレンス先が複数ある場合
  ((<file/label>))として参照先を特定する

* ((<substitute|label>))

  <A HREF="label">substitute</A>

以上、未だ勘違いがあるようならご指摘願います。

--
新井康司 (Koji Arai)