summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/luatex/gregoriotex/Command_Index_User.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/luatex/gregoriotex/Command_Index_User.tex')
-rw-r--r--Master/texmf-dist/doc/luatex/gregoriotex/Command_Index_User.tex735
1 files changed, 382 insertions, 353 deletions
diff --git a/Master/texmf-dist/doc/luatex/gregoriotex/Command_Index_User.tex b/Master/texmf-dist/doc/luatex/gregoriotex/Command_Index_User.tex
index 4c7380a69c2..ae1dbd80222 100644
--- a/Master/texmf-dist/doc/luatex/gregoriotex/Command_Index_User.tex
+++ b/Master/texmf-dist/doc/luatex/gregoriotex/Command_Index_User.tex
@@ -18,21 +18,21 @@ The optional arguments are:
\bigskip\rowcolors{1}{lightgray}{lightgray}
\begin{tabular}{lp{10cm plus .5cm}}
- Argument & Description \\
- \hline
- \texttt{debug} & Debug messages will be printed to the output log. Can also be specified as \verb:debug={<types>}:, in which case only messages of the types listed will be printed to the output log.\\
- \hline
- \texttt{nevercompile} & Default. The classic behavior of Gregorio\TeX. The user is %
- responsible for compiling gabc scores into gtex files.\\
- \texttt{autocompile} & Gregorio\TeX\ will automatically compile gtex files from gabc %
- files when necessary. If the gabc has been modified, or the %
- gtex has an outdated version, or the gtex file does not exist, %
- THEN Gregorio\TeX\ will compile a new gtex file.\\
- \texttt{forcecompile} & Gregorio\TeX\ will compile all scores from their gabc files.\\
- \hline
- \texttt{allowdeprecated=false} & Force all deprecated commands to raise a package error %
- rather than a warning. This allows the user to ensure that their file is %
- compliant with the current version of Gregorio\TeX.\\
+ Argument & Description \\
+ \hline
+ \texttt{debug} & Debug messages will be printed to the output log. Can also be specified as \verb:debug={<types>}:, in which case only messages of the types listed will be printed to the output log.\\
+ \hline
+ \texttt{nevercompile} & Default. The classic behavior of Gregorio\TeX. The user is %
+ responsible for compiling gabc scores into gtex files.\\
+ \texttt{autocompile} & Gregorio\TeX\ will automatically compile gtex files from gabc %
+ files when necessary. If the gabc has been modified, or the %
+ gtex has an outdated version, or the gtex file does not exist, %
+ THEN Gregorio\TeX\ will compile a new gtex file.\\
+ \texttt{forcecompile} & Gregorio\TeX\ will compile all scores from their gabc files.\\
+ \hline
+ \texttt{allowdeprecated=false} & Force all deprecated commands to raise a package error %
+ rather than a warning. This allows the user to ensure that their file is %
+ compliant with the current version of Gregorio\TeX.\\
\end{tabular}\bigskip
\textbf{Note:} \verb=nevercompile=, \verb=autocompile=, and
@@ -73,27 +73,27 @@ Once you've included the package in your document (as explained above) the follo
Macro for including scores. Works on both gabc and tex files.
\begin{argtable}
- \#1 & \texttt{n} & Optional. \#2 will be included as is. \\
- & \texttt{a} & Optional. Gregorio\TeX\ will automatically compile gabc files if necessary.\\
- & \texttt{f} & Optional. Forces Gregorio\TeX\ to compile the gabc file.\\
- \#2 & string & Relative or absolute path to the score.\\
+ \#1 & \texttt{n} & Optional. \#2 will be included as is. \\
+ & \texttt{a} & Optional. Gregorio\TeX\ will automatically compile gabc files if necessary.\\
+ & \texttt{f} & Optional. Forces Gregorio\TeX\ to compile the gabc file.\\
+ \#2 & string & Relative or absolute path to the score.\\
\end{argtable}
Example:\par\medskip
\begin{latexcode}
- \gregorioscore[n]{TecumPrincipium.gtex}
- \gregorioscore{Chant/VirgoVirginum.gabc}
- \gregorioscore{/home/user/chant/AdTeLevavi}
- \gregorioscore[a]{AveMaria}
-
- %The following lines include the same score:
- \gregorioscore{Christus}
- \gregorioscore{Christus.gtex}
- \gregorioscore{./Christus}
- \gregorioscore{./Christus.gabc}
-
- %With the optional arg [f], #2 must be a file usable by \TeX.
- \gregorioscore[f]{TecumPrincipium.gabc} % Wrong
+ \gregorioscore[n]{TecumPrincipium.gtex}
+ \gregorioscore{Chant/VirgoVirginum.gabc}
+ \gregorioscore{/home/user/chant/AdTeLevavi}
+ \gregorioscore[a]{AveMaria}
+
+ %The following lines include the same score:
+ \gregorioscore{Christus}
+ \gregorioscore{Christus.gtex}
+ \gregorioscore{./Christus}
+ \gregorioscore{./Christus.gabc}
+
+ %With the optional arg [f], #2 must be a file usable by \TeX.
+ \gregorioscore[f]{TecumPrincipium.gabc} % Wrong
\end{latexcode}
\textbf{Important:} For the sake of clarity it is recommended that the
@@ -114,7 +114,7 @@ compiled are:
\begin{itemize}
\item If a gtex file does not exist.
\item If the modification time of the gabc file is newer than its
- corresponding gtex file.
+ corresponding gtex file.
\item If the version of the gtex file is outdated.
\end{itemize}
@@ -131,32 +131,32 @@ A macro to change the behavior of the way Gregorio\TeX\ includes scores. This i
\begin{argtable}
- \#1 & \texttt{force} & all later calls of \verb=\gregorioscore= will compile the gabc
+ \#1 & \texttt{force} & all later calls of \verb=\gregorioscore= will compile the gabc
file into a gtex file.\\
- & \texttt{auto} & all later calls of \verb=\gregorioscore= will use Gregorio\TeX's
+ & \texttt{auto} & all later calls of \verb=\gregorioscore= will use Gregorio\TeX's
automatic compilation of gabc files.\\
- & \texttt{never} & all later calls of \verb=\gregorioscore= will include the score
+ & \texttt{never} & all later calls of \verb=\gregorioscore= will include the score
without doing anything else.
\end{argtable}
\medskip This macro can be combined in the same document with different arguments to
switch between different behaviors: \par\medskip
\begin{latexcode}
- \usepackage{gregoriotex} % [nevercompile] is the default.
- ----
- \gregorioscore{TecumPrincipium} % gabc never compiled.
- \gregorioscore[f]{TecumPrincipium} % gabc always compiled.
- \gregorioscore[a]{TecumPrincipium} % gabc auto compiled.
-
- \gresetcompilegabc{auto}
- \gregorioscore{TecumPrincipium} % gabc auto compiled.
- \gregorioscore[n]{TecumPrincipium} % gabc never compiled.
- \gregorioscore[f]{TecumPrincipium} % gabc always compiled.
-
- \gresetcompilegabc{force}
- \gregorioscore{TecumPrincipium} % gabc always compiled.
- \gregorioscore[n]{TecumPrincipium} % gabc never compiled.
- \gregorioscore[a]{TecumPrincipium} % gabc auto compiled.
+ \usepackage{gregoriotex} % [nevercompile] is the default.
+ ----
+ \gregorioscore{TecumPrincipium} % gabc never compiled.
+ \gregorioscore[f]{TecumPrincipium} % gabc always compiled.
+ \gregorioscore[a]{TecumPrincipium} % gabc auto compiled.
+
+ \gresetcompilegabc{auto}
+ \gregorioscore{TecumPrincipium} % gabc auto compiled.
+ \gregorioscore[n]{TecumPrincipium} % gabc never compiled.
+ \gregorioscore[f]{TecumPrincipium} % gabc always compiled.
+
+ \gresetcompilegabc{force}
+ \gregorioscore{TecumPrincipium} % gabc always compiled.
+ \gregorioscore[n]{TecumPrincipium} % gabc never compiled.
+ \gregorioscore[a]{TecumPrincipium} % gabc auto compiled.
\end{latexcode}
\macroname{\textbackslash gabcsnippet}{\{\#1\}}{gregoriotex-main.tex}
@@ -164,12 +164,12 @@ Converts the gabc notation specified in \texttt{\#1} to Gregorio\TeX\ and
includes it directly in the document.
\begin{argtable}
- \#1 & string & The gabc to insert into the document.\\
+ \#1 & string & The gabc to insert into the document.\\
\end{argtable}
\medskip For example:\par\medskip
\begin{latexcode}
- \gabcsnippet{(c3) Al(eg~)le(gv.fhg)lu(efe___)ia(e.) (::)}
+ \gabcsnippet{(c3) Al(eg~)le(gv.fhg)lu(efe___)ia(e.) (::)}
\end{latexcode}
@@ -199,8 +199,8 @@ disabled by default.
Macro to enable or disable the point-and-click feature.
\begin{argtable}
- \#1 & \texttt{on} & Enable point-and-click link generation.\\
- & \texttt{off} & Disable point-and-click link generation (default).
+ \#1 & \texttt{on} & Enable point-and-click link generation.\\
+ & \texttt{off} & Disable point-and-click link generation (default).
\end{argtable}
This feature may be switched on and off as desired between scores.
@@ -213,14 +213,14 @@ While the default size for Gregorio scores is designed to approximate that found
Macro to adjust the size of the staff.
\begin{argtable}
- \#1 & integer & The size of the staff lines. Default value is 17. Higher numbers yield larger staves.
+ \#1 & integer & The size of the staff lines. Default value is 17. Higher numbers yield larger staves.
\end{argtable}
\macroname{\textbackslash grechangestafflinethickness}{\{\#1\}}{gregoriotex-spaces.tex}
Macro to adjust the thickness of the staff lines.
\begin{argtable}
- \#1 & integer & The thickness of the staff lines. The default value is same as staff size.
+ \#1 & integer & The thickness of the staff lines. The default value is same as staff size.
\end{argtable}
@@ -231,54 +231,56 @@ In addition to providing control over the overall size of your scores, Gregorio\
Macro to create one of Gregorio\TeX’s distances. Used to initialize distances in a space configuration file. For an example of such a file, please see \textit{gsp-default.tex}, which contains the default spacing configuration for Gregorio\TeX.
\begin{argtable}
- \#1 & string & The name of the distance to be changed. See \nameref{distances} below.\\
- \#2 & string & The distance in string format. \textbf{Note:} You cannot use a length register for this argument. You \emph{must} use a string because of the way that Gregorio\TeX\ handles spaces.\\
- \#3 & \texttt{fixed} & Distance will not scale when staff size is changed.\\
- & \texttt{scalable} & Distance will scale when staff size is changed.
+ \#1 & string & The name of the distance to be changed. See \nameref{distances} below.\\
+ \#2 & string & The distance in string format. \textbf{Note:} You cannot use a length register for this argument. You \emph{must} use a string because of the way that Gregorio\TeX\ handles spaces.\\
+ \#3 & \texttt{fixed} & Distance will not scale when staff size is changed.\\
+ & \texttt{scalable} & Distance will scale when staff size is changed.\\
+ & \texttt{inherited} & Distance will inherit its value from another distance. When this argument is used, then \#2 should be the name of another Gregorio\TeX\ distance.
\end{argtable}
\macroname{\textbackslash grechangedim}{\{\#1\}\{\#2\}\{\#3\}}{gregoriotex-spaces.tex}
Macro to change one of Gregorio\TeX’s distances. This function will check to make sure the distance you are trying to change exists first.
\begin{argtable}
- \#1 & string & The name of the distance to be changed. See \nameref{distances} below.\\
- \#2 & string & The distance in string format. \textbf{Note:} You cannot use a length register for this argument. You \emph{must} use a string because of the way that Gregorio\TeX\ handles spaces.\\
- \#3 & \texttt{fixed} & Distance will not scale when staff size is changed.\\
- & \texttt{scalable} & Distance will scale when staff size is changed.
+ \#1 & string & The name of the distance to be changed. See \nameref{distances} below.\\
+ \#2 & string & The distance in string format. \textbf{Note:} You cannot use a length register for this argument. You \emph{must} use a string because of the way that Gregorio\TeX\ handles spaces.\\
+ \#3 & \texttt{fixed} & Distance will not scale when staff size is changed.\\
+ & \texttt{scalable} & Distance will scale when staff size is changed.\\
+ & \texttt{inherited} & Distance will inherit its value from another distance. When this argument is used, then \#2 should be the name of another Gregorio\TeX\ distance.
\end{argtable}
\macroname{\textbackslash grescaledim}{\{\#1\}\{\#2\}}{gregoriotex-spaces.tex}
Macro to turn on or off scaling with the staff size for a particular distance.
\begin{argtable}
- \#1 & string & The name of the distance for which scaling is to changed. See \nameref{distances} below.\\
- \#2 & \texttt{yes}/\texttt{true}/\texttt{on}/\texttt{scalable} & Choose just one of the given keywords. Scale the distance when changing the size of the staff.\\
- & string not in list above & Do not scale the distance when changing the size of the staff.
+ \#1 & string & The name of the distance for which scaling is to changed. See \nameref{distances} below.\\
+ \#2 & \texttt{yes}/\texttt{true}/\texttt{on}/\texttt{scalable} & Choose just one of the given keywords. Scale the distance when changing the size of the staff.\\
+ & string not in list above & Do not scale the distance when changing the size of the staff.
\end{argtable}
\textbf{Nota bene:} This macro also can be used to change whether or not the staff line thickness scales with the staff size by specifying \texttt{stafflinefactor} for the first argument.
\macroname{\textbackslash grechangecount}{\{\#1\}\{\#2\}}{gregoriotex-spaces.tex}
-Macro to change one of Gregorio\TeX’s counts (numeric values).
+Macro to change one of Gregorio\TeX’s counts or penalities (numeric values).
\begin{argtable}
- \#1 & string & The name of the count to be changed. See \nameref{counts} below.\\
- \#2 & integer & The new value.\\
+ \#1 & string & The name of the count to be changed. See \nameref{counts} and \nameref{penalties} below.\\
+ \#2 & integer & The new value.\\
\end{argtable}
\macroname{\textbackslash greloadspaceconf}{\{\#1\}}{gregoriotex-spaces.tex}
Macro to load a space configuration file. Space configuration file names have the format \verb=gsp-identifier.tex= and must be in the same directory as your project or in your texmf directory.
\begin{argtable}
- \#1 & string & The identifier of the space configuration file.
+ \#1 & string & The identifier of the space configuration file.
\end{argtable}
Example:\par\medskip
\begin{latexcode}
- % loads gsp-default.tex, the default configuration file
- \greloadspaceconf{default}
- % loads a custom configuration called gsp-myspaces.tex
- \greloadspaceconf{myspaces}
+ % loads gsp-default.tex, the default configuration file
+ \greloadspaceconf{default}
+ % loads a custom configuration called gsp-myspaces.tex
+ \greloadspaceconf{myspaces}
\end{latexcode}
\macroname{\textbackslash greconffactor}{}{gsp-default.tex}
@@ -289,9 +291,9 @@ Macro to configure line height expansion behavior when notes appear
above or below the staff lines.
\begin{argtable}
- \#1 & \texttt{variable} & Expand lines within a score independently
- of each other \\
- & \texttt{uniform} & Expand all lines within a score uniformly
+ \#1 & \texttt{variable} & Expand lines within a score independently
+ of each other \\
+ & \texttt{uniform} & Expand all lines within a score uniformly
\end{argtable}
By default, Gregorio\TeX{} uses \texttt{variable} line expansion. This
@@ -311,14 +313,14 @@ necessary.
\begin{small}
\begin{framed}
- \textit{For experts only:}\bigskip
-
- It is possible to suppress the line height computation and just use
- whatever has been computed from the previous run. If you are sure
- that the score line heights haven't changed from the previous run,
- define the \verb=\greskipheightcomputation= control sequence before
- including the Gregorio\TeX{} package. This will save a little bit
- of time per run.
+ \textit{For experts only:}\bigskip
+
+ It is possible to suppress the line height computation and just use
+ whatever has been computed from the previous run. If you are sure
+ that the score line heights haven't changed from the previous run,
+ define the \verb=\greskipheightcomputation= control sequence before
+ including the Gregorio\TeX{} package. This will save a little bit
+ of time per run.
\end{framed}
\end{small}
@@ -329,10 +331,10 @@ horizontal episema that surround a line on which a ledger line may appear
when the ledger line \textit{does not} appear.
\begin{argtable}
- \#1 & \texttt{enable} & Ledger line heuristics will be used in placing
- the horizontal episema \\
- & \texttt{disable} & Ledger line heuristics will not be used in
- placing the horizontal episema \\
+ \#1 & \texttt{enable} & Ledger line heuristics will be used in placing
+ the horizontal episema \\
+ & \texttt{disable} & Ledger line heuristics will not be used in
+ placing the horizontal episema \\
\end{argtable}
Because of the complexity of computing distances exactly, the heuristic may
@@ -352,36 +354,36 @@ system should act as if the ledger line exists (\texttt{1}) or not
Macro for changing the color of the staff lines. The two most common colors you're going to want to use are \texttt{gregoriocolor} (see \nameref{colors}) and \texttt{black} (the default).
\begin{argtable}
- \#1 & color name & The color of the staff lines
+ \#1 & color name & The color of the staff lines
\end{argtable}
\macroname{\textbackslash gresetlines}{\{\#1\}}{gregoriotex-main.tex}
Macro for setting whether the staff lines should be rendered or not.
\begin{argtable}
- \#1 & \texttt{visible} & The staff lines should be printed (default)\\
- & \texttt{invisible} & The staff lines should not be printed
+ \#1 & \texttt{visible} & The staff lines should be printed (default)\\
+ & \texttt{invisible} & The staff lines should not be printed
\end{argtable}
\macroname{\textbackslash gresetlinesbehindpunctumcavum}{\{\#1\}}{gregoriotex-signs.tex}
Macro for setting whether the staff lines behind a punctum cavum should be shown or not.
\begin{argtable}
- \#1 & \texttt{visible} & The staff lines behind a punctum cavum should be printed (Plain \TeX\ default)\\
- & \texttt{invisible} & The staff lines behind a punctum cavum should not be printed (\LaTeX\ default)
+ \#1 & \texttt{visible} & The staff lines behind a punctum cavum should be printed (Plain \TeX\ default)\\
+ & \texttt{invisible} & The staff lines behind a punctum cavum should not be printed (\LaTeX\ default)
\end{argtable}
\macroname{\textbackslash gresetlinesbehindalteration}{\{\#1\}}{gregoriotex-signs.tex}
Macro for setting whether the staff lines behind an alternation (\ie, an accidental) should be shown or not.
\begin{argtable}
- \#1 & \texttt{visible} & The staff lines behind an alteration should be printed (Plain \TeX\ default)\\
- & \texttt{invisible} & The staff lines behind an alteration should not be printed (\LaTeX\ default)
+ \#1 & \texttt{visible} & The staff lines behind an alteration should be printed (Plain \TeX\ default)\\
+ & \texttt{invisible} & The staff lines behind an alteration should not be printed (\LaTeX\ default)
\end{argtable}
\subsubsection{Score Font}
-Gregorio\TeX\ currently supports 3 different fonts for the glyphs in a score (neumes, clefs, alterations, \etc): Greciliae (a customized version of Caeciliae by Fr.\ Matthew Spencer, OSJ), Gregorio, and Parmesan (developed for Lilypond by Juergen Reuter).
+Gregorio\TeX\ currently supports 3 different fonts for the glyphs in a score (neumes, clefs, alterations, \etc): Greciliae (a customized version of Caeciliae by Fr.\ Matthew Spencer, OSJ), Gregorio, and Grana Padano (née Parmesan, developed for Lilypond by Juergen Reuter).
\macroname{\textbackslash gresetgregoriofont}{[\optional{\#1}]\{\#2\}}{gregoriotex-main.tex}
Set the font used for the neumes. The optional argument \texttt{[\#1]}
@@ -391,11 +393,11 @@ available alternate font/rule set is \texttt{op} for Dominican neumes.
Note that the font will be looked up by name through luaotfload, see the documentation of luaotfload for what it implies.
\begin{argtable}
- \#1 & \textit{(omitted)} & Use the normal font and rule set (default).\\
- & \texttt{op} & Use the alternate Dominican font/rule set.\\
- \#2 & \texttt{greciliae} & Use the Greciliae font (default).\\
- & \texttt{gregorio} & Use the Gregorio font.\\
- & \texttt{parmesan} & Use the Parmesan font.\\
+ \#1 & \textit{(omitted)} & Use the normal font and rule set (default).\\
+ & \texttt{op} & Use the alternate Dominican font/rule set.\\
+ \#2 & \texttt{greciliae} & Use the Greciliae font (default).\\
+ & \texttt{gregorio} & Use the Gregorio font.\\
+ & \texttt{granapadano} & Use the Grana Padano font.\\
\end{argtable}
\macroname{\textbackslash gresetgregoriofontscaled}{[\optional{\#1}]\{\#2\}\{\#3\}}{gregoriotex-main.tex}
@@ -412,11 +414,11 @@ Substitutes the given Gregorio\TeX\ score glyph with the specified glyph
from the specified font.
\begin{argtable}
- \#1 & string & The name of the Gregorio\TeX\ glyph to replace.\\
- \#2 & string & The name of the font to use.\\
- \#3 & number & The code point of the glyph to use.\\
- & \texttt{.}string & The name of the variant (appended to \#1) to use.\\
- & string & (any other string) The name of the glyph to use.
+ \#1 & string & The name of the Gregorio\TeX\ glyph to replace.\\
+ \#2 & string & The name of the font to use.\\
+ \#3 & number & The code point of the glyph to use.\\
+ & \texttt{.}string & The name of the variant (appended to \#1) to use.\\
+ & string & (any other string) The name of the glyph to use.
\end{argtable}
\medskip If \texttt{\#1} has a wildcard (a \texttt{*}) in it, then
@@ -430,14 +432,14 @@ to be available in all score fonts.
\medskip For example, to use the old glyphs (from Caeciliae) for the
strophicus, use the following:\par\medskip
\begin{latexcode}
- \grechangeglyph{Stropha}{greciliae}{.caeciliae}
- \grechangeglyph{StrophaAucta}{greciliae}{.caeciliae}
+ \grechangeglyph{Stropha}{greciliae}{.caeciliae}
+ \grechangeglyph{StrophaAucta}{greciliae}{.caeciliae}
\end{latexcode}
\medskip To replace all torculus resupinus glyphs with their alternate
versions, use the following:\par\medskip
\begin{latexcode}
- \grechangeglyph{TorculusResupinus*}{*}{.alt}
+ \grechangeglyph{TorculusResupinus*}{*}{.alt}
\end{latexcode}
\macroname{\textbackslash greresetglyph}{\{\#1\}}{gregoriotex-main.tex}
@@ -445,7 +447,7 @@ Removes a Gregorio\TeX\ score glyph substitution, restoring it back to
its original form.
\begin{argtable}
- \#1 & string & The name of the Gregorio\TeX\ glyph to restore.\\
+ \#1 & string & The name of the Gregorio\TeX\ glyph to restore.\\
\end{argtable}
\medskip If \texttt{\#1} has a wildcard (a \texttt{*}) in it, then
@@ -454,14 +456,14 @@ all glyphs matching \texttt{\#1} will be restored.
\medskip For example, to restore the strophicus back to the new glyphs,
use the following:\par\medskip
\begin{latexcode}
- \greresetglyph{Stropha}
- \greresetglyph{StrophaAucta}
+ \greresetglyph{Stropha}
+ \greresetglyph{StrophaAucta}
\end{latexcode}
\medskip To restore all torculus resupinus glyphs to their original
form, use the following:\par\medskip
\begin{latexcode}
- \greresetglyph{TorculusResupinus*}
+ \greresetglyph{TorculusResupinus*}
\end{latexcode}
\macroname{\textbackslash gredefsymbol}{\{\#1\}\{\#2\}\{\#3\}}{gregoriotex-symbols.tex}
@@ -469,10 +471,10 @@ Defines (or redefines) a \TeX\ control sequence to be a non-score symbol.
If defined this way, the symbol will scale with the text font.
\begin{argtable}
- \#1 & string & The name of the \TeX\ control sequence (without leading backslash).\\
- \#2 & string & The name of the font to use.\\
- \#3 & number & The code point of the glyph to use.\\
- & string & The name of the glyph to use.
+ \#1 & string & The name of the \TeX\ control sequence (without leading backslash).\\
+ \#2 & string & The name of the font to use.\\
+ \#3 & number & The code point of the glyph to use.\\
+ & string & The name of the glyph to use.
\end{argtable}
\macroname{\textbackslash gredefsizedsymbol}{\{\#1\}\{\#2\}\{\#3\}}{gregoriotex-symbols.tex}
@@ -481,45 +483,45 @@ which requires a single numeric argument (in points) to which the symbol
will be scaled.
\begin{argtable}
- \#1 & string & The name of the \TeX\ control sequence (without leading backslash).\\
- \#2 & string & The name of the font to use.\\
- \#3 & number & The code point of the glyph to use.\\
- & string & The name of the glyph to use.
+ \#1 & string & The name of the \TeX\ control sequence (without leading backslash).\\
+ \#2 & string & The name of the font to use.\\
+ \#3 & number & The code point of the glyph to use.\\
+ & string & The name of the glyph to use.
\end{argtable}
\macroname{\textbackslash gresethepisema}{\{\#1\}}{gregoriotex-signs.tex}
Determines whether Gregorio\TeX\ should join (bridge) horizontal episemata on adjacent notes.
\begin{argtable}
- \#1 & \texttt{bridge} & Adjacent horizontal episemata are joined together (default).\\
- & \texttt{break} & Adjacent horizontal episemata are not joined.
+ \#1 & \texttt{bridge} & Adjacent horizontal episemata are joined together (default).\\
+ & \texttt{break} & Adjacent horizontal episemata are not joined.
\end{argtable}
\macroname{\textbackslash gresetpunctumcavum}{\{\#1\}}{gregoriotex-signs.tex}
A shortcut for switching to the alternative punctum cavum and back.
\begin{argtable}
- \#1 & \texttt{alternate} & use the alternate punctum cavum\\
- & \texttt{normal} & use the normal punctum cavum
+ \#1 & \texttt{alternate} & use the alternate punctum cavum\\
+ & \texttt{normal} & use the normal punctum cavum
\end{argtable}
Using the alternate punctum cavum is the equivalent of issuing the following commands:
\begin{latexcode}
- \grechangeglyph{PunctumCavum}{greciliae}{.caeciliae}%
- \grechangeglyph{LineaPunctumCavum}{greciliae}{.caeciliae}%
- \grechangeglyph{PunctumCavumHole}{greciliae}{.caeciliae}%
- \grechangeglyph{LineaPunctumCavumHole}{greciliae}{.caeciliae}%
+ \grechangeglyph{PunctumCavum}{greciliae}{.caeciliae}%
+ \grechangeglyph{LineaPunctumCavum}{greciliae}{.caeciliae}%
+ \grechangeglyph{PunctumCavumHole}{greciliae}{.caeciliae}%
+ \grechangeglyph{LineaPunctumCavumHole}{greciliae}{.caeciliae}%
\end{latexcode}
\macroname{\textbackslash gresetglyphstyle}{\{\#1\}}{gregoriotex-chars.tex}
Gregorio\TeX\ supports several glyph styles which can be changed with this macro. These style replace some non-note glyphs with alternatives.
\begin{argtable}
- \#1 & \texttt{default} & Use the default style\\
- & \texttt{medicaea} & Use a Medicaea style\\
- & \texttt{hufnagel} & Use the hufnagel style\\
- & \texttt{mensural} & Use the mensural style
+ \#1 & \texttt{default} & Use the default style\\
+ & \texttt{medicaea} & Use a Medicaea style\\
+ & \texttt{hufnagel} & Use the hufnagel style\\
+ & \texttt{mensural} & Use the mensural style
\end{argtable}
%%% Should there be a table here or in the appendix which shows the affected glyphs in each of the styles?
@@ -531,8 +533,8 @@ Gregorio\TeX\ supports several glyph styles which can be changed with this macro
Redefines a \TeX\ control sequence to be a a barred symbol.
\begin{argtable}
- \#1 & character & must be \texttt{A}, \texttt{R}, or \texttt{V}.\\
- \#2 & dimension & how much the bar will be shifted left.\\
+ \#1 & character & must be \texttt{A}, \texttt{R}, or \texttt{V}.\\
+ \#2 & dimension & how much the bar will be shifted left.\\
\end{argtable}
Gregorio\TeX\ does not have precomposed barred letters, instead, it has bars that you
@@ -542,7 +544,7 @@ simple version.
For example:
\medskip \begin{latexcode}
- \gresimpledefbarredsymbol{A}{0.3em}
+ \gresimpledefbarredsymbol{A}{0.3em}
\end{latexcode}
Will define \texttt{\textbackslash Abar} to be a A with a bar shifted right
@@ -554,12 +556,12 @@ certainly have to change this value by calling the \texttt{\textbackslash gresim
Redefines a \TeX\ control sequence to be a barred symbol.
\begin{argtable}
- \#1 & string & the name of the command you want to define.\\
- \#2 & string & command to typeset the text.\\
- \#3 & string & symbol of the bar (must be defined through \texttt{gredefsizedsymbol}).\\
- \#4 & number & the size of greextra to use (in pt).\\
- \#5 & dimension & horizontal right shift of the bar.\\
- \#6 & dimension & vertical shift of the bar glyph.\\
+ \#1 & string & the name of the command you want to define.\\
+ \#2 & string & command to typeset the text.\\
+ \#3 & string & symbol of the bar (must be defined through \texttt{gredefsizedsymbol}).\\
+ \#4 & number & the size of greextra to use (in pt).\\
+ \#5 & dimension & horizontal right shift of the bar.\\
+ \#6 & dimension & vertical shift of the bar glyph.\\
\end{argtable}
This is a more complete version of the previous command, it allows you to define
@@ -570,7 +572,7 @@ For example:
\begin{footnotesize}
\begin{latexcode}
- \gredefbarredsymbol{RBarBold}{\textbf{R}}{greRBarSmall}{13}{1.7mm}{0.1mm}
+ \gredefbarredsymbol{RBarBold}{\textbf{R}}{greRBarSmall}{13}{1.7mm}{0.1mm}
\end{latexcode}
\end{footnotesize}
@@ -589,11 +591,11 @@ Redefines a \TeX\ control sequence to be a barred symbol.
\bigskip\textbf{Only available in \LaTeX.}
\begin{argtable}
- \#1 & character & must be \texttt{A}, \texttt{R}, or \texttt{V}.\\
- \#2 & dimension & how much the bar will be shifted left when upright and medium weight.\\
- \#3 & dimension & how much the bar will be shifted left when italic/slanted and medium weight.\\
- \#4 & dimension & how much the bar will be shifted left when upright and bold.\\
- \#5 & dimension & how much the bar will be shifted left when italic/slanted and bold.\\
+ \#1 & character & must be \texttt{A}, \texttt{R}, or \texttt{V}.\\
+ \#2 & dimension & how much the bar will be shifted left when upright and medium weight.\\
+ \#3 & dimension & how much the bar will be shifted left when italic/slanted and medium weight.\\
+ \#4 & dimension & how much the bar will be shifted left when upright and bold.\\
+ \#5 & dimension & how much the bar will be shifted left when italic/slanted and bold.\\
\end{argtable}
This is like \verb=\gresimpledefbarglyph=, but allows setting different shifts
@@ -607,11 +609,11 @@ definitions. Instead, it actually generates the code that would show the
barred symbol.
\begin{argtable}
- \#1 & string & command to typeset the text.\\
- \#2 & string & symbol of the bar (must be defined through \texttt{gredefsizedsymbol}).\\
- \#3 & number & the size of greextra to use (in pt).\\
- \#4 & dimension & horizontal right shift of the bar.\\
- \#5 & dimension & vertical shift of the bar glyph.\\
+ \#1 & string & command to typeset the text.\\
+ \#2 & string & symbol of the bar (must be defined through \texttt{gredefsizedsymbol}).\\
+ \#3 & number & the size of greextra to use (in pt).\\
+ \#4 & dimension & horizontal right shift of the bar.\\
+ \#5 & dimension & vertical shift of the bar glyph.\\
\end{argtable}
\macroname{\textbackslash gothRbar}{}{gregoriotex-symbols.tex}
@@ -636,16 +638,16 @@ Prints \gresixstar. Defined with \verb=\gredefsymbol=.
A macro for invoking one of the five separators (fancy lines) which are contained in the greextra font.
\begin{argtable}
- \#1 & \texttt{1}--\texttt{5} & Choose the number of the line desired\\
- \#2 & integer & the point size at which to print the line\\
+ \#1 & \texttt{1}--\texttt{5} & Choose the number of the line desired\\
+ \#2 & integer & the point size at which to print the line\\
\end{argtable}
\macroname{\textbackslash greornamentation}{\{\#1\}\{\#2\}}{gregoriotex-symbols.tex}
A macro for invoking one of the ornamentation elements which are contained in the greextra font.
\begin{argtable}
- \#1 & \texttt{1}--\texttt{2} & Choose the number of the ornamentation desired\\
- \#2 & integer & the point size at which to print the line\\
+ \#1 & \texttt{1}--\texttt{2} & Choose the number of the ornamentation desired\\
+ \#2 & integer & the point size at which to print the line\\
\end{argtable}
@@ -658,9 +660,9 @@ Sets a special character. Special characters are used from gabc within
\texttt{<sp>} and \texttt{</sp>}.
\begin{argtable}
- \#1 & string & The text between \texttt{<sp>} and \texttt{</sp>}.\\
- \#2 & \TeX\ code & The \TeX\ code to substitute when \texttt{<sp>\#1</sp>}
- is used in gabc.\\
+ \#1 & string & The text between \texttt{<sp>} and \texttt{</sp>}.\\
+ \#2 & \TeX\ code & The \TeX\ code to substitute when \texttt{<sp>\#1</sp>}
+ is used in gabc.\\
\end{argtable}
\textbf{Nota Bene:} If you need to use a character in \#1 that is made special
@@ -674,13 +676,13 @@ Un-sets a special character. Using an unset special character will use its
text directly.
\begin{argtable}
- \#1 & string & The text between \texttt{<sp>} and \texttt{</sp>}.\\
+ \#1 & string & The text between \texttt{<sp>} and \texttt{</sp>}.\\
\end{argtable}
\textbf{Nota Bene:} The same rules apply for \#1 as in \verb=\gresetspecial=.
\macroname{\textbackslash gretilde}{}{gregoriotex-main.tex}
-Macro to print $\sim$. This macro is set using the above for \texttt{<sp>~</sp>}.
+Macro to print $\sim$. This macro is set using the above for \texttt{<sp>$\sim$</sp>}.
@@ -692,55 +694,54 @@ Different elements of an include score have different styles applied. These ele
\renewcommand{\thefootnote}{\fnsymbol{footnote}}
\bigskip\rowcolors{1}{lightgray}{lightgray}
\begin{tabular}{lp{7cm plus .5cm}r}
- Element Name & Description & Default\\
- \hline
- \stylename{abovelinestext} & above line text (\texttt{<alt></alt>} in gabc, appears above the staff) & normal\\
- \stylename{additionalstafflines} & short lines behind notes above or below the staff & special\footnotemark[1]\\
- \stylename{annotation} & the annotation & none\\
- \stylename{commentary} & the commentary & {\footnotesize\it footnote-size italics}\\
- \stylename{elision} & elisions (\texttt{<e></e>} in gabc) & {\textit{\small small-size italics}} (\LaTeX)\\
- && {\textit{italics}} (Plain \TeX)\\
- \stylename{firstsyllable} & the first syllable of the score excluding the score initial & none\\
- \stylename{firstsyllableinitial} & the first letter of the first syllable of a score which is not the score initial & none\\
- \stylename{firstword} & the first word of the first score excluding the score initial & none\\
- \stylename{highchoralsign} & high choral signs & none\\
- \stylename{initial} & Score initial (the first letter of the score, when offset from the rest of the text) & 40 pt font\\
- \stylename{lowchoralsign} & low choral signs & none\\
- \stylename{modedifferentia} & the rendered annotation from the \texttt{mode-differentia: ;} header in the gabc file & \parbox[t]{2.2cm}{\raggedleft\textbf{bold}}\\
- \stylename{modeline} & the rendered annotation from the \texttt{mode: ;} header in the gabc file & \parbox[t]{2.2cm}{\raggedleft\textsc{\textbf{bold small capitals}}}\\
- \stylename{modemodifier} & the rendered annotation from the \texttt{mode-modifier: ;} header in the gabc file & \parbox[t]{2.2cm}{\raggedleft\textit{\textbf{bold italics}}}\\
- \stylename{nabc} & ancient notation & {\color{gregoriocolor}gregoriocolor} (\LaTeX)\\
- && none (Plain \TeX)\\
- \stylename{normalstafflines} & Full length staff lines & none\\
- \stylename{translation} & Translation text (appears below lyrics) & {\it italics}\\
+ Element Name & Description & Default\\
+ \hline
+ \stylename{abovelinestext} & above line text (\texttt{<alt></alt>} in gabc, appears above the staff) & normal\\
+ \stylename{additionalstafflines} & short lines behind notes above or below the staff & special\footnotemark[1]\\
+ \stylename{annotation} & the annotation & none\\
+ \stylename{commentary} & the commentary & {\footnotesize\it footnote-size italics}\\
+ \stylename{elision} & elisions (\texttt{<e></e>} in gabc) & {\textit{\small small-size italics}} (\LaTeX)\\
+ && {\textit{italics}} (Plain \TeX)\\
+ \stylename{firstsyllable} & the first syllable of the score excluding the score initial & none\\
+ \stylename{firstsyllableinitial} & the first letter of the first syllable of a score which is not the score initial & none\\
+ \stylename{firstword} & the first word of the first score excluding the score initial & none\\
+ \stylename{highchoralsign} & high choral signs & none\\
+ \stylename{initial} & Score initial (the first letter of the score, when offset from the rest of the text) & 40 pt font\\
+ \stylename{lowchoralsign} & low choral signs & none\\
+ \stylename{modedifferentia} & the rendered annotation from the \texttt{mode-differentia: ;} header in the gabc file & \parbox[t]{2.2cm}{\raggedleft\textbf{bold}}\\
+ \stylename{modeline} & the rendered annotation from the \texttt{mode: ;} header in the gabc file & \parbox[t]{2.2cm}{\raggedleft\textsc{\textbf{bold small capitals}}}\\
+ \stylename{modemodifier} & the rendered annotation from the \texttt{mode-modifier: ;} header in the gabc file & \parbox[t]{2.2cm}{\raggedleft\textit{\textbf{bold italics}}}\\
+ \stylename{nabc} & ancient notation & {\color{gregoriocolor}gregoriocolor}\\
+ \stylename{normalstafflines} & Full length staff lines & none\\
+ \stylename{translation} & Translation text (appears below lyrics) & {\it italics}\\
\end{tabular}
\end{adjustbox}
\footnotemark[1]\textit{Special:} By default, \texttt{additionalstafflines} inherits its properties from \texttt{normalstafflines}. To decouple these environments, you must manually change \texttt{additionalstafflines} using \texttt{\textbackslash grechangestyle}.
\renewcommand{\thefootnote}{\arabic{footnote}}\breakabletrue
-\macroname{\textbackslash grechangestyle}{\{\#1\}\{\#2\}[\#3]}{gregoriotex.sty \textup{and} gregoriotex.tex}
+\macroname{\textbackslash grechangestyle}{\{\#1\}\{\#2\}[\optional{\#3}]}{gregoriotex.sty \textup{and} gregoriotex.tex}
Command to change styling of a score element.
\begin{argtable}
- \#1 & string & element whose styling is to be changed (see list above for options)\\
- \#2 & \TeX\ code & the code necessary to turn on the styling\\
- \#3 & \TeX\ code & Optional. The code necessary to turn off the styling (\eg, if the code to turn on the styling contains a \verb=\begin{environment}= then the code to turn it off must have the matching \verb=\end{environment}=.
+ \#1 & string & element whose styling is to be changed (see list above for options)\\
+ \#2 & \TeX\ code & the code necessary to turn on the styling\\
+ \#3 & \TeX\ code & Optional. The code necessary to turn off the styling (\eg, if the code to turn on the styling contains a \verb=\begin{environment}= then the code to turn it off must have the matching \verb=\end{environment}=.
\end{argtable}
Examples:\par\medskip
\begin{latexcode}
- % This one works for both PlainTeX and LaTeX this would make
- % the translations bold and italic
- \grechangestyle{translation}{\it\bf}
+ % This one works for both PlainTeX and LaTeX this would make
+ % the translations bold and italic
+ \grechangestyle{translation}{\it\bf}
- % This one is LaTeX only, and would make the above lines
- % text small and italic
- \grechangestyle{abovelinestext}{\begin{small}\begin{itshape}}%
- [\end{itshape}\end{small}]
+ % This one is LaTeX only, and would make the above lines
+ % text small and italic
+ \grechangestyle{abovelinestext}{\begin{small}\begin{itshape}}%
+ [\end{itshape}\end{small}]
- % This would make the initial print in 36pt font.
- \grechangestyle{initial}{\fontsize{36}{36}\selectfont}
+ % This would make the initial print in 36pt font.
+ \grechangestyle{initial}{\fontsize{36}{36}\selectfont}
\end{latexcode}
\bigskip
@@ -749,24 +750,24 @@ Each element will be typeset within an isolated group to prevent styling command
\subsubsection{Text Elements}
While the gabc headers provide support for some of the text elements commonly found on chant scores, Gregorio\TeX\ provides the following functions to allow you to enter and control those elements with a greater degree of precision than the gabc headers.
-\macroname{\textbackslash greannotation}{[\#1]\{\#2\}}{gregoriotex-main.tex}
+\macroname{\textbackslash greannotation}{[\optional{\#1}]\{\#2\}}{gregoriotex-main.tex}
Macro to add annotations (the text which appears above the initial) to a score. While a single call of the function does not support multiple lines, successive calls to the function will be added to the annotation as a new line below what is already there.
\begin{argtable}
- \#1 & \texttt{c} & When adding a new line, align the center of the new line with the center of the existing lines\\
- & \texttt{l} & When adding a new line, align the left side of the new line with the left side of the existing lines\\
- & \texttt{r} & When adding a new line, align the right side of the new line with the right side of the existing lines\\
- \#2 & string & the text of the annotation
+ \#1 & \texttt{c} & When adding a new line, align the center of the new line with the center of the existing lines\\
+ & \texttt{l} & When adding a new line, align the left side of the new line with the left side of the existing lines\\
+ & \texttt{r} & When adding a new line, align the right side of the new line with the right side of the existing lines\\
+ \#2 & string & the text of the annotation
\end{argtable}
\textbf{Nota Bene:} The first argument does not affect the alignment of lines already in the annotation, only the way the new line aligns with the existing lines as a whole.
-\macroname{\textbackslash grecommentary}{[\optional{\#2}]\{\#1\}}{gregoriotex-main.tex}
+\macroname{\textbackslash grecommentary}{[\optional{\#1}]\{\#2\}}{gregoriotex-main.tex}
Macro to add commentary (the text flush right at the top, usually a scripture reference) to a score. While a single call of this function does not support multiple lines, successive calls to the function will add a new line to the commentary directly below the previous.
\begin{argtable}
- \#1 & distance & Optional. Additional distance to be placed between the commentary and the top staff line for the next score only.\\
- \#2 & string & The text of the commentary.\\
+ \#1 & distance & Optional. Additional distance to be placed between the commentary and the top staff line for the next score only.\\
+ \#2 & string & The text of the commentary.\\
\end{argtable}
\textbf{Nota Bene:} If your commentary is multi-lined, then the optional argument of the last line, and only the last line, will be taken into account. Further, pay attention to the fact that the optional argument is \emph{additional} distance, \ie, it will be added to \texttt{commentaryraise} to determine the distance from the baseline of the commentary to the top line of the staff.
@@ -775,29 +776,38 @@ Macro to add commentary (the text flush right at the top, usually a scripture re
Macro to add an illuminated initial.
\begin{argtable}
- \#1 & \TeX\ code & the code necessary to make the illuminated initial appear\\
+ \#1 & \TeX\ code & the code necessary to make the illuminated initial appear\\
\end{argtable}
\textbf{Nota Bene:} Usually the argument of this command should be an \verb=\includegraphics= command, but you may use what ever you want as the illuminated initial.
-\macroname{\textbackslash gresetinitiallines}{\#1}{gregoriotex-syllable.tex}
+\macroname{\textbackslash gresetinitiallines}{\{\#1\}}{gregoriotex-syllable.tex}
Sets the number of lines the score initial requires.
\begin{argtable}
- \#1 & number & The number of lines required by the initial. If \texttt{0}, the score will have no separated initial.\\
+ \#1 & number & The number of lines required by the initial. If \texttt{0}, the score will have no separated initial.\\
\end{argtable}
\textbf{Nota Bene:} As currently implemented, you cannot set an initial which is larger than 2 lines and in order to do so you must set manual line breaks in the gabc for the first two lines.
-\macroname{\textbackslash gresetmodenumbersystem}{\#1}{gregoriotex-main.tex}
+\macroname{\textbackslash gresetmodenumbersystem}{\{\#1\}}{gregoriotex-main.tex}
Sets the number system used for the mode number.
\begin{argtable}
- \#1 & \texttt{roman-minuscule} & Use lower-case Roman numerals (the default, good for small capitals).\\
- & \texttt{roman-majuscule} & Use upper-case Roman numerals.\\
- & \texttt{arabic} & Use Arabic numerals.\\
+ \#1 & \texttt{roman-minuscule} & Use lower-case Roman numerals (the default, good for small capitals).\\
+ & \texttt{roman-majuscule} & Use upper-case Roman numerals.\\
+ & \texttt{arabic} & Use Arabic numerals.\\
\end{argtable}
+\macroname{\textbackslash gresetlyrics}{\{\#1\}}{gregoriotex-syllable.tex}
+Sets the visibility of the lyrics.
+
+\begin{argtable}
+ \#1 & \texttt{visible} & Lyrics are visible (default).\\
+ & \texttt{invisible} & Lyrics are not visible.\\
+\end{argtable}
+
+
\subsubsection{Text Alignment}
Gregorio\TeX\ allows you to manipulate the global alignment behavior of some text elements using the following commands.
@@ -811,9 +821,9 @@ Macro to set how the text of the lyrics aligns with the alignment point of its r
\end{itemize}
\begin{argtable}
- \#1 & \texttt{vowel} & The center of the vowel in the syllable will align with the alignment point of the neumes\\
- & \texttt{syllable} & The center of the syllable will align with the alignment point of the neumes\\
- & \texttt{firstletter} & The center of the first letter/character of the syllable will align with the alignment point of the neumes\\
+ \#1 & \texttt{vowel} & The center of the vowel in the syllable will align with the alignment point of the neumes\\
+ & \texttt{syllable} & The center of the syllable will align with the alignment point of the neumes\\
+ & \texttt{firstletter} & The center of the first letter/character of the syllable will align with the alignment point of the neumes\\
\end{argtable}
\textbf{Nota Bene:} What constitutes the ``vowel'' of the syllable is determined by the language the lyric text is written in, as specified by the use of the \texttt{language} header in the gabc file. Out of the box, Gregorio\TeX\ explicitly supports only Latin and English, but the rules for Latin have a high degree of overlap with many Romance languages, allowing them to fall back on the Latin rules with acceptable results.
@@ -826,33 +836,33 @@ Finally, in cases where you want some sort of exceptional alignment, you can for
Macro to determine whether a forced center (\ie, one specified by curly braces (``\{'' and ``\}'') in your gabc file) should influence the alignment of that syllable when \texttt{syllable} and \texttt{firstletter} alignments are in effect.
\begin{argtable}
- \#1 & \texttt{allow} & Forced centers in gabc are allowed to influence the syllable alignment (default).\\
- & \texttt{prohibit} & Forced centers in gabc do not influence the syllable alignment.\\
+ \#1 & \texttt{allow} & Forced centers in gabc are allowed to influence the syllable alignment (default).\\
+ & \texttt{prohibit} & Forced centers in gabc do not influence the syllable alignment.\\
\end{argtable}
\macroname{\textbackslash gresettranslationcentering}{\{\#1\}}{gregoriotex-main.tex}
Macro to specify how the translation text should be aligned with it respective syllable text.
\begin{argtable}
- \#1 & \texttt{left} & The translation text is left aligned with its respective syllable text.\\
- & \texttt{center} & The translation text is centered under its respective syllable.
+ \#1 & \texttt{left} & The translation text is left aligned with its respective syllable text.\\
+ & \texttt{center} & The translation text is centered under its respective syllable.
\end{argtable}
\macroname{\textbackslash gresetannotationby}{\{\#1\}}{gregoriotex-main.tex}
Macro to specify which line of the annotation should be used to determine its starting placement (i.e. before \texttt{annotationraise} is applied).
\begin{argtable}
- \#1 & \texttt{firstline} & Annotation placement is determined by the first line (default)\\
- & \texttt{lastline} & annotation placement is determined by the last line\\
+ \#1 & \texttt{firstline} & Annotation placement is determined by the first line (default)\\
+ & \texttt{lastline} & annotation placement is determined by the last line\\
\end{argtable}
\macroname{\textbackslash gresetannotationvalign}{\{\#1\}}{gregoriotex-main.tex}
Macro to specify which part of the control line in the annotation should be aligned with the top line of the staff before \texttt{annotationraise} is applied.
\begin{argtable}
- \#1 & \texttt{top} & The top of the annotation control line will align with the top line of the staff\\
- & \texttt{baseline} & The baseline of the control line is used (default)\\
- & \texttt{bottom} & The bottom of the control line is used\\
+ \#1 & \texttt{top} & The top of the annotation control line will align with the top line of the staff\\
+ & \texttt{baseline} & The baseline of the control line is used (default)\\
+ & \texttt{bottom} & The bottom of the control line is used\\
\end{argtable}
\textbf{Nota Bene:} These variable refer to the actual contents of the line and not to the ``hypothetical'' limits for the font. As a result if the top of an annotation containing only short letters will be different from one which contains tall ones even if both use the same font. Likewise, if the annotation contains no descenders, then baseline and bottom will be the same. If this is a problem, then the use of struts within the annotation can be used to control the line height (distance from baseline to top) and depth (distance from baseline to bottom).
@@ -864,8 +874,8 @@ While Gregorio\TeX\ will automatically wrap scores to fit your page, there are s
Macro to determine whether an automatic linebreak before a EUOUAE area is justified or not.
\begin{argtable}
- \#1 & \texttt{justified} & Automatic line breaks before EUOUAE areas should be justified (default)\\
- & \texttt{ragged} & Automatic line breaks before EUOUAE areas should be ragged\\
+ \#1 & \texttt{justified} & Automatic line breaks before EUOUAE areas should be justified (default)\\
+ & \texttt{ragged} & Automatic line breaks before EUOUAE areas should be ragged\\
\end{argtable}
\textbf{Important:} When set to \texttt{ragged}, Gregorio\TeX{} will require a
@@ -883,24 +893,33 @@ Module gregoriotex warning: Line heights or variable brace lengths may have chan
Macro to determine whether line breaks are allowed inside a EUOUAE area (delimited by \texttt{<eu></eu>} tags in gabc).
\begin{argtable}
- \#1 & \texttt{allow} & Line breaks are allowed\\
- & \texttt{prohibit} & Line breaks are prohibited, the entire EUOUAE area should appear on one line
+ \#1 & \texttt{allow} & Line breaks are allowed\\
+ & \texttt{prohibit} & Line breaks are prohibited, the entire EUOUAE area should appear on one line
\end{argtable}
\macroname{\textbackslash gresetbreakintranslation}{\{\#1\}}{gregoriotex-main.tex}
Macro to determine whether line breaks are allowed inside a translation.
\begin{argtable}
- \#1 & \texttt{allow} & Line breaks are allowed\\
- & \texttt{prohibit} & Line breaks are prohibited, the entire translation should appear on one line
+ \#1 & \texttt{allow} & Line breaks are allowed\\
+ & \texttt{prohibit} & Line breaks are prohibited, the entire translation should appear on one line
+\end{argtable}
+
+\macroname{\textbackslash gresetcustosalteration}{\{\#1\}}{gregoriotex-signs.tex}
+Macro for setting whether an alteration (flat, sharp, or natural) should be
+rendered before a custos or not.
+
+\begin{argtable}
+ \#1 & \texttt{visible} & The custos alteration should be printed (default)\\
+ & \texttt{invisible} & The custos alteration should not be printed
\end{argtable}
\macroname{\textbackslash greseteolcustos}{\{\#1\}}{gregoriotex-main.tex}
Macro to determine whether Gregorio\TeX\ should automatically place the custos at a line break.
\begin{argtable}
- \#1 & \texttt{auto} & Custos will be automatically placed at each line break\\
- & \texttt{manual} & Custos will only be placed at line breaks if they are specified in the gabc (\eg \texttt{(g+z)})
+ \#1 & \texttt{auto} & Custos will be automatically placed at each line break\\
+ & \texttt{manual} & Custos will only be placed at line breaks if they are specified in the gabc (\eg \texttt{(g+z)})
\end{argtable}
\textbf{Nota Bene:} This command only effects the custos that appears at the end of a line. Custos which are placed at a key change are unaffected. Further, if custos are specified in the gabc file manually and Gregorio\TeX\ is set to place custos automatically, you will get two custos at the line breaks.
@@ -909,8 +928,8 @@ Macro to determine whether Gregorio\TeX\ should automatically place the custos a
Macro to determine whether Gregorio\TeX\ should automatically place the custos at a line break before a EUOUAE. Since the EUOUAE block is typically not a continuation of the melody but rather a reminder of the end of the tone that follows, this is set to \texttt{suppressed} (no custos) by default.
\begin{argtable}
- \#1 & \texttt{suppressed} & Custos will not automatically be placed at a line break before a EUOUAE block (the default)\\
- & \texttt{auto} & Custos will behave according to \verb=greseteolcustos= at a line break before a EUOUAE block\\
+ \#1 & \texttt{suppressed} & Custos will not automatically be placed at a line break before a EUOUAE block (the default)\\
+ & \texttt{auto} & Custos will behave according to \verb=greseteolcustos= at a line break before a EUOUAE block\\
\end{argtable}
\textbf{Nota Bene:} If \verb=\greseteolcustos= is set to \texttt{manual}, this setting is effectively ignored.
@@ -919,24 +938,39 @@ Macro to determine whether Gregorio\TeX\ should automatically place the custos a
Macro to determine whether Gregorio\TeX\ should apply a small shift at the end of each line which allows lyrics to stretch under the final custos.
\begin{argtable}
- \#1 & \texttt{enable} & The shifts are applied (default)\\
- & \texttt{disable} & The shifts are not applied.
+ \#1 & \texttt{enable} & The shifts are applied (default)\\
+ & \texttt{disable} & The shifts are not applied.
\end{argtable}
\macroname{\textbackslash gresetbolshifts}{\{\#1\}}{gregoriotex-main.tex}
Macro to determine whether Gregorio\TeX\ should apply a small shift at the beginning of each line so that lines are aligned on the notes rather than the syllable text.
\begin{argtable}
- \#1 & \texttt{enable} & The shifts are applied (default)\\
- & \texttt{disable} & The shifts are not applied.
+ \#1 & \texttt{enable} & The shifts are applied (default)\\
+ & \texttt{disable} & The shifts are not applied.
\end{argtable}
\macroname{\textbackslash gresetlastline}{\{\#1\}}{gregoriotex-main.tex}
Macro to determine whether the last line of the score should be justified or not.
\begin{argtable}
- \#1 & \texttt{justified} & Set the last line justified with the rest of the score\\
- & \texttt{ragged} & Set the last line ragged (default)
+ \#1 & \texttt{justified} & Set the last line justified with the rest of the score\\
+ & \texttt{ragged} & Set the last line ragged (default)
+\end{argtable}
+
+\macroname{\textbackslash gresetunbreakablesyllablenote}{\{\#1\}\{\#2\}\{\#3\}}{gregoriotex-syllable.tex}
+Configures how notes should be kept together on line breaks.
+
+\begin{argtable}
+ \#1 & integer & The minimum number of notes in the syllable before the
+ syllable may be broken across lines. Defaults to
+ \getgrecount{unbreakabletotalnotes}.\\
+ \#2 & integer & The minimum number of notes at the start of a syllable that
+ must be kept together when the syllable is broken across
+ lines. Defaults to \getgrecount{unbreakableinitialnotes}.\\
+ \#3 & integer & The minimum number of notes at the end of a syllable that
+ must be kept together when the syllable is broken across
+ lines. Defaults to \getgrecount{unbreakablefinalnotes}.\\
\end{argtable}
@@ -946,12 +980,12 @@ Macro to determine whether the last line of the score should be justified or not
Macro to change the behaviour for separation between notes of two syllables when the first ends with a punctum mora. The argument changes the cases in which punctum mora are ignored in space computation:
\begin{argtable}
- \#1 & \texttt{always} & punctum mora are always ignored (default)\\
- & \texttt{notesonly} & punctum mora are ignored before notes, not bars\\
- & \texttt{barsonly} & punctum mora are ignored before bars, not notes\\
- & \texttt{notextonly} & punctum mora are ignored only before bars inside syllables, or bars having their own syllable without text\\
- & \texttt{insideonly} & punctum mora are ignored only before bars inside syllables\\
- & \texttt{never} & punctum mora are never ignored\\
+ \#1 & \texttt{always} & punctum mora are always ignored (default)\\
+ & \texttt{notesonly} & punctum mora are ignored before notes, not bars\\
+ & \texttt{barsonly} & punctum mora are ignored before bars, not notes\\
+ & \texttt{notextonly} & punctum mora are ignored only before bars inside syllables, or bars having their own syllable without text\\
+ & \texttt{insideonly} & punctum mora are ignored only before bars inside syllables\\
+ & \texttt{never} & punctum mora are never ignored\\
\end{argtable}
When a punctum mora is ignored, the bar will also be shifted by \texttt{moraadjustmentbar} (zero by default), see its description in the \nameref{distances} section.
@@ -960,22 +994,32 @@ When a punctum mora is ignored, the bar will also be shifted by \texttt{moraadju
Macro to activate the new bar spacing algorithm. The new algorithm attempts to place the bar line exactly midway between its surrounding notes. Any text associated with the bar is placed midway between its surrounding text. Since this might result in the bar line and the text being widely separated, there are also a limits to the distance between their respective centers: \texttt{maxbaroffsettextleft} and \texttt{maxbaroffsettextright} (when text center is respectively on the left or on the right of bar center).
\begin{argtable}
- \#1 & \texttt{new} & Activates the new spacing algorithm\\
- & \texttt{old} & Activates the old behavior (Default)\\
+ \#1 & \texttt{new} & Activates the new spacing algorithm\\
+ & \texttt{old} & Activates the old behavior (Default)\\
\end{argtable}
\subsubsection{Sign printing}
+\macroname{\textbackslash gresetnotes}{\{\#1\}}{gregoriotex-syllable.tex}
+Sets the visibility of the notes.
+
+\begin{argtable}
+ \#1 & \texttt{visible} & Notes are visible (default).\\
+ & \texttt{invisible} & Notes are not visible.\\
+\end{argtable}
+
+\textbf{Nota Bene:} If the notes are set to be invisible, then bar lines, rythmic signs, and the like will also be invisible. However, the staff lines and clefs will still show up (since their visibility is controlled by other settings).
+
\macroname{\textbackslash greprintsigns}{\{\#1\}\{\#2\}}{gregoriotex-signs.tex}
Macro to prevent rythmic signs from printing (all signs are printed by default):
\begin{argtable}
- \#1 & \texttt{vepisema} & sets the printing of vertical episema\\
- & \texttt{hepisema} & sets the printing of horizontal episema\\
- & \texttt{mora} & sets the printing of punctum mora and auctum duplex\\
- & \texttt{all} & set the printing of all of these\\
- \#2 & \texttt{enable} & enable the printing\\
- & \texttt{disable} & disable the priting\\
+ \#1 & \texttt{vepisema} & sets the printing of vertical episema\\
+ & \texttt{hepisema} & sets the printing of horizontal episema\\
+ & \texttt{mora} & sets the printing of punctum mora and auctum duplex\\
+ & \texttt{all} & set the printing of all of these\\
+ \#2 & \texttt{enable} & enable the printing\\
+ & \texttt{disable} & disable the printing\\
\end{argtable}
Note that punctum mora and auctum duplex have an influence on spacings, so removing them will have an impact on that matter.
@@ -986,31 +1030,31 @@ Note that punctum mora and auctum duplex have an influence on spacings, so remov
Tells Gregorio\TeX\ how to place a hyphen between syllables in polysyllabic words in a score.
\begin{argtable}
- \#1 & \texttt{force} & Hyphens will appear between all syllables in polysyllabic words.\\
- & \texttt{auto} & Hyphens will appear based on the setting of \texttt{maximumspacewithoutdash} (default)
+ \#1 & \texttt{force} & Hyphens will appear between all syllables in polysyllabic words.\\
+ & \texttt{auto} & Hyphens will appear based on the setting of \texttt{maximumspacewithoutdash} (default)
\end{argtable}
\macroname{\textbackslash gresetemptyfirstsyllablehyphen}{\{\#1\}}{gregoriotex-syllable.tex}
Tells Gregorio\TeX\ how to place a hyphen after an empty first syllable (\ie, when the first syllable consists only of the big initial).
\begin{argtable}
- \#1 & \texttt{force} & A hyphen will appear after an empty first syllable. (default)\\
- & \texttt{auto} & A hyphen will appear after an empty first syllable based on the setting of \texttt{maximumspacewithoutdash}
+ \#1 & \texttt{force} & A hyphen will appear after an empty first syllable. (default)\\
+ & \texttt{auto} & A hyphen will appear after an empty first syllable based on the setting of \texttt{maximumspacewithoutdash}
\end{argtable}
\macroname{\textbackslash greseteolhyphen}{\{\#1\}}{gregoriotex-main.tex}
Marco to determine how much space the hyphen at the end of a line occupies for the purposes of spacing calculations (the visible appearance of the hyphen is unchanged).
\begin{argtable}
- \#1 & \texttt{normal} & The hyphen occupies its normal space\\
- & \texttt{zero} & The hyphen is considered to take up no space
+ \#1 & \texttt{normal} & The hyphen occupies its normal space\\
+ & \texttt{zero} & The hyphen is considered to take up no space
\end{argtable}
\macroname{\textbackslash gresethyphenprotrusion}{\{\#1\}}{gregoriotex-spaces.tex}
Sets the protrusion factor of hyphens at end of lines. The default value is 50, a good compromise in the tested scores.
\begin{argtable}
- \#1 & \texttt{number} & The protrusion factor, percent
+ \#1 & \texttt{number} & The protrusion factor, percent
\end{argtable}
Note that a proper interface for setting protrusion factor of punctuation signs might appear in the next version, deprecating this one. Also, this protrusion factor does not apply to all hyphens (only those inserted by the Lua pass), so use it with caution.
@@ -1021,8 +1065,8 @@ Note that a proper interface for setting protrusion factor of punctuation signs
Macro to tell Gregorio\TeX\ whether the clefs should be printed or not.
\begin{argtable}
- \#1 & \texttt{visible} & Clefs will be printed (default)\\
- & \texttt{invisible} & Clefs will not be printed
+ \#1 & \texttt{visible} & Clefs will be printed (default)\\
+ & \texttt{invisible} & Clefs will not be printed
\end{argtable}
@@ -1033,9 +1077,9 @@ Since the center of the clivis is different from most neumes, Gregorio\TeX\ supp
Macro to determine the method used for aligning the clivis with its lyrics.
\begin{argtable}
- \#1 & \texttt{always} & Align on the real center of the clivis\\
- & \texttt{never} & align on the center of the first punctum in the clivis\\
- & \texttt{special} & align on the real center of the clivis except when (1) notes would go left of text or (2) consonants after vowels are larger than \verb=\gre@dimen@clivisalignmentmin= (default)
+ \#1 & \texttt{always} & Align on the real center of the clivis\\
+ & \texttt{never} & align on the center of the first punctum in the clivis\\
+ & \texttt{special} & align on the real center of the clivis except when (1) notes would go left of text or (2) consonants after vowels are larger than \verb=\gre@dimen@clivisalignmentmin= (default)
\end{argtable}
@@ -1050,13 +1094,13 @@ harmonize (and thus match best) with greciliae, but they still look good
with the other score fonts.
\begin{argtable}
- \#1 & \textit{(omitted)} & change all braces\\
- & \texttt{brace} & change round braces that appear over the staff\\
- & \texttt{underbrace} & change round braces that appear under the staff\\
- & \texttt{curlybrace} & change curly braces\\
- & \texttt{barbrace} & change round braces that appear over divisio bars\\
- \#2 & \texttt{metapost} & \MP{} will be used to render braces\\
- & \texttt{font} & The score font will be used to render braces\\
+ \#1 & \textit{(omitted)} & change all braces\\
+ & \texttt{brace} & change round braces that appear over the staff\\
+ & \texttt{underbrace} & change round braces that appear under the staff\\
+ & \texttt{curlybrace} & change curly braces\\
+ & \texttt{barbrace} & change round braces that appear over divisio bars\\
+ \#2 & \texttt{metapost} & \MP{} will be used to render braces\\
+ & \texttt{font} & The score font will be used to render braces\\
\end{argtable}
\macroname{\textbackslash grebarbracewidth}{}{gregoriotex-signs.tex}
@@ -1077,17 +1121,17 @@ Macro to tell Gregorio\TeX{} to capture a given header of the gabc file, passing
specified \TeX{} macro. Passing an empty \#2 will cancel capture of the given header.
\begin{argtable}
- \#1 & string & The name of the gabc header\\
- \#2 & string & The name of the macro to use (without the leading backslash)
- or empty to stop capturing the given header\\
- \#3 & string & a comma-separated list of options\\
+ \#1 & string & The name of the gabc header\\
+ \#2 & string & The name of the macro to use (without the leading backslash)
+ or empty to stop capturing the given header\\
+ \#3 & string & a comma-separated list of options\\
\end{argtable}
The options are:
\begin{tabular}{ll}
- \texttt{name} & The header name should also be passed to the macro\\
- \texttt{string} & The header value should be passed to the macro as a string\\
+ \texttt{name} & The header name should also be passed to the macro\\
+ \texttt{string} & The header value should be passed to the macro as a string\\
\end{tabular}
If the \texttt{name} option is not supplied, the macro is called with one
@@ -1121,7 +1165,7 @@ Defaults to nothing. If this is called multiple times, the most recent call
will define the behavior at the next set of headers.
\begin{argtable}
- \#1 & \TeX\ code & The code to process before a set of headers.\\
+ \#1 & \TeX\ code & The code to process before a set of headers.\\
\end{argtable}
\macroname{\textbackslash greafterheaders}{\{\#1\}}{gregoriotex-main.tex}
@@ -1130,7 +1174,7 @@ Defaults to nothing. If this is called multiple times, the most recent call
will define the behavior at the next set of headers.
\begin{argtable}
- \#1 & \TeX\ code & The code to process after a set of headers.\\
+ \#1 & \TeX\ code & The code to process after a set of headers.\\
\end{argtable}
@@ -1141,30 +1185,26 @@ For a full description of how to make use of the ancient notation capabilities o
Macro to set the font to be used for the ancient notation.
\begin{argtable}
- \#1 & string & the name of the font\\
- \#2 & integer & point size at which the font should be loaded\\
+ \#1 & string & the name of the font\\
+ \#2 & integer & point size at which the font should be loaded\\
\end{argtable}
\subsection{Counts}\label{counts}
Each of the following counts controls some aspect of the configuration of the Gregorio\TeX\ score. They are changed using \verb=\grechangecount=, documented above.
-\macroname{additionaltopspacethreshold}{}{gsp-default.tex}
-
+\begin{gcount}{additionaltopspacethreshold}
The threshold above which we start accounting notes above lines for additional
vertical space. For instance with a threshold of \texttt{2}, notes with a pitch
of \texttt{k} and \texttt{l} will not interfere with the space above lines.
Set it to a high value if you don't want high notes to interfere with space
above lines.
+\end{gcount}
-Default: \texttt{2}
-
-\macroname{additionaltopspacealtthreshold}{}{gsp-default.tex}
-
+\begin{gcount}{additionaltopspacealtthreshold}
Same as \texttt{additionaltopspacethreshold} but setting the threshold for
notes taken into account with above lines text vertical placement.
-
-Default: \texttt{0}
+\end{gcount}
\subsection{Distances}\label{distances}
@@ -1290,7 +1330,11 @@ Space between notes of a bistropha or tristrophae.
\end{gdimension}
\begin{gdimension}{punctuminclinatumshift}
-Space between two punctum inclinatum.
+Space between two descending puncta inclinata.
+\end{gdimension}
+
+\begin{gdimension}{punctuminclinatumunisonshift}
+Space between two unison puncta inclinata.
\end{gdimension}
\begin{gdimension}{beforepunctainclinatashift}
@@ -1298,7 +1342,8 @@ Space before puncta inclinata.
\end{gdimension}
\begin{gdimension}{punctuminclinatumanddebilisshift}
-Space between a punctum inclinatum and a punctum inclinatum deminutus.
+Space between a punctum inclinatum and a punctum inclinatum deminutus,
+descending.
\end{gdimension}
\begin{gdimension}{punctuminclinatumdebilisshift}
@@ -1306,11 +1351,11 @@ Space between two punctum inclinatum deminutus.
\end{gdimension}
\begin{gdimension}{punctuminclinatumbigshift}
-Space between puncta inclinata, larger ambitus (range=3rd).
+Space between descending puncta inclinata, larger ambitus (range=3rd).
\end{gdimension}
\begin{gdimension}{punctuminclinatummaxshift}
-Space between puncta inclinata, larger ambitus (range=4th or 5th).
+Space between descending puncta inclinata, larger ambitus (range=4th or 5th).
\end{gdimension}
\begin{gdimension}{ascendingpunctuminclinatumshift}
@@ -1421,9 +1466,9 @@ Space at the beginning of the lines if there is no clef.
The distance to shift choral signs down. The following choral signs are shifted down:
\begin{itemize}
- \item Low choral signs that are not lower than the note
- \item High choral signs which are in a space
- \item Low choral signs that are lower than the note which are in a space
+ \item Low choral signs that are not lower than the note
+ \item High choral signs which are in a space
+ \item Low choral signs that are lower than the note which are in a space
\end{itemize}
\end{gdimension}
@@ -1431,8 +1476,8 @@ The distance to shift choral signs down. The following choral signs are shifted
The distance to shift choral signs up. The following choral signs are shifted up:
\begin{itemize}
- \item High choral signs which are on a line
- \item Low choral signs that are lower than the note which are on a line
+ \item High choral signs which are on a line
+ \item Low choral signs that are lower than the note which are on a line
\end{itemize}
\end{gdimension}
@@ -1552,7 +1597,7 @@ Vertical distance to place a punctum mora for the second note in a porrectus (or
Distance to place a ``rare'' sign above the top space in a score.
\end{gdimension}
-\subsubsection*{Bar distances}
+\subsubsection{Bar distances}
\begin{gdimension}{bar@finalfinalis}
This space is added before the final divisio final of a score (old bar spacing algorithm only).
@@ -1684,87 +1729,74 @@ Same as \texttt{maxbaroffsettextleft@eol} but when the center of the text goes r
\subsection{Penalties}\label{penalties}
-Penalties are used by \TeX\ to determine where line and page breaks should occur. Gregorio\TeX\ modifies or defines a few of its own to help with that process in scores.
+Penalties are used by \TeX\ to determine where line and page breaks should occur. Gregorio\TeX\ modifies or defines a few of its own to help with that process in scores. With the exception of \texttt{emergencystretch} (which should be changed using \verb=\grechangedim=) these should be changed using \verb=\grechangecount=, described above.
-\macroname{\textbackslash grebrokenpenalty}{}{gsp-default.tex}
+\begin{gcount}{brokenpenalty}
The vertical penalty inserted after a break on a clef change.
+\end{gcount}
-Default: 0
-
-\macroname{\textbackslash greclubpenalty}{}{gsp-default.tex}
+\begin{gcount}{clubpenalty}
The club penalty (determines how important it is to prevent orphans from occurring).
+\end{gcount}
-Default: 0
-
-\macroname{\textbackslash grewidowpenalty}{}{gsp-default.tex}
+\begin{gcount}{widowpenalty}
The widow penalty (determines how important it is to prevent widows from occurring).
+\end{gcount}
-Default: 0
-
-\macroname{\textbackslash greemergencystretch}{}{gsp-default.tex}
-The value of the last ditch stretch for overfull boxes.
+\macroname{emergencystretch}{}{gsp-default.tex}
+The value of the last ditch stretch for overfull boxes. This should be set using \verb=\grechangedim=.
Default: \verb=\emergencystretch=
-\macroname{\textbackslash greendafterbarpenalty}{}{gsp-default.tex}
+\begin{gcount}{endafterbarpenalty}
The end after bar penalty.
+\end{gcount}
-Default: $-200$
-
-\macroname{\textbackslash greendafterbaraltpenalty}{}{gsp-default.tex}
+\begin{gcount}{endafterbaraltpenalty}{}{gsp-default.tex}
The alternate end after bar penalty (used when there is no text under the bar).
+\end{gcount}
-Default: $-200$
-
-\macroname{\textbackslash greendofelementpenalty}{}{gsp-default.tex}
+\begin{gcount}{endofelementpenalty}{}{gsp-default.tex}
The end of element penalty.
+\end{gcount}
-Default: $-50$
-
-\macroname{\textbackslash greendofsyllablepenalty}{}{gsp-default.tex}
+\begin{gcount}{endofsyllablepenalty}{}{gsp-default.tex}
The end of element penalty.
+\end{gcount}
-Default: $-50$
-
-\macroname{\textbackslash greendofwordpenalty}{}{gsp-default.tex}
+\begin{gcount}{endofwordpenalty}{}{gsp-default.tex}
The end of element penalty.
+\end{gcount}
-Default: $-100$
-
-\macroname{\textbackslash grehyphenpenalty}{}{gsp-default.tex}
+\begin{gcount}{hyphenpenalty}{}{gsp-default.tex}
The hyphen penalty.
+\end{gcount}
-Default: $-200$
-
-\macroname{\textbackslash grenobreakpenalty}{}{gsp-default.tex}
+\begin{gcount}{nobreakpenalty}{}{gsp-default.tex}
Penalty to prevent a line break.
+\end{gcount}
-Default: 10001
-
-\macroname{\textbackslash grenewlinepenalty}{}{gsp-default.tex}
+\begin{gcount}{newlinepenalty}
Penalty to force a line break.
+\end{gcount}
-Default: $-10001$
-
-\macroname{\textbackslash grefinalpenalty}{}{gsp-default.tex}
+\begin{gcount}{finalpenalty}
The penalty applied after the final element of a score.
+\end{gcount}
-Default: $0$
-
-\macroname{\textbackslash grelooseness}{}{gsp-default.tex}
+\macroname{looseness}{}{gsp-default.tex}
The \TeX\ looseness within a score.
Default: \verb=\looseness=
-\macroname{\textbackslash gretolerance}{}{gsp-default.tex}
+\begin{gcount}{tolerance}
The \TeX\ tolerance within a score. See \url{https://en.wikibooks.org/wiki/TeX/tolerance} for an explanation of what tolerance is.
+\end{gcount}
-Default: 9000
-
-\macroname{\textbackslash grepretolerance}{}{gsp-default.tex}
+\macroname{pretolerance}{}{gsp-default.tex}
The \TeX\ pretolerance within a score. See \url{https://en.wikibooks.org/wiki/TeX/pretolerance} for an explanation of what pretolerance is.
-Default: $-1$ (Lua\TeX\ versions prior to 0.80) or \verb=\pretolerance= (versions after, and including, 0.80)
+Default: $-1$ (Lua\TeX\ versions prior to 0.80) or \verb=\pretolerance= (versions after, and including, 0.80)]
\textit{Nota bene:} For more details on why this is necessary see the comments in gsp-default.tex.
@@ -1773,15 +1805,12 @@ Default: $-1$ (Lua\TeX\ versions prior to 0.80) or \verb=\pretolerance= (version
\subsection{Colors}\label{colors}
-Colors are strictly a \LaTeX\ phenomena as currently implemented. All
-commands which change a color will raise a warning in Plain \TeX, but will not alter the document.
-
All colors can be redefined using \verb=\definecolor=. See the
-\verb=xcolor= package for documentation.
+\verb=xcolor= (\LaTeX) or \verb=color= (Plain\TeX) package for documentation.
Example:\par\medskip
\begin{latexcode}
- \definecolor{gregoriocolor}{RGB}{229,53,44}
+ \definecolor{gregoriocolor}{RGB}{229,53,44}
\end{latexcode}
\macroname{grebackgroundcolor}{}{gregoriotex.sty}