[ruby-list:23239] Re: readablity of RD

Toshです。

In message "[ruby-list:23233] Re: readablity of RD"
    on 00/06/14, TAKAHASHI Masayoshi <[e-mail]> writes:
>Toshiro Kuwabara <[e-mail]>さん：
>> 余談になりますが、一般に字がつまっていると読みづらくなる傾向が
>> ありますね。
>
>ありますです。
># RDtoolのREADME.rdも、見出しが重なると詰まって見えますです。

そうですね。(^^;;
見出しと本文の間は一行開けるべきだし。

>> その点、あらいさんの提案で今の形のMethodListができてからはリファ
>> レンスみたいなドキュメントは
>> 
>>   --- Array#unshift(obj)
>>         ....
>> 
>> って感じでちょうどいいスペースが左右にあくのでいい感じです。
>> これは個人的にかなり気に入っているのです。
>
>なるほど。
># MethodListはいまいち使い方が分からず……(汗;

MethodListは一見複雑そうですけど、実は話は簡単で、
「RubyのマニュアルみたいなMethodのリファレンスを書く時はDescListの
代わりにMethodListを使いましょう、そうすると、"(...)"とか"{....}"
とかはLabelとしては無視されるので、

  --- Array#unshift(obj)

に対して、"((<Array#unshift>))"みたいなReferenceが書けます。さらに
Rubyで良く使われるMethod記法 Class#method や Class::CONST を使うと
Method Indexとか色々ご利益がありますよ。」
ってのがMethodListです。

>> 高橋さんのいっているセパレタはそれとは機能がちょっと違いますね。
>
>HTMLでは反映させなくても構わないので、plaintext時には欲しい、
>ということなので。

そうですね。見出しの一部としてセパレタが欲しいのか、セパレタそのもの
が欲しいのかどっちでしょ？

>> あれ？ RDの文法の方を変更しようと言う話にはいかないのですか？
>> せっかくそれなりに考えておいたのに。(^^;;;
>
>ちょっと穏健になってみました :-D
>読みやすさが気になる一方、文法が複雑になるのも好ましくない
>という気持ちもあるのです。

なるほど。高橋さん自身が完全にRDizeされてしまったとか。(^^;;

>> 例えば、
>> 
>>   === Headline =====
>> 
>> みたいにして、後ろの「/=+\s*$/」は無視される、とか。
>
>なるほど。これはいいかも。

文法の変更は最小ですね。問題は

  + Headline ==========

はさすがにアレなのですが、

  + Headline ++++++++++

もなんかちょっと、ってとこです。

あとは

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

のどっちがレベル大きいのか見ためには伝わりませんね。

# この例は書き方が悪いかも知れませんけど。

>> あるいは、
>> 
>> =======
>> == Headline
>> ======
>> 
>> のように、前後1行の「/^(=+|-+)$/」は無視される、とか。
>> 
>> === Headline
>> ---------------
>> 
>> ってのも可、ってことで。
>
>これは明らかに文法が複雑になりそげな気がするので、他の記法との
>兼ね合いも含め、考える必要があると思います。
># でも、ごとけんさんもるびきちさんもOKっぽいですね。大丈夫かな？

もちろん思い付きで書いただけなので、十分な考察と議論の必要があると
思います。

# 後者の方が変更が大きいのでその分慎重になりますね。

---
Tosh
Toshiro Kuwabara