From: Toshiro Kuwabara Date: 2000-05-18T23:53:26+09:00 Subject: [ruby-list:22725] Re: (RD) Verbatim Toshです。 In message "[ruby-list:22706] Re: (RD) Verbatim" on 00/05/18, GOTO Kentaro writes: >>ちょっと一般的な(?)本の場合どうなっているかを見ようと手元の本を >>ぱらぱらとめくってみました。 >>日本語の本だと、Chaptionは大抵の場合10文字程度で1文におさまり、 >>名詞句(?)であることが多い様です。 >> >>例外的に長い例はアンチパターンの本のP113に50文字くらいのものが >>ありました。ぱらぱら見た程度では、2番目に長いのは20文字程度で >>しかしこれは1文におさまる名詞句になっていました。 > >どうも僕は科学論文を念頭に置いてるみたいです。図って本文とは >独立しても意味がある資源だと思ってるんですかね > 俺。 完全に独立できるかどうかはわかりませんが、ある程度の独立性みたいな ものはあるかと思います。 図はFloating要素ですから、編集の都合で本文とは離れ離れになってしまう こともあるので、本文が無いと何の事だかさっぱりな図と言うのは、問題が あるかもしれません。 >>この場合だと、元のキャプションは全て図(表?)の中にいれてしまって、 >>キャプションを「サーバーとクライアントの動作」等とする、のでしょうか。 > >普通(?)はキャプションはその図を読むのに必要な情報をダイジェ >ストしますね。詳細は本文をみよ、という形で。ベンチマークの結 >果のグラフなんかだと、こういう形があると思います。 そうです。どちらかというと、本文に「図を見よ」と参照が入っているわけ ですが、始めに目に入るのは図の方ですから、「詳細は本文を」がむしろ 読者の読み方かも知れません。 >>つまり、提案はFigureのCaptionセクションの中にLabelという属性 >>を付加するのではなくて、CaptionセクションをそのままLabelにする、 >>ことです。 > >…なんだかんだ言いましたがToshさんの意見の方がやっぱり良さそ >うです。ただ、Captionと別にLabel指定するオプションもあると良 >いかと思います。:::Figure:label::: のlabelがあればそっちを使 >うとか。 そうですね。これまでの議論で図のキャプションは必ずしも見出しと 対応しているわけではないということもわかったので、Labelを別に 指定することができてもよいかと思います。 ところで、形式をどうするか、についてもちょっと掘り下げたいですね。 :::Figure::: :::Caption :::... といった記述は「:::」が多く並ぶとやや文字が見づらいのでないかと 思うのですが、どうでしょうか？ >>それって、「図 2.1」みたいな番号ってことですか？ >>それはRDのこと、というよりはRDtoolの機能としてってことですよね？ > >そうです。これはRD自体の話ではなかったです。失礼 __;; 了解しました。 >>>また、実行例と、コードを分ける仕組みはあると良いですね。 >>>Verbatim の :::Execution::: で :::Code::: とか。 >> >>Rubyの場合、実行例の形式には良く使われるものでも2種類(もっと?) >>あるので、区別の必要があるかもしれません。 >># むしろフォーマッタが自動判別っていうのが現実的でしょうか。 > >いや、難しいことはひとにさせるのが安上がりな気もします :-) > >>ひとつは、ごとけんさんのxmpでの出力にもなっている >> "a b c".split(/\s/) >> #=> ["a", "b", "c"] > >これはコード片と思ってよいのではないでしょうか?? ふむ、そうかも。 「#=>」以降はスタイル変えられるように 「["a", "b", "c"]」とかしておく とかはできるのではないかと思います。今回の提案が実現すれば。 >ちなみに xmp の出力はカット&ペーストを目的にデザインしてます。 >あんまり流行らないけど (^^; そう言えば、以前、Emacsから呼び出すようにして「regionを各行 xmpに評価」とかできるようにすれば便利かも、とか考えたのですが。 それとも、すでにできるのですかね？誰かやっていてもおかしくない 使い方だと思うのですが。 >>みたいなやつで、もうひとつはシェルからスクリプトファイルを >>実行した時の >> $ ruby foo.rb >> .... >>みたいなやつです。 > >コンソールって特別ですね。細かく言えば HTML だと > >$ ruby foo.rb > >したくなるような。でもここまではRDの可読性を保って実現するの >は難しそう…しかしヘッダなどでプロンプトを指定できるとRDを読 >むひとにも優しいかも知れません。 > >=begin AboutThisDocument >.... >Prompt: "hoge>", "#" >.... >=end ヘッダに色々詰め込みすぎるのもRDとしてはどうだろうか、とも思う のですが、どうせヘッダはオプションなんだから詰めるだけ詰めちゃって もよいのでしょうかねぇ？ ここらへんのポリシーについてはかなり迷ってます。 ただ、さすがにプロンプト指定はやりすぎではないかと思います。 ヘッダにいれると実際の実行例の部分と距離的に離れていますし。 追加議題。 Verbatim => FloatingBlock の様に名前を変更すべき？ --- Tosh Toshiro Kuwabara