ruby-list

新井です。

新案(RDのマクロ)についてつらつらと考えていました。

RDは拡張しにくいのが難点なのは前にも書いたとおりです。これを補うために 
RD のマクロを用意する考えはそんなに悪くはないと思います。前に「RD の 
wrapper を用意する」と例示しましたが、これよりはマクロ展開(のようなも
の)を RD の一機能にした方が良いように思います。というのも、ruby に埋め
込まれた RD を処理することを考えた場合、ツールがRDと拡張RDで分かれてい
るとドキュメントの内容からユーザがどのツールを使うか判断しなければなり
ません。それよりは、例えば、

=begin マクロ名
...
=end

のような記述から RD がどのマクロを使うか選べるようにした方が便利です。

この点に関して何かご意見はありますか？拡張した記法のRDもRDと呼んでもよ
いでしょうか？

・書式

いっそ、rubyのフォーマットとできるだけ似せるというのもあり？

=class Class < Superclass
==include Foo
==def self.classmethod()
==def method()

＃ 思っただけですが、このままだと詰めれば問題点は出て来るでしょうね。

・新案の疑問点

今の RD は

  RDファイル --> RD parser --> 後処理(rd2html-lib) --> HTMLファイル

といった処理を行います。マクロの導入はこれに前処理を加える形になると思
います。

  RDファイル --> 前処理 --> RD parser --> 後処理 --> HTMLファイル

前処理の切り替えでどのようなドキュメントを書くかを決定し、後処理の切り
替えでどのようなフォーマットを出力するかを決定します。うん美しいですね。

ちょっと疑問がわきました。これだと「前処理」を通した時点で元のマクロ付
きドキュメントにある「意味」は失われてしまいます。RD parser をあくまで
も参照やINLINE (`(({}))' とかのことです)の解決を行うものと定義した場合
という前提条件がありますが。

例えば、rd2xml を考えたときうまく行かないのではないかと思います。また
rd2texiなんてのも無理です。(今でもできてませんけど、MethodListはこれを
目論んでいたんだけど、別のところで引っかかった)

これはこれでよいと思いますか？一見、前後処理をひっくるめてRDとみなした
場合高級っぽいようだけど、実は低レベルな出力しか出せないのです。「情報
を落とすツールを使うぐらいだったら、情報を残すツールを作って使ったほう
がよい」ということはないですか？「HTMLを使って便利だなあと思ってたけど
結局XMLがでてきた」のと同じことにはならないでしょうか？

おそらく大半の人は問題ないと思うのでしょう(HTMLが大半の用途に十分なよ
うに)。元のRDが好きな人はRDのコア部分がその程度の情報しか残さないこと
を問題視していないのですよね。結局 RD は HTML を書きやすくするものです
ね。RDはそういうものだと決めつけてもよいでしょうか？

＃ 私にはもうちょっとだけruby用に高級なものにしたかったという欲があり
＃ ますが。

インデックス出力は以下のような形で行われるので RD parser が低レベルで
も問題ありません。

RDファイル --> 前処理 --> RD parser --> 後処理 --> HTML
                 \
                  `→ インデックス出力

クラスの階層出力なんてのもできそうです。

でも、

RDファイル --> 前処理 --> RD parser --> 後処理 --> HTML
      \
       `→ Texinfo変換処理 --> Texinfoファイル

はやっぱり無理ですね。INLINEなどを解釈する機能がTexinfo変換処理部に必
要です。RD parser をライブラリとして使用するしかない。これは暇なときに
挑戦してみようかな。これを rd2texi と言ったら怒られます？

いっそ、

     .---> 普通の処理(+ libRD) --> 後処理(HTML) --> HTML
    /                          \
   /                            `-> 後処理(man)  --> man
  /
RDファイル --> ライブラリマニュアル処理(+ libRD) --> 後処理(HTML) --> HTML
    \ 
     \
      `--> Texinfo変換処理(+ libRD) --> Texinfoファイル

なんてイメージもわきました。情報を失わないのが特徴です(あくまでもイメー
ジだけ)。

--
新井康司 (Koji Arai)

Thread

Prev Next

In This Thread

Prev Next

[#24065] Perl/Ruby Conference in Kyoto — Noritsugu Nakamura <nnakamur@...>

[#24068] continuation in thread — Takaaki Tateishi <ttate@...>

[#24070] 謎の Segmentation fault — YASUI Kentarow <kenyasui@...>

[#24073] Ruby で使える XML パーザーについて — Takaharu Yamashita <takayan@...2.so-net.ne.jp>

[#24082] Array#assoc — Kazuhiro NISHIYAMA <zn@...>

[#24086] // は偽？ — rubikitch <rubikitch@...>

[#24088] mod_ruby-0.1.8 and postgres-0.6.1 — Teruki Shigitani <shigi@...>

[#24095] p <obj> の返値 — ARIMA Yasuhiro <fit0298@...>

[#24102] Perl/Ruby Conference 開催決定 ! — matz@... (Yukihiro Matsumoto)

[#24109] gtk+ なクラスブラウザ — kadu <kadu3@...16.alpha-net.ne.jp>

[#24112] ある method がどこで def されたか調べる方法 — Yasushi Shoji <yashi@...>

[#24123] CGI::pretty — Kazuhiro NISHIYAMA <zn@...>

[#24125] rbcw145.zip に lib/net/telnet.rb がない — Kazuhiro NISHIYAMA <zn@...>

[#24126] embedded Ruby for Verilog — "Kikutani, Makoto" <kikutani@...>

[#24134] File.rename error message — Kazuhiro Yoshida <moriq.kazuhiro@...>

[#24149] methods — Kazuhiro NISHIYAMA <zn@...>

[#24156] 改行コードが… — Hagemu Higuchi <hahiguc@...11.odn.ne.jp>

[#24158] Hash の初期値に [] を使う — Mitsuhiro Kondo <kondo@...>

[#24174] ruby によるバグ追跡システム — 堀川 久 <vzw00011@...>

[#24176] FreeBSD ports — "Akinori -Aki- MUSHA" <knu@...>

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

[#24191] drb.rb: 0x40155740 is recycled object (IndexError) — Hideto ISHIBASHI <hideto-i@...4u.or.jp>

[#24193] FreeBSD ports #2 — "Akinori -Aki- MUSHA" <knu@...>

[#24195] HTML 関連ライブラリ — MoonWolf <moonwolf@...>

[#24206] iconv 0.4.2 pre3 — nobu.nakada@...

[#24210] install guide — gotoken@... (GOTO Kentaro)

[#24222] FreeBSD ports #3 — "Akinori -Aki- MUSHA" <knu@...>

[#24226] Ruby で日本語とスペイン語の混在文は？ — Kakuzi TAKAHASI <ktaka@...>

[#24230] Ruby 1.4.6 repacked — matz@...

[#24249] no oper in %Ruby — Shugo Maeda <shugo@...>

[#24250] コマンドの STDERR への出力を補足したい。 — Kengo Nakajima <ringo@...>

[#24255] DBM failed on cygwin version — Ataru NAKATA <anakata@...>

[#24257] デバッグ用にデータをダンプしたい — Mitsuhiro Kondo <kondo@...>

[#24259] RDindex 1.1.0 — rubikitch <rubikitch@...>

[#24261] — Shigeki Shiroshima <pakshima@...>

[#24267] What's the biggest Ruby development? — Dave Thomas <Dave@...>

[#24268] はじめまして & cygwinでconfigure不能 — "Mitsuo Igarashi" <mitsu5@...>

[#24270] 1.4.6 cgi-lib — Masatoshi SEKI <m_seki@...>

[#24271] Tiki, ruby-1.4.6 — Masatoshi SEKI <m_seki@...>

[#24272] How to read buffered data? — Tanaka Akira <akr@...17n.org>

[#24274] About sub with multilines — kiri@...

[#24280] RE: [ruby-list:24268] cygwinでconfigure不能:cygwin1.dllの問題 — "Mitsuo Igarashi" <mitsu5@...>

[#24284] 拡張ライブラリ作成時の NULL ポインター — Akimichi Tatsukawa <akimichi@...>

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

[#24294] grep(!/hoge/)? — kiri@...

[#24298] Re: cygwin で configure 不能 :cygwin1.dll の問題 — "Mitsuo Igarashi" <mitsu5@...>

[#24299] Where MDArray? — kiri@...

[#24305] Status: header and cgi.rb — Yasuhiro Fukuma <yasuf@...>

[#24314] はじめまして ...? — polygon <kiyose@...>

[#24316] 画像のサイズを調べるスクリプト — kadu <kadu3@...16.alpha-net.ne.jp>

[#24317] undefined cygwin_dll_entry — polygon <kiyose@...>

[#24321] shttpsrv — TAKAHASHI Masayoshi <maki@...>

[#24323] HP-UX 上での ruby1.4.6 make getaddrinfo.c err — yasuaki onishi <yasuaki@...4u.or.jp>

[#24324] ruby の発展の為に — "Mitsuo Igarashi" <mitsu5@...>

[#24329] Coerce between Range and Boolean — NISHIKAWA <nyasu@...3web.ne.jp>

[#24341] install guide draft — gotoken@... (GOTO Kentaro)

[#24357] FreeBSD ports #4 — "Akinori -Aki- MUSHA" <knu@...>

[#24378] bin package on win/dos — Noritsugu Nakamura <nnakamur@...>

[#24384] erb-1.3.1 — Masatoshi SEKI <m_seki@...>

[#24399] 「 Ruby プログラミング入門」査読者募集 — Shin-ichiro Hara <sinara@...>

[#24430] (RDP) Engurish ftools.rd — gotoken@... (GOTO Kentaro)

[#24439] HotLinks — NISHIKAWA <nyasu@...3web.ne.jp>

[#24447] (RDP) tempfile.rd — Toshiro Kuwabara <toshirok@...3.so-net.ne.jp>

[#24464] Tips for Perl -> Ruby — kiri@...

[#24469] レンタルサーバで eruby — Tokita Kousui <ktokita@...>

[#24473] RD for(?) Cygwin — polygon <kiyose@...>

[#24491] Re: レンタルサーバで eruby — "Kahori Takeuchi" <EB89012@...>

[#24499] FreeBSD port: x11-toolkits/rubytk — Yasuhiro Fukuma <yasuf@...>

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

[#24515] MSWin Ruby on Windows2000 — arton <arton@...>

[#24520] wildcard arg for ruby1.4 — arton <arton@...>

[#24522] (RDP) readline — Koji Arai <JCA02266@...>

[#24531] RD 質問 — Koji Arai <JCA02266@...>

[#24550] Array への nil の代入について — Kenya Ogata <k_ogata@...>

[#24556] 埋め込みドキュメント仕様 RubyDoc( 提案) — MoonWolf <moonwolf@...>

[#24559] 配列内のオブジェクトの配列内のオブジェクトの関数 — Yasuki <yasuki@...>

[#24565] Ruby FAQ — Kazuhiro NISHIYAMA <zn@...>

[#24592] perl to ruby — "Yasuyuki Imai" <waver@...3.ttcn.ne.jp>

[#24625] member list was crashed — matz@... (Yukihiro Matsumoto)

[#24631] Re: RubyDocumentationProject( 仮 ) — TAKAHASHI Masayoshi <maki@...>

[#24174] ruby によるバグ追跡システム — 堀川　久 <vzw00011@...>