Toshです。

In message "[ruby-list:23222] readablity of RD"
    on 00/06/13, TAKAHASHI Masayoshi <maki / inac.co.jp> writes:
>RDをいろいろ試しているのですが、なかなか「読みやすいRD」という
>のが書きにくくて難儀しています。なお、ここでいう「読みやすい」
>とは、プレインテキストで見た時点での見た目の問題を指しています。

余談になりますが、一般に字がつまっていると読みづらくなる傾向が
ありますね。
その点、あらいさんの提案で今の形のMethodListができてからはリファ
レンスみたいなドキュメントは

  --- Array#unshift(obj)
        ....

って感じでちょうどいいスペースが左右にあくのでいい感じです。
これは個人的にかなり気に入っているのです。

>例えば、((* 強調 *))とか((<URL:http〜>)とかはわりと読みやすい
>かと思うのですが、逆に読みやすくしづらいのが「見出し」です。
>
>一般のプレインテキストの場合ですと、見出しを目立たせるには、
>
> * 段落の区切りに明示的なセパレータを使う。
>   セパレータとしては「----------」とか「===========」とか
>   「##########」とかが多用される。
>
> * 見出しの(前)後に派手な装飾をつける
>
>    例:
>========
>大見出し
>========
>
>
>中見出し
>--------
>
> * 見出しをセンタリングする
>
>
>といった技が使われていますが、RDではこれらは使えません。

そうです。セパレタは割と初期の頃に提案をいただいた覚えもあり
ますが、その時にはHTMLにおけるHR要素相当って感じだったので、
見送りになったのです。

高橋さんのいっているセパレタはそれとは機能がちょっと違いますね。

>そのため、目立たせるには前後に空行を入れること、見出しの
>レベルを変えるには「=」の数を変えること、くらいしかできま
>せん。しかし、空行を入れまくっていると、特にソース中では
>空行が多くなりがちで間の抜けた感じになってしまうのが難点
>です。
>
>というわけで、「これなら読みやすい！」というRDの書き方が
>あればご教授していただきたく。

あれ？ RDの文法の方を変更しようと言う話にはいかないのですか？
せっかくそれなりに考えておいたのに。(^^;;;

例えば、

  === Headline =====

みたいにして、後ろの「/=+\s*$/」は無視される、とか。

あるいは、

=======
== Headline
======

のように、前後1行の「/^(=+|-+)$/」は無視される、とか。

=== Headline
---------------

ってのも可、ってことで。

>感覚の問題なんで、漠然とした言い方になってしまうのですが……。
># というかんじなんですよ＞Toshさん :-)

ふぃ〜りんぐ重要なので、これでいいんじゃないでしょうか。:-)

---
Tosh
Toshiro Kuwabara