ruby-list

Toshです。
RDtoolをいじってたらこっちの返事が遅くなっちゃいました。
あらいさんにパッチしていただいたバグなどを修正したバージョンをRAA
に登録しました。

In message "[ruby-list:19962] Re: RD with method index (again)"
    on 99/12/28, Koji Arai <JCA02266@nifty.ne.jp> writes:
>> 僕の案(ってほど具体的ではないですが)では「先頭の数文字、他のラベルとの
>> 区別が可能なくらいまでの記述でリファレンスになるように判定を甘くする」
>> というものです。つまり上の例だと"((<Class#method>))"の他に、
>> "((<Class#meth>))"とかでも構わないとしてしまう(ただし他に同様に始まる
>> ラベルが無ければ)ということです。この案は既存のHeadline&DescListに対す
>> るリファレンスの方法で、Method indexのことは考慮していません。
>
>メソッドに関しては重複は考慮しなくてもよいと思います。提案し
>た慣習に従えばrubyの名前空間で重複しないはずなので(別ライブ
>ラリ、同名関数なんてのは現在ありましたっけ？)

あ、上の話はそういう意味ではなかったのですが(「僕の案」というのは
「以前話していた、Ruby Reference Manual形式のRDの解析を採用したとき
の話です。)、この話も重要そうですね。

>もちろん、
>= Class#method
>なんて章を作るとダメですけど。仕方ないかな。

この場合にはむしろ既存のラベル重複の問題ですから、解決にはパス指定
のリファレンスみたいなものを採用する、ってことになるでしょう。
もし、"--- Class#method"と"= Class#method"が両方あったならば
((<Class#method>))では"--- Class#method"を優先、くらいはしてもよいかも。

>あと、1つのメソッドで複数の引数形式を書く場合一括で記述する
>必要があります。(リファレンス先を一箇所にするため)
>
>  --- method(hash)
>  --- method(arg1..arg2)
>  --- method(array)
>      メソッドmethodは引数がハッシュの場合は...

こういうメソッドって、どの程度使われているものなんでしょうか？
# 別にこういうのを認めないと言うつもりは無いですが。
Rubyの標準クラスではたぶんArray#[], Array#[]= くらいですね。
リファレンスマニュアルは残念な事に、こういう形にはなってません。

>えっとこれは、
>
>=== (({Code}))
>: ((|Var|))
>
>ってことですね。でもきっと一部だけInlineを使いたいことはありそう
>
>  === ほげな(({HOGE}))の章
>   ...
>
>とか。参照側を((<ほげなHOGEの章>))とするのは簡単にはいかない
>のでしょうか？(いかないのでしょうね)

とりあえず、問題がおきそうなのはReferenceとか、Footnoteとかですね。
  = ((<substitute|label>)) <- 今まだつかえないけど代わりのテキストがある場合。
  # ((<substitute>)) or ((<"substitute|label">))??
  # 後者は"substitute|label"ってラベル、って意味です。
  = Footnote((- Footnoteは長くなりがちなのでラベルにするには無理があります。-))
  = ((<URL:http://www.ruby-lang.org>))はRubyのオフィシャルサイト
  # これもラベルがどうなるか難しかったり。

極端な例をあげましたが、一番悩んでいたのは、ラベルには"((.", ".))"
のようなカッコはないほうがいいのだろうか？ってことです。
# RD書く人は生のRDを見ているので、カッコを省略した形にするのはわかり
# にくいかも？ それとも、カッコをつけたままのほうがわかりにくい？

あと、リファレンスの方も対応するHeadlineと同じように修飾すべきなのか？
ってのもありますね。例えばあらいさんの例だと、"((<ほげなHOGEの章>))"を
  <A HREF="...">ほげな<CODE>HOGE</CODE>の章</A>
というふうに出力すべきなのか。

>  トップレベルの定数:    --- const::Const (または、Const または Object::Const)

トップレベルの定数は"main::Const"では？

>> リファレンスマニュアルみたいな用途を想定されていると思いますが、
>> それ考えると"Class"をいちいち書くのが多少めんどくさいかもしれません。
>
>うーん、クラスの宣言も可ってのはどうです？
>
>@class Class
>
>--- .method
>--- #method
>--- ::Const
>...
>
>・RDtoolのコアの処理では接頭語"Class"を"#method"に繋げるだけ
>  の処理。
>・参照する側はちゃんと((<Class#metod>))と書かないといけない。
>となりますが。

この程度の処理だったら簡単にこの形式のドキュメントを
"--- Class#method"に直すための補助ツールで実現できそうですが、
このやり方がいいかどうかは、わかりませんね。

>> あと、Rubyのリファレンスマニュアルは演算子メソッドは
>>   --- self + other
>> のような書き方になっているので、ここらへんをどうするか、とか。
>
>これは、それが望まれるのなら rb2xxx-lib.rbの仕事になると思い
>ます。RDのフォーマットが rubyでの定義に似ていることはRDの書
>きやすさ(コピーで済む)の点で良いことだと思います。

なるほど。同意します。

>> あれ？Rubyって";"もコメント扱いになるんですか？しらなかった。
>
>空の式ですね。# と ; なら大抵の言語はOKだろうと思いまして。

あ、そうか。なるほど。
# Rubyだと";"つかうのはone-linerのときくらいだから。(^^;;

>年越しになるとは思いますが、一旦暫定で作ってみてRubyのリファ
>レンスマニュアルが書けるかどうか試してみようと思います。
>html2texi使いまわせば簡単に変換できるかなと目論んでます。
>
># これを先にやった方が議論が進むかも知れませんね。

それはありがたいです。
ただ、rubytk.rdを見ても思いましたが、やっぱり一番必要なのは複数ページの
HTMLに分割して出力する機能ですね。(^^;;

---
Tosh
Toshiro Kuwabara

Thread

Prev Next

In This Thread

Prev Next

[#19075] [book] 誤植 ? — Yuji Irie <irie@...>

[#19079] reference of object — "Hideaki Takata" <hideakit@...3.dion.ne.jp>

[#19082] TermIO for ioctl — Shugo Maeda <shugo@...>

[#19086] iconv wrapper — nobu.nakada@...

[#19088] — nashiro <nashiro@...>

[#19114] Class::name or foo.name? — h-isikaw@...

[#19115] eRuby を題材にしたページ — TAKEUCHi Kahori <take-k@...>

[#19123] require で SEGV — ruby <g96p0935@...>

[#19124] Re: eRuby を題材にしたページ — TAKEUCHi Kahori <take-k@...>

[#19127] rand が同じ値を返す — とみたまさひろ <tommy@...>

[#19133] String#rindex for multi-byte chars — kjana@... (YANAGAWA Kazuhisa)

[#19139] 簡易プリプロセッサ epp 0.1 — SASAKI Shunsuke <ele@...17.odn.ne.jp>

[#19140] ruby は何かの略語？ — Noritsugu Nakamura <nnakamur@...>

[#19142] Win32OLE on NT — Masaki Suketa<CQN02273@...>

[#19143] [book] errata — Masaki Suketa<CQN02273@...>

[#19145] eRuby with Japanese text — Yamada Kenji <kyamada@...>

[#19146] Re: eRuby with Japanese text — TAKEUCHi Kahori (竹内かほり) <take-k@...>

[#19151] ruby 本第 1 版第 2 刷での直し忘れ — Noritsugu Nakamura <nnakamur@...>

[#19154] Re: eRuby with Japanese text — TAKEUCHi Kahori (竹内かほり) <take-k@...>

[#19155] Re: eRuby with Japanese text — TAKEUCHi Kahori (竹内かほり) <take-k@...>

[#19163] RubyMgl 991205 — 中村暁史 Nakamura Akifumi <BXQ04723@...>

[#19165] how to get extended modules list — Dai <MAP2303@...>

[#19171] Re: eRuby を題材にしたページ — TAKEUCHi Kahori <take-k@...>

[#19174] eRuby の patch — Tadashige Morii <m_tada@...>

[#19182] ruby book. — Katsuya Tanaka <tanaka@...>

[#19184] Re: eRuby の patch — TAKEUCHi Kahori <take-k@...>

[#19190] — miyamo@... (Yukinobu 'Dr.GIL' MIYAMOTO)

[#19191] — miyamo@... (Yukinobu 'Dr.GIL' MIYAMOTO)

[#19193] Japanese Regular Expression — Hiroyuki KUROSAKI <noir@...>

[#19197] GC and IO on SunOS-4.1.4-JLE — kjana@... (YANAGAWA Kazuhisa)

[#19199] eRuby 中の <%, %> — TAKEUCHi Kahori (竹内かほり) <take-k@...>

[#19202] ファイルへ追加書き込み — Ayanosuke <aya@...>

[#19211] Clipbord を Ruby で使うには？ — Itou-T15@...

[#19228] Ruby 1.4.3 — Yukihiro Matsumoto <matz@...>

[#19240] emacs の ruby モードについて — nakajima kengo<ringo@...>

[#19241] thread を使った socket について — yuuichi satoh <yuuichi.satoh@...>

[#19243] (無題) — matsumotoya <matsumotoya@...>

[#19246] 破壊的イテレータ？ — Hiroshi Saito <HiroshiSaito@...>

[#19249] ruby story ? — "Kikutani, Makoto" <kikutani@...>

[#19263] Re: eRuby 中の <%, %> — TAKEUCHi Kahori <take-k@...>

[#19265] Word matching — nobu.nakada@...

[#19283] Ruby 1.4.3 repacked — Yukihiro Matsumoto <matz@...>

[#19289] Free on Free — matz@... (Yukihiro Matsumoto)

[#19299] Re: eRuby 中の <%, %> — TAKEUCHi Kahori (竹内かほり) <take-k@...>

[#19301] i've remembered another ruby — nobsun@...

[#19304] about -T option on ruby 1.4.2 — nakajima kengo<ringo@...>

[#19307] 年越しの一時休止の予約方法 — Itou-T15@...

[#19347] [ANNOUNCE: Ruby Who's Who] e-mail address — Tomoyuki Kosimizu <greentea@...2.so-net.ne.jp>

[#19350] Re: オブジェクトの代入について — Toyofuku <toyofuku@...>

[#19353] Other languages. — ruby <g96p0935@...>

[#19384] — Teruyuki AIHARA <aihara@...>

[#19396] $<.gets and $<.eof — kjana@... (YANAGAWA Kazuhisa)

[#19399] 改行コード — Akihiro Yamauchi <aygoofy@...>

[#19404] [Book] born — OZAWA Sakuro <crouton@...>

[#19412] Review for Ruby Book — Hiroshi IGARASHI <igarashi@...>

[#19413] media watch — Noritsugu Nakamura <nnakamur@...>

[#19420] xtoolkit — Kazuhiro Yoshida <moriq.kazuhiro@...>

[#19430] parsedate.rb — YASUI Kentarow <kenyasui@...>

[#19434] Ruby/Tk Reference Manual (Draft 1999-12-12) — Koji Arai <JCA02266@...>

[#19441] 自動翻訳プロジェクト — matz@... (Yukihiro Matsumoto)

[#19442] ClipBoard I/O 対応 — Itou-T15@...

[#19444] 「 (」を使う時の正規表現について — yuuichi satoh <yuuichi.satoh@...>

[#19456] mod_ruby & eRuby — Wakou Aoyama <wakou@...>

[#19484] Ruby Application Archive — matz@... (Yukihiro Matsumoto)

[#19493] -X で coredump — "U.Nakamura" <usa@...>

[#19514] ruby-1.4.3.tar.gz — Akinori MUSHA aka knu <knu@...>

[#19525] localhost 内の交信のしくみ — Itou-T15@...

[#19533] Ｗｉｎｄｏｗｓ環境 — "Shigeo Kobayashi" <shigeo@...>

[#19534] スレッドを起動するのが遅い — yuuichi satoh <yuuichi.satoh@...>

[#19544] String#shift? — Kazuhiko Izawa <izawa@...>

[#19545] Re: localhost 内の交信のしくみ — "Masatoshi SEKI" <m_seki@...>

[#19546] Book Review — Noritsugu Nakamura <nnakamur@...>

[#19549] RubyRing — TAKEUCHi Kahori (竹内かほり) <take-k@...>

[#19552] RubyMidi 、とその今後 — 中村暁史 Nakamura Akifumi <BXQ04723@...>

[#19563] REQ: Regexp#source — Tomoyuki Kosimizu <greentea@...2.so-net.ne.jp>

[#19568] Re: mod_ruby & eRuby — TAKEUCHi Kahori <take-k@...>

[#19576] X application on gtk application — gotoken@... (GOTO Kentaro)

[#19578] ruby-list の過去ログの作り方 — Momotaro Nishiumi <momotaro@...>

[#19593] SMF class 0.3 — Tadayoshi Funaba <tadf@...>

[#19596] Re: build on alpha — Toyofuku <toyofuku@...>

[#19211] Clipbord を　 Ruby で使うには？ — Itou-T15@...

[#19862] GC in Thread::new — 土岐仁謙 <toki@...>

[#19931] Web 掲示板 — 堀川　久 <vzw00011@...>