[ << lilypond-book を実行する ]	[Top][Contents][Index]	[ 外部プログラム >> ]
[ < DocBook ]	[ Up : lilypond-book を実行する ]	[ lilypond-book を呼び出す > ]

---

3.3 楽譜断片オプション

以下では、‘LilyPond コマンド’ は、これまでのセクションで説明した楽譜断片を作り出すために lilypond-book によって処理される任意のコマンドを意味します。シンプルにするために、LaTeX 構文の LilyPond コマンドだけを示します。

オプション文字列は左から右の順で解析されるということに注意してください。あるオプションを複数指定した場合、最後のオプションが有効となります。

LilyPond コマンドで以下のオプションを使うことができます:

staffsize=ht

譜サイズを ht にセットします。単位はポイントです。

ragged-right

デフォルトの間隔を用いるため、行の右端が揃いません。つまり、LilyPond コード断片に ragged-right = ##t を追加します。明示的に noragged-right を指定しない限り、1 行の楽譜断片はデフォルトでは常に ragged-right で譜刻されます。

noragged-right

楽譜断片が 1 行の場合に、譜の長さを行幅まで広げます。つまり、LilyPond コード断片に ragged-right = ##f を追加します。

line-width

line-width=size\unit

行幅を size にセットします。unit は単位です。unit は以下の文字列のどれかです: cm, mm, in, あるいは pt。このオプションは LilyPond 出力 (つまり、楽譜断片の譜の幅に) に影響を与えますが、テキスト レイアウトには影響を与えません。

引数無しで使用した場合、行幅はデフォルト値にセットされます (試行錯誤的なアルゴリズムで算出される値です)。

line-width オプションが指定されなかった場合、lilypond-book は ragged-right オプションを使用しない lilypond 環境のデフォルトを推測しようと試みます。

papersize=string

string は scm/paper.scm で定義されている紙面サイズ – つまり、a5, quarto, 11x17 等 – です。

scm/paper.scm で定義されていない値は無視され、警告が発せられ、楽譜断片はデフォルトの a4 サイズで譜刻されます。

notime

拍子記号と小節線を譜刻しません。

fragment

lilypond-book が常用コードを追加するので、\layout, \score 等を入力する必要がなく、単に以下のように入力できます:

c'4

nofragment

楽譜断片の LilyPond コードに補完コードを追加しません。これがデフォルトなので、通常、nofragment は不要です。

indent=size\unit

楽譜の最初の段のインデントを size にセットします。unit は単位です。unit は以下の文字列のどれかです: cm, mm, in, あるいは pt。このオプションは LilyPond に影響を与えますが、テキスト レイアウトには影響を与えません。

noindent

楽譜の最初の段のインデントを 0 にセットします。このオプションは LilyPond に影響を与えますが、テキスト レイアウトには影響を与えません。これがデフォルトなので、通常、noindent は不要です。

quote

楽譜の両端に 0.4in のインデントを挿入して、引用ブロックで囲みます。値 ‘0.4in’ は exampleindent オプションで制御することができます。

exampleindent

quote オプションが楽譜断片に挿入するインデントの量をセットします。

relative

relative=n

相対オクターブ モードを使用します。デフォルトでは、音符はミドル C との相対関係で指定します。オプションで指定する整数の引数は開始音符のオクターブを指定します – デフォルトの 1 はミドル C です。relative オプションは fragment オプションがセットされている場合にのみ機能するため、relative オプションがセットされるとソースの中の (no)fragment オプション有無にかかわらず fragment が自動的、暗黙的にセットされます。

LilyPond もそれ自体のドキュメントを作り出すのに lilypond-book を使います。LilyPond のドキュメントを作るために、さらに細かな楽譜断片オプションが用意されています。

verbatim

LilyPond コマンドの引数をそのまま出力ファイルにコピーして、ブロックで囲み、その後に intertext オプションで与えられた任意のテキストが続きます (intertext オプションはまだ実装されていません)。それから実際の楽譜が表示されます。段落の一部となっている \lilypond{} でこのオプションを指定しても機能しません。

lilypondfile コマンドで verbatim を使用した場合、ソース ファイルの一部だけをそのままコピーして囲むことができます。ソース ファイルが ‘begin verbatim’ (引用符を除く) という文字列を含むコメントを保持している場合、最後の ‘begin verbatim’ より後のソースが引用されます。同様に、‘end verbatim’ を含むコメントがあれば、ソースの引用は最初の ‘end verbatim’ の前で終了します。以下のソース ファイル例で、楽譜コードは相対モードで解釈されますが、ソースの引用に relative ブロックは表示されません。つまり、

\relative { % begin verbatim
  c'4 e2 g4
  f2 e % end verbatim
}

上記のソースは以下のように引用されます。

  c4 e2 g4
  f2 e

ソースの引用の中にあるコメントと変数名を翻訳したけれども、ソース自体の中にあるコメントと変数名は翻訳したくない場合、環境変数 LYDOC_LOCALEDIR をディレクトリ パスにセットします – セットしたディレクトリはドメインに lilypond-doc を指定した.mo メッセージ カタログのツリーを保持する必要があります。

texidoc

(Texinfo 出力専用です) 入力ファイル foo.ly に対して --header=texidoc オプションを指定して lilypond を呼び出した場合、入力ファイルの \header に texidoc フィールドがあればファイル foo.texidoc が作成されます。texidoc オプションは lilypond-book にそのようなファイルをインクルードさせ、その内容を楽譜断片の直前 (ただし、quote オプションによって生成される example 環境の外側) にドキュメントとして追加させます。

ファイル foo.ly は以下を保持していて、

\header {
  texidoc = "This file demonstrates a single note."
}
{ c'4 }

Texinfo ドキュメント test.texinfo に以下の記述があると仮定すると、

@lilypondfile[texidoc]{foo.ly}

以下のコマンドで期待した結果を得られます。

lilypond-book --pdf --process="lilypond \
  --header=texidoc" test.texinfo

たいていの LilyPond テスト ドキュメント (配布ソースの input ディレクトリにあります) はこのような形の小さな .ly ファイルです。

ローカライズするために Texinfo ドキュメントが @documentlanguage LANG 保持していて、foo.ly のヘッダが texidocLANG フィールドを保持している場合、--header=texidocLANG を付けて lilypond を呼び出すと、foo.texidoc の代わりに foo.texidocLANG がインクルードされます。

doctitle

(Texinfo 出力専用です) このオプションは texidoc オプションと同じような働きをします: \header に doctitle フィールドを持つ入力ファイル foo.ly に対して --header=doctitle オプションを指定して lilypond を呼び出した場合、foo.doctitle が生成されます。doctitle オプションを使用した場合、foo.doctitle の内容 – 1 行のテキスト text である必要があります – は Texinfo ドキュメントに @lydoctitle text として挿入されます。@lydoctitle は Texinfo ドキュメントの中で定義されたマクロである必要があります。あとはローカライズされた言語に対する texidoc 処理と同じ説明になります。

nogettext

(Texinfo 出力専用です) 楽譜ソース引用の中にあるコメントと変数名を翻訳しません。

printfilename

\lilypondfile で LilyPond 入力ファイルをインクルードした場合、楽譜断片の直前にインクルードしたファイルの名前を表示します。HTML 出力では、これはリンクになります。ファイルのベース名だけが表示されます – つまり、ファイル パスのディレクトリ部分は取り除かれます。