[ruby-list:16148] Re: RD specification

ごとけんです

In message "[ruby-list:16138] Re: RD specification"
    on 99/08/14, Toshiro Kuwabara <[e-mail]> writes:

>> # 祝1.4.0!　＼(^-^)／
>御意♪お盆は1.4.0とデート、とか。(^^)

そういえばもうお盆なんですね (^^;;

>> >: メタ文字列のエスケープか実体参照のような機能。
>インラインのverbatimの方が便利かも。Rubyのスクリプトをインラインに
>はさみたいときにも使えますし。

確かに。ただ、\verb+...+ みたいのはたぶん正規表現では書けま
せんね。あと、他のインライン要素とは構文を分けないといけない
でしょうね。

>> # blade で [ruby-dev:3067] をみたら「字面」が処理されてるよ
>> # うに見える :-)
>始め見たときしばし悩みました。(^^;

僕もです(^^;;

>> RD は SGML とちがって汎用な括弧を用意しない思想なのでこの辺
>> ツラいですね。しかし、podみたいのかSGMLみたいなのはなにかし
>> ら用意しないと考えるのが大変かも(インライン要素はもうすこし
>> ほしいので)。
>インライン要素は結構ほしい機能とかたくさんでてきそうですが、
>開始と終了の記号をかなり慎重に決めないとあっという間に可読性
>が損なわれそうです。RDは可読性が嬉しいところなので、汎用の
>ものを用意するにしても今の思想に従うにしてもなるべく慎重に
>進めたいところです。

これなんですけど、まつもとさんも「ジャマにならなければ、現在
の仕様とは違うある程度汎用的なインラインかっこの導入は構わな
いと思います。plain2の((x ..))とかいうのも嫌いじゃない」とおっ
しゃっている[ruby-list:16134]ので、podのL<...>かplain2の
((x...))程度のモノなら導入しませんか?? さすがにSGMLみたいの
はさすがに可読性が下がりそうなのでやめたいですが。まぁやるな
らplain2のかな。確かに読みやすいし、平文を書くのにも不自由し
なさそうだし。

そこで少し考えて見ました。plain2では、((x...))の一文字目は英
文字なんだけど、これを記号文字にしたらだいぶ読みやすいんでは
ないかと思います。あと、内容の前後に呼応する記号を書くと言う
ことを考えて見ました。

:強調
   LaTeX の \em 相当。((!強調!))
:コード
   HTML の code 相当。((|while gets...|))
:変数
   HTML の var 相当。((変数))
:キーボード
   HTML の kbd 相当。((%ruby -v%))
:見出し語
   索引に載せる語。((:見出し語:))
:リンク
   HTML の a href= 相当。((<見出し語>))
:脚注
   LaTeX の \footnote 相当。((-脚注-))
:そのまま
   LaTeX の \verb 相当。((`そのまま')) もしくは {{そのまま}} 

> [構文要素:ラベル]と
> {構文要素:ラベル}ってことですよね?
>
>それで構わないと思います。
>構文要素に何を許すかにちょっと議論の余地がありますが。

んー、どうしましょう。インライン要素は((x...))型に統一して、
その同義語として「[ホゲ:hoge]を参照」みたいにしますか??  

ところでインラインなラベルって本当にいるんでしょうか?? 
plain2だと、参照を意味する ((x...)) は LaTeX の \section や 
\table などに相当する箇所に対してしか使えません(この場合、見
出しやcaptionが((x...))の...に入る)が、それで十分な気がしま
す。甘い?? んで、引用の順序が変わりますが、

>う〜む。実は[ruby-dev:3070]を読み返してみて、構文要素にリストなどのブロック
>が入ってくると無理がでて来るような気がしました。
>少なくとも同じラベルという要素にブロックのものとインラインのものの二つが
>必要になりそうです。
>現状でもリストはやや特殊な要素になってます。リストだけがブロックを含む
>ブロックなので。

問題は、リストのようなブロック要素にラベルをつける
方法ですが、
* 自動生成したラベルを使う
* 直前に置いた # で始まる行にラベルを書く
のいずれかで済むような気もします。

>外に出すようにすると、例えば複数のライブラリのRDから得たauxをまとめて
>一つの索引ファイルとして出力するスクリプトがあればお手軽にライブラリの
>リファレンスができて便利かな、とか思いました。
>それと、HTMLの最後に索引がついててもそれほど便利かなって思います。

了解です。索引の位置は各rd2*に任せることにしても、auxみたい
なのは悪くないかも知れません。

>> >: 強制的な改行の機能
>> :::br::: とかどうでしょう。実体参照もこの手でいけるような。
>=br=とかも。どうせ行頭に来る事はないでしょうからHeadlineと紛らわしいという
>こともありません。

強制改行は不要な気がして来ました。必要ならverbatimにするとか
でしのげると思うんですが。

>> >: スクリプトに埋め込まないRDの決まり事
>.rdだと.rbと似ていて紛らわしいかも。
>もっとも=begin,=endがつくならruby *.rdとしても問題は起きませんが。

=begin =end は残して、.rd ってことにしません??

# しかし授業で .rb を .rd としてた学生が結構いたのを思い出した(^^;;;


>> >あと、ちょっと思い付いただけのものですが、
>> > {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とかに使ったり、とか。
>>
>ラベルと参照のどちらかに"{"をつかうなら、重なっちゃいますから、
>上の形のままだとだめですね。
>Rubyの代入やハッシュ式を真似て
> { key => value }
>のような形がいいのか、もしくはそれだと問題が起きそうだから全く
>別の形式にすべきなのでしょうか。

いっそのこと、ある規約にしたがって、Rubyのモジュールを吐き出
すのもいいかも知れません。

>ところで、rd2html.rb(Ruby本体のsample/の)にある、「@input」とか
>はどうしましょう?あったほうが便利ですか?
># そういえば、rd2html.rbの@inputの処理にバグを見付けて、それを
>直そうとしたのがそもそものきっかけでした。(^^)

ドキュメントを書く道具としてなら、あると便利かも知れませんね。
LaTeXの\includeみたいな使い方をするというのはありそうです。

-- gotoken