ruby-list

Toshです。


> >		    メソッド名で索引、くらいなら他に方法ありますし。
> 
> あれ？そうなんですか？これはヤパイ。私がRDを知らな
> いだけだったらゴメンナサイ。
> 
> もう一度考え直して、意見をまとめます。

あ、いや。これはこの後に書いたメソッドをHeadlineでならべちゃえば、
目次作るくらいの事はできるけどね、ってやつです。それで不十分なら
もちょっと解決策を考えなきゃなりませんね。
もひとつお手軽な(というか今の仕様でやりくりする)方法としては、
"((:Class#Method:))"って書く、とか。これはそのまんまインデクスの
機能です。

> まず大前提
> 1. メソッドの索引を作れる仕組みがあるとよい。
> そして、できれば
> 2. ライブラリのマニュアルは、ある程度スタイルが統一
>    された方がよい。
> このための案として、
> 3. =end\s+(def|class|module) をパースしてはどうだろう？
> 
> ってところです。Texinfoへの変換も1、2が満たされれ
> ばたぶんなんとかなると思います。つまり、3っていう
> のは案の1つであって全然別の方法でも構わないです。

ふむふむ。

> > でも、まずひとつめに、推奨されるスタイルってのもRDのフォーマット自体
> > になにかそういう制約がついてる、よりは、メジャーなライブラリのドキュ
> > メントに共通のスタイルがある、とかそういう「暗黙の了解」みたいなもの
> > の方がいいんじゃないかな、と。
> 
> で、暗黙の了解を作るための材料みたいなのがあった方
> が良いと思うんですが、この点はどうでしょ？
>
> RD側で「別に使う必要はないですよー。でも、これ使え
> ば後々得しますぜ。ダンナ」みたいなものを用意するっ
> てことですが。これは制約を作ることにはならないです
> よね？

そういうのは別に構わないし、あれば便利な物はあったほうがいいかと
思います。
ただ、僕は保守的なのか割とRD自体の機能をどんどん追加していってそれ
を実現するのに消極的な(というか結構きっぱり反対してるかも(^^;;)だけで。

> 具体的な*例*で言えば、例えば以下の3種類の見出しは
> 単にフォーマットしただけならまったく同じ見ためにな
> るようにします。
> 
> == Foo
> =c Foo
> =d Foo
> 
> ただし、=c(lass) にはクラス名、=d(ef) にはメソッド
> 名の意味を持たせているためメソッド名だけの索引を作
> るのが簡単になります。

そういうわけで、これもRD自体のシンタックスに手をいれること
になるので、慎重な態度をとってしまうのですね。

例えば、
== Class#Method
って感じに、メソッド名と*思われる*見出しを見付けて索引を
つくる、ってツールであれば、(RD自体には変更を迫らないので)
反対する理由もありません。
# これだと、Headlineの付け方に制約出て来ちゃうけど、やりたい人だけ
# そうすりゃいいことなので、まぁ、構わないかと。

> おそらく、先にRD側で書き方を決めつけるよりは、皆の
> 書き方を見てその後でRD側がそれに合せた書きやすさを
> (必要なら)提供する。ってことを考えてるのですよね？
> それはそれで全然構いません。(今、それほどRDに夢中っ
> てわけでもないですし)

そんな感じでいいんじゃないかと。
黙っていれば自然とノウハウが集まって、標準的な書き方とか
便利なツールとかを誰かが勝手に作ってくれるんじゃないかと
期待してます。
# バザール方式？(^^;;

> > 例えば、「公開メソッド(単にpublicって意味でなく)は見出しにする」とか
> > いうスタイルにすればRDtoolが目次を出力してくれるようになれば、メソッド
> > で索引は実現可能ですよね？
> 
> そうでしょうか？目次と索引は全然別物だと思うんです
> けど、この辺で意見が食い違うのはなぜだろう？
> 
> 私がRDにまだ詳しくないからかもしれないので、全然別
> の例をあげます。
> 
> HTMLで書かれたRubyのリファレンスマニュアルは、メソッ
> ドも変数も見出しもあらゆるものが<A NAME="..."></A>
> でマークされてます。HTMLなんだから当然ですよね。

# 余談。
RDの場合には、HeadlineとDescListのTermに勝手にラベル(HTMLだと
<A NAME="label:n">...</A>がつきます。
そして他の部分にラベルつけるって機能は今のところなし、です。

> あのマニュアルには、MethodIndex.htmlっていう
> のもあるんですけど、はたしてあのマニュアルから
> MethodIndex.htmlを自動で生成できるでしょうか？

う〜ん。
Headlineにはメソッド名しかつけない、とか、Indexをメソッド名だけにしか
使わないとか、しなきゃ無理じゃないですかねぇ。
やれるとこまでやって、上に挙げたような「Headlineからメソッドらしいもの
を自動で取り出す」ってやりかたが精いっぱいでしょう。
# そういうのはrubyapiの方に任せてしまおうか、って気もちょっとあり。

# ところで、MethodIndex.htmlって手元のリファレンスマニュアルに
# 見当たらないのですが、どこでしょ？

> # 実際、マニュアルからではなくruby本体から
> # Object#methods を使って自動生成しているように見
> # えます。(ん？RDにもその手が使えないかなぁ？)
> 
> RubyのリファレンスマニュアルをRDに書き換えることを
> 考えたとき、これは可能でしょうか？(可能ならよいの
> ですが、話終っちゃうけど)

上に書いた通り、「無理」か「工夫すればできないわけでもないけど、・・」
くらいでしょうか。

> > ruby-talkの方でも「他のRDへの参照」とかの話題も出ていますので
> > 何か御意見があればそちらもよろしくお願いします。
> 
> ruby-talkは一時期流量が多くなってついていけなくなっ
> たのでした。たしかRDのせいだったような(^^; (今、妙
> に古いバグ報告とか読んでたりしてます)

そです。(^^;;＜RDのせい
ただ、ちょっと前にあらかた収束しちゃっいましたが。

> RDを理解するには、あちらの議論もしっかり読まないと
> いけませんね。

RD自体のドキュメントも書かなきゃならんような気もしてますが、
さぼってます、すみません。

> > # infoに出力するときにはもろに影響がある問題でしょうし。
> 
> そうなんですよねぇ。結局、
> 
> 4. Texinfoにするための情報がRDに足りない
> 
> んですよ。(結局、私の個人的な要求はこっちだった^^) 
> 理解が足りないだけかも知れませんが。とりあえず、も
> う少しお勉強してから出直したいと思います。

RD自体がとりあえずHTMLとLaTeXあたりを参考に最低限のものだけを
詰め込んだ、って感じなので、本当に情報が足りてない可能性はあり
ますね。僕はtexiわからないので、どこらへんが足らないのかよく
わからないんですが。

> # 別に、Texinfo大好き人間ってわけじゃないんですけ
> # どね。信じてもらえないかも知れませんが(^^;

Texinfoとかは興味あったりもするので、これを機にちょっと調べて
みようかと思ってます。

> # 長々とすみません。お時間のあるときで構いませんの
> # でおつき合いしてくださいませ。

どうもこちらこそ。

---
Tosh
Toshiro Kuwabara

Thread

Prev Next

In This Thread

Prev Next

[#17284] Re: [CFV] Ruby icon competition — Kazuya Shiida <BYC05717@...>

[#17297] Thread について — kkubota@18software.co.jp

[#17303] Re: Thread について — kkubota@18software.co.jp

[#17309] Re: Thread について — kkubota@18software.co.jp

[#17322] fa8h-kym@asahi-net.or.jp — Koyama Hideo <fa8h-kym@...>

[#17328] gtk: pixmap concatenation — OZAWA Sakuro <crouton@...>

[#17330] nkf -f — NOTOYA Junichi <not@...>

[#17334] RubyWin 0.0.0.4a — Masaki Suketa <CQN02273@...>

[#17335] rubyunit — Masaki Suketa <CQN02273@...>

[#17350] ruby-man-1.4.2-jp — Koretsugu Daigoro <tmmcross@...>

[#17353] Ruby の DLL — polygon <kiyose@...>

[#17354] Re: Thread について — kkubota@18software.co.jp

[#17364] Re: Thread について — kkubota@18software.co.jp

[#17365] Curses — Kazuhiko Izawa <izawa@...>

[#17373] message of unpack — Kazuhiko Izawa <izawa@...>

[#17375] Re: Thread について — kkubota@18software.co.jp

[#17381] Re: Thread について — kkubota@18software.co.jp

[#17388] command line option -e WITHOUT temporary file — nobu.nakada@...

[#17394] cgi-lib.rb — wakou@...

[#17401] Ruby/GTK for Cygwin(0.21) — たむら けんいち <ken-ichi.tamura@...>

[#17402] nif.rb — wakou@...

[#17406] Content-Length in CGI.rb — Koichi Shigematsu <shige@...>

[#17407] Content-Length in CGI.rb — Koichi Shigematsu <shige@...>

[#17429] 配列のハッシュ — Ayanosuke <aya@...>

[#17434] faster? jlength — Koretsugu Daigoro <tmmcross@...>

[#17454] Exception.html & Errno.hmlt for ruby-man-1.4.2-jp — nobu.nakada@...

[#17455] C のデータを Ruby から参照したい — kkubota@18software.co.jp

[#17465] Ruby Library Manual — TAKAHASHI Masayoshi <maki@...>

[#17466] inetclient — Ayanosuke <aya@...>

[#17468] Time.now on Cygwin — Ayanosuke <aya@...>

[#17477] Hash に nil 値を入れたなら — 中村暁史 Nakamura Akifumi <BXQ04723@...>

[#17478] 「なんでもない」値を得るには — 中村暁史 Nakamura Akifumi <BXQ04723@...>

[#17486] Re: C のデータを Ruby から参照したい — kkubota@18software.co.jp

[#17491] Re: C のデータを Ruby から参照したい — kkubota@18software.co.jp

[#17494] Re: C のデータを Ruby から参照したい — kkubota@18software.co.jp

[#17498] ruby/gtk を Cygwin 版で動かすには — Suguru Kakishita <kakky@...>

[#17500] parse error when writen by EUC — Ayanosuke <aya@...>

[#17509] [Patch] ftpmirror/1.2.2 - optimistic timestamp comparison — "NAKAMURA, Hiroshi" <nakahiro@...>

[#17525] SGmail が日経 Linux 11 月号に — WATANABE Tetsuya <tetsu@...>

[#17537] http://www.ruby-lang.org/ja/ — matz@... (Yukihiro Matsumoto)

[#17548] oracle8i での oracle モジュールについて — Tadashige Morii <m_tada@...>

[#17550] Ruby 1.4.3 ? — wakou@...

[#17554] 日付 — matz@... (Yukihiro Matsumoto)

[#17580] can't exec extconf.rb (LoadError) — Jota Matsubara <jota@...2.so-net.ne.jp>

[#17584] オープンソースまつり '99 — Noritsugu Nakamura <nnakamur@...>

[#17585] attr :a=,true — Kazuhiro Yoshida <moriq.kazuhiro@...>

[#17596] ruby ML archive top page on blade.nagaokaut.ac.jp — kjana@... (YANAGAWA Kazuhisa)

[#17597] maillib/smtp log — "Kikutani, Makoto" <kikutani@...>

[#17610] fix man-jp — Kazuhiro Yoshida <moriq.kazuhiro@...>

[#17612] ruby 本の値段は安い？高い？ — Noritsugu Nakamura <nnakamur@...>

[#17627] IO#read(0) bug — 牧瀬 芳太郎 <ee77058@...>

[#17630] "#" and Ruby/Gtk — Ryunosuke Ohshima <ryu@...>

[#17640] Re: youbi, rokki, eto, zodiac — Tadayoshi Funaba <tadf@...>

[#17652] www.ruby-lang.org — matz@... (Yukihiro Matsumoto)

[#17654] ダイアログの destroy を知るには？ — kkubota@18software.co.jp

[#17656] inforuby 0.1 — Norio Kasahara <kasa@...>

[#17661] Re: Welcome to our (ruby mailing list)You are added automatically — Keiichi Mizusawa <mizu@...>

[#17681] Ruby for cygwin bug?? — Ayanosuke <aya@...>

[#17687] Linux Journal — Daisuke Sato <densuke@...2.so-net.ne.jp>

[#17688] PATH の記述方法 ruby for Cygwin — Ayanosuke <aya@...>

[#17690] rescue BAKE-NAMA-JIS (Re: Hash$B$K(Bnil$BCM$rF~$l$?$J$i(B) — "Kikutani, Makoto" <kikutani@...>

[#17691] Re: rescue BAKE-NAMA-JIS (Re: Hash$B$K(Bnil$BCM$rF~$l$?$J$i(B) — "Kikutani, Makoto" <kikutani@...>

[#17713] Re: サンマイクロシステムよりお電話 — takanori adachi <adachi@...>

[#17721] cbreak.rb /freebsd — Shin-ichiro Hara <sinara@...>

[#17730] 組込関数 "test" について — "kurata" <m_kurata@...02.odn.ne.jp>

[#17731] [proposition] new definition of Array#sort — Koretsugu Daigoro <tmmcross@...>

[#17736] postgres-0.5.3 cant create makefile on FreeBSD — Kazumi Hayashi <kazumi@...>

[#17742] maillib UIDL — "Kikutani, Makoto" <kikutani@...>

[#17749] ttelnet-0.20.tar.gz — Shin-ichiro Hara <sinara@...>

[#17753] RubyWin Version up — Masaki Suketa <CQN02273@...>

[#17755] gtk texthook.rb — akaishi@...

[#17756] how to contribute — matz@... (Yukihiro Matsumoto)

[#17764] how to get GMT with TIMEZONE — "Kikutani, Makoto" <kikutani@...>

[#17768] WINGKR — Masaki Suketa <CQN02273@...>

[#17778] 拡張ライブラリとファイル名について — ishihara-k@...3.tiki.ne.jp

[#17796] ISBN — matz@... (Yukihiro Matsumoto)

[#17798] — Jota Matsubara <jota@...2.so-net.ne.jp>

[#17802] 本日発売の雑誌の中の ruby — Noritsugu Nakamura <nnakamur@...>

[#17817] ruby-gtk の tree オブジェクトに関する質問 — Maki Izumida <izumida@...>

[#17821] Ruby 本、献本 — matz@... (Yukihiro Matsumoto)

[#17401] Ruby/GTK for Cygwin(0.21) — たむら　けんいち <ken-ichi.tamura@...>

[#17627] IO#read(0) bug — 牧瀬芳太郎 <ee77058@...>