nächstes: lilypond-book aufrufen, voriges: Noten in Text integrieren, aufwärts: LilyPond-book
Im Folgenden meint ‚LilyPond-Kommando‘ ein beliebiges in den vorgehenden Abschnitten beschriebenes Kommando, welches ein LilyPond-Fragment in eine Datei einfügt und von lilypond-book verarbeitet wird. Der Einfachheit halber werden hier alle LilyPond-Kommandos in der Syntax von LaTeX dargestellt.
Zu beachten ist, dass die Optionen eines LilyPond-Kommandos von links nach rechts verarbeitet werden. Wenn eine Option also mehrfach angegeben wird, wird nur die letzte benutzt.
Die folgenden Optionen können für LilyPond-Kommandos benutzt werden:
staffsize=
htragged-right
ragged-right = ##t
wird in das Musikfragment
eingefügt. Dies ist die Standardeinstellung für das \lilypond{}
Kommando, wenn die Option line-width
nicht angegeben wird.
Ebenso ist dies die Standardeinstellung für die lilypond
-Umgebung,
wenn die Option fragment
, aber keine Zeilenlänge
explizit angegeben ist.
noragged-right
ragged-right = ##f
in das Musikfragment eingefügt.
packed
packed = ##t
in das Musikfragment eingefügt.
line-width
line-width=
Breite\
Einheitcm
, mm
, in
oder pt
. Diese Option hat
nur Einfluss auf die Breite von Notenzeilen und Text im Musikfragment, nicht
jedoch auf den restlichen Text des Dokuments.
Wird diese Option ohne einen Wert angegeben, wird die Zeilenbreite auf einen Standardwert gesetzt, der durch einen heuristischen Algorithmus bestimmt wird.
Wenn die line-width
Option nicht angegeben wird, versucht
lilypond-book einen geeigneten Standardwert für alle
lilypond
-Umgebungen zu finden, die die ragged-right
Option
nicht benutzen.
notime
fragment
c'4
ohne \layout
, \score
, etc. eingegeben werden kann.
nofragment
indent=
Einzug\
Einheitcm
, mm
, in
oder pt
. Diese
Option hat nur Einfluss auf den Einzug von Notenzeilen und Text im
Musikfragment, nicht jedoch auf den restlichen Text des Dokuments.
noindent
quote
exampleindent
Option angepasst werden.
exampleindent
quote
Option eingerückt wird.
relative
relative=
n1
das mittlere C bedeutet. Die relative
Option macht nur
Sinn in Verbindung mit der fragment
Option, weshalb fragment
automatisch durch die Angabe der relative
Option impliziert wird.
Eine explizite Angabe der (no)fragment
Option hat keinen Effekt.
LilyPond benutzt zur Erzeugung seiner eigenen Dokumentation ebenfalls lilypond-book. Zu diesem Zweck stehen noch zahlreiche spezialisierte Optionen zur Verfügung:
verbatim
intertext
Option1 und der
Grafik des tatsächlichen Notensatzes. Diese Option funktioniert nur
fehlerhaft, wenn \lilypond{}
im Fließtext benutzt wird.
Wird verbatim
in Verbindung mit einem lilypondfile
-Kommando
benutzt, so ist es auch möglich, nur ein Teil der Datei wörtlich einfügen
zu lassen: Wenn die eingebundene LilyPond-Datei ein Kommentar mit dem Inhalt
‘begin verbatim’ (ohne Anführungszeichen) enthält, wird nur der
Dateiinhalt ab dieser Position eingefügt. Enthält die Datei mehrere
solche Kommentare, wirkt nur das letzte. Analog wird nur der Dateiinhalt
bis zu einem etwaigen Kommentar mit dem Inhalt ‘end verbatim’
eingefügt. Im folgenden Beispiel wird das gesamte Musik für die
Erzeugung der Grafik im relativen Oktavenmodus interpretiert, der
wörtlich in das Dokument kopierte LilyPond-Code zeigt den relative
-Befehl jedoch nicht.
\relative c' { % begin verbatim c4 e2 g4 f2 e % end verbatim }
erzeugt ein Zitat der Form
c4 e2 g4 f2 e
addversion
\version
@w{"@version{}"}
an den Beginn des Fragments der Ausgabe mit
verbatim
.
texidoc
texidoc
-Feld im
\header
-Block, so wird dessen Inhalt in die Datei
foo.texidoc ausgegeben. Die texidoc
Option veranlasst
lilypond-book
, den Inhalt dieser .texidoc Dateien innerhalb
eines Dokumentationsblocks direkt vor dem Musikfragment in das aktuelle
Dokument einzufügen.
Enthält also die Datei foo.ly etwa den LilyPond-Code
\header { texidoc = "Dieses Beispiel zeigt eine einzelne Note." } { c'4 }
und das Texinfo-Dokument text.texinfo
@lilypondfile[texidoc]{foo.ly}
so liefert der folgende Aufruf von lilypond-book
das gewünschte
Ergebnis:
lilypond-book --process="lilypond --format=tex --tex \ --header=texidoc test.texinfo
Die meisten Test-Dateien (im input/ Verzeichnis von LilyPond) sind kleine .ly Dateien von genau dieser Form.
Auch die Übersetzung dieser zusätzlichen Kommentare ist möglich:
Dazu muss das Texinfo-Dokument den Befehl @documentlanguage
LANG
und der \header
Block in der Datei foo.ly
die Übersetzung im Feld texidoc
LANG enthalten. Wird nun
lilypond mit der Option --header=texidocLANG
aufgerufen, so wird der Inhalt der Datei foo.texidocLANG anstelle von foo.texidoc eingefügt.
lilyquote
quote
Option, außer dass nur das Musikfragment (und natürlich optional der
gesamte LilyPond-Code bei Benutzung von verbatim
) in den Zitatblock eingefügt wird. Dies ist nützlich, wenn Sie ein Musikfragment zitieren möchten, nicht aber dessen texidoc
Dokumentationsblock.
doctitle
texidoc
Option: Wenn lilypond mit der Option
--header=doctitle aufgerufen wird und die Eingabedatei
foo.ly ein Feld doctitle
im \header
-Block enthält,
wird dessen Wert in die Datei foo.doctitle geschrieben. Wird die
doctitle
Option für ein Musikfragment benutzt, so wird der Inhalt
dieser Datei, der eine einzelne Textzeile sein sollte, im Texinfo-Dokument
als @lydoctitle
Text eingefügt. @lydoctitle
muss
allerdings in Ihrem Texinfo-Dokument als Makro selbst definiert werden.
Die Übersetzung funktioniert völlig analog zu texidoc
.
printfilename
\lilypondfile
und dieser Option
eingebunden wird, wird der Dateiname (ohne die Pfadangabe) unmittelbar vor
dem Musikfragment ausgegeben. In HTML-Dateien ist er außerdem ein Link
auf die LilyPond-Datei.
fontload
Diese Seite ist für LilyPond-2.11.58 (Entwicklungszweig).
Fehler bitte an http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs melden.
Ihre Vorschläge für die Dokumentation sind willkommen.