10. 引用と例

引用と例は，テキストの塊が区切られた一つ以上の段落全体から成り立つテキス トとなっていて，取り扱いが異なります．通常字下げされます．

Texinfoでは，引用や例は，常に行の最初に単独で@-コマンドを書くことから始 まり，行の最初に単独行で@endコマンドを書くことで終ります．例えば， 例を@exampleを行の最初に単独行で書くことで始め，行の始めに単独行 で@end exampleを書くことで終えます．

10.1 ブロックで囲むコマンド

以下のものは次のセクションで更に説明しますが，引用と例のコマンドです．

@quotation

引用されたテキストを示します．テキストは補充され，字下げされ，そしてデフォ ルトでローマンフォントで印刷されます．

@example

コードとコマンドのようなものを例示します．テキストは等幅フォントで印刷さ れ，字下げされますが，補充されません．

@verbatim

逐語的に出力されるテキストの一部に印をつけます．次の@end verbatimまで，置換される文字は無く，すべてのコマンドは無視されます．テ キストは固定幅フォントで出力され，字下げも補充もされません．余分なスペー スと空の行は重要で，タブは展開されます．

@smallexample

TeXでこのコマンドがより小さいフォントでテキストを植字する以外， @example と同じです．

@lisp

@exampleに似ていますが，特にLispコードの例示に対するものです．テ キストは等幅フォントで印刷され字下げされますが，補充されません．

@smalllisp

@exampleに対する@smallexampleのような@lispに対す るものです．

@display

例示のテキストを表示します．テキストは字下げされますが補充されず，フォン トの選択もされません(そのため，デフォルトでフォントはローマンです)．

@smalldisplay

@exampleに対する@smallexampleのような@displayに 対するものです．

@format

@display(テキストは補充されずフォントの選択もありません)に似てい ますが，字下げされません．

@smallformat

@exampleに対する@smallexampleのような@formatに対 するものです．

@exdentコマンドは，行の字下げを元に戻すため，上記の構成の中で使 用されます．

@flushleftと@flushrightコマンドは，補充されないテキスト の左右のマージンを整えるために使用されます．

@noindentは，それに続くテキストを新しい段落のように字下げするの を妨げるため，上の構成の一つの後で使用してもかまいません．

上の構成物の一つの中で角丸の四角を描いて例や引用を強調するため， @cartoucheコマンドを使用することが可能です．See section Drawing Cartouches Around Examples.

10.2 @quotation

引用のテキストを，以下の場合以外は普通に処理します．

• マージンがページの中心に近く，そのため引用全体を字下げできない場合．
• 段落の最初の行が他の行以上に字下げできない場合．
• 印刷物で，段落間の間隔が減らされている場合．

これは@quotationコマンドと@end quotationコマンドの間に書 かれているテキストの例です．@quotationコマンドは，他の(実際また は架空の)印刷された本から抜粋されたテキストを示すために，最もよく使用さ れます．

@quotationコマンドは単独行のテキストとして書いてください．この行 は出力に現れません．引用の終りを，行の最初に@end quotationのみを 含む行で印を付けてください．@end quotation行は出力に現れません． こうして，以下のようになります．

@quotation
This is
a foo.
@end quotation

以下を生成します．

This is a foo.

10.3 @example: 例のテキスト

@exampleコマンドは，コンピュータの入力や出力のような実行している テキスト以外の例を示すために使用されます．

これは，@exampleコマンドと
@end exampleコマンドの間に書かれている
テキストの例です．
字下げされますが補充されません．

印刷されたマニュアルでは，テキストは等幅フォントで植字され，
余分な空白と空白行は意味があります．Infoファイルでは，
それぞれの行を五個のスペースで字下げされ，
似たような結果が得られます．

@end exampleコマンドを行の最初に単独行に書いてください．例の終り に@end exampleコマンドで印を付け，それも行の最初に単独行で書いて ください．

例えば，以下のようにします．

@example
mv foo bar
@end example

以下を生成します．

mv foo bar

@exampleと@end exampleを含む行は出力に現れません．出力の 見ためが良くなるように，@exampleの前に空白行を置き，もう一つの空 白行を@end exampleの後に置くべきです．始めの@exampleと終 りの@end exampleの中の空白行は出力に現れることに注意してください．

注意:(逐語的な環境以外の)例の行や問題となりうるTexinfoのあらゆ る場所でタブを使用しないでください！TexinfoのTeXの実装ではタブを一つの スペースとして扱い，表示されているようにはなりません．(必要な場合，Emacs でタブをその領域を占める複数のスペースに変換するためM-x untabify を使用することが可能です．)

例は，論理的に言うと段落の“真中にある”ものと，例の後に字下げされずに続 けられるテキストとなります．@noindentコマンドはテキストの部分が 新しい段落のように字下げされるのを妨げます．

(@codeコマンドは文の中に埋め込まれるコードの例に使用されますが， 前後のテキストを区切りません．See section @code.)

10.4 @verbatim:リテラルテキスト

コンピュータの入力や出力のような，特殊な文字や解釈して欲しくないコマンド を含む可能性のあるテキストを出力するために，@verbatimの環境を使 用してください(@exampleはそのテキストを通常のTexinfoコマンドとし て解釈します)．これは，自動的に生成される出力をTexinfoマニュアルに含める ときに特に役に立ちます．例は以下のようになります．見ることになる出力は， @verbatimの前の行と@end verbatimの後の行も含めて，入力と 全く同じになります．

@c This is an example of text written in a @verbatim
@c block.  No character substitutions are made.  All commands
@c are ignored, until `<at>end verbatim'.
@c 
これは，@verbatimブロックの例です．
文字の置換はありません．`<at>end verbatim'まで，
すべてのコマンドは無視されます．

@c In the printed manual, the text is typeset in a
@c fixed-width font, and not indented or filled.  All
@c spaces and blank lines are significant, including tabs.
@c 
印刷されたマニュアルでは，テキストは固定幅フォントで植字され，
字下げも補充もされません．
すべてのスペースと空白行は，タブも含めて重要です．

@verbatimコマンドを行の始めに単独行で書いてください．この行は出 力に現れません．verbatimブロックの終りを@end verbatimコマンドで 印を付け，これも行の始めから単独行にしてください．@end verbatim も出力には現れません．

例えば以下のようにします．

@verbatim
{
<tab>@command with strange characters: @'e 
expand<tab>me
}
@end verbatim

以下を生成します．

{
       @command with strange characters: @'e 
expand	me
}

@verbatimと@end verbatimを含んでいる行は出力を生成しない ので，通常は@verbatimの前の空白行と，@end verbatimの後に も空白行を書くべきです．最初の@verbatimと終りの@end verbatimの間の空白行は出力に現れます．

10.5 @verbatiminclude file:ファイルをそのまま含める

@verbatimincludeコマンドでファイルの内容を正確にドキュメントに含 めることが可能です．

@verbatiminclude filename

filenameの内容は，verbatimで囲まれたように出力されます (see section @verbatim)．一般的に，ファイルはそのまま正確 に出力され，すべての特殊文字と空白はそのままになります．

10.6 @lisp:Lispの例の印付け

@lispコマンドはLispコードに対し使用します．それは @exampleコマンドの類語です．

これは，@lispコマンドと
@end lispコマンドの間に書かれたテキストの例です．

例の性質に関する情報を保護するため，@exampleの代わりに @lispを使用してください．例えば，TexinfoファイルにLispコードのみ を評価しそれが全てである関数を書く場合，これは役に立ちます．Lispライブラ リのようにTexinfoファイルを使用すること可能です．(10)

@lispの終りは，単独行の@end lispで印を付けてください．

10.7 @small…ブロックコマンド

正規の@exampleと@lispコマンドに加えて，Texinfoは “small”という例のような形式のコマンドがあります．これらは， @smalldisplay，@smallexample，@smallformat，そし て@smalllispです．

TeXでは，@small…コマンドは，小さい例のコマンドより小さ いフォントでテキストを植字します．したがって，長い行を含んでいる例の多く は，短くする必要が無いように，ページに適したものになります．

Infoでは，@small…コマンドは，“small”が無いコマンドと同じ です．

@small…ブロックは，対応する@end small…で印を 付けてください．例えば@smallexampleは@end smallexampleと 対になります．

@small…コマンドで，狭いページに適したものになるよう手動で 例を編集することなく，マニュアルの準備がより簡単になります．

一般的な規則として，(例えば)@exampleまたは@smallexample の一つのみを章の中で一貫して使用すると，印刷されたドキュメントはより良く 見えます．たまにだけ，二つの書式を混ぜるべきです．

@smallbookコマンドの詳細は，See section Printing “Small” Books.

10.8 @displayと@smalldisplay

@displayコマンドは，例のようなものを開始します．印刷されたマニュ アルで@displayは等幅フォントを選択しない以外は，@example コマンドに似ています．実際，フォントを全く指定しないので，テキストは @displayコマンドを用いていないところに現れるものと同じフォントで 現れます．

これは，@displayコマンドと@end displayコマンドの間に書かれ
たテキストの例です．@displayコマンドは，テキストを字下げしますが，
補充しません．

Texinfoは@smalldisplayコマンドも提供していて，それは @displayに似ていますが，@smallbook書式でより小さいフォン トを使用します．See section @small…ブロックコマンド.

10.9 @formatと@smallformat

@formatコマンドは，印刷されたマニュアルで@formatが等幅フォ ントを選択せず，マージンを狭くしないこと以外は，@exampleに似てい ます．

これは@formatコマンドと@end formatコマンドの間に書かれてい
るテキストの例です．
この例で分かるように，
@formatコマンドは，テキストを補充しません．

Texinfoは@smallformatも提供していて，それは，@formatに似 ていますが，@smallbook書式でより小さいフォントを使用します． See section @small…ブロックコマンド.

10.10 @exdent: 行の字下げの取り消し

@exdentコマンドは行が持つ字下げを削除します．このコマンドは行の 最初に書き，同じ行にあるコマンドに続くテキストのみに適用されます．テキス トの周りにカッコを使用しないでください．印刷されたマニュアルでは， @exdent行のテキストはローマンフォントで印刷されます．

@exdentは通常例の内部で使用されます．このため，以下のようになり ます．

@example
この行は，@@exampleコマンドに続いています．
@exdent この行は字下げされません．
この行は字下げされていない行に続いています．
@@end exampleは次の行にあります．
@end group

以下を生成します．

この行は，@exampleコマンドに続いています．
この行は字下げされません．
この行は字下げされていない行に続いています．
@end exampleは次の行にあります．

実際は，@exdentコマンドは滅多に使用されません．通常幅に変えるた め，通常は例を終りにしたり，ページをかえたりして，テキストを字下げしない ようにします．

10.11 @flushleftと@flushright

@flushleftと@flushrightコマンドは，ページの左右のマージ ンで行の終りを整えますが，テキストを補充しません．コマンドはカッコを使用 せず，単独行に書かれます．@flushleftと@flushrightコマン ドは，単独行の@end flushleftと@end flushrightコマンドで 終りになります．

例えば，以下のようにします．

@flushleft
このテキストは
左揃えで書かれています．
@end flushleft

以下を生成します．

このテキストは 左揃えで書かれています．

@flushrightは，手紙の返信先住所でよく使用される字下げの形式を生 成します．例えば，以下のようにします．

@flushright
これは，右揃えで書かれてたテキストの例です．
@code{@flushright}コマンドは
全ての行を右揃えにしますが，
左端はバラバラのままです．
@end flushright

以下を生成します．

これは，右揃えで書かれてたテキストの例です． @flushrightコマンドは 全ての行を右揃えにしますが， 左端はバラバラのままです．

10.12 @noindent: 字下げを行なわない

例やその他の包含物は，段落を部分に切り分けます．通常，フォーマッタは例に 続くテキストを新しい段落として字下げします．時と場合によって @noindentを行の最初に単独行に書いたり，それに続くテキストの前に 書くことで，これを妨げることが可能です．@paragraphindentを用いる ことで，段落全体すべての字下げを行なわないことも可能です (see section Paragraph Indenting)．

ほとんどの囲まれている部分で，コマンドの直後のスペースは無視されないので， @noindentを単独行に書いた方が良いでしょう．囲まれている部分以外 では，行の最初に使用し，それにテキストを続けてもかまいません．

例えば，以下のようにします．

@example
これは例です．
@end example

@noindent
この行は，字下げされません．御覧のように，行の最初は
その後も続けて全体が左寄せになっています．
(この全体の例は，@code{@@display}と
@code{@@end display}の間にあります．)

以下を生成します．

これは例です．

この行は，字下げされません．御覧のように，行の最初は
その後も続けて全体が左寄せになっています．
(この全体の例は，@displayと@end
displayの間にあります．)

Info出力で空白行の数を正確に調整するため，@noindentを含む行は， 空白行を生成せず，@end example行もそうしないことを覚えておいてく ださい．

このマニュアルのTexinfoソースファイルでは，‘以下を生成します’と書いてあ るそれぞれの行の前に，@noindentが前置されています．

@noindentコマンドの後にカッコを書かないでください． @noindentは段落の外で使用されるので，それは不要です (see section @-コマンドの構文)．

10.13 @cartouche:例の周りに枠を描く

印刷されたマニュアルで，@cartoucheコマンドは，その内容の周りに角 丸の箱を描きます．例や引用をより強調するために使用することが可能です．例 えば，例の一つの形式が強調のため枠で囲まれているマニュアルを書くことが可 能です．

@cartoucheは印刷されたマニュアルのみで効果があります．他の出力で は効果がありません．

例えば，以下のようにします．

@example
@cartouche
% pwd
/usr/local/share/emacs
@end cartouche
@end example

二行の例は，印刷されたマニュアルで，角丸の箱で囲まれます．

この文書は新堂 安孝によって2009年9月22日にtexi2html 1.82を用いて生成されました。