[ruby-list:22706] Re: (RD) Verbatim

ごとけんです

In message "[ruby-list:22642] Re: (RD) Verbatim"
    on 00/05/17, Toshiro Kuwabara <[e-mail]> writes:
>ちょっと一般的な(?)本の場合どうなっているかを見ようと手元の本を
>ぱらぱらとめくってみました。
>日本語の本だと、Chaptionは大抵の場合10文字程度で1文におさまり、
>名詞句(?)であることが多い様です。
>
>例外的に長い例はアンチパターンの本のP113に50文字くらいのものが
>ありました。ぱらぱら見た程度では、2番目に長いのは20文字程度で
>しかしこれは1文におさまる名詞句になっていました。

どうも僕は科学論文を念頭に置いてるみたいです。図って本文とは
独立しても意味がある資源だと思ってるんですかね > 俺。

# 論文だと図だけ見て読むか読まないか決めたりするせいかな

>この場合だと、元のキャプションは全て図(表?)の中にいれてしまって、
>キャプションを「サーバーとクライアントの動作」等とする、のでしょうか。

普通(?)はキャプションはその図を読むのに必要な情報をダイジェ
ストしますね。詳細は本文をみよ、という形で。ベンチマークの結
果のグラフなんかだと、こういう形があると思います。

>つまり、提案はFigureのCaptionセクションの中にLabelという属性
>を付加するのではなくて、CaptionセクションをそのままLabelにする、
>ことです。

…なんだかんだ言いましたがToshさんの意見の方がやっぱり良さそ
うです。ただ、Captionと別にLabel指定するオプションもあると良
いかと思います。:::Figure:label::: のlabelがあればそっちを使
うとか。

>>LaTeX だと自動生成される図の番号を使えますが、あれもあると良
>>いですけど、これはRD向きじゃないかも知れない。
>
>それって、「図 2.1」みたいな番号ってことですか？
>それはRDのこと、というよりはRDtoolの機能としてってことですよね？

そうです。これはRD自体の話ではなかったです。失礼 __;;

>本の様なメディアはフォントを変える事で見やすい表示を簡単に
>実現できますが、RDの場合、Inlineのカッコは増えれば増える程
>見づらくなりがちなので、あまり多くを加えるのは難しいかと
>思います。

確かに。

>>また、実行例と、コードを分ける仕組みはあると良いですね。
>>Verbatim の :::Execution::: で :::Code::: とか。
>
>Rubyの場合、実行例の形式には良く使われるものでも2種類(もっと?)
>あるので、区別の必要があるかもしれません。
># むしろフォーマッタが自動判別っていうのが現実的でしょうか。

いや、難しいことはひとにさせるのが安上がりな気もします :-)

>ひとつは、ごとけんさんのxmpでの出力にもなっている
>  "a b c".split(/\s/)
>     #=> ["a", "b", "c"]

これはコード片と思ってよいのではないでしょうか?? 

ちなみに xmp の出力はカット&ペーストを目的にデザインしてます。
あんまり流行らないけど (^^;

>みたいなやつで、もうひとつはシェルからスクリプトファイルを
>実行した時の
>  $ ruby foo.rb
>  ....
>みたいなやつです。

コンソールって特別ですね。細かく言えば HTML だと

$ <KBD>ruby foo.rb<KBD>

したくなるような。でもここまではRDの可読性を保って実現するの
は難しそう…しかしヘッダなどでプロンプトを指定できるとRDを読
むひとにも優しいかも知れません。

=begin AboutThisDocument
....
Prompt: "hoge>", "#"
....
=end

-- gotoken