3.2.2 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 versions of the manual are made from the Texinfo document.

lilypond-book provides the following commands and environments to include music in Texinfo files:

In the input file, music is specified with any of the following commands

@lilypond[options,go,here]
  YOUR LILYPOND CODE
@end lilypond

@lilypond[options,go,here]{ YOUR LILYPOND CODE }

@lilypondfile[options,go,here]{filename}

@musicxmlfile[options,go,here]{filename}

Additionally, @lilypondversion displays the current version of LilyPond.

The lilypond environment must start a line (possibly preceded by whitespace), even if used with the inline fragment option. Similarly, @end lilypond can be preceded by whitespace, but no text is allowed after it. If the environment has options, the opening bracket must be on the same line as the lilypond keyword (this does not hold for the commands that take its argument in braces). Except for this restriction, whitespace and line breaks are allowed before, in, and after the command options. Unbalanced opening or closing braces are not supported within @lilypond{...}.

When lilypond-book is run on it, this results in a Texinfo file (with extension .texi) containing @image tags for HTML, Info and printed output. lilypond-book generates images of the music in EPS and PDF formats for use in the printed output, and in PNG format for use in HTML and Info output.

We show some examples here. The lilypond environment

@lilypond[quote,fragment]
  c'4 d' e' f' g'2 g'
@end lilypond

produces

[image of music]

The short version

@lilypond[quote,fragment,staffsize=11]{<c' e' g'>}

produces

[image of music]

See also

There are specific lilypond-book command-line options and other details to know when processing Texinfo documents, see Invoking lilypond-book.


LilyPond Application Usage v2.27.2 (development-branch).