X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;ds=sidebyside;f=Documentation%2Fusage%2Flilypond-book.itely;h=5a98ab492cdb79abf80d8c980953862a49364f71;hb=7b46bbecb1628b100a282d2554db5f79caba20cb;hp=d1018be507685bbcd4dad5dc0c3988cf90bbe8c9;hpb=bb8a0a5387af94dd2702877256334b160575a730;p=lilypond.git diff --git a/Documentation/usage/lilypond-book.itely b/Documentation/usage/lilypond-book.itely index d1018be507..5a98ab492c 100644 --- a/Documentation/usage/lilypond-book.itely +++ b/Documentation/usage/lilypond-book.itely @@ -128,7 +128,7 @@ xpdf lilybook Running @command{lilypond-book} and @command{latex} creates a lot of temporary files, which would clutter up the working directory. To -remedy this, use the @code{--output=@var{dir}} option. It will create +remedy this, use the @option{--output=@var{dir}} option. It will create the files in a separate subdirectory @file{dir}. Finally the result of the @LaTeX{} example shown above.@footnote{This @@ -200,27 +200,44 @@ See @emph{The Not So Short Introduction to @LaTeX{}}} for an overview on how to use @LaTeX{}. -Music is entered using +@code{lilypond-book} provides the following commands and environments to include +music in @LaTeX{} files: + +@itemize + +@item +the @code{\lilypond@{...@}} command, where you can directly enter short +lilypond code + +@item +the @code{\begin@{lilypond@}...\end@{lilypond@}} environment, where you +can directly enter longer lilypond code + +@item +the @code{\lilypondfile@{...@}} command to insert a lilypond file + +@item +the @code{\musicxmlfile@{...@}} command to insert a MusicXML file, which +will be processed by @code{musicxml2ly} and @code{lilypond}. + +@end itemize + +In the input file, music is specified with any of the following commands @example \begin@{lilypond@}[options,go,here] YOUR LILYPOND CODE \end@{lilypond@} -@end example -@noindent -or +\lilypond[options,go,here]@{ YOUR LILYPOND CODE @} -@example \lilypondfile[options,go,here]@{@var{filename}@} + +\musicxmlfile[options,go,here]@{@var{filename}@} @end example -@noindent -or -@example -\lilypond[options,go,here]@{ YOUR LILYPOND CODE @} -@end example +@noindent Additionally, @code{\lilypondversion} displays the current version of lilypond. @@ -397,26 +414,40 @@ Texinfo is the standard format for documentation of the GNU project. An example of a Texinfo document is this manual. The HTML, PDF, and Info versions of the manual are made from the Texinfo document. -In the input file, music is specified with +@code{lilypond-book} provides the following commands and environments to include +music into Texinfo files: + +@itemize + +@item +the @code{@@lilypond@{...@}} command, where you can directly enter short +lilypond code + +@item +the @code{@@lilypond...@@end lilypond} environment, where you can directly +enter longer lilypond code + +@item +the @code{@@lilypondfile@{...@}} command to insert a lilypond file + +@item +the @code{@@musicxmlfile@{...@}} command to insert a MusicXML file, which +will be processed by @code{musicxml2ly} and @code{lilypond}. + +@end itemize + +In the input file, music is specified with any of the following commands @example @@lilypond[options,go,here] YOUR LILYPOND CODE @@end lilypond -@end example - -@noindent -or -@example @@lilypond[options,go,here]@{ YOUR LILYPOND CODE @} -@end example - -@noindent -or -@example @@lilypondfile[options,go,here]@{@var{filename}@} + +@@musicxmlfile[options,go,here]@{@var{filename}@} @end example Additionally, @code{@@lilypondversion} displays the current version @@ -461,8 +492,51 @@ in-line image. It always gets a paragraph of its own. @node HTML @subsection HTML -Music is entered using +@code{lilypond-book} provides the following commands and environments to include +music in HTML files: + +@itemize + +@item +the @code{} command, where you can directly enter short lilypond code + +@item +the @code{...} environment, where you can directly enter longer +lilypond code + +@item +the @code{...} command to insert a lilypond file + +@item +the @code{...} command to insert a MusicXML file, which +will be processed by @code{musicxml2ly} and @code{lilypond}. + +@end itemize + +In the input file, music is specified with any of the following commands + +\begin@{lilypond@}[options,go,here] + YOUR LILYPOND CODE +\end@{lilypond@} + +\lilypond[options,go,here]@{ YOUR LILYPOND CODE @} + +\lilypondfile[options,go,here]@{@var{filename}@} + +\musicxmlfile[options,go,here]@{@var{filename}@} +@example + + YOUR LILYPOND CODE + + + +@var{filename} + +@var{filename} +@end example + +For example, you can write @example \key c \minor c4 es g2 @@ -490,6 +564,9 @@ To include separate files, say @var{filename} @end example +@code{} uses the same syntax as @code{}, but simply +references a MusicXML file rather than a LilyPond file. + For a list of options to use with the @code{lilypond} or @code{lilypondfile} tags, see @ref{Music fragment options}. @@ -845,7 +922,7 @@ will be included in the @file{.ps} and @file{.pdf} files. Running @command{dvips} may produce some warnings about fonts; these are harmless and may be ignored. If you are running @command{latex} in -twocolumn mode, remember to add @code{-t landscape} to the +twocolumn mode, remember to add @option{-t landscape} to the @command{dvips} options. @subsubheading Texinfo @@ -902,7 +979,7 @@ Add @var{dir} to the include path. @command{lilypond-book} also looks for already compiled snippets in the include path, and does not write them back to the output directory, so in some cases it is necessary to invoke further processing commands such as @command{makeinfo} or -@command{latex} with the same @code{-I @var{dir}} options. +@command{latex} with the same @option{-I @var{dir}} options. @item -o @var{dir} @itemx --output=@var{dir} @@ -927,7 +1004,7 @@ Do not fail if no PNG images are found for EPS files. It is used for LilyPond Info documentation without images. @itemx --lily-output-dir=@var{dir} -Write lily-XXX files to directory @var{dir}, link into @code{--output} +Write lily-XXX files to directory @var{dir}, link into @option{--output} directory. Use this option to save building time for documents in different directories which share a lot of identical snippets. @@ -953,8 +1030,8 @@ line to the right by the same amount. @item -P @var{command} @itemx --process=@var{command} Process LilyPond snippets using @var{command}. The default command is -@code{lilypond}. @code{lilypond-book} will not @code{--filter} and -@code{--process} at the same time. +@code{lilypond}. @code{lilypond-book} will not @option{--filter} and +@option{--process} at the same time. @item --pdf Create PDF files for use with PDF@LaTeX{}. @@ -966,8 +1043,8 @@ all output to log files in the same directory as the source files. @itemx --use-source-file-names Write snippet output files with the same base name as their source file. This option works only for snippets included with @code{lilypondfile} -and only if directories implied by @code{--output-dir} and -@code{--lily-output-dir} options are different. +and only if directories implied by @option{--output-dir} and +@option{--lily-output-dir} options are different. @item -V @itemx --verbose @@ -1017,7 +1094,7 @@ selects the output format based on the input filename's extension. If you use the same filename extension for the input file than the extension @command{lilypond-book} uses for the output file, and if the input file is in the same directory as @command{lilypond-book} working -directory, you must use @code{--output} option to make +directory, you must use @option{--output} option to make @command{lilypond-book} running, otherwise it will exit with an error message like @qq{Output would overwrite input file}.