summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support/lyluatex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2019-05-28 21:25:42 +0000
committerKarl Berry <karl@freefriends.org>2019-05-28 21:25:42 +0000
commita77f7d3afb1f5e076c5190ab9c84372e72dd67ba (patch)
tree07abaa851e7402501a55f39bf35690554541cbdb /Master/texmf-dist/doc/support/lyluatex
parent65ff5cb34596f15fda21e8d5b484b6d938b72c8a (diff)
lyluatex (28may19)
git-svn-id: svn://tug.org/texlive/trunk@51252 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/support/lyluatex')
-rw-r--r--Master/texmf-dist/doc/support/lyluatex/LICENSE2
-rw-r--r--Master/texmf-dist/doc/support/lyluatex/README.md11
-rw-r--r--Master/texmf-dist/doc/support/lyluatex/lyluatex.pdfbin1666763 -> 1664216 bytes
-rw-r--r--Master/texmf-dist/doc/support/lyluatex/lyluatex.tex686
-rw-r--r--Master/texmf-dist/doc/support/lyluatex/lyluatexbase.cls5
-rw-r--r--Master/texmf-dist/doc/support/lyluatex/lyluatexmanual.cls15
6 files changed, 451 insertions, 268 deletions
diff --git a/Master/texmf-dist/doc/support/lyluatex/LICENSE b/Master/texmf-dist/doc/support/lyluatex/LICENSE
index 3054be29583..515e3806dff 100644
--- a/Master/texmf-dist/doc/support/lyluatex/LICENSE
+++ b/Master/texmf-dist/doc/support/lyluatex/LICENSE
@@ -1,6 +1,6 @@
The MIT License (MIT)
-Copyright (c) 2015--2018 jperon and others
+Copyright (c) 2015--2019 jperon and others
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
diff --git a/Master/texmf-dist/doc/support/lyluatex/README.md b/Master/texmf-dist/doc/support/lyluatex/README.md
index 4d9f3690e52..18475559cca 100644
--- a/Master/texmf-dist/doc/support/lyluatex/README.md
+++ b/Master/texmf-dist/doc/support/lyluatex/README.md
@@ -84,3 +84,14 @@ That way, documents typeset with `lilypond-book` can be adapted to use
# Credits
Cf. [Contributors.md](Contributors.md)
+
+# Contributing
+
+If you want improvements or encounter an error, do not hesitate to
+to report the [issue](https://github.com/jperon/lyluatex/issues).
+If you have programming skills, you may also propose your changes
+via a [pull request](https://github.com/jperon/lyluatex/pulls).
+
+This extension is and will remain free; if you find it useful and
+wish to encourage its development by a
+[donation](https://www.paypal.me/abjperon), many thanks!
diff --git a/Master/texmf-dist/doc/support/lyluatex/lyluatex.pdf b/Master/texmf-dist/doc/support/lyluatex/lyluatex.pdf
index ea4de76b24f..adc90037912 100644
--- a/Master/texmf-dist/doc/support/lyluatex/lyluatex.pdf
+++ b/Master/texmf-dist/doc/support/lyluatex/lyluatex.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/support/lyluatex/lyluatex.tex b/Master/texmf-dist/doc/support/lyluatex/lyluatex.tex
index b36e17ff5f5..aaa95d7848b 100644
--- a/Master/texmf-dist/doc/support/lyluatex/lyluatex.tex
+++ b/Master/texmf-dist/doc/support/lyluatex/lyluatex.tex
@@ -40,37 +40,37 @@
\DefineVerbatimEnvironment{Highlighting}{Verbatim}{commandchars=\\\{\}}
% Add ',fontsize=\small' for more characters per line
\newenvironment{Shaded}{}{}
-\newcommand{\KeywordTok}[1]{\textcolor[rgb]{0.00,0.44,0.13}{\textbf{#1}}}
-\newcommand{\DataTypeTok}[1]{\textcolor[rgb]{0.56,0.13,0.00}{#1}}
-\newcommand{\DecValTok}[1]{\textcolor[rgb]{0.25,0.63,0.44}{#1}}
+\newcommand{\AlertTok}[1]{\textcolor[rgb]{1.00,0.00,0.00}{\textbf{#1}}}
+\newcommand{\AnnotationTok}[1]{\textcolor[rgb]{0.38,0.63,0.69}{\textbf{\textit{#1}}}}
+\newcommand{\AttributeTok}[1]{\textcolor[rgb]{0.49,0.56,0.16}{#1}}
\newcommand{\BaseNTok}[1]{\textcolor[rgb]{0.25,0.63,0.44}{#1}}
-\newcommand{\FloatTok}[1]{\textcolor[rgb]{0.25,0.63,0.44}{#1}}
-\newcommand{\ConstantTok}[1]{\textcolor[rgb]{0.53,0.00,0.00}{#1}}
+\newcommand{\BuiltInTok}[1]{#1}
\newcommand{\CharTok}[1]{\textcolor[rgb]{0.25,0.44,0.63}{#1}}
-\newcommand{\SpecialCharTok}[1]{\textcolor[rgb]{0.25,0.44,0.63}{#1}}
-\newcommand{\StringTok}[1]{\textcolor[rgb]{0.25,0.44,0.63}{#1}}
-\newcommand{\VerbatimStringTok}[1]{\textcolor[rgb]{0.25,0.44,0.63}{#1}}
-\newcommand{\SpecialStringTok}[1]{\textcolor[rgb]{0.73,0.40,0.53}{#1}}
-\newcommand{\ImportTok}[1]{#1}
\newcommand{\CommentTok}[1]{\textcolor[rgb]{0.38,0.63,0.69}{\textit{#1}}}
-\newcommand{\DocumentationTok}[1]{\textcolor[rgb]{0.73,0.13,0.13}{\textit{#1}}}
-\newcommand{\AnnotationTok}[1]{\textcolor[rgb]{0.38,0.63,0.69}{\textbf{\textit{#1}}}}
\newcommand{\CommentVarTok}[1]{\textcolor[rgb]{0.38,0.63,0.69}{\textbf{\textit{#1}}}}
-\newcommand{\OtherTok}[1]{\textcolor[rgb]{0.00,0.44,0.13}{#1}}
-\newcommand{\FunctionTok}[1]{\textcolor[rgb]{0.02,0.16,0.49}{#1}}
-\newcommand{\VariableTok}[1]{\textcolor[rgb]{0.10,0.09,0.49}{#1}}
+\newcommand{\ConstantTok}[1]{\textcolor[rgb]{0.53,0.00,0.00}{#1}}
\newcommand{\ControlFlowTok}[1]{\textcolor[rgb]{0.00,0.44,0.13}{\textbf{#1}}}
-\newcommand{\OperatorTok}[1]{\textcolor[rgb]{0.40,0.40,0.40}{#1}}
-\newcommand{\BuiltInTok}[1]{#1}
+\newcommand{\DataTypeTok}[1]{\textcolor[rgb]{0.56,0.13,0.00}{#1}}
+\newcommand{\DecValTok}[1]{\textcolor[rgb]{0.25,0.63,0.44}{#1}}
+\newcommand{\DocumentationTok}[1]{\textcolor[rgb]{0.73,0.13,0.13}{\textit{#1}}}
+\newcommand{\ErrorTok}[1]{\textcolor[rgb]{1.00,0.00,0.00}{\textbf{#1}}}
\newcommand{\ExtensionTok}[1]{#1}
+\newcommand{\FloatTok}[1]{\textcolor[rgb]{0.25,0.63,0.44}{#1}}
+\newcommand{\FunctionTok}[1]{\textcolor[rgb]{0.02,0.16,0.49}{#1}}
+\newcommand{\ImportTok}[1]{#1}
+\newcommand{\InformationTok}[1]{\textcolor[rgb]{0.38,0.63,0.69}{\textbf{\textit{#1}}}}
+\newcommand{\KeywordTok}[1]{\textcolor[rgb]{0.00,0.44,0.13}{\textbf{#1}}}
+\newcommand{\NormalTok}[1]{#1}
+\newcommand{\OperatorTok}[1]{\textcolor[rgb]{0.40,0.40,0.40}{#1}}
+\newcommand{\OtherTok}[1]{\textcolor[rgb]{0.00,0.44,0.13}{#1}}
\newcommand{\PreprocessorTok}[1]{\textcolor[rgb]{0.74,0.48,0.00}{#1}}
-\newcommand{\AttributeTok}[1]{\textcolor[rgb]{0.49,0.56,0.16}{#1}}
\newcommand{\RegionMarkerTok}[1]{#1}
-\newcommand{\InformationTok}[1]{\textcolor[rgb]{0.38,0.63,0.69}{\textbf{\textit{#1}}}}
+\newcommand{\SpecialCharTok}[1]{\textcolor[rgb]{0.25,0.44,0.63}{#1}}
+\newcommand{\SpecialStringTok}[1]{\textcolor[rgb]{0.73,0.40,0.53}{#1}}
+\newcommand{\StringTok}[1]{\textcolor[rgb]{0.25,0.44,0.63}{#1}}
+\newcommand{\VariableTok}[1]{\textcolor[rgb]{0.10,0.09,0.49}{#1}}
+\newcommand{\VerbatimStringTok}[1]{\textcolor[rgb]{0.25,0.44,0.63}{#1}}
\newcommand{\WarningTok}[1]{\textcolor[rgb]{0.38,0.63,0.69}{\textbf{\textit{#1}}}}
-\newcommand{\AlertTok}[1]{\textcolor[rgb]{1.00,0.00,0.00}{\textbf{#1}}}
-\newcommand{\ErrorTok}[1]{\textcolor[rgb]{1.00,0.00,0.00}{\textbf{#1}}}
-\newcommand{\NormalTok}[1]{#1}
\setlength{\emergencystretch}{3em} % prevent overfull lines
\providecommand{\tightlist}{%
\setlength{\itemsep}{0pt}\setlength{\parskip}{0pt}}
@@ -93,9 +93,9 @@
\title{\lyluatex}
\providecommand{\subtitle}[1]{}
-\subtitle{1.0b}
+\subtitle{1.0f}
\author{Fr. Jacques Peron \and Urs Liska \and Br. Samuel Springuel}
-\date{}
+\date{\lyluatexmanualdate}
\begin{document}
\maketitle
@@ -107,8 +107,8 @@
\hypertarget{introduction}{%
\section{Introduction}\label{introduction}}
-\lyluatex~is a \LaTeX~package that manages the inclusion of musical
-scores in \LaTeX~documents. It uses the GNU LilyPond\footnote{\url{http://lilypond.org}}
+\lyluatex~is a comprehensive \LuaLaTeX~package to manage the inclusion
+of musical scores in text documents. It uses the GNU LilyPond\footnote{\url{http://lilypond.org}}
score writer to produce beautiful music elements in beautifully typeset
text documents. \lyluatex~supports a wide range of use cases and lends
itself equally well to authoring musicological texts with music examples
@@ -119,10 +119,10 @@ and exams.
\lyluatex~is inspired by and provides a fully compatible drop-in
replacement to
\href{http://lilypond.org/doc/v2.18/Documentation/usage/invoking-lilypond_002dbook.html}{lilypond-book},
-a \LaTeX~document preprocessor shipping with LilyPond. However, thanks
-to the use of \LuaLaTeX~it can overcome substantial limitations of the
-scripted solution, and it actually is a \emph{superset} of
-\texttt{lilypond-book}, providing numerous additional features.
+a \LaTeX~document preprocessor shipping with LilyPond, which it actually
+is a \emph{superset} of. However, thanks to the use of \LuaLaTeX~it can
+overcome substantial usability limitations of the scripted solution and
+provide numerous additional features.
\lyluatex's main features include:
@@ -141,79 +141,89 @@ scripted solution, and it actually is a \emph{superset} of
Comprehensive configuration through global and per-score options
\end{itemize}
-\hypertarget{installation}{%
-\subsection{Installation}\label{installation}}
-
-\hypertarget{for-a-single-document}{%
-\subsubsection{For a single document}\label{for-a-single-document}}
-
-Copy \texttt{lyluatex.sty} and \texttt{lyluatex.lua} into the folder
-containing the document you wish to typeset.
-
-\hypertarget{for-all-documents-compiled-with-your-latex-distribution}{%
-\subsubsection{For all documents compiled with your LaTeX
-distribution}\label{for-all-documents-compiled-with-your-latex-distribution}}
-
-\hypertarget{texlive-version}{%
-\paragraph{TeXLive version}\label{texlive-version}}
-
-Just run this command~:
+What \lyluatex~does \emph{not} try to do is managing the handling of
+floating environments, counters and lists of music examples. The
+\emph{ly}\LuaTeX\textsc{mp} package\footnote{\url{https://github.com/uliska/lyluatexmp}}
+is currently under construction and practical testing and will
+eventually be released to become a suitable wrapper for using
+\lyluatex~to create numbered music examples.
+
+\hypertarget{installation-and-requirements}{%
+\subsection{Installation and
+Requirements}\label{installation-and-requirements}}
+
+\hypertarget{prerequisites}{%
+\subsubsection{Prerequisites}\label{prerequisites}}
+
+As the name \lyluatex~implies this package can only be used with the
+\LuaLaTeX~engine. For more information on this please refer to
+\protect\hyperlink{usage}{Usage} below.
+
+Musical scores are created in real-time (instead of incorporating
+pre-built \emph{image} files) using the GNU LilyPond\footnote{\url{http://lilypond.org}}
+score writer, so of course this has to be installed too.
+\lyluatex~should work with any versions of LilyPond but it has been
+developed against the stable and development versions that were current
+at the time of this writing: 2.18.2 and 2.19.83.
+
+\hypertarget{texlive-and-miktex}{%
+\subsubsection{TeXLive and MiKTeX}\label{texlive-and-miktex}}
+
+\lyluatex~is included in both the TeXLive and MiKTeX
+\LaTeX~distributions and can be installed through their package
+management systems. In TeXLive it is included in the
+\texttt{texlive-music} collection and -- of course -- in
+\texttt{texlive-full}. If neither of these collections is installed
+\lyluatex~can be added to a TeXLive installation by running
\begin{verbatim}
tlmgr install lyluatex
\end{verbatim}
-\hypertarget{latest-version}{%
-\paragraph{Latest version}\label{latest-version}}
+from the command line.
-Copy \texttt{lyluatex.sty} and \texttt{lyluatex.lua} from this
-repository into your \texttt{TEXMF} tree, or clone this repostory into
-your \texttt{TEXMF} tree using Git, then run \texttt{mktexlsr}. Note
-that in this case your local copy will shadow the version possibly
-installed in your \TeX~distribution.
+\textbf{TODO:} Document handling with MiKTeX.
-\hypertarget{usage}{%
-\section{Usage}\label{usage}}
+\hypertarget{latest-version}{%
+\subsubsection{Latest version}\label{latest-version}}
-\lyluatex~is loaded with the command
-\texttt{\textbackslash{}usepackage\{lyluatex\}} which also accepts a
-number of \texttt{key=value} options. Their general use is described in
-the \protect\hyperlink{option-handling}{Option Handling} section below.
+The \lyluatex~versions shipped with the \LaTeX~distributions may be
+significantly outdated so you may want to install and use the latest
+version from the Github repository\footnote{\url{https://github.com/jperon/lyluatex}}
+instead.
-By default \lyluatex~invokes LilyPond simply as \texttt{lilypond}. If
-LilyPond is installed in another location or a specific version of
-LilyPond should be used the invocation is controlled with the
-\option{program} option, see \protect\hyperlink{program}{The LilyPond
-Executable}.
-
-\lyIssue{Note:} \lyluatex~can only be used with \LuaLaTeX, and compiling
-with any other \LaTeX~engine will fail.
+Copy \texttt{lyluatex.sty} and \texttt{lyluatex.lua} from this
+repository into your \texttt{\$TEXMFHOME} tree, or clone this repostory
+into your \texttt{\$TEXMFHOME} tree using Git. In many cases this will
+be \texttt{\$HOME/texmf}, and \lyluatex~should be located below
+\texttt{\$TEXMFHOME/tex/luatex}. It is important that this is the
+\texttt{tex/luatex} subtree rather than \texttt{tex/latex}: if
+\lyluatex~should \emph{also} be present in the \LaTeX~distribution
+\LuaLaTeX~would otherwise find that version first and use that instead
+of your local clone.
+
+\lyMargin{Note:}
+
+It may be useful to clone the Git repository not into the
+\texttt{\$TEXMFHOME} tree directly but to some arbitrary location and
+link to that. Please note that \LuaLaTeX~will only follow such symbolic
+links if there is at least one \emph{real} subdirectory in each
+directory. So if there is a directory \texttt{\$TEXMFHOME/tex/luatex}
+containing \emph{only} symbolic links it is necessary to create a dummy
+subdirectory in it.
-\lyIssue{Note:} In order to avoid unexpected behaviour it is strongly
-suggested that documents are generally compiled from their actual
-directory, i.e.~without referring to it through a path.
+\hypertarget{for-a-single-document}{%
+\subsubsection{For a single document}\label{for-a-single-document}}
-\lyIssue{NOTE:} \lyluatex~requires that \LuaLaTeX~is started with the
-\texttt{-\/-shell-escape} command line option to enable the execution of
-arbitrary shell commands, which is necessary to let LilyPond compile the
-inserted scores on-the-fly and to perform some auxiliary shell
-operations. However, this opens a significant security hole, and only
-fully trusted input files should be compiled. You may mitigate (but not
-totally remove) this security hole by adding \texttt{lilypond} and
-\texttt{gs} to \texttt{shell\_escape\_commands}, and using
-\texttt{-\/-shell-restricted} instead of \texttt{-\/-shell-escape}: look
-at the documentation of your \TeX~distribution. For example, on Debian
-Linux with TeXLive:
+Copy \texttt{lyluatex.sty} and \texttt{lyluatex.lua} into the folder
+containing the document you wish to typeset.
-\begin{Shaded}
-\begin{Highlighting}[]
-\ExtensionTok{%}\NormalTok{ export shell_escape_commands=}\VariableTok{$(}\ExtensionTok{kpsewhich}\NormalTok{ -expand-var }\StringTok{'$shell_escape_commands'}\VariableTok{)}\NormalTok{,lilypond,gs}
-\ExtensionTok{%}\NormalTok{ lualatex --shell-restricted DOCUMENT.tex}
-\end{Highlighting}
-\end{Shaded}
+\hypertarget{usage}{%
+\section{Usage}\label{usage}}
-\hypertarget{basic-operation}{%
-\subsection{Basic Operation}\label{basic-operation}}
+\hypertarget{the-big-picture-and-caveats}{%
+\subsection{The Big Picture and
+caveats}\label{the-big-picture-and-caveats}}
Once \lyluatex~is loaded it provides commands and environments to
include musical scores and score fragments which are produced using the
@@ -224,7 +234,11 @@ the scores if necessary -- making use of an intelligent caching
mechanism --, and it will match the score's layout to that of the text
document. \lyluatex~will produce PDF image files which are automatically
included within the current paragraph, in their own paragraphs or as
-full pages.
+full pages. The behaviour of \lyluatex~and the appearance of the
+resulting scores are highly configurable through package, global, and
+per-score options which are globally described in the
+\protect\hyperlink{option-handling}{Option Handling} section below and
+in detail throughout the rest of this manual.
\lyluatex~aims at being an upwards-compatible drop-in replacement for
the \highlight{lilypond-book} preprocessor shipping with
@@ -257,6 +271,67 @@ So, if you want \lyluatex~to mimic as much as possible
\highlight{lilypond-book}, you should load it with options as follows:
\cmd{usepackage[nofragment, insert=systems]\{lyluatex\}}.
+\lyIssue{Note:}
+
+By default \lyluatex~invokes LilyPond simply as \texttt{lilypond}. If
+LilyPond is installed in another location or a specific version of
+LilyPond should be used the invocation is controlled with the
+\option{program} option, see \protect\hyperlink{program}{The LilyPond
+Executable}.
+
+\lyIssue{Note:} \lyluatex~can only be used with \LuaLaTeX, and compiling
+with any other \LaTeX~engine will fail.
+
+\lyIssue{Note:} In order to avoid unexpected behaviour it is strongly
+suggested that documents are generally compiled from their actual
+directory, i.e.~without referring to it through a path. This is because
+in many places during the compilation process relative paths are
+calculated from this starting point. Building \emph{out-of-tree} isn't
+supported, though it should be possible with the following workarounds:
+
+\begin{enumerate}
+\def\labelenumi{\arabic{enumi}.}
+\tightlist
+\item
+ \texttt{includepaths=\{..\}}: (for example, if you build from a
+ subdirectory of main directory) tell lyluatex to search the parent
+ directory;
+\item
+ if the book contain figures, enter only the name of the files, then
+ set two paths, e.g.:
+ \texttt{\textbackslash{}graphicspath\{\{images/\}\{../images/\}\}}, so
+ images will be found either way.
+\end{enumerate}
+
+\lyIssue{NOTE:} \lyluatex~requires that \LuaLaTeX~is started with the
+\texttt{-\/-shell-escape} command line option to enable the execution of
+arbitrary shell commands, which is necessary to let LilyPond compile the
+inserted scores on-the-fly and to perform some auxiliary shell
+operations. However, this opens a significant security hole, and only
+fully trusted input files should be compiled. You may mitigate (but not
+totally remove) this security hole by adding \texttt{lilypond} and
+\texttt{gs} to \texttt{shell\_escape\_commands}, and using
+\texttt{-\/-shell-restricted} instead of \texttt{-\/-shell-escape}: look
+at the documentation of your \TeX~distribution. For example, on Debian
+Linux with TeXLive:
+
+\begin{Shaded}
+\begin{Highlighting}[]
+\ExtensionTok{%}\NormalTok{ export shell_escape_commands=}\VariableTok{$(}\ExtensionTok{kpsewhich}\NormalTok{ -expand-var }\StringTok{'$shell_escape_commands'}\VariableTok{)}\NormalTok{,lilypond,gs}
+\ExtensionTok{%}\NormalTok{ lualatex --shell-restricted DOCUMENT.tex}
+\end{Highlighting}
+\end{Shaded}
+
+\hypertarget{basic-operation}{%
+\subsection{Basic Operation}\label{basic-operation}}
+
+\lyluatex~is loaded with the command
+\texttt{\textbackslash{}usepackage\{lyluatex\}} which also accepts a
+number of \texttt{key=value} options. Their general use is described in
+the \protect\hyperlink{option-handling}{Option Handling} section below.
+If LilyPond can be invoked through \texttt{lilypond} on the given system
+using the package without any options already provides a usable system.
+
\lyMargin{lilypond\index{lilypond}}
The basic mode of inserting scores into text documents is the
@@ -311,6 +386,15 @@ included in the text document. A hash value including the full content
and all options will be used to determine if the score has already been
compiled earlier, so unnecessary recompilations are avoided.
+\lyIssue{Note:} Despite its familiar appearance, this environment is
+very special, using a mechanism specific to \LuaLaTeX. One consequence
+is that you necessarily need a newline after
+\texttt{\textbackslash{}begin\{lilypond\}}, and before
+\texttt{\textbackslash{}end\{lilypond\}}; another is that you have to be
+careful when you want to wrap this environment in a custom one: see
+\protect\hyperlink{wrapping-commands}{Wrapping \lyluatex~commands} and
+the examples at the end of the manual.
+
\lyCmd{lilypond}
Very short fragments of LilyPond code can be entered inline using the
@@ -479,10 +563,28 @@ With this default option each score is compiled as a sequence of PDF
files representing one system each. By default the systems are separated
by a paragraph and a variable skip depending on the staffsize.
+\lyIssue{Note:}
+
+\option{insert=systems} implies the use of
+\texttt{lilypond-book-preamble.ly}. It is worth pointing out that the
+score will \emph{not} have any notion of pages anymore - resulting in
+the staff-staff spacing to be minimal/natural. Usually LilyPond will
+space out the inter-staff (not -system!) space when the page is not
+filled, but with \option{insert=systems} this will not happen. While
+this behavior is usually desirable when including score examples in
+text, it may result in suboptimal output for multi-page scores, when
+there's the typical issues of how many systems will fit on a page.
+
+Also notice that by default pages will be ragged-bottom, and LilyPond
+will not make any efforts to optimize page breaks.
+\cmd{betweenLilyPondSystem} can be used when the space between systems
+seems too tight, for example using something like
+\texttt{\textbackslash{}vfill}.
+
\lyCmd{betweenLilyPondSystem}
-However, if a macro \cmd{betweenLilyPondSystem} is defined it will be
-expanded between each system. This macro is documented in
+If a macro \cmd{betweenLilyPondSystem} is defined it will be expanded
+between each system. This macro is documented in
\href{http://lilypond.org/doc/v2.18/Documentation/usage/latex}{LilyPond
documentation}. It must accept one argument, which will be the number of
systems already printed in the score (`1' after the first system). With
@@ -540,6 +642,15 @@ in the score. By default this is set to \texttt{false}, so the default
setting of these two options means that LilyPond does \emph{not} print
page numbers while \LaTeX~continues to print headers and footers.
+The same may be achieved only for first page with
+\option{print-first-page-number}.
+
+\lyOption{first-page-number}{false}
+
+Normally, \lyluatex~should automatically determine the first page number
+of the score to match its place in the document. Should you like to
+force it to another value, you may do it thanks to this option.
+
\hypertarget{inline}{%
\subsubsection{Inline}\label{inline}}
@@ -685,6 +796,13 @@ indented; otherwise, they aren't. \option{noindent} is equivalent to
\option{indent=0pt}. Please also see the section about
\protect\hyperlink{indent}{Dynamic Indentation}.
+\lyOption{system-count}{}
+
+Forces LilyPond to produce a fixed number of systems. This may be useful
+when LilyPond breaks a score that can manually be squeezed to one system
+less, but it is also possible to spread out a score to more systems than
+LilyPond would consider necessary.
+
\lyOption{quote}{false}
This option, which is there for compatibility with
@@ -768,7 +886,9 @@ print-only=1]
}
\end{lilypond}
-\lyOption{max-protrusion}{\cmd{maxdimen}}\lyOption{max-left-protrusion}{default}\lyOption{max-right-protrusion}{default}
+\lyOption{max-protrusion}{\cmd{maxdimen}}
+\lyOption{max-left-protrusion}{default}
+\lyOption{max-right-protrusion}{default}
These options set the protrusion limit. If either of the \texttt{-left-}
or \texttt{-right-} options is unset then the value will be taken from
@@ -1116,7 +1236,9 @@ LilyPond score, and it may make the \emph{scores} look inconsistent with
each other. Therefore \lyluatex~by default passes the text document's
three font families to their directy LilyPond counterparts.
-\lyOption{rmfamily}{}\lyOption{sffamily}{}\lyOption{ttfamily}{}
+\lyOption{rmfamily}{}
+\lyOption{sffamily}{}
+\lyOption{ttfamily}{}
The roman, sans, and mono fonts can also be specified explicitly to be
passed into the LilyPond document independently from the text document's
@@ -1359,10 +1481,10 @@ Windows.
\lyOption{includepaths}{./}
-With the \option{includepaths} option a comma-separated list of search
-paths can be specified. These paths will be used by \lyluatex~to locate
-external files, and relative paths are searched for in the following
-order:
+With the \option{includepaths} option a comma-separated list (enclosed
+in curly brackets) of search paths can be specified. These paths will be
+used by \lyluatex~to locate external files, and relative paths are
+searched for in the following order:
\begin{itemize}
\tightlist
@@ -1381,6 +1503,14 @@ path, so they can be used for including files from within the LilyPond
code. Paths starting with the tilde will implicitly be expanded to
absolute paths in that process.
+\begin{Shaded}
+\begin{Highlighting}[]
+\FunctionTok{\textbackslash{}lysetoption}\NormalTok{\{includepaths\}\{}\FunctionTok{\textbackslash{}string}\NormalTok{~/lilypond-lib\}}
+
+\FunctionTok{\textbackslash{}lilypondfile}\NormalTok{[includepaths=\{}\FunctionTok{\textbackslash{}string}\NormalTok{~/lilypond-lib,/home/johndoe/project-lib\}]}
+\end{Highlighting}
+\end{Shaded}
+
\hypertarget{program}{%
\subsubsection{LilyPond Executable}\label{program}}
@@ -1454,6 +1584,36 @@ files might remove scores needed by \emph{other} documents. Therefore
\texttt{\textless{}documentname\textgreater{}.list} files and only
remove scores that are not referenced by \emph{any} list file.
+\hypertarget{writing-headers-to-include-file}{%
+\subsubsection{Writing headers to include
+file}\label{writing-headers-to-include-file}}
+
+\lyOption{write-headers}{false}
+
+When using \texttt{\textbackslash{}lilypondfile} it is possible to write
+a copy of the LilyPond headers defining the layout and appearance of the
+score to an include file. When working on the score in an external
+editor this makes it possible to include this file to see the score in
+the layout it will have in the final \LaTeX\\
+document. Using this option together with non-filebased scores makes no
+sense, therefore it is ignored while a warning is issued.
+
+\emph{NOTE}: Of course this will produce conflicts if a LilyPond file is
+used in multiple \LaTeX~documents.
+
+If set to a \emph{path} the LilyPond headers defining the layout and
+appearance of the score will be exported to a file
+\texttt{\textless{}path\textgreater{}/\textless{}input-file-basename\textgreater{}-lyluatex-headers.ily}.
+The target directory will be created if necessary.
+
+If set to a \emph{filename} (i.e.~a path with a file extension) the
+headers will be written to this specific file. This is useful because in
+most cases the headers will be consistent throughout a \LaTeX~document,
+so it should be unncecessary to copy them for all input files. A typical
+use case might be to specify one header file as a package option while
+overriding the option for specific scores that require different headers
+(e.g.~in combination with a different \texttt{staffsize})
+
\hypertarget{pdf-optimization}{%
\subsubsection{PDF optimization}\label{pdf-optimization}}
@@ -1472,7 +1632,10 @@ which will be detected and handled (if possible) by \lyluatex. The most
basic problem is when LilyPond can't be started at all. \lyluatex~will
correctly determine and report an error if \LuaLaTeX~has been started
without the \option{--shell-escape} option or if the \option{program}
-option doesn't point to a valid LilyPond executable.
+option doesn't point to a valid LilyPond executable. However, if the
+\option{showfailed} option is also set then only a \emph{warning} is
+issued while instead of a score an information box is created in the
+document, informing about the problem.
Two other situations that are correctly recognized are when LilyPond
\emph{reports} a compilation failure but still produces a (potentially
@@ -1501,6 +1664,30 @@ on the other hand \option{showfailed} is set to \texttt{true} only a
warning is issued and a box with an informative text is typeset into the
resulting document.
+\hypertarget{forcing-re-compilation}{%
+\subsubsection{Forcing (Re-)Compilation}\label{forcing-re-compilation}}
+
+\lyOption{force-compilation}{false}
+
+In some cases \lyluatex's heuristics to determine the need for
+recompilation may fail, especially when not all relevant code is
+included through LilyPond's \cmd{include} command, in which cases
+\lyluatex~may consider the content unchanged. In such cases the
+\option{force-compilation} option skips the checks and unconditionally
+recompiles the score, which may be a better solution than to
+(selectively) delete the scores from the \option{tmpdir} directory.
+
+\hypertarget{bug-workaround}{%
+\subsubsection{Bug workaround}\label{bug-workaround}}
+
+\lyOption{fix\_badly\_cropped\_staffgroup\_brackets}{false}
+
+This option is a dirty workaround for a
+\href{https://lists.gnu.org/archive/html/lilypond-user/2018-11/msg00039.html}{known
+bug} of LilyPond. It's disabled by default; should you enable it
+globally, you may cancel it locally with
+\option{nofix\_badly\_cropped\_staffgroup\_brackets}.
+
\hypertarget{musicxml-options}{%
\subsection{MusicXML options}\label{musicxml-options}}
@@ -1509,7 +1696,9 @@ resulting document.
This option does the same for \texttt{\textbackslash{}musicxmlfile} as
\option{program} for \texttt{\textbackslash{}lilypondfile}.
-\lyOption{language}{}\lyOption{absolute, lxml, verbose}{false}\lyOption{
+\lyOption{language}{}
+\lyOption{absolute, lxml, verbose}{false}
+\lyOption{
no-articulation-directions, no-beaming, no-page-layout, no-rest-positions
}{true}
@@ -1574,7 +1763,8 @@ Examples on how raw filenames can be wrapped in secondary commands can
be found in \protect\hyperlink{insert-raw-pdf}{Wrapping Raw PDF
Filenames}.
-\printindex\addcontentsline{toc}{section}{Index}
+\printindex
+\addcontentsline{toc}{section}{Index}
\hypertarget{examples}{%
\section{Examples}\label{examples}}
@@ -1584,31 +1774,22 @@ Those examples and others may be found in
\addcontentsline{toc}{subsection}{Insert Systems}
\hypertarget{insert-systems}{}
-
\section*{Insert System-by-System}
-
By default scores defined by the \option{lilypond} environment or the \cmd{lilypondfile} command are inserted as a sequence of systems.
-
\lyluatex\ determines the vertical space between the systems as a flexible length calculated from the \emph{staff size} of the score (as opposed to from the font size) to produce an regular-looking vertical spacing:
-
\begin{lilypond}[]
{
\repeat unfold 30 { c' d' e' d' }
}
\end{lilypond}
-
The following score has a significantly smaller staff size, and consequently the inter-system space is reduced:
-
\begin{lilypond}[staffsize=12]
{
\repeat unfold 36 { c' d' e' d' }
}
\end{lilypond}
-
\subsection*{Before and After the Score}
-
\cmd{preLilyPondExample} and \cmd{postLilyPondExample} allow some code to be printed before and after the score. This may for example be used to wrap the resulting score in an environment. In the following example rules are printed:
-
\def\preLilyPondExample{%
\par\bigskip
\noindent Before the score:
@@ -1617,43 +1798,35 @@ The following score has a significantly smaller staff size, and consequently the
\par\bigskip
\hrule\par\medskip\noindent After the score
\par\bigskip}
-
\begin{verbatim}
\newcommand{\preLilyPondExample}{%
\par\bigskip
\noindent Before the score:
\par\medskip\hrule\par\medskip}
-
\newcommand{\postLilyPondExample}{%
\par\bigskip
\hrule\par\medskip\noindent After the score
\par\bigskip}
\end{verbatim}
-
\begin{lilypond}[]
{
\repeat unfold 30 { c' d' e' d' }
}
\end{lilypond}
-
\subsection*{Configuring the Inter-System Content}
-
\let\preLilyPondExample\undefined
\let\postLilyPondExample\undefined
-
Using \cmd{betweenLilyPondSystem} it is possible to define a macro that is
expanded between each system pair. It is given the index of the previous system
as an argument to work with. The following example simply prints that index
between the systems, but with some programming more complicated and useful
things could be done, for example printing a rule after every third system or
conditionally insert a page break.
-
\def\betweenLilyPondSystem#1{%
\begin{center}
System #1
\end{center}
}
-
\begin{verbatim}
\newcommand{\betweenLilyPondSystem}[1]{%
\begin{center}
@@ -1661,53 +1834,42 @@ System #1
\end{center}
}
\end{verbatim}
-
\bigskip
-
\begin{lilypond}[]
{
\repeat unfold 30 { c' d' e' d' }
}
\end{lilypond}
-
\let\betweenLilyPondSystem\undefined
-
\addcontentsline{toc}{subsection}{Insert Inline}
\hypertarget{insert-inline}{}
-
\section*{Insert Scores Inline}
-
With the \option{insert=inline} option it is simple to insert arbitrary
notational fragments in the \lilypond{ e'8 d'16 e' } continuous text of a
document. By default the staffsize is scaled to be 2/3 of the staffsize a
regular score would have at this point. This means if the \option{staffsize}
option is modified globally or locally then the staffsize of the inline score is
changed too.
-
In order to make the size of inline scores independent from the regular
staffsize the option \option{inline-staffsize} can be used the same way as
\option{staffsize}. \lilypond[inline-staffsize=8]{ e'8 d'16 e' } has the inline
staffsize manually set to \texttt{8}.
-
\paragraph{Alignment and padding} By default inline scores are vertically
centered to a line 1/2em above the text's baseline. \lilypond[valign=top]{ e'8
d'16 e' } but the score can also be aligned \lilypond[valign=bottom]{ e'8 d'16
e' } to the top or the baseline of the text.
-
Unfortunately this can only consider the borders of the \emph{image} and not
those of the \emph{score} or the staff lines. To alleviate this situation a
specific vertical offset can be given with \option{voffset=-3pt} (or any other
\TeX\ lengths). This offset is calculated after the alignment.
\lilypond[valign=bottom,voffset=-6pt]{ e'8 d'16 e' } is inserted with
\option{valign=bottom,voffset=-4pt}.
-
Horizontally inline scores are padded by \option{hpadding=0.75ex} -- except if
they happen to appear at the beginning or end of a line, as can be seen in the
last score in the previous paragraph. \lilypond[hpadding=2em]{ e'8 d'16 e' }
Increasing the \option{hpadding} will ensure more space around the score.
-
\paragraph{Bare Inline scores} \option{insert=bare-inline} will remove all the
staff elements (staff symbol, time signature, clef) by implicitly applying
\option{nostaff}, which is most useful for including notational symbols like
@@ -1723,156 +1885,121 @@ possibility of inserting arbitrary LilyPond material without having to prepare
precompiled PDF images.
-
\addcontentsline{toc}{subsection}{Choosing Systems}
\hypertarget{print-only}{}
-
\def\postLilyPondExample{\par\bigskip\hrule\par\bigskip}
-
\section*{Print only Selected Systems or Pages}
-
-The \texttt{print-only} option allows to limit the printed systems or pages from
-a score. A typical use case is to print a score interspersed with comments. The
-advantage of this approach is that the score is compiled only once while the
-individual systems are simply reused by \LaTeX.
-
+The \texttt{print-only} and \texttt{do-not-print} options allow to limit
+the printed systems or pages from a score. A typical use case is to print
+a score interspersed with comments. The advantage of this approach is that
+the score is compiled only once while the individual systems are simply
+reused by \LaTeX.
Throughout this document we'll demonstrate the different options to
select systems from the following score:
-
\lilypondfile[verbatim]{eight-systems.ly}
-
The simplest selection is a single system: \texttt{print-only=4}
-
\lilypondfile[print-only=4]{eight-systems.ly}
-
Ranges are also possible: \texttt{print-only=3-5}, with the special form of
\texttt{print-only=6-} which prints from the given system throughout the end of
the score. Negative ranges can be given with \texttt{print-only=7-5}
-
\lilypondfile[print-only=3-5]{eight-systems.ly}
-
\lilypondfile[print-only=6-]{eight-systems.ly}
-
\lilypondfile[print-only=7-5]{eight-systems.ly}
-
With a comma-separated list an arbitrary sequence of systems can be specified.
The list has to be enclosed in curly brackets: \texttt{print-only={4,1,2}}
-
\lilypondfile[print-only={4,1,2}]{eight-systems.ly}
-
Each element of the list can include any of the forms described above:\\
\texttt{print-only={3,5-7,4,7-}}
-
\lilypondfile[print-only={3,5-7,4,7-}]{eight-systems.ly}
-
+\texttt{do-not-print} does the opposite: it prevents the list of systems from
+being printed. It might be used alone, or in combination with
+\texttt{print-only}:\\
+\texttt{print-only=3-,do-not-print=6}
+\lilypondfile[print-only=3-,do-not-print=6]{eight-systems.ly}
The functionality is identical with fullpage scores where the selection applies
to \emph{pages} instead. This can for example be used when the “score” file
contains a number of individual pieces (e.g. songs for a song book), and
individual selections are to be printed.
-
-Systems have some specific behaviour with regard to \emph{indent}, but this is demonstrated in its own file \texttt{dynamic-indent.tex}.
-
+Systems have some specific behaviour with regard to \emph{indent},
+but this is demonstrated in its own file \texttt{dynamic-indent.tex}.
\let\postLilyPondExample\undefined
-
\addcontentsline{toc}{subsection}{Dynamic Indent Handling}
\hypertarget{dynamic-indent}{}
-
\def\postLilyPondExample{\par\bigskip\hrule\par\bigskip}
-
\section*{Dynamic Indent}
-
This document demonstrates the use of \texttt{indent} and \texttt{autoindent},
partially in combination with \texttt{print-only}.
-
\texttt{indent=1cm} indents the first line, but if the resulting score contains
only one system this indent is suppressed (issuing a warning on the console):
-
\begin{lilypond}[indent=1cm]
\set Staff.instrumentName = "Violin"
\repeat unfold 12 { c' d' e' d' }
\end{lilypond}
-
\begin{lilypond}[indent=1cm]
{
\set Staff.instrumentName = "Violin"
c' d' e' d'
}
\end{lilypond}
-
If the output of a score which contains more than one system is limited to the
first system using \texttt{print-only=1} then the indent is removed but the
score is recompiled to ensure a full-length system. The following score shows
the two-system score from above (with \texttt{indent=1cm}), limited to its first
system:
-
\begin{lilypond}[indent=1cm,print-only=1]
\set Staff.instrumentName = "Violin"
\repeat unfold 12 { c' d' e' d' }
\end{lilypond}
-
Note that this behaviour also applies when \texttt{print-only} causes the first
system to be printed at another position, e.g. with \texttt{print-only={3,1,2}}.
In this case the indent of the first system is suppressed in order to avoid a
“hole”. Of course this is a corner case, but might be useful when a score
consists of separate entities (examples, exercises) per system.
-
\begin{lilypond}[indent=1cm,print-only={3,1,2},max-protrusion=0.5cm]
\repeat unfold 25 { c' d' e' d' }
\end{lilypond}
-
If a protrusion limit has been set with \texttt{max-protrusion=0.5cm} and the
score exceeds that limit in spite of \texttt{indent=1cm} then the whole score
will appropriately be narrowed:
-
\begin{lilypond}[indent=1cm,max-protrusion=0.5cm]
\set Staff.instrumentName = "Violin I. and II."
\repeat unfold 11 { c' d' e' d' }
\end{lilypond}
-
-
This doesn't really look good because the indentation of the second system
wouldn't have been necessary since only the first system exceeds the protrusion
limit. The solution to this situation is the option \texttt{autoindent} which
handles the indentation \emph{automatically} and set the indent to a value that
will make the \emph{first} system fit into the protrusion limit and leave the
remaining systems unchanged:
-
\begin{lilypond}[autoindent=true,max-protrusion=0.5cm]
\set Staff.instrumentName = "Violin I. and II."
\repeat unfold 11 { c' d' e' d' }
\end{lilypond}
-
-
However, if the protrusion limit is not only exceeded by the \emph{first} system
(which should be the typical case due to the instrument name) \texttt{lyluatex}
will deal with the situation by narrowing the \emph{whole} score by the
appropriate amount and adjusting the indent of the first system so all systems
will just fit into the protrusion limit:
-
\begin{lilypond}[autoindent=true,max-protrusion=0.5cm]
\set Staff.instrumentName = "Violin I. and II."
\set Staff.shortInstrumentName = "Violin I/II"
\repeat unfold 11 { c' d' e' d' }
\end{lilypond}
-
There is one special case to be mentioned. As described above the indent is
deactivated if the first system of a score is printed at a later position.
However, if this score will exceed the left protrusion limit \texttt{autoindent}
will be automatically activated to avoid having the \emph{whole} score narrowed:
-
\begin{lilypond}[indent=1cm,print-only={3,1,2},max-protrusion=0.5cm]
\set Staff.instrumentName = "Violin"
\repeat unfold 25 { c' d' e' d' }
\end{lilypond}
-
\paragraph{Right protrusion}
The dynamic handling of (automatic) indent also works correctly when there is
protrusion handling to the right. The following score has the ties manually
shaped to exceed the staff symbol by 10, and 7 staff spaces, and
\texttt{max-protrusion=1cm} .
-
\begin{lilypond}[nofragment,max-protrusion=1cm,]
{
\set Staff.instrumentName = "Violin 1 & 2"
@@ -1884,57 +2011,42 @@ shaped to exceed the staff symbol by 10, and 7 staff spaces, and
c'
}
\end{lilypond}
-
-
\paragraph{Performance considerations}
The handling of indent suppression may require up to four compilations of the
score, but these are handled automatically, and the resulting intermediate
stages of the score are cached just like the scores actually used in the
document.
-
The \texttt{autoindent} option is active by default but will be deactivated if
\texttt{indent} is set explicitly. It has to be noted that this option will add
more LilyPond compilations and therefore compilation time. But it will only
apply and be executed if the score exceeds the protrusion limit, so it can only
occur in circumstances where multiple LilyPond runs are expected anyway.
-
\let\postLilyPondExample\undefined
-
\addcontentsline{toc}{subsection}{Font Handling}
\hypertarget{fonts}{}
-
\defaultfontfeatures{Ligatures=TeX,Numbers=OldStyle,Scale=MatchLowercase}
\setmainfont{Linux Libertine O}
\setsansfont[BoldFont={Linux Biolinum O Bold}]{Linux Biolinum O}
\setmonofont{Inconsolata}
-
\section*{Font Handling}
-
To demonstrate the font handling features of \lyluatex\ we will repeatedly
include the following score from an external file. It includes roman (lyrics,
instrument name), sans (rehearsal mark), and mono (tempo) text, first using
LilyPond's built-in default fonts.
-
\lilypondfile[verbatim]{fonts}
-
\bigskip
The current document uses \option{fontspec} to set roman font to \emph{Linux
Libertine O}, sans font to \emph{Linux Biolinum O}, and mono font to
\emph{Inconsolata}. So if you compile this document yourself and don't have
these fonts installed you will receive unexpected results.
-
\subsection*{Passing Document Fonts to Score}
-
With \option{pass-fonts} the currently active font families for roman, sans, and
mono fonts are passed to LilyPond in order to achieve the most coherent
appearance between text and music.
-
\bigskip
-
\lilypondfile[pass-fonts]{fonts}
-
\bigskip
Note that LilyPond loads fonts differently than \LaTeX\ and can only make use of
fonts installed as system fonts, fonts that are only installed through a \LaTeX\
@@ -1942,14 +2054,11 @@ distribution are not accessible to it. That means that if the document fonts are
not installed system-wide (e.\,g. the default fonts) LilyPond will use rather
ugly fallback fonts. This can't be demonstrated here but the section about
explicitly setting font families will include an example.
-
The inherent problem of fallback fonts, especially with \LaTeX's default
settings, is the reason \option{pass-fonts} is inactive by default. But the
general recommendation is to set \option{pass-fonts} as package option if the
text document uses fonts that are available to LilyPond.
-
\bigskip
-
\sffamily \option{current-font-as-main} will use the font that is
\emph{currently} used for typesetting as LilyPond's main (roman) font. This can
make sure that the score's main font (and roman is usually the font used most in
@@ -1960,12 +2069,9 @@ is one of the two others. Additionally this \emph{may} introduce an
inconsistency not between the score and the surrounding text but between
different scores in a document. For all these reasons the option is by default
set to \texttt{false}.
-
\bigskip
\lilypondfile[pass-fonts,current-font-as-main]{fonts}
-
\subsection*{Setting Score Fonts Explicitly}
-
With \option{rmfamily}, \option{sffamily}, and \option{ttfamily} specific
families can be set to arbitrary fonts, independently from the text document.
For the following score \option{ttfamily=\{TeXGyre Adventor\}} is
@@ -1973,31 +2079,24 @@ used.\footnote{Note that this font (which is included in TeXLive) has to be
installed if you want to successfully compile this document.} Note that this
implicitly sets \option{pass-fonts=true}, and \emph{Linux Libertine O} and
\emph{Linux Biolinum O} are used from the text document.
-
\bigskip
\lilypondfile[ttfamily={TeXGyre Adventor}]{fonts}
-
\highlight{NOTE:} when \option{rmfamily} is set explicitly
\option{current-font-as-main} is forced to \texttt{false} to ensure that the
roman font is actually used. The next score sets \option{rmfamily=\{TeXGyre
Adventor\}} and \option{current-font-as-main}, and despite the current font still being \cmd{sffamily}
\emph{Adventor} is used as the score's main font:
-
\bigskip
\lilypondfile[current-font-as-main,rmfamily={TeXGyre Adventor}]{fonts}
-
\subsection*{LilyPond's Font Fallback}
-
If unavailable fonts are set in a LilyPond document they will \emph{silently} be
replaced with fallback fonts that tend to cause ugly results. This will be shown
by setting \option{rmfamily=FantasyFontOne}, \option{sffamily=FantasyFontTwo},
and \option{tfamily=FantasyFontThree}:
-
\bigskip
\lilypondfile[rmfamily=FantasyFontOne,%
sffamily=FantasyFontTwo,%
ttfamily=FantasyFontThree]{fonts}
-
This can happen in several contexts: apart from compiling the document on a
different computer where the used fonts are missing it is most likely to occur
with the \option{pass-fonts} option, when the text document uses internal
@@ -2005,27 +2104,28 @@ with the \option{pass-fonts} option, when the text document uses internal
family is specified explicitly with an option and the other families are passed
from the text document.
-
+\defaultfontfeatures{Ligatures=TeX,Numbers=OldStyle,Scale=MatchLowercase}
+\setmainfont{Linux Libertine O}
+\setsansfont[BoldFont={Linux Biolinum O Bold}]{Linux Biolinum O}
+\setmonofont{Inconsolata}
\addcontentsline{toc}{subsection}{Wrapping Commands}
\hypertarget{wrappingcommands}{}
-
+\VerbatimFootnotes
\section*{Wrapping Commands}
-
+\subsection*{Command within commands}
\cmd{lily} can be wrapped within another command as usual:
-
\begin{verbatim}
\newcommand\mylily[2][1]{\lily[inline-staffsize=10, #1]{#2}}
-
This is \mylily[voffset=10pt]{a' b' c''} an example.
\end{verbatim}
-
\newcommand\mylily[2][1]{\lily[inline-staffsize=10, #1]{#2}}
-
-This is \mylily[voffset=10pt]{a' b' c''} an example.
-
+This is \mylily[voffset=10pt]{a' b' c''} an example.\par
+\subsection*{Environment within environments}
+\emph{It isn't possible to wrap \highlight{ly} environment within a command.}\par
It's possible to wrap \highlight{ly} within and environment, but there are
-several drawbacks:
+several drawbacks\footnote{%
+Those drawbacks are:
\begin{itemize}
\item this custom environment cannot have optional parameters. To be more
precise, if it has only optional parameters, it will be necessary to add \verb`[]`
@@ -2038,34 +2138,32 @@ several drawbacks:
\item or use the \TeX\ primitives \verb`\ly \endly` (not only for \highlight{ly},
but also for other environments).
\end{itemize}
-\end{itemize}
-
+\end{itemize}%
+}.
+To avoid those drawbacks, \lyluatex\ defines a special command, \verb`\lynewenvironment`,
+that behaves as you'd expect from \verb`\newenvironment`.
\begin{verbatim}
-\newenvironment{myly}{%
+\lynewenvironment{myly}{%
This is \emph{my} lilypond environment.
- \begin{ly}[]%
+ \begin{ly}%
}{%
\end{ly}
}
-
\begin{myly}
a b c
\end{myly}
\end{verbatim}
-
\newenvironment{myly}{%
This is \emph{my} lilypond environment.
- \begin{ly}[]%
+ \begin{ly}%
}{%
\end{ly}
}
-
\begin{myly}
a b c
\end{myly}
-
\begin{verbatim}
-\newenvironment{lyfigure}[2][]{%
+\lynewenvironment{lyfigure}[2][]{%
\edef\mycaption{#2}
\begin{figure}
\begin{center}
@@ -2076,14 +2174,12 @@ several drawbacks:
\end{center}
\end{figure}
}
-
-\begin{lyfigure}{caption}
+\begin{lyfigure}{This is a caption}
a' b' c
d' e' f
\end{lyfigure}
\end{verbatim}
-
-\newenvironment{lyfigure}[2][]{%
+\lynewenvironment{lyfigure}[2][]{%
\edef\mycaption{#2}
\begin{figure}
\begin{center}
@@ -2094,14 +2190,12 @@ d' e' f
\end{center}
\end{figure}
}
-
-\begin{lyfigure}{caption}
+\begin{lyfigure}{This is a caption}
a' b' c
d' e' f
\end{lyfigure}
-
\begin{verbatim}
-\newenvironment{lyotherfigure}[1][]{%
+\lynewenvironment{lyotherfigure}[1][]{%
\edef\option{#1}
\figure
\center
@@ -2112,14 +2206,12 @@ d' e' f
\endcenter
\endfigure
}
-
-\begin{lyotherfigure}[]
+\begin{lyotherfigure}
d' e' f
a' b' c
\end{lyotherfigure}
\end{verbatim}
-
-\newenvironment{lyotherfigure}[1][]{%
+\lynewenvironment{lyotherfigure}[1][]{%
\edef\option{#1}
\figure
\center
@@ -2130,35 +2222,121 @@ a' b' c
\endcenter
\endfigure
}
-
-\begin{lyotherfigure}[]
+\begin{lyotherfigure}
d' e' f
a' b' c
\end{lyotherfigure}
-
+\begin{verbatim}
+\begin{lyotherfigure}[This time with a caption]
+d' e' f
+a' b' c
+\end{lyotherfigure}
+\end{verbatim}
+\begin{lyotherfigure}[This time with a caption]
+d' e' f
+a' b' c
+\end{lyotherfigure}
+\textbf{Important note:} \verb`\lynewenvironment` is intended to insert \LaTeX\ code before
+and after the scores; due to the special behavior of \verb`ly` environment, it isn't possible
+to insert \emph{LilyPond} code that way. So this won't work:
+\begin{verbatim}
+ \lynewenvironment{myly}{%
+ \begin{ly}
+ a b c
+ }{%
+ \end{ly}
+ }
+\end{verbatim}
+To do such a thing, \lyluatex\ defines a command and four options:
+\begin{itemize}
+ \item \verb`\lysavefrag` lets one save a LilyPond fragment to be re-used afterward;
+ \item \verb`include_header`, \verb`include_footer`, \verb`include_before_body` and \verb`include_after_body` options
+ let one insert such fragments at designed places within inserted score.
+\end{itemize}
+So this works:
+\begin{verbatim}
+\begin{lysavefrag}{head}
+a b c
+\end{lysavefrag}
+\begin{lysavefrag}{foot}
+g a' b
+\end{lysavefrag}
+\begin{lysavefrag}{mymark}
+\mark \default
+\end{lysavefrag}
+\begin{lysavefrag}{mymark}
+\mark \default
+\end{lysavefrag}
+begin{ly}[
+ include_before_body={head,mymark,head},
+ include_after_body=foot,
+]
+d e f
+\end{ly}
+\end{verbatim}
+It's also possible to use \verb`\lynewenvironment` to wrap such a command:
+\begin{verbatim}
+\begin{lysavefrag}{head}
+a b c
+\end{lysavefrag}
+\begin{lysavefrag}{foot}
+g a' b
+\end{lysavefrag}
+\begin{lysavefrag}{mymark}
+\mark \default
+\end{lysavefrag}
+\lynewenvironment{yourly}[1][]{%
+ {\centering test \par}
+ \begin{ly}[
+ include_before_body={head,mymark,head},
+ include_after_body=foot,
+ ]
+}{
+ \end{ly}
+}
+\begin{yourly}
+d e f
+\end{yourly}
+\end{verbatim}
+\begin{lysavefrag}{head}
+a b c
+\end{lysavefrag}
+\begin{lysavefrag}{foot}
+g a' b
+\end{lysavefrag}
+\begin{lysavefrag}{mymark}
+\mark \default
+\end{lysavefrag}
+\lynewenvironment{yourly}[1][]{%
+ {\centering test \par}
+ \begin{ly}[
+ include_before_body={head,mymark,head},
+ include_after_body=foot,
+ ]
+}{
+ \end{ly}
+}
+\begin{yourly}
+d e f
+\end{yourly}
\addcontentsline{toc}{subsection}{Wrapping Raw PDF Filenames}
\hypertarget{insert-raw-pdf}{}
-
\section*{Wrapping Raw PDF Filenames}
-
With the \option{raw-pdf} option it is possible to create wrapping commands that
circumvent \lyluatex's layout considerations by working with the raw PDF
filename of the generated score. This is especially useful for developing
packages or personal class and style files. For this scores generated with
\option{raw-pdf} define a command \cmd{lyscore} that can be used in the wrapping
commands or environments.
-
All examples in this document could also be realized using “default” \lyluatex\
without \option{raw-pdf}, but they are intended to show how this low-level
access can be used to retrieve the information from the generated score in order
to build custom versions of commands that don't have to adhere to \lyluatex's
pre-built strategies of including the score in the document
-
The easiest way to use a “raw” score is to simply access \cmd{lyscore} in a
command and pass it to an \cmd{includegraphics} macro:
-
\begin{verbatim}
\newcommand\lilyinline[2][]{%
\lily[raw-pdf,%
@@ -2170,33 +2348,27 @@ command and pass it to an \cmd{includegraphics} macro:
\includegraphics{\lyscore{}}%
}
\end{verbatim}
-
\newcommand\lilyinline[2][]{%
\lily[raw-pdf,insert=bare-inline,inline-staffsize=8,hpadding=0.25ex,#1]{
\omit Stem
#2}%
\includegraphics{\lyscore{}}%
}
-
This basically is a way to provide pre-configured commands. In this case
\lilyinline{ c'8 d' c' d'} it is used to pre-configure an inline
type, entered as \verb+\lilyinline{ c'8 d' c' d'}+.
-
-
\bigskip \cmd{lyscore} takes one mandatory argument which can be empty -- as in
the example above --, receive a number, one of the keywords \texttt{nsystems}
and \texttt{hoffset}, or any of the score's options. If passed a number it will
return the filename of the N-th system. With \texttt{nsystems} the number of
systems in the generated score will be returned, while \texttt{hoffset}
generates the code that shifts the score to the left to accommodate protrusion.
-
The following example takes an optional argument with options that are passed to
\lyluatex, and one mandatory argument which expects the system to be used. It
prints the given system centered in a figure and uses the file name as the
caption and makes use of the score's \texttt{label}. Figure \ref{centered} shows
the centering of a short fragment, figure \ref{fifth} the selection of the fifth
system from a larger score.
-
\begin{verbatim}
\newenvironment{centeredlilypondsystem}[2][]{%
\def\usesystem{#2}
@@ -2211,16 +2383,13 @@ system from a larger score.
\end{center}
\end{figure}
}
-
\begin{centeredlilypondsystem}[label=centered]{1}
c'1 d' e'
\end{centeredlilypondsystem}
-
\begin{centeredlilypondsystem}[label=fifth]{5}
\repeat unfold 8 { c'1 \break }
\end{centeredlilypondsystem}
\end{verbatim}
-
\newenvironment{centeredlilypondsystem}[2][]{%
\def\usesystem{#2}
\begin{figure}
@@ -2234,22 +2403,17 @@ system from a larger score.
\end{center}
\end{figure}
}
-
\begin{centeredlilypondsystem}[label=centered]{1}
c'1 d' e'
\end{centeredlilypondsystem}
-
\begin{centeredlilypondsystem}[label=fifth]{5}
\repeat unfold 8 { c'1 \break }
\end{centeredlilypondsystem}
-
-
Finally there's an example showing how to iterate over the systems of a score
using \cmd{foreach} from the \option{pgffor} package. It iterates over all the
systems in the given score, prints them using the protrusion adjustment seen
before, and if the system is the third it prints this information, otherwise
just a line break:
-
\begin{verbatim}
\newcommand\myforlily[2][]{%
\lily[insert=systems,raw-pdf,#1]{#2}%
@@ -2258,12 +2422,10 @@ just a line break:
\ifthenelse{\equal{\n}{3}}{\par Third system\par}{\\}
}%
}
-
\myforlily[staffsize=24]{
\set Staff.instrumentName = "Vl. "
\repeat unfold 4 { c'1 \break } }
\end{verbatim}
-
\newcommand\myforlily[2][]{%
\lily[insert=systems,raw-pdf,#1]{#2}%
\foreach \n in {1,...,\lyscore{nsystems}}%
@@ -2271,11 +2433,9 @@ just a line break:
\ifthenelse{\equal{\n}{3}}{\par\bigskip Third system\par\bigskip}{\\}
}%
}
-
\myforlily[staffsize=24]{
\set Staff.instrumentName = "Vl. "
\repeat unfold 4 { c'1 \break } }
-
\end{document}
diff --git a/Master/texmf-dist/doc/support/lyluatex/lyluatexbase.cls b/Master/texmf-dist/doc/support/lyluatex/lyluatexbase.cls
index 48d6040c055..1e8b048dd87 100644
--- a/Master/texmf-dist/doc/support/lyluatex/lyluatexbase.cls
+++ b/Master/texmf-dist/doc/support/lyluatex/lyluatexbase.cls
@@ -1,11 +1,11 @@
%Lyluatex LaTeX class.
%
-% Copyright (C) 2015-2018 jperon and others (see CONTRIBUTORS.md)
+% Copyright (C) 2015-2019 jperon and others (see CONTRIBUTORS.md)
% License: MIT
% This file is part of lyluatex.
\NeedsTeXFormat{LaTeX2e}
-\ProvidesClass{lyluatexbase}[2018/03/12 v1.0b] %%LYLUATEX_DATE LYLUATEX_VERSION
+\ProvidesClass{lyluatexbase}[2019/05/27 v1.0f] %%LYLUATEX_DATE LYLUATEX_VERSION
\LoadClass[DIV=11]{scrartcl}
\RequirePackage{lyluatex}
@@ -14,6 +14,7 @@
\RequirePackage{listings}
\RequirePackage{minted}
\RequirePackage{pgffor}
+\RequirePackage{fancyvrb}
\RequirePackage[colorlinks=true]{hyperref}
\lysetoption{includepaths}{./, ly/}
diff --git a/Master/texmf-dist/doc/support/lyluatex/lyluatexmanual.cls b/Master/texmf-dist/doc/support/lyluatex/lyluatexmanual.cls
index 5bd075e8d52..8e1a85d2900 100644
--- a/Master/texmf-dist/doc/support/lyluatex/lyluatexmanual.cls
+++ b/Master/texmf-dist/doc/support/lyluatex/lyluatexmanual.cls
@@ -1,11 +1,11 @@
%Lyluatex LaTeX class for the manual.
%
-% Copyright (C) 2015-2018 jperon and others (see CONTRIBUTORS.md)
+% Copyright (C) 2015-2019 jperon and others (see CONTRIBUTORS.md)
% License: MIT
% This file is part of lyluatex.
\NeedsTeXFormat{LaTeX2e}
-\ProvidesClass{lyluatexmanual}[2018/03/12 v1.0b] %%LYLUATEX_DATE LYLUATEX_VERSION
+\ProvidesClass{lyluatexmanual}[2019/05/27 v1.0f] %%LYLUATEX_DATE LYLUATEX_VERSION
\LoadClass{lyluatexbase}
@@ -28,3 +28,14 @@
\addcontentsline{toc}{subsection}{#2}
\hypertarget{#1}{}
}
+
+
+\newcommand{\lyluatexmanualdate}{
+ \directlua{
+ local PC = string.char(37)
+ local date_fmt = PC..'Y-'..PC..'m-'..PC..'d'
+ local p = io.popen('git log -n1 --date=short --format='..PC..'"ad"', 'r')
+ tex.sprint(p and p:read('*a') or os.date(date_fmt))
+ if p then p:close() end
+ }
+} \ No newline at end of file