X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2Flilypond-book.itely;h=08f50350cdac62fd4029bbe3b61d43c24c9cc242;hb=d9eae1e3bede9ecd812f8bc29ea588d6353e5b4e;hp=543a4cdd429b884170bfdaa59cf354f2218e6fbd;hpb=fff60a761b1e447aa316ab55e64bf8c419e69950;p=lilypond.git diff --git a/Documentation/user/lilypond-book.itely b/Documentation/user/lilypond-book.itely index 543a4cdd42..08f50350cd 100644 --- a/Documentation/user/lilypond-book.itely +++ b/Documentation/user/lilypond-book.itely @@ -1,5 +1,5 @@ @c -*- coding: utf-8; mode: texinfo; -*- -@c This file is part of lilypond.tely +@c This file is part of lilypond-program.tely @ignore Translation of GIT committish: FILL-IN-HEAD-COMMITTISH @@ -8,18 +8,6 @@ @end ignore -@ignore - -TODO: cleanup - -** AARGH. We also have tutorial.itely: Integrating text and music. - - Could also do with a cleanup. Lost inspiration to fix this manual - where to describe what? - -@end ignore - - @c Note: keep this node named so that `info lilypond-book' brings you here. @node LilyPond-book @chapter @command{lilypond-book}: Integrating text and music @@ -27,7 +15,7 @@ TODO: cleanup If you want to add pictures of music to a document, you can simply do it the way you would do with other types of pictures. The pictures are created separately, yielding PostScript output or PNG images, and those -are included into a La@TeX{} or HTML document. +are included into a @LaTeX{} or HTML document. @command{lilypond-book} provides a way to automate this process: This program extracts snippets of music from your document, runs @@ -35,20 +23,30 @@ program extracts snippets of music from your document, runs substituted for the music. The line width and font size definitions for the music are adjusted to match the layout of your document. -This procedure may be applied to La@TeX{}, HTML, Texinfo or DocBook documents. +This is a separate programs from lilypond itself, and is run +on the command-line; see @ref{Command-line usage} for more information. + +This procedure may be applied to @LaTeX{}, HTML, Texinfo or DocBook documents. + +@cindex texinfo +@cindex latex +@cindex texinfo +@cindex texi +@cindex html +@cindex docbook +@cindex documents, adding music to +@cindex HTML, music in +@cindex Texinfo, music in +@cindex DocBook, music in +@cindex @LaTeX{}, music in @menu * An example of a musicological document:: -* Integrating LaTeX and music:: -* Integrating Texinfo and music:: -* Integrating HTML and music:: -* Integrating DocBook and music:: +* Integrating music and text:: * Music fragment options:: * Invoking lilypond-book:: * Filename extensions:: -* Many quotes of a large score:: -* Inserting LilyPond output into OpenOffice.org:: -* Inserting LilyPond output into other programs:: +* Alternate methods of mixing text and music:: @end menu @@ -56,21 +54,19 @@ This procedure may be applied to La@TeX{}, HTML, Texinfo or DocBook documents. @section An example of a musicological document @cindex musicology -@cindex La@TeX{}, music in -@cindex HTML, music in -@cindex Texinfo, music in -@cindex DocBook, music in Some texts contain music examples. These texts are musicological treatises, songbooks, or manuals like this. Such texts can be made by hand, simply by importing a PostScript figure into the word processor. However, there is an automated procedure to reduce the amount of work -involved in HTML, La@TeX{}, Texinfo and DocBook documents. +involved in HTML, @LaTeX{}, Texinfo and DocBook documents. A script called @code{lilypond-book} will extract the music fragments, format them, and put back the resulting notation. Here we show a small -example for use with La@TeX{}. The example also contains explanatory +example for use with @LaTeX{}. The example also contains explanatory text, so we will not comment on it further. +@subheading Input + @quotation @verbatim \documentclass[a4paper]{article} @@ -101,6 +97,8 @@ Larger examples can be put into a separate file, and introduced with @end verbatim @end quotation +@subheading Processing + Under Unix, you can view the results as follows @example @@ -135,12 +133,14 @@ the files in a separate subdirectory @file{dir}. Running dvips will produce many warnings about fonts. They are not harmful; please ignore them. -Finally the result of the La@TeX{} example shown above.@footnote{This +Finally the result of the @LaTeX{} example shown above.@footnote{This tutorial is processed with Texinfo, so the example gives slightly different results in layout.} This finishes the tutorial section. @page +@subheading Output + Documents for @command{lilypond-book} may freely mix music and text. For example, @@ -161,28 +161,32 @@ Larger examples can be put into a separate file, and introduced with @lilypondfile[quote,noindent]{screech-boink.ly} + @page -@cindex texinfo -@cindex latex -@cindex texinfo -@funindex texi -@cindex html -@cindex docbook -@cindex documents, adding music to +@node Integrating music and text +@section Integrating music and text + +Here we explain how to integrate LilyPond with various output formats. +@menu +* LaTeX:: +* Texinfo:: +* HTML:: +* DocBook:: +@end menu -@node Integrating LaTeX and music -@section Integrating La@TeX{} and music +@node LaTeX +@subsection @LaTeX{} -La@TeX{} is the de-facto standard for publishing layouts in the exact +@LaTeX{} is the de-facto standard for publishing layouts in the exact sciences. It is built on top of the @TeX{} typesetting engine, providing the best typography available anywhere. See @uref{http://@/www@/.ctan@/.org/@/tex@/-archive/@/info/@/lshort/@/english/, -@emph{The Not So Short Introduction to La@TeX{}}} for an overview on how -to use La@TeX{}. +@emph{The Not So Short Introduction to @LaTeX{}}} for an overview on how +to use @LaTeX{}. Music is entered using @@ -207,7 +211,7 @@ or @end example Running @command{lilypond-book} yields a file that can be further -processed with La@TeX{}. +processed with @LaTeX{}. We show some examples here. The lilypond environment @@ -243,13 +247,13 @@ Currently, you cannot include @code{@{} or @code{@}} within The default line width of the music will be adjusted by examining the commands in the document preamble, the part of the document before @code{\begin@{document@}}. The @command{lilypond-book} command sends -these to La@TeX{} to find out how wide the text is. The line width for +these to @LaTeX{} to find out how wide the text is. The line width for the music fragments is then adjusted to the text width. Note that this heuristic algorithm can fail easily; in such cases it is necessary to use the @code{line-width} music fragment option. @cindex titling and lilypond-book -@funindex \header in La@TeX{} documents +@cindex \header in @LaTeX{} documents Each snippet will call the following macros if they have been defined by the user: @@ -299,7 +303,7 @@ kpsewhich feta20.tex @cindex dvips @cindex invoking dvips -For printing the La@TeX{} document you need a DVI to PostScript +For printing the @LaTeX{} document you need a DVI to PostScript translator like @command{dvips}. To use @command{dvips} to produce a PostScript file, add the following options to the @command{dvips} command line: @@ -310,7 +314,7 @@ command line: @noindent where the @var{file}@command{psfonts} file is obtained from -@command{lilypond-book}, @xref{Invoking lilypond-book}, for details. PDF +@command{lilypond-book}, @xref{Invoking lilypond-book}, for details. PDF can then be produced with a PostScript to PDF translator like @code{ps2pdf} (which is part of GhostScript). Running @command{dvips} will produce some warnings about fonts; these are harmless and may @@ -327,7 +331,7 @@ as if they continued after the end of the fragment. This can be done by breaking the staff and suppressing inclusion of the rest of the lilypond output. -In La@TeX{}, define @code{\betweenLilyPondSystem} in such a way that +In @LaTeX{}, define @code{\betweenLilyPondSystem} in such a way that inclusion of other systems is terminated once the required number of systems are included. Since @code{\betweenLilypondSystem} is first called @b{after} the first system, including only the first system @@ -342,8 +346,8 @@ is trivial. @end example If a greater number of systems is requested, a TeX conditional must be -used before the @code{\endinput}. In this example, replace "2" by -the numer of systems you want in the output, +used before the @code{\endinput}. In this example, replace @q{2} by +the number of systems you want in the output, @example \def\betweenLilyPondSystem#1@{ @@ -352,7 +356,7 @@ the numer of systems you want in the output, @end example Remember that the definition of @code{\betweenLilyPondSystem} is -effective until @TeX{} quits the current group (such as the La@TeX{} +effective until @TeX{} quits the current group (such as the @LaTeX{} environment) or is overridden by another definition (which is, in most cases, for the rest of the document). To reset your definition, write @@ -383,8 +387,8 @@ and then saying only how many systems you want before each fragment, @end example -@node Integrating Texinfo and music -@section Integrating Texinfo and music +@node Texinfo +@subsection Texinfo 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 @@ -443,7 +447,7 @@ produces @lilypond[fragment,staffsize=11]{} -Contrary to La@TeX{}, @code{@@lilypond@{...@}} does not generate an +Contrary to @LaTeX{}, @code{@@lilypond@{...@}} does not generate an in-line image. It always gets a paragraph of its own. When using the Texinfo output format, @command{lilypond-book} also @@ -451,8 +455,8 @@ generates bitmaps of the music (in PNG format), so you can make an HTML document with embedded music. -@node Integrating HTML and music -@section Integrating HTML and music +@node HTML +@subsection HTML Music is entered using @@ -487,25 +491,25 @@ To include separate files, say @cindex preview image @cindex thumbnail -@node Integrating DocBook and music -@section Integrating DocBook and music +@node DocBook +@subsection DocBook For inserting LilyPond snippets it is good to keep the conformity of our DocBook document, thus allowing us to use DocBook editors, validation etc. So we don't use custom tags, only specify a convention based on the standard DocBook elements. -@unnumberedsubsec Common conventions +@subheading Common conventions For inserting all type of snippets we use the @code{mediaobject} and @code{inlinemediaobject} element, so our snippets can be formatted inline or not inline. -The snippet formatting options are always provided in the @code{role} property of the innermost element (see in next sections). Tags are +The snippet formatting options are always provided in the @code{role} property of the innermost element (see in next sections). Tags are chosen to allow DocBook editors format the content gracefully. The DocBook files to be processed with @command{lilypond-book} should have the extension @file{.lyxml}. -@unnumberedsubsec Including a LilyPond file +@subheading Including a LilyPond file -This is the most simple case. We must use the @file{.ly} extension for the included file, and insert it as a standard @code{imageobject}, +This is the most simple case. We must use the @file{.ly} extension for the included file, and insert it as a standard @code{imageobject}, with the following structure: @example @@ -518,7 +522,7 @@ with the following structure: Note that you can use mediaobject or inlinemediaobject as the outermost element as you wish. -@unnumberedsubsec Including LilyPond code +@subheading Including LilyPond code Including LilyPond code is possible by using a @code{programlisting}, where the language is set to @code{lilypond} with the following structure: @@ -537,11 +541,17 @@ Including LilyPond code is possible by using a @code{programlisting}, where the As you can see, the outermost element is a @code{mediaobject} or @code{inlinemediaobject}, and there is a @code{textobject} containing the @code{programlisting} inside. -@unnumberedsubsec Processing the DocBook document +@subheading Processing the DocBook document + +Running @command{lilypond-book} on our @file{.lyxml} file will create a +valid DocBook document to be further processed with @file{.xml} +extension. If you use +@uref{http://@/dblatex@/.sourceforge@/.net@/,dblatex}, it will create a +PDF file from this document automatically. For HTML (HTML Help, +JavaHelp etc.) generation you can use the official DocBook XSL +stylesheets, however, it is possible that you have to make some +customization for it. -Running @command{lilypond-book} on our @file{.lyxml} file will create a valid DocBook document to be further processed with @file{.xml} extension. -If you use @uref{http://@/dblatex@/.sourceforge@/.net@/,dblatex}, it will create a PDF file from this document automatically. -For HTML (HTML Help, JavaHelp etc.) generation you can use the official DocBook XSL stylesheets, however, it is possible that you have to make some customization for it. @node Music fragment options @section Music fragment options @@ -549,7 +559,7 @@ For HTML (HTML Help, JavaHelp etc.) generation you can use the official DocBook In the following, a @q{LilyPond command} refers to any command described in the previous sections which is handled by @command{lilypond-book} to produce a music snippet. For simplicity, LilyPond commands are only -shown in La@TeX{} syntax. +shown in @LaTeX{} syntax. Note that the option string is parsed from left to right; if an option occurs multiple times, the last one is taken. @@ -685,7 +695,7 @@ a link. @item fontload This option includes fonts in all of the generated EPS-files for this -snippet. This should be used if the snippet uses any font that LaTeX +snippet. This should be used if the snippet uses any font that LaTeX cannot find on its own. @end table @@ -783,14 +793,14 @@ cd out ... @end example -@itemx --padding=@var{amount} +@itemx --left-padding=@var{amount} Pad EPS boxes by this much. @var{amount} is measured in milimeters, and is 3.0 by default. This option should be used if the lines of music stick out of the right margin. The width of a tightly clipped systems can vary, due to notation elements that stick into the left margin, such as bar numbers and -instrument names. This option will shorten each line and move each +instrument names. This option will shorten each line and move each line to the right by the same amount. @@ -816,7 +826,7 @@ Print version information. @refbugs The Texinfo command @code{@@pagesizes} is not interpreted. Similarly, -La@TeX{} commands that change margins and line widths after the preamble +@LaTeX{} commands that change margins and line widths after the preamble are ignored. Only the first @code{\score} of a LilyPond block is processed. @@ -837,11 +847,11 @@ output format based on the input filename's extension. @item @item @file{.html} @tab HTML @item @file{.itely} @tab Texinfo -@item @file{.latex} @tab La@TeX{} -@item @file{.lytex} @tab La@TeX{} +@item @file{.latex} @tab @LaTeX{} +@item @file{.lytex} @tab @LaTeX{} @item @file{.lyxml} @tab DocBook @item @file{.tely} @tab Texinfo -@item @file{.tex} @tab La@TeX{} +@item @file{.tex} @tab @LaTeX{} @item @file{.texi} @tab Texinfo @item @file{.texinfo} @tab Texinfo @item @file{.xml} @tab HTML @@ -849,15 +859,24 @@ output format based on the input filename's extension. @end quotation -@node Many quotes of a large score -@section Many quotes of a large score +@node Alternate methods of mixing text and music +@section Alternative methods of mixing text and music + +@menu +* Many quotes from a large score:: +* Inserting LilyPond output into OpenOffice.org:: +* Inserting LilyPond output into other programs:: +@end menu + +@node Many quotes from a large score +@subsection Many quotes from a large score -If you need to quote many fragments of a large score, you can also use -the clip systems feature, see @ref{Extracting fragments of notation}. +If you need to quote many fragments from a large score, you can also use +the clip systems feature, see @ruser{Extracting fragments of notation}. @node Inserting LilyPond output into OpenOffice.org -@section Inserting LilyPond output into OpenOffice.org +@subsection Inserting LilyPond output into OpenOffice.org @cindex OpenOffice.org @@ -866,7 +885,7 @@ LilyPond notation can be added to OpenOffice.org with @node Inserting LilyPond output into other programs -@section Inserting LilyPond output into other programs +@subsection Inserting LilyPond output into other programs To insert LilyPond output in other programs, use @code{lilypond} instead of @code{lilypond-book}. Each example must be created @@ -893,6 +912,6 @@ the following options To produce a useful @file{eps} file, use @example -lilypond -b eps -dno-gs-load-fonts -dinclude-eps-fonts myfile.ly +lilypond -dbackend=eps -dno-gs-load-fonts -dinclude-eps-fonts myfile.ly @end example