summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/luatex/gregoriotex/Command_Index_internal.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/luatex/gregoriotex/Command_Index_internal.tex')
-rw-r--r--Master/texmf-dist/doc/luatex/gregoriotex/Command_Index_internal.tex901
1 files changed, 478 insertions, 423 deletions
diff --git a/Master/texmf-dist/doc/luatex/gregoriotex/Command_Index_internal.tex b/Master/texmf-dist/doc/luatex/gregoriotex/Command_Index_internal.tex
index 6aa2afc5901..17798653673 100644
--- a/Master/texmf-dist/doc/luatex/gregoriotex/Command_Index_internal.tex
+++ b/Master/texmf-dist/doc/luatex/gregoriotex/Command_Index_internal.tex
@@ -11,7 +11,7 @@ only.
Prints an error to the \TeX\ output log.
\begin{argtable}
- \#1 & string & error message\\
+ \#1 & string & error message\\
\end{argtable}
@@ -19,14 +19,14 @@ Prints an error to the \TeX\ output log.
Prints a warning to the \TeX\ output log.
\begin{argtable}
- \#1 & string & warning message\\
+ \#1 & string & warning message\\
\end{argtable}
\macroname{\textbackslash gre@metapost}{\#1}{gregoriotex.sty \textup{and} gregoriotex.tex}
Executes \MP{} commands using luamplib.
\begin{argtable}
- \#1 & \MP{} commands & The \MP{} commands to execute.
+ \#1 & \MP{} commands & The \MP{} commands to execute.
\end{argtable}
\macroname{\textbackslash gre@deprecated}{\#1\#2}{gregoriotex-main.tex}
@@ -36,18 +36,23 @@ are allowed and a warning is printed. If the package option
package error, halting \TeX.
\begin{argtable}
- \#1 & string & name of the deprecated macro\\
- \#2 & string & name of the correct macro to use\\
+ \#1 & string & name of the deprecated macro\\
+ \#2 & string & name of the correct macro to use\\
\end{argtable}
\macroname{\textbackslash gre@obsolete}{\#1\#2}{gregoriotex-main.tex}
Macro that handles obsolescence errors.
\begin{argtable}
- \#1 & string & name of the obsolete macro\\
- \#2 & string & name of the correct macro to use\\
+ \#1 & string & name of the obsolete macro\\
+ \#2 & string & name of the correct macro to use\\
\end{argtable}
+\macroname{\textbackslash gre@allowdeprecated@asboolean}{}{gregoriotex-main.tex}
+Macro that evaluates \texttt{true} or \texttt{false} depending on whether
+deprecated usage is allowed. This is used to pass the value of
+\verb=\ifgre@allowdeprecated= to Lua.
+
\macroname{\textbackslash gre@loadgregoriofont}{}{gregoriotex-main.tex}
Loads the chosen font for the neumes at the correct size.
@@ -65,22 +70,22 @@ Macro which calculates \verb=\gre@additionalbottomspace= and\\
\verb=\gre@additionaltopspace=
\begin{argtable}
- \#1 & integer & the height number of the top pitch, including signs\\
- \#2 & integer & the height number of the bottom pitch, including signs\\
- \#3 & \texttt{0} & there is no translation line\\
- & \texttt{1} & there is a translation line\\
- \#4 & \texttt{0} & there is no above lines text\\
- & \texttt{1} & there is above lines text
+ \#1 & integer & the height number of the top pitch, including signs\\
+ \#2 & integer & the height number of the bottom pitch, including signs\\
+ \#3 & \texttt{0} & there is no translation line\\
+ & \texttt{1} & there is a translation line\\
+ \#4 & \texttt{0} & there is no above lines text\\
+ & \texttt{1} & there is above lines text
\end{argtable}
\macroname{\textbackslash gre@calculate@textaligncenter}{\#1\#2\#3}{gregoriotex-spaces.tex}
Macro for calculating \verb=\gre@textaligncenter=.
\begin{argtable}
- \#1 & string & The first part of the syllable (any preceding consonants in Latin).\\
- \#2 & string & The middle part of the syllable (the vowel in Latin, the whole syllable in English).\\
- \#3 & \texttt{0} & Calculation is being performed for the current syllable.\\
- & \texttt{1} & Calculation is being performed for the next syllable.\\
+ \#1 & string & The first part of the syllable (any preceding consonants in Latin).\\
+ \#2 & string & The middle part of the syllable (the vowel in Latin, the whole syllable in English).\\
+ \#3 & \texttt{0} & Calculation is being performed for the current syllable.\\
+ & \texttt{1} & Calculation is being performed for the next syllable.\\
\end{argtable}
\macroname{\textbackslash gre@calculate@annotationtrueraise}{}{gregoriotex-spaces.tex}
@@ -120,29 +125,29 @@ Aggregates all of the global distance calculations and calls them in the order n
Calculates the raise value for a glyph (glyphraisevalue) based on where it is to be placed and what kind of a glyph it is. This is a time of use calculation.
\begin{argtable}
- \#1 & integer & The number for where the glyph is located. \texttt{a} in gabc is \texttt{1}, \texttt{b} is \texttt{2}, \etc\\
- \#2 & \texttt{0} & no modification\\
- & \texttt{1} & puts the value on the interline just above if it is on a line\\
- & \texttt{2} & puts the value on the interline just beneath if it is on a line\\
- & \texttt{3} & case of the vertical episema, which is not placed at the same place if the corresponding note is on a line or not\\
- & \texttt{4} & case of the punctum mora, for the same reason\\
- & \texttt{5} & case of the horizontal episema under a note, that must be placed a bit lower if the note is on a line\\
- & \texttt{6} & case of the signs above (accentus, \etc)\\
- & \texttt{8} & case of the punctum mora of the first note of a podatus or the 2nd note of a porrectus, \etc\\
- & \texttt{9} & case of the horizontal episema, that must be placed a bit lower if the note is on a line\\
- & \texttt{10} & case of the low choral sign\\
- & \texttt{11} & case of the high choral sign\\
- & \texttt{12} & case of the low choral sign which is lower than the note\\
- & \texttt{13} & case of the brace above the bars\\
- & \texttt{14} & case of the punctum mora in a space with a note on the line below it\\
- & \texttt{15} & case of the over-the-notes slur\\
- & \texttt{16} & case of the under-the-notes slur\\
- \#3 & \texttt{0} & for horizontal episema cases, use automatic positioning within the space\\
- & \texttt{1} & for horizontal episema cases, position in the middle of the space\\
- & \texttt{2} & for horizontal episema cases, position low within the space as if the episema is over the note\\
- & \texttt{3} & for horizontal episema cases, position high within the space as if the episema is under the note\\
- & \texttt{4} & for horizontal episema cases, position low within the space as if the episema is over the note\\
- & \texttt{5} & for horizontal episema cases, position high within the space as if the episema is under the note\\
+ \#1 & integer & The number for where the glyph is located. \texttt{a} in gabc is \texttt{1}, \texttt{b} is \texttt{2}, \etc\\
+ \#2 & \texttt{0} & no modification\\
+ & \texttt{1} & puts the value on the interline just above if it is on a line\\
+ & \texttt{2} & puts the value on the interline just beneath if it is on a line\\
+ & \texttt{3} & case of the vertical episema, which is not placed at the same place if the corresponding note is on a line or not\\
+ & \texttt{4} & case of the punctum mora, for the same reason\\
+ & \texttt{5} & case of the horizontal episema under a note, that must be placed a bit lower if the note is on a line\\
+ & \texttt{6} & case of the signs above (accentus, \etc)\\
+ & \texttt{8} & case of the punctum mora of the first note of a podatus or the 2nd note of a porrectus, \etc\\
+ & \texttt{9} & case of the horizontal episema, that must be placed a bit lower if the note is on a line\\
+ & \texttt{10} & case of the low choral sign\\
+ & \texttt{11} & case of the high choral sign\\
+ & \texttt{12} & case of the low choral sign which is lower than the note\\
+ & \texttt{13} & case of the brace above the bars\\
+ & \texttt{14} & case of the punctum mora in a space with a note on the line below it\\
+ & \texttt{15} & case of the over-the-notes slur\\
+ & \texttt{16} & case of the under-the-notes slur\\
+ \#3 & \texttt{0} & for horizontal episema cases, use automatic positioning within the space\\
+ & \texttt{1} & for horizontal episema cases, position in the middle of the space\\
+ & \texttt{2} & for horizontal episema cases, position low within the space as if the episema is over the note\\
+ & \texttt{3} & for horizontal episema cases, position high within the space as if the episema is under the note\\
+ & \texttt{4} & for horizontal episema cases, position low within the space as if the episema is over the note\\
+ & \texttt{5} & for horizontal episema cases, position high within the space as if the episema is under the note\\
\end{argtable}
\macroname{\textbackslash gre@stafflinefactor}{}{gregoriotex-spaces.tex}
@@ -152,22 +157,22 @@ A number indicating the thickness of the staff lines.
Macro to calculate the distance from the beginning of the text of a syllable to its alignment point (the center of the vowel for Latin centering, the center of the syllable for English centering). This is a time of use calculation.
\begin{argtable}
- \#1 & string & the first part of the syllable\\
- \#2 & string & the middle part of the syllable\\
- \#3 & \texttt{0} & perform this calculation for the current syllable\\
- & \texttt{1} & perform this calculation for the next syllable
+ \#1 & string & the first part of the syllable\\
+ \#2 & string & the middle part of the syllable\\
+ \#3 & \texttt{0} & perform this calculation for the current syllable\\
+ & \texttt{1} & perform this calculation for the next syllable
\end{argtable}
\macroname{\textbackslash gre@calculate@enddifference}{\#1\#2\#3\#4\#5}{gregoriotex-spaces.tex}
Calculates the difference between the end of the notes and the end of the syllable text. Also stores the value for the previous syllable if needed. This is a time of use calculation.
\begin{argtable}
- \#1 & length & the total width of the notes\\
- \#2 & length & the total width of the syllable text\\
- \#3 & length & the alignment distance for the text (\texttt{textaligncenter})\\
- \#4 & length & the alignment distance for the notes (\texttt{notesaligncenter})\\
- \#5 & \texttt{0} & do not save the value for the previous syllable before calculating the new value\\
- & \texttt{1} & save the value for the previous syllable before calculating the new value
+ \#1 & length & the total width of the notes\\
+ \#2 & length & the total width of the syllable text\\
+ \#3 & length & the alignment distance for the text (\texttt{textaligncenter})\\
+ \#4 & length & the alignment distance for the notes (\texttt{notesaligncenter})\\
+ \#5 & \texttt{0} & do not save the value for the previous syllable before calculating the new value\\
+ & \texttt{1} & save the value for the previous syllable before calculating the new value
\end{argtable}
The formula used is \verb=#1 - #2 + #3 - #4= or (more sensibly) \verb=(#1 - #4) - (#2 - #3)=. This is also equivalent to \verb=-#4 - \gre@dimen@begindifference + #3=, a fact we take advantage of when calculating the end difference for a bar syllable under the new bar spacing algorithm.
@@ -176,43 +181,43 @@ The formula used is \verb=#1 - #2 + #3 - #4= or (more sensibly) \verb=(#1 - #4)
Change the scale of a single distance from one factor to another.
\begin{argtable}
- \#1 & string & name of the distance to be scaled. See \nameref{distances}.\\
- \#2 & integer & the factor the distance is currently in\\
- \#3 & integer & the factor the distance is to be put into\\
+ \#1 & string & name of the distance to be scaled. See \nameref{distances}.\\
+ \#2 & integer & the factor the distance is currently in\\
+ \#3 & integer & the factor the distance is to be put into\\
\end{argtable}
\macroname{\textbackslash gre@changedimenfactor}{\#1\#2}{gregoriotex-spaces.tex}
Rescales all the distances (and \texttt{stafflinefactor}) which are supposed to scale with a change in staff size.
\begin{argtable}
- \#1 & integer & the factor the distances are currently in\\
- \#2 & integer & the factor the distances are to be put into\\
+ \#1 & integer & the factor the distances are currently in\\
+ \#2 & integer & the factor the distances are to be put into\\
\end{argtable}
\macroname{\textbackslash gre@calculate@nextbegindifference}{\#1\#2\#3\#4}{gregoriotex-spaces.tex}
Macro to calculate \texttt{nextbegindifference}.
\begin{argtable}
- \#1 & string & the first letters of the next syllable\\
- \#2 & string & the middle letters of the next syllable (the vowel in Latin, the whole syllable in English)\\
- \#3 & string & the end letters of the next syllable\\
- \#4 & $0 \le$ integer $\le 19$ & the type of notes alignment. See \nameref{notesalign}.\\
- & $20 \le$ integer $\le 39$ & Same as below 20 except there is a flat before the notes. Subtract 20 to get the type of notes alignment.\\
- & $40 \le$ integer $\le 59$ & Same as below 20 except there is a natural before the notes. Subtract 40 to get the type of notes alignment.
+ \#1 & string & the first letters of the next syllable\\
+ \#2 & string & the middle letters of the next syllable (the vowel in Latin, the whole syllable in English)\\
+ \#3 & string & the end letters of the next syllable\\
+ \#4 & $0 \le$ integer $\le 19$ & the type of notes alignment. See \nameref{notesalign}.\\
+ & $20 \le$ integer $\le 39$ & Same as below 20 except there is a flat before the notes. Subtract 20 to get the type of notes alignment.\\
+ & $40 \le$ integer $\le 59$ & Same as below 20 except there is a natural before the notes. Subtract 40 to get the type of notes alignment.
\end{argtable}
\macroname{\textbackslash gre@strip@pt}{\#1}{gregoriotex.sty \textup{and} gregoriotex.tex}
Strips the units from a distance. Under \LaTeX{}, this is an alias to \verb=\strip@pt=.
\begin{argtable}
- \#1 & control sequence & should be the control sequence for the the distance register (including the leading backslash)\\
+ \#1 & control sequence & should be the control sequence for the the distance register (including the leading backslash)\\
\end{argtable}
\macroname{\textbackslash gre@rem@pt}{\#1}{gregoriotex.tex}
Strips the units from a distance. Used internally by \verb=\gre@strip@pt=. Under \LaTeX{}, this is not defined.
\begin{argtable}
- \#1 & distance & should be in the form ``[0-9]+.[0-9]+pt’’. (\ie the result of applying \verb=\the= to a distance register)\\
+ \#1 & distance & should be in the form ``[0-9]+.[0-9]+pt’’. (\ie the result of applying \verb=\the= to a distance register)\\
\end{argtable}
\macroname{\textbackslash gre@count@temp@...}{}{gregoriotex-spaces.tex}
@@ -222,8 +227,8 @@ Temporary count used in calculations. There are currently three of these.
Macro which converts a distance into a particular set of units. Result is placed in \verb=\gre@converted= as a string.
\begin{argtable}
- \#1 & string & two letter abbreviation for the units. Should recognize all legal \TeX\ units.\\
- \#2 & distance & Distance to be converted.
+ \#1 & string & two letter abbreviation for the units. Should recognize all legal \TeX\ units.\\
+ \#2 & distance & Distance to be converted.
\end{argtable}
\macroname{\textbackslash gre@converted}{}{gregoriotex-spaces.tex}
@@ -233,8 +238,8 @@ Macro holding result of last call to \verb=\gre@convertto=.
This function takes a distance and formats it as a string so that its units conform to the pattern set by a string representation of a distance. Result is placed in \verb=\gre@stringdist=.
\begin{argtable}
- \#1 & string & the standard whose format is to be matched.\\
- \#2 & distance & the distance to be adjusted.
+ \#1 & string & the standard whose format is to be matched.\\
+ \#2 & distance & the distance to be adjusted.
\end{argtable}
\macroname{\textbackslash gre@stringdist}{}{gregoriotex-spaces.tex}
@@ -245,7 +250,7 @@ Macro that handles \verb=\gregorioscore= calls when they do not have an
optional argument.
\begin{argtable}
- \#1 & string & Relative or absolute path to the score.\\
+ \#1 & string & Relative or absolute path to the score.\\
\end{argtable}
\macroname{\textbackslash gre@gregorioscore@option}{[\#1]\#2}{gregoriotex-main.tex}
@@ -253,10 +258,10 @@ Macro that handles \verb=\gregorioscore= calls when they have an optional
argument.
\begin{argtable}
- \#1 & \texttt{n} & \#2 will be included as is. \\
- & \texttt{a} & Gregorio\TeX\ will automatically compile gabc files if necessary.\\
- & \texttt{f} & Forces Gregorio\TeX\ to compile the gabc file.\\
- \#2 & string & Relative or absolute path to the score.\\
+ \#1 & \texttt{n} & \#2 will be included as is. \\
+ & \texttt{a} & Gregorio\TeX\ will automatically compile gabc files if necessary.\\
+ & \texttt{f} & Forces Gregorio\TeX\ to compile the gabc file.\\
+ \#2 & string & Relative or absolute path to the score.\\
\end{argtable}
\macroname{\textbackslash gre@gabcsnippet}{\#1}{gregoriotex-main.tex}
@@ -264,7 +269,7 @@ Macro that handles \verb=\gabcsnippet= calls when they do not have an
optional argument.
\begin{argtable}
- \#1 & string & Snippet of gabc code.\\
+ \#1 & string & Snippet of gabc code.\\
\end{argtable}
\macroname{\textbackslash gre@writemode}{\#1\#2\#3}{gregoriotex-main.tex}
@@ -272,29 +277,29 @@ Macro that writes its arguments with \verb=\greannotation=. This
macro is typically called by \verb=\GreMode= in the gtex file.
\begin{argtable}
- \#1 & \TeX\ code & Mode text to place above the initial of a score in the \texttt{modeline} style.\\
- \#2 & \TeX\ code & Arbitrary code to typeset, in the \texttt{modemodifier} style, after the mode text.\\
- \#3 & \TeX\ code & Arbitrary code to typeset, in the \texttt{modedifferentia} style, after \#2.\\
+ \#1 & \TeX\ code & Mode text to place above the initial of a score in the \texttt{modeline} style.\\
+ \#2 & \TeX\ code & Arbitrary code to typeset, in the \texttt{modemodifier} style, after the mode text.\\
+ \#3 & \TeX\ code & Arbitrary code to typeset, in the \texttt{modedifferentia} style, after \#2.\\
\end{argtable}
\macroname{\textbackslash gre@setallbracerendering}{\#1}{gregoriotex-signs.tex}
Macro used by \verb=\gresetbracerendering= to change all braces.
\begin{argtable}
- \#1 & \texttt{metapost} & \MP{} will be used to render braces\\
- & \texttt{font} & The score font will be used to render braces\\
+ \#1 & \texttt{metapost} & \MP{} will be used to render braces\\
+ & \texttt{font} & The score font will be used to render braces\\
\end{argtable}
\macroname{\textbackslash gre@setbracerendering}{[\#1]\#2}{gregoriotex-signs.tex}
Macro used by \verb=\gresetbracerendering= to change a single type of brace.
\begin{argtable}
- \#1 & \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 & \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 gre@@setbracerendering}{\#1\#2}{gregoriotex-signs.tex}
@@ -303,27 +308,27 @@ Secondary macro used by \verb=\gre@setallbracerendering= and
secondary macro, it doesn't check its first argument.
\begin{argtable}
- \#1 & \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 & \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 gre@brace@common}{\#1\#2\#3\#4\#5\#6\#7}{gregoriotex-signs.tex}
Common macro used internally to render braces.
\begin{argtable}
- \#1 & length & The width of the brace.\\
- \#2 & length & A vertical shift.\\
- \#3 & length & A horizontal shift.\\
- \#4 & \texttt{0} & Don’t shift before starting the brace.\\
- & \texttt{1} & Shift back a punctum’s width before starting the brace.\\
- \#5 & \texttt{0} & No accentus above the brace.\\
- & \texttt{1} & Typeset an accentus above the brace.\\
- \#6 & integer & The height number for the brace.\\
- \#7 & csname & The control sequence name representing the brace.
+ \#1 & length & The width of the brace.\\
+ \#2 & length & A vertical shift.\\
+ \#3 & length & A horizontal shift.\\
+ \#4 & \texttt{0} & Don’t shift before starting the brace.\\
+ & \texttt{1} & Shift back a punctum’s width before starting the brace.\\
+ \#5 & \texttt{0} & No accentus above the brace.\\
+ & \texttt{1} & Typeset an accentus above the brace.\\
+ \#6 & integer & The height number for the brace.\\
+ \#7 & csname & The control sequence name representing the brace.
\end{argtable}
\macroname{\textbackslash gre@render@barbrace}{}{gregoriotex-signs.tex}
@@ -334,55 +339,55 @@ Returns the \MP{} preamble for braces. The control sequence name does
not have the \texttt{@} symbol because this macro is used within \MP{}.
\begin{argtable}
- \#1 & string & the width of the brace; if \texttt{*}, use the bar brace width.
+ \#1 & string & the width of the brace; if \texttt{*}, use the bar brace width.
\end{argtable}
\macroname{\textbackslash gre@draw@curlybrace}{\#1}{gregoriotex-signs.tex}
Draws a curly over-brace using \MP{}.
\begin{argtable}
- \#1 & length & the width of the brace.
+ \#1 & length & the width of the brace.
\end{argtable}
\macroname{\textbackslash gre@draw@brace}{\#1}{gregoriotex-signs.tex}
Draws a round over-brace using \MP{}.
\begin{argtable}
- \#1 & string & the width of the brace; if \texttt{*}, use the bar brace width.
+ \#1 & string & the width of the brace; if \texttt{*}, use the bar brace width.
\end{argtable}
\macroname{\textbackslash gre@draw@fontbrace}{\#1\#2}{gregoriotex-signs.tex}
Draws a brace using the score font.
\begin{argtable}
- \#1 & string & the width of the brace.\\
- \#2 & \TeX\ code & \TeX\ code that renders the brace using the score font.\\
+ \#1 & string & the width of the brace.\\
+ \#2 & \TeX\ code & \TeX\ code that renders the brace using the score font.\\
\end{argtable}
\macroname{\textbackslash gre@draw@underbrace}{\#1}{gregoriotex-signs.tex}
Draws a round under-brace using \MP{}.
\begin{argtable}
- \#1 & length & the width of the brace.
+ \#1 & length & the width of the brace.
\end{argtable}
\macroname{\textbackslash gre@draw@roundbrace}{\#1\#2\#3}{gregoriotex-signs.tex}
Draws a round over- or under-brace using \MP{}.
\begin{argtable}
- \#1 & length & the width of the brace.\\
- \#2 & number & the height of the bounding box in em-relative units.\\
- \#3 & \MP{} commands & \MP{} commands to draw the brace outline.
+ \#1 & length & the width of the brace.\\
+ \#2 & number & the height of the bounding box in em-relative units.\\
+ \#3 & \MP{} commands & \MP{} commands to draw the brace outline.
\end{argtable}
\macroname{\textbackslash gre@draw@slur}{\#1\#2\#3}{gregoriotex-signs.tex}
Draws a slur using \MP{}.
\begin{argtable}
- \#1 & length & the x-dimension of the slur.\\
- \#2 & length & the y-dimension of the slur.\\
- \#3 & \texttt{-1} & draw an under-the-notes slur.\\
- & \texttt{1} & draw an over-the-notes slur.\\
+ \#1 & length & the x-dimension of the slur.\\
+ \#2 & length & the y-dimension of the slur.\\
+ \#3 & \texttt{-1} & draw an under-the-notes slur.\\
+ & \texttt{1} & draw an over-the-notes slur.\\
\end{argtable}
@@ -390,7 +395,7 @@ Draws a slur using \MP{}.
Evaluates to \verb=#1= if running under \LaTeX{}.
\begin{argtable}
- \#1 & \TeX{} code & the \TeX{} code to use if running under \LaTeX{}.
+ \#1 & \TeX{} code & the \TeX{} code to use if running under \LaTeX{}.
\end{argtable}
\macroname{\textbackslash gre@latex@barredsymbol}{\#1\#2\#3\#4}{gregoriotex-signs.tex}
@@ -400,10 +405,10 @@ the cascading of conditionals used to implement that macro.
\bigskip\textbf{Only available in \LaTeX.}
\begin{argtable}
- \#1 & string & the value of \verb=\f@series/\f@shape= to match.\\
- \#2 & \TeX{} code & the \TeX{} for the base symbol (\ie, \texttt{A}, \texttt{R}, or \texttt{V}).\\
- \#3 & string & the control sequence name created by \verb=\gredefsizedsymbol= to use for the bar.\\
- \#4 & dimension & the amount to shift the bar to the left from the end of the base symbol.
+ \#1 & string & the value of \verb=\f@series/\f@shape= to match.\\
+ \#2 & \TeX{} code & the \TeX{} for the base symbol (\ie, \texttt{A}, \texttt{R}, or \texttt{V}).\\
+ \#3 & string & the control sequence name created by \verb=\gredefsizedsymbol= to use for the bar.\\
+ \#4 & dimension & the amount to shift the bar to the left from the end of the base symbol.
\end{argtable}
\macroname{\textbackslash gre@additionalbottomcustoslineend}{}{gregoriotex-signs.tex}
@@ -422,11 +427,25 @@ Macro to place a top custos with an additional line (positions \texttt{l} and \t
Macro to pick the appropriate custos character.
\begin{argtable}
- \#1 & integer & height of the custos character to be placed\\
+ \#1 & integer & height of the custos character to be placed\\
\end{argtable}
-\macroname{\textbackslash gre@nextcustos}{}{gregoriotex-signs.tex}
-Macro that saves the next custos height.
+\macroname{\textbackslash gre@nextcustospitch}{}{gregoriotex-signs.tex}
+Macro that saves the next custos pitch (height).
+
+\macroname{\textbackslash gre@nextcustosalteration}{}{gregoriotex-signs.tex}
+Macro that saves the next custos alteration.
+
+\macroname{\textbackslash gre@custosalteration}{\#1\#2}{gregoriotex-signs.tex}
+Typesets the alteration for a custos, if enabled.
+
+\begin{argtable}
+ \#1 & integer & The pitch (height number) of the custos.\\
+ \#2 & \texttt{Flat} & The custos should have a flat.\\
+ & \texttt{Natural} & The custos should have a natural.\\
+ & \texttt{Sharp} & The custos should have a sharp.\\
+ & \textit{empty} & The custos should not have an alteration.\\
+\end{argtable}
\macroname{\textbackslash gre@beginnotes}{}{gregoriotex-main.tex}
Macro to draw the staff lines. Comes after the initial but before the clef.
@@ -459,14 +478,14 @@ Macro to decrease the space above the lines as there is no longer any above line
Macro to typeset an alteration.
\begin{argtable}
- \#1 & integer & height of the alteration\\
- \#2 & character alias & the alteration\\
- \#3 & character alias & the hole of the alteration\\
- \#4 & \texttt{1} & the alteration is part of the clef\\
- & \texttt{0} & the alteration is not part of the clef\\
- \#5 & \TeX\ code & signs to typeset before the glyph (typically additional bars, as they must be "behind" the glyph)\\
- \#6 & \TeX\ code & signs to typeset after the glyph (almost all signs)\\
- \#7 & string & the line, byte offset, and column address for textedit links when point-and-click is enabled\\
+ \#1 & integer & height of the alteration\\
+ \#2 & character alias & the alteration\\
+ \#3 & character alias & the hole of the alteration\\
+ \#4 & \texttt{1} & the alteration is part of the clef\\
+ & \texttt{0} & the alteration is not part of the clef\\
+ \#5 & \TeX\ code & signs to typeset before the glyph (typically additional bars, as they must be "behind" the glyph)\\
+ \#6 & \TeX\ code & signs to typeset after the glyph (almost all signs)\\
+ \#7 & string & the line, byte offset, and column address for textedit links when point-and-click is enabled\\
\end{argtable}
\macroname{\textbackslash gre@clef}{}{gregoriotex-signs.tex}
@@ -521,42 +540,42 @@ A spot to save the \verb=\gre@lastoflinecount= so we can change it temporarily a
The macro which needs to be called each time a new lines is started.
\begin{argtable}
- \#1 & \texttt{0} & Justifying the line being ended\\
- & \texttt{1} & Do not justify the line being ended\\
- \#2 & \texttt{0} & Take care of eolshift\\
- & \texttt{1} & Do not adjust end of line (when already done by the new spacing algorithm)\\
+ \#1 & \texttt{0} & Justifying the line being ended\\
+ & \texttt{1} & Do not justify the line being ended\\
+ \#2 & \texttt{0} & Take care of eolshift\\
+ & \texttt{1} & Do not adjust end of line (when already done by the new spacing algorithm)\\
\end{argtable}
\macroname{\textbackslash gre@endafterbar}{\#1}{gregoriotex-main.tex}
Macro to call after ending a bar.
\begin{argtable}
- \#1 & \texttt{0} & We are at the end of a line\\
- & \texttt{1} & We not at the end of a line\\
+ \#1 & \texttt{0} & We are at the end of a line\\
+ & \texttt{1} & We not at the end of a line\\
\end{argtable}
\macroname{\textbackslash gre@endofsyllable}{\#1\#2\#3}{gregoriotex-syllable.tex}
Macro called at end of a syllable, adds a penalty and a space.
\begin{argtable}
- \#1 & \texttt{0} & to only add the penalty\\
- & \texttt{1} & adds both penalty and space\\
- \#2 & \texttt{0} & if end of syllable\\
- & \texttt{1} & if end of word\\
- \#3 & \texttt{1} & if next syllable is a bar\\
- & \texttt{0} & otherwise\\
+ \#1 & \texttt{0} & to only add the penalty\\
+ & \texttt{1} & adds both penalty and space\\
+ \#2 & \texttt{0} & if end of syllable\\
+ & \texttt{1} & if end of word\\
+ \#3 & \texttt{1} & if next syllable is a bar\\
+ & \texttt{0} & otherwise\\
\end{argtable}
\macroname{\textbackslash gre@setfirstsyllabletext}{\#1\#2\#3\#4\#5\#6}{gregoriotex-syllable.tex}
Internal macro to set the first syllable text after all parts are known.
\begin{argtable}
- \#1 & \TeX\ code & First part of the syllable (before the vowel)\\
- \#2 & \TeX\ code & Middle part of the syllable (the vowel)\\
- \#3 & \TeX\ code & Last part of the syllable (after the vowel)\\
- \#4 & \TeX\ code & First letter of the syllable\\
- \#5 & \TeX\ code & Everything after the first letter of the syllable\\
- \#6 & \TeX\ code & Macros to run after the text is emitted\\
+ \#1 & \TeX\ code & First part of the syllable (before the vowel)\\
+ \#2 & \TeX\ code & Middle part of the syllable (the vowel)\\
+ \#3 & \TeX\ code & Last part of the syllable (after the vowel)\\
+ \#4 & \TeX\ code & First letter of the syllable\\
+ \#5 & \TeX\ code & Everything after the first letter of the syllable\\
+ \#6 & \TeX\ code & Macros to run after the text is emitted\\
\end{argtable}
\macroname{\textbackslash gre@opening@syllabletext}{}{gregoriotex-syllable.tex}
@@ -574,30 +593,30 @@ Default: 17 (approximately the size found in graduals)
Macro to fill the hole in a glyph so that staff lines do not show through a hole in it.
\begin{argtable}
- \#1 & Gregorio\TeX\ char & character to use to fill the hole\\
+ \#1 & Gregorio\TeX\ char & character to use to fill the hole\\
\end{argtable}
\macroname{\textbackslash gre@calculate@notesaligncenter}{\#1}{gregoriotex-syllable.tex}
Macro to find the alignment center for a group of notes. The value is the distance from the left edge of the group to the alignment point and is stored in \verb=\gre@dimen@notesaligncenter=.
\begin{argtable}
- \#1 & Note alignment type & See \ref{notesalign}\\
+ \#1 & Note alignment type & See \ref{notesalign}\\
\end{argtable}
\macroname{\textbackslash gre@calculate@nextnotesaligncenter}{\#1}{gregoriotex-syllable.tex}
Same as previous, but for the next syllable.
\begin{argtable}
- \#1 & Note alignment type & See \ref{notesalign}\\
+ \#1 & Note alignment type & See \ref{notesalign}\\
\end{argtable}
\macroname{\textbackslash gre@calculate@simplenotesaligncenter}{\#1\#2}{gregoriotex-syllable.tex}
Workhorse function behind \verb=\gre@calculate@notesaligncenter= and\\ \verb=\gre@calculate@nextnotesaligncenter=.
\begin{argtable}
- \#1 & Note alignment type & See \ref{notesalign}\\
- \#2 & \texttt{0} & this is for the current syllable\\
- & \texttt{1} & this is for the next syllable\\
+ \#1 & Note alignment type & See \ref{notesalign}\\
+ \#2 & \texttt{0} & this is for the current syllable\\
+ & \texttt{1} & this is for the next syllable\\
\end{argtable}
\macroname{\textbackslash gre@gregoriofontname}{}{gregoriotex-main.tex}
@@ -607,87 +626,87 @@ Macro which stores the name of the currently selected font for the neumes.
Macro for aligning clivis syllables according to the flag \verb=\gre@clivisalignment=.
\begin{argtable}
- \#1 & Gregorio\TeX\ glyph & Glyph to use when aligning clivis on its center\\
- \#2 & Gregorio\TeX\ glyph & Glyph to use when aligning clivis on the center of the first punctum\\
- \#3 & \texttt{0} & this is for the current syllable\\
- & \texttt{1} & this is for the next syllable\\
+ \#1 & Gregorio\TeX\ glyph & Glyph to use when aligning clivis on its center\\
+ \#2 & Gregorio\TeX\ glyph & Glyph to use when aligning clivis on the center of the first punctum\\
+ \#3 & \texttt{0} & this is for the current syllable\\
+ & \texttt{1} & this is for the next syllable\\
\end{argtable}
\macroname{\textbackslash gre@hepisorline}{\#1\#2\#3\#4\#5\#6\#7}{gregoriotex-signs.tex}
Macro to typeset a horizontal line (either an additional staff line or an episema).
\begin{argtable}
- \#1 & character & The letter of the height of the episema (not the height of the note it corresponds to).\\
- \#2 & \texttt{0} & go back to the beginning of the previous glyph; this starts the episema at the beginning of the previous glyph\\
- & \texttt{1} & stay at the end of the glyph; doesn’t make much sense to use this\\
- & \texttt{2} & go back the width of \#1; this starts the episema at the glyph from the end that starts at \#1’s width from the end\\
- & \texttt{3} & go back to the beginning of the previous glyph and then forward the width of \#1; this starts the episema at the glyph from the start that starts just after \#1’s width from the start\\
- & \texttt{4} & go back to the beginning of the previous glyph and then forward the width of \#1, then back the width of \#2; this ends the episema at the end of \#1\\
- \#3 & integer &the ambitus for a two note episema at the diagonal stroke of a porrectus, porrectus flexus, orculus resupinus, or torculus resupinus flexus\\
- \#4 & \texttt{0} & an horizontal episema\\
- & \texttt{1} & an horizontal episema under a note\\
- & \texttt{2} & a line at the top\\
- & \texttt{3} & a line at the bottom\\
- \#5 & \texttt{f} & a normal episema\\
- & \texttt{l} & a small episema aligned left\\
- & \texttt{c} & a small episema aligned center\\
- & \texttt{r} & for a small episema aligned right\\
- \#6 & string & a positive or negative "nudge" (dimension) for the vertical position of the horizontal episema\\
- \#7 & \texttt{0} & for horizontal episema cases, use automatic positioning within the space\\
- & \texttt{1} & for horizontal episema cases, position in the middle of the space\\
- & \texttt{2} & for horizontal episema cases, position low within the space as if the episema is over the note\\
- & \texttt{3} & for horizontal episema cases, position high within the space as if the episema is under the note\\
- & \texttt{4} & for horizontal episema cases, position low within the space as if the episema is over the note\\
- & \texttt{5} & for horizontal episema cases, position high within the space as if the episema is under the note\\
+ \#1 & character & The letter of the height of the episema (not the height of the note it corresponds to).\\
+ \#2 & \texttt{0} & go back to the beginning of the previous glyph; this starts the episema at the beginning of the previous glyph\\
+ & \texttt{1} & stay at the end of the glyph; doesn’t make much sense to use this\\
+ & \texttt{2} & go back the width of \#1; this starts the episema at the glyph from the end that starts at \#1’s width from the end\\
+ & \texttt{3} & go back to the beginning of the previous glyph and then forward the width of \#1; this starts the episema at the glyph from the start that starts just after \#1’s width from the start\\
+ & \texttt{4} & go back to the beginning of the previous glyph and then forward the width of \#1, then back the width of \#2; this ends the episema at the end of \#1\\
+ \#3 & integer &the ambitus for a two note episema at the diagonal stroke of a porrectus, porrectus flexus, orculus resupinus, or torculus resupinus flexus\\
+ \#4 & \texttt{0} & an horizontal episema\\
+ & \texttt{1} & an horizontal episema under a note\\
+ & \texttt{2} & a line at the top\\
+ & \texttt{3} & a line at the bottom\\
+ \#5 & \texttt{f} & a normal episema\\
+ & \texttt{l} & a small episema aligned left\\
+ & \texttt{c} & a small episema aligned center\\
+ & \texttt{r} & for a small episema aligned right\\
+ \#6 & string & a positive or negative "nudge" (dimension) for the vertical position of the horizontal episema\\
+ \#7 & \texttt{0} & for horizontal episema cases, use automatic positioning within the space\\
+ & \texttt{1} & for horizontal episema cases, position in the middle of the space\\
+ & \texttt{2} & for horizontal episema cases, position low within the space as if the episema is over the note\\
+ & \texttt{3} & for horizontal episema cases, position high within the space as if the episema is under the note\\
+ & \texttt{4} & for horizontal episema cases, position low within the space as if the episema is over the note\\
+ & \texttt{5} & for horizontal episema cases, position high within the space as if the episema is under the note\\
\end{argtable}
\macroname{\textbackslash gre@hepisorlineaux}{\#1\#2\#3\#4}{gregoriotex-signs.tex}
Macro that will help in the typesetting of a horizontal episema and additional lines.
\begin{argtable}
- \#1 & Gregorio\TeX\ glyph & an offset glyph (see \#3, below)\\
- \#2 & Gregorio\TeX\ glyph & the episema glyph\\
- \#3 & \texttt{0} & go back to the beginning of the previous glyph; this starts the episema at the beginning of the previous glyph\\
- & \texttt{1} & stay at the end of the glyph; doesn’t make much sense to use this\\
- & \texttt{2} & go back the width of \#1; this starts the episema at the glyph from the end that starts at \#1’s width from the end\\
- & \texttt{3} & go back to the beginning of the previous glyph and then forward the width of \#1; this starts the episema at the glyph from the start that starts just after \#1’s width from the start\\
- \#4 & \texttt{0} & an horizontal episema\\
- & \texttt{1} & an horizontal episema under a note\\
- & \texttt{2} & a line at the top\\
- & \texttt{3} & a line at the bottom\\
+ \#1 & Gregorio\TeX\ glyph & an offset glyph (see \#3, below)\\
+ \#2 & Gregorio\TeX\ glyph & the episema glyph\\
+ \#3 & \texttt{0} & go back to the beginning of the previous glyph; this starts the episema at the beginning of the previous glyph\\
+ & \texttt{1} & stay at the end of the glyph; doesn’t make much sense to use this\\
+ & \texttt{2} & go back the width of \#1; this starts the episema at the glyph from the end that starts at \#1’s width from the end\\
+ & \texttt{3} & go back to the beginning of the previous glyph and then forward the width of \#1; this starts the episema at the glyph from the start that starts just after \#1’s width from the start\\
+ \#4 & \texttt{0} & an horizontal episema\\
+ & \texttt{1} & an horizontal episema under a note\\
+ & \texttt{2} & a line at the top\\
+ & \texttt{3} & a line at the bottom\\
\end{argtable}
\macroname{\textbackslash gre@vepisemaorrare}{\#1\#2\#3\#4\#5}{gregoriotex-signs.tex}
Macro to typeset a vertical episema or a rare accent (like accentus, circulus, etc.). This function must be called after a call to \verb=\GreGlyph=.
\begin{argtable}
- \#1 & character & the letter of the height of the episema (not the height of the note it corresponds to.\\
- \#2 & integer & See \nameref{EpisemaSpecial}\\
- \#3 & Gregorio\TeX\ glyph & the sign glyph\\
- \#4 & \texttt{1} & vertical episema\\
- & \texttt{2} & rare sign\\
- & \texttt{3} & choral sign\\
- & \texttt{4} & brace above the bar\\
- \#5 & string & the choral sign, if relevant\\
+ \#1 & character & the letter of the height of the episema (not the height of the note it corresponds to.\\
+ \#2 & integer & See \nameref{EpisemaSpecial}\\
+ \#3 & Gregorio\TeX\ glyph & the sign glyph\\
+ \#4 & \texttt{1} & vertical episema\\
+ & \texttt{2} & rare sign\\
+ & \texttt{3} & choral sign\\
+ & \texttt{4} & brace above the bar\\
+ \#5 & string & the choral sign, if relevant\\
\end{argtable}
\macroname{\textbackslash gre@vepisemaorrareaux}{\#1\#2\#3\#4\#5\#6\#7}{gregoriotex-signs.tex}
Macro to help typesetting vertical episema.
\begin{argtable}
- \#1 & Gregorio\TeX\ glyph & is an offset glyph (see \#3 below)\\
- \#2 & Gregorio\TeX glyph & the glyph upon which the sign is to be centered\\
- \#3 & \texttt{0} & go back to the beginning of the previous glyph and then forward half the width of \#2; this puts the sign at the beginning of the previous glyph, whose first note is the size of \#2\\
- & \texttt{1} & go back half the width of \#2; this puts the sign at the end of the previous glyph, whose last note is the size of \#2\\
- & \texttt{2} & go back the width of \#1 and then forward half the width of \#2; this puts the sign at the glyph from the end that starts at \#1’s width from the end\\
- & \texttt{3} & go back to the beginning of the previous glyph and then forward the width of \#1 and then back half the width of \#2; this puts the sign at the glyph from the start that ends at \#1’s width from the start\\
- \#4 & dimension & a shift that we want to get applied, useful for punctum inclinatum for example\\
- \#5 & integer & is the glyph number\\
- \#6 & \texttt{1} & vertical episema\\
- & \texttt{2} & rare sign\\
- & \texttt{3} & choral sign\\
- & \texttt{4} & brace above the bar\\
- \#7 & string & the choral sign if relevant\\
+ \#1 & Gregorio\TeX\ glyph & is an offset glyph (see \#3 below)\\
+ \#2 & Gregorio\TeX glyph & the glyph upon which the sign is to be centered\\
+ \#3 & \texttt{0} & go back to the beginning of the previous glyph and then forward half the width of \#2; this puts the sign at the beginning of the previous glyph, whose first note is the size of \#2\\
+ & \texttt{1} & go back half the width of \#2; this puts the sign at the end of the previous glyph, whose last note is the size of \#2\\
+ & \texttt{2} & go back the width of \#1 and then forward half the width of \#2; this puts the sign at the glyph from the end that starts at \#1’s width from the end\\
+ & \texttt{3} & go back to the beginning of the previous glyph and then forward the width of \#1 and then back half the width of \#2; this puts the sign at the glyph from the start that ends at \#1’s width from the start\\
+ \#4 & dimension & a shift that we want to get applied, useful for punctum inclinatum for example\\
+ \#5 & integer & is the glyph number\\
+ \#6 & \texttt{1} & vertical episema\\
+ & \texttt{2} & rare sign\\
+ & \texttt{3} & choral sign\\
+ & \texttt{4} & brace above the bar\\
+ \#7 & string & the choral sign if relevant\\
\end{argtable}
\macroname{\textbackslash gre@newglyphcommon}{}{gregoriotex-syllable.tex}
@@ -715,7 +734,7 @@ Macro for opening up greextra font.
Macro for populating \verb=\gre@box@syllablenotes=.
\begin{argtable}
- \#1 & string & The contents to be placed in the box\\
+ \#1 & string & The contents to be placed in the box\\
\end{argtable}
\macroname{\textbackslash gre@symbolfontsize}{}{gregoriotex-symbols.tex}
@@ -728,39 +747,39 @@ Macro which applies the default text format.
Saves clef information for use in \verb=gre@updatelinesclef=.
\begin{argtable}
- \#1 & character & the type of the clef: c or f\\
- \#2 & integer & the line of the clef (1 is the lowest)\\
- \#3 & integer & if \texttt{3}, it means that we must not put a flat after the clef, otherwise it’s the height of the flat\\
- \#4 & character & the type of the secondary clef: c or f\\
- \#5 & integer & the line of the secondary clef (1 is the lowest, 0 for no secondary clef)\\
- \#6 & integer & if \texttt{3}, it means that we must not put a flat after the secondary clef, otherwise it’s the height of the flat\\
+ \#1 & character & the type of the clef: c or f\\
+ \#2 & integer & the line of the clef (1 is the lowest)\\
+ \#3 & integer & if \texttt{3}, it means that we must not put a flat after the clef, otherwise it’s the height of the flat\\
+ \#4 & character & the type of the secondary clef: c or f\\
+ \#5 & integer & the line of the secondary clef (1 is the lowest, 0 for no secondary clef)\\
+ \#6 & integer & if \texttt{3}, it means that we must not put a flat after the secondary clef, otherwise it’s the height of the flat\\
\end{argtable}
\macroname{\textbackslash gre@typeclef}{\#1\#2\#3\#4\#5\#6\#7\#8}{gregoriotex-signs.tex}
Macro which typesets the clef.
\begin{argtable}
- \#1 & character & the type of the clef: c or f\\
- \#2 & integer & the line of the clef (1 is the lowest)\\
- \#3 & \texttt{0} & no need to use small clef characters (inside a line)\\
- & \texttt{1} & we must use small clef characters (inside a line)\\
- \#4 & \texttt{0} & no extra space is needed after the clef\\
- & \texttt{}1 & we must type a space after the clef\\
- \#5 & integer & if \texttt{3}, it means that we must not put a flat after the clef, otherwise it’s the height of the flat\\
- \#6 & character & the type of the secondary clef: c or f\\
- \#7 & integer & the line of the secondary clef (1 is the lowest, 0 for no secondary clef)\\
- \#8 & integer & if \texttt{3}, it means that we must not put a flat after the secondary clef, otherwise it’s the height of the flat\\
+ \#1 & character & the type of the clef: c or f\\
+ \#2 & integer & the line of the clef (1 is the lowest)\\
+ \#3 & \texttt{0} & no need to use small clef characters (inside a line)\\
+ & \texttt{1} & we must use small clef characters (inside a line)\\
+ \#4 & \texttt{0} & no extra space is needed after the clef\\
+ & \texttt{}1 & we must type a space after the clef\\
+ \#5 & integer & if \texttt{3}, it means that we must not put a flat after the clef, otherwise it’s the height of the flat\\
+ \#6 & character & the type of the secondary clef: c or f\\
+ \#7 & integer & the line of the secondary clef (1 is the lowest, 0 for no secondary clef)\\
+ \#8 & integer & if \texttt{3}, it means that we must not put a flat after the secondary clef, otherwise it’s the height of the flat\\
\end{argtable}
\macroname{\textbackslash gre@typesingleclef}{\#1\#2\#3\#4}{gregoriotex-signs.tex}
Macro which typesets a single clef.
\begin{argtable}
- \#1 & character & the type of the clef: c or f\\
- \#2 & integer & the line of the clef (1 is the lowest)\\
- \#3 & \texttt{0} & no need to use small clef characters (inside a line)\\
- & \texttt{1} & we must use small clef characters (inside a line)\\
- \#4 & integer & if \texttt{3}, it means that we must not put a flat after the clef, otherwise it’s the height of the flat\\
+ \#1 & character & the type of the clef: c or f\\
+ \#2 & integer & the line of the clef (1 is the lowest)\\
+ \#3 & \texttt{0} & no need to use small clef characters (inside a line)\\
+ & \texttt{1} & we must use small clef characters (inside a line)\\
+ \#4 & integer & if \texttt{3}, it means that we must not put a flat after the clef, otherwise it’s the height of the flat\\
\end{argtable}
\macroname{\textbackslash gre@updateleftbox}{}{gregoriotex-main.tex}
@@ -782,17 +801,17 @@ Macro for calculating the width of its argument and storing it in \verb=\gre@dim
Macro to write a bar.
\begin{argtable}
- \#1 & \texttt{0} & virgula\\
- & \texttt{1} & minima\\
- & \texttt{2} & minor\\
- & \texttt{3} & major\\
- & \texttt{4} & finalis\\
- & \texttt{5} & the last finalis\\
- \#2 & \texttt{0} & in a syllable containing only this bar\\
- & \texttt{1} & in a syllable containing other notes\\
- \#3 & \texttt{0} & if there is no text underneath the bar\\
- & \texttt{1} & if there is text underneath the bar\\
- \#4 & \TeX\ code & macros that may happen before the skip after the bar (typically GreVEpisema)\\
+ \#1 & \texttt{0} & virgula\\
+ & \texttt{1} & minima\\
+ & \texttt{2} & minor\\
+ & \texttt{3} & major\\
+ & \texttt{4} & finalis\\
+ & \texttt{5} & the last finalis\\
+ \#2 & \texttt{0} & in a syllable containing only this bar\\
+ & \texttt{1} & in a syllable containing other notes\\
+ \#3 & \texttt{0} & if there is no text underneath the bar\\
+ & \texttt{1} & if there is text underneath the bar\\
+ \#4 & \TeX\ code & macros that may happen before the skip after the bar (typically GreVEpisema)\\
\end{argtable}
\macroname{\textbackslash gre@@arg}{}{gregoriotex-syllable.tex}
@@ -805,18 +824,18 @@ A dummy macro which has not contents. Used for \verb=\ifx= comparisons.
Workhorse function behind \verb=\greannotation=.
\begin{argtable}
- \#1 & \texttt{c} & center align the new line with the existing annotation content\\
- & \texttt{l} & left align the new line with the existing annotation content\\
- & \texttt{r} & right align the new line with the existing annotation content\\
- \#2 & string & the new annotation content\\
+ \#1 & \texttt{c} & center align the new line with the existing annotation content\\
+ & \texttt{l} & left align the new line with the existing annotation content\\
+ & \texttt{r} & right align the new line with the existing annotation content\\
+ \#2 & string & the new annotation content\\
\end{argtable}
\macroname{\textbackslash gre@commentary}{[\#1]\#2}{gregoriotex-main.tex}
Workhorse function behind \verb=\grecommentary=.
\begin{argtable}
- \#1 & distance & Additional distance to be placed between the commentary and the top staff line for the next score only.\\
- \#2 & string & the new commentary content\\
+ \#1 & distance & Additional distance to be placed between the commentary and the top staff line for the next score only.\\
+ \#2 & string & the new commentary content\\
\end{argtable}
\macroname{\textbackslash gre@atletter}{}{gregoriotex-main.tex}
@@ -841,7 +860,7 @@ Workhorse function behind \verb=\grechangestyle=. Necessary because the interna
Macro used in \verb=\GreSyllable=. Sets \verb=\gre@skip@bolshift= to the left kern that should appear at the beginning of a line in case of a forced linebreak. The goal of this left kern is to have all lines aligned on notes. This shift is applied to the right before every syllable and then to the left after placing an empty box. At the beginning of the line the shift to the right is ignored by \TeX\ as leading white space, but the shift left is not because of the presence of the “character” of the empty box.
\begin{argtable}
- \#1 & dimension & \verb=begindifference= of the syllable\\
+ \#1 & dimension & \verb=begindifference= of the syllable\\
\end{argtable}
\macroname{\textbackslash gre@calculate@eolshift}{\#1}{gregoriotex-spaces.tex}
@@ -851,17 +870,17 @@ text go further than notes in the last syllable of a line, the idea
is to allow text to go a bit further right, under the custos. This shift is applied to the left after every syllable and then to the right after setting the line break penalty. If the line break occurs after this syllable, it will occur between the two shifts, pushing the shift right to the beginning of the next line where \TeX\ will ignore it as leading white space.
\begin{argtable}
- \#1 & dimension & The \verb=enddifference= of the corresponding syllable\\
+ \#1 & dimension & The \verb=enddifference= of the corresponding syllable\\
\end{argtable}
\macroname{\textbackslash gre@calculate@syllablefinalskip}{\#1\#2}{gregoriotex-spaces.tex}
Macro computing the skip at the end of the syllable.
\begin{argtable}
- \#1 & \texttt{0} & if end of syllable\\
- & \texttt{1} & if end of word\\
- \#2 & \texttt{0} & if next syllable is normal\\
- & \texttt{1} & if it’s a bar\\
+ \#1 & \texttt{0} & if end of syllable\\
+ & \texttt{1} & if end of word\\
+ \#2 & \texttt{0} & if next syllable is normal\\
+ & \texttt{1} & if it’s a bar\\
\end{argtable}
\macroname{\textbackslash gre@convert}{}{gregoriotex-spaces.tex}
@@ -874,46 +893,46 @@ Macro to hold the list of debug messages which should be designated as printing.
Macro to print debugging messages.
\begin{argtable}
- \#1 & string & The category of the message (used in conjunction with \verb=\gre@debug= to determine whether to print the message or not\\
- \#2 & string & The debug message\\
+ \#1 & string & The category of the message (used in conjunction with \verb=\gre@debug= to determine whether to print the message or not\\
+ \#2 & string & The debug message\\
\end{argtable}
\macroname{\textbackslash gre@declarefileversion}{\#1\#2}{gregoriotex-main.tex}
Macro which checks for version consistency between Gregorio\TeX\ files.
\begin{argtable}
- \#1 & string & name of the current file\\
- \#2 & string & version of the current file\\
+ \#1 & string & name of the current file\\
+ \#2 & string & version of the current file\\
\end{argtable}
\macroname{\textbackslash gre@def@char@he}{\#1\#2}{gregoriotex-chars.tex}
Macro for defining the various types of horizontal episema.
\begin{argtable}
- \#1 & string & name of the horizontal episema to be defined\\
- \#2 & string & Camel case name of horizontal episema to be defined\\
+ \#1 & string & name of the horizontal episema to be defined\\
+ \#2 & string & Camel case name of horizontal episema to be defined\\
\end{argtable}
\macroname{\textbackslash gre@def@char@he@porr}{\#1\#2}{gregoriotex-chars.tex}
Macro for defining the various types of horizontal episema porrectus.
\begin{argtable}
- \#1 & string & name of the horizontal episema porrectus to be defined\\
- \#2 & string & Camel case name of horizontal episema porrectus to be defined\\
+ \#1 & string & name of the horizontal episema porrectus to be defined\\
+ \#2 & string & Camel case name of horizontal episema porrectus to be defined\\
\end{argtable}
\macroname{\textbackslash gre@char@cavum}{\#1\#2\#3\#4\#5\#6\#7\#8}{gregoriotex-signs.tex}
Macro to typeset a “cavum” character.
\begin{argtable}
- \#1 & length & Argument \#2 from \verb=\GreGlyph=. Height to raise the glyph.\\
- \#2 & length & Argument \#3 from \verb=\GreGlyph=. Height of the next note.\\
- \#3 & integer & Argument \#4 from \verb=\GreGlyph=. The type of glyph.\\
- \#4 & \TeX\ code & Macros executed before the punctum cavum is written.\\
- \#5 & character & Argument \#5 from \verb=\GreGlyph=. The signs to typeset before the glyph.\\
- \#6 & string & the line, byte offset, and column address for textedit links when point-and-click is enabled.\\
- \#7 & control sequence & The control sequence for the glyph.\\
- \#8 & control sequence & The control sequence for the hole glyph.
+ \#1 & length & Argument \#2 from \verb=\GreGlyph=. Height to raise the glyph.\\
+ \#2 & length & Argument \#3 from \verb=\GreGlyph=. Height of the next note.\\
+ \#3 & integer & Argument \#4 from \verb=\GreGlyph=. The type of glyph.\\
+ \#4 & \TeX\ code & Macros executed before the punctum cavum is written.\\
+ \#5 & character & Argument \#5 from \verb=\GreGlyph=. The signs to typeset before the glyph.\\
+ \#6 & string & the line, byte offset, and column address for textedit links when point-and-click is enabled.\\
+ \#7 & control sequence & The control sequence for the glyph.\\
+ \#8 & control sequence & The control sequence for the hole glyph.
\end{argtable}
\macroname{\textbackslash gre@get@spaceskip}{\#1}{gregoriotex-signs.tex}
@@ -921,29 +940,29 @@ Loads \verb=\gre@skip@temp@four= with the appropriate rubber length given the
desired case.
\begin{argtable}
- \#1 & \texttt{0} & Default space.\\
- & \texttt{1} & Zero-width space.\\
- & \texttt{2} & Space between flat or natural and a note.\\
- & \texttt{3} & Space between two puncta inclinata, descending.\\
- & \texttt{4} & Space between bivirga or trivirga.\\
- & \texttt{5} & space between bistropha or tristropha.\\
- & \texttt{6} & Space after a punctum mora XXX: not used yet, not so sure it is a good idea\ldots\\
- & \texttt{7} & Space between a punctum inclinatum and a punctum inclinatum debilis, descending.\\
- & \texttt{8} & Space between two puncta inclinata debilis.\\
- & \texttt{9} & Space before a punctum (or something else) and a punctum inclinatum.\\
- & \texttt{10} & Space between puncta inclinata (also debilis for now), larger ambitus (range=3rd), descending.\\
- & \texttt{11} & Space between puncta inclinata (also debilis for now), larger ambitus (range=4th or 5th), descending.\\
- & \texttt{12} & Space between two puncta inclinata, ascending. \\
- & \texttt{13} & Space between a punctum inclinatum and a punctum inclinatum debilis, ascending. \\
- & \texttt{14} & Space between puncta inclinata (also debilis for now), larger ambitus (range=3rd), ascending. \\
- & \texttt{15} & Space between puncta inclinata (also debilis for now), larger ambitus (range=4th or 5th), ascending. \\
- & \texttt{16} & Space between a punctum inclinatum and a ``no-bar'' glyph one pitch below. \\
- & \texttt{17} & Space between a punctum inclinatum and a ``no-bar'' glyph two pitches below. \\
- & \texttt{18} & Space between a punctum inclinatum and a ``no-bar'' glyph three or four pitches below \\
- & \texttt{19} & Space between a punctum inclinatum and a ``no-bar'' glyph one pitch above. \\
- & \texttt{20} & Space between a punctum inclinatum and a ``no-bar'' glyph two pitches above. \\
- & \texttt{21} & Space between a punctum inclinatum and a ``no-bar'' glyph three or four pitches above \\
- & \texttt{22} & Half-space. \\
+ \#1 & \texttt{0} & Default space.\\
+ & \texttt{1} & Zero-width space.\\
+ & \texttt{2} & Space between flat or natural and a note.\\
+ & \texttt{3} & Space between two puncta inclinata, descending.\\
+ & \texttt{4} & Space between bivirga or trivirga.\\
+ & \texttt{5} & space between bistropha or tristropha.\\
+ & \texttt{6} & Space after a punctum mora XXX: not used yet, not so sure it is a good idea\ldots\\
+ & \texttt{7} & Space between a punctum inclinatum and a punctum inclinatum debilis, descending.\\
+ & \texttt{8} & Space between two puncta inclinata debilis.\\
+ & \texttt{9} & Space before a punctum (or something else) and a punctum inclinatum.\\
+ & \texttt{10} & Space between puncta inclinata (also debilis for now), larger ambitus (range=3rd), descending.\\
+ & \texttt{11} & Space between puncta inclinata (also debilis for now), larger ambitus (range=4th or 5th), descending.\\
+ & \texttt{12} & Space between two puncta inclinata, ascending. \\
+ & \texttt{13} & Space between a punctum inclinatum and a punctum inclinatum debilis, ascending. \\
+ & \texttt{14} & Space between puncta inclinata (also debilis for now), larger ambitus (range=3rd), ascending. \\
+ & \texttt{15} & Space between puncta inclinata (also debilis for now), larger ambitus (range=4th or 5th), ascending. \\
+ & \texttt{16} & Space between a punctum inclinatum and a ``no-bar'' glyph one pitch below. \\
+ & \texttt{17} & Space between a punctum inclinatum and a ``no-bar'' glyph two pitches below. \\
+ & \texttt{18} & Space between a punctum inclinatum and a ``no-bar'' glyph three or four pitches below \\
+ & \texttt{19} & Space between a punctum inclinatum and a ``no-bar'' glyph one pitch above. \\
+ & \texttt{20} & Space between a punctum inclinatum and a ``no-bar'' glyph two pitches above. \\
+ & \texttt{21} & Space between a punctum inclinatum and a ``no-bar'' glyph three or four pitches above \\
+ & \texttt{22} & Half-space. \\
\end{argtable}
\macroname{\textbackslash gre@nabcfontname}{}{gregoriotex-main.tex}
@@ -974,14 +993,14 @@ Macro which stores the middle part of the next syllable (the part which aligns w
A macro which applies formatting that needs to apply to the whole syllable (rather than the parts individually) for the current syllable. Necessary to preserve ligatures across parts within a syllable.
\begin{argtable}
- \#1 & string & The syllable (usually built as \verb=\gre@firstsyllablepart\gre@middlesyllablepart\gre@endsyllablepart=\\
+ \#1 & string & The syllable (usually built as \verb=\gre@firstsyllablepart\gre@middlesyllablepart\gre@endsyllablepart=\\
\end{argtable}
\macroname{\textbackslash gre@fixednexttextformat}{\#1}{gregoriotex-syllable.tex}
A macro which applies formatting that needs to apply to the whole syllable (rather than the parts individually) for the next syllable. Necessary to preserve ligatures across parts within a syllable.
\begin{argtable}
- \#1 & string & The syllable (usually built as \verb=\gre@nextfirstsyllablepart\gre@nextmiddlesyllablepart\gre@nextendsyllablepart=\\
+ \#1 & string & The syllable (usually built as \verb=\gre@nextfirstsyllablepart\gre@nextmiddlesyllablepart\gre@nextendsyllablepart=\\
\end{argtable}
\macroname{\textbackslash gre@gabcname}{}{gregoriotex-main.tex}
@@ -1050,43 +1069,49 @@ The pitch of a rare sign (semicirculus, \etc).
\macroname{\textbackslash gre@pitch@dummy}{}{gregoriotex-main.tex}
A meaningless (don't-care) pitch.
+\macroname{\textbackslash gre@pitch@nominal}{}{gregoriotex-main.tex}
+A pitch guaranteed to be in the staff.
+
\macroname{\textbackslash gre@pointandclick}{\#1\#2}{gregoriotex-main.tex}
Macro to generate the point-and-click links.
\begin{argtable}
- \#1 & \TeX\ code & the entity which is to contain the link\\
- \#2 & link target & line:char:column for the link\\
+ \#1 & \TeX\ code & the entity which is to contain the link\\
+ \#2 & link target & line:char:column for the link\\
\end{argtable}
\macroname{\textbackslash gre@prefix}{}{gregoriotex-spaces.tex}
-Either ``skip’’ or ``dimen’’ according to the distance being set or changed at the given moment.
+Either \texttt{skip} or \texttt{dimen} according to the distance being set or changed at the given moment.
+
+\macroname{\textbackslash gre@prefixII}{}{gregoriotex-spaces.tex}
+Same as \verb=\gre@prefix=. Used when we were dealing with two distances simultaneously.
\macroname{\textbackslash gre@rubberpermit}{\#1}{gregoriotex-spaces.tex}
Determines whether the given distance is allowed to take a rubber length.
\begin{argtable}
- \#1 & string & the name of the distance to check\\
+ \#1 & string & the name of the distance to check\\
\end{argtable}
\macroname{\textbackslash gre@setgregoriofont}{[\#1]\#2}{gregoriotex-main.tex}
Workhorse function behind \verb=\gresetgregoriofont=.
\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 gre@syllable@end}{\#1\#2\#3}{gregoriotex-syllable.tex}
Macro to make a few checks and call the right macros between \verb=\endbeforebar, \endofword, \endofsyllable=.
\begin{argtable}
- \#1 & & next syllable type (\#7 of \verb=\GreSyllable=)\\
- \#2 & string & next syllable text\\
- \#3 & \texttt{0} & this syllable is not the end of a word\\
- & \texttt{1} & this syllable is the end of a word\\
+ \#1 & & next syllable type (\#7 of \verb=\GreSyllable=)\\
+ \#2 & string & next syllable text\\
+ \#3 & \texttt{0} & this syllable is not the end of a word\\
+ & \texttt{1} & this syllable is the end of a word\\
\end{argtable}
\macroname{\textbackslash gre@typeout}{\#1}{gregoriotex.sty \textup{and} gregoriotex.tex}
@@ -1114,13 +1139,13 @@ Alias for \verb=\luatexlocalrightbox= or \verb=\localrightbox=, depending on \La
Alias for \verb=\resizebox=.
\macroname{\textbackslash gre@dimension}{}{gregoriotex-spaces.tex}
-Workhorse function behind \verb=\grecreatedim= and \verb=\grechangedim=.
+Workhorse function for setting distances in \verb=\grecreatedim= and \verb=\grechangedim=.
\macroname{\textbackslash gre@setstafflines}{\#1}{gregoriotex-main.tex}
Sets the number of staff lines.
\begin{argtable}
- \#1 & integer & The number of staff lines\\
+ \#1 & integer & The number of staff lines\\
\end{argtable}
\macroname{\textbackslash gre@stafflines}{}{gregoriotex-main.tex}
@@ -1130,39 +1155,39 @@ Contains the number of staff lines.
Typesets its numeric argument as an upper-case Roman numeral.
\begin{argtable}
- \#1 & integer & The number to typeset\\
+ \#1 & integer & The number to typeset\\
\end{argtable}
\macroname{\textbackslash gre@romannumeral@minuscule}{\#1}{gregoriotex-main.tex}
Typesets its numeric argument as a lower-case Roman numeral.
\begin{argtable}
- \#1 & integer & The number to typeset\\
+ \#1 & integer & The number to typeset\\
\end{argtable}
\macroname{\textbackslash gre@bar@space@suffix}{\#1\#2}{gregoriotex-symbols.tex}
Macro used to select the corresct suffix of the \verb=bar@x= spaces.
\begin{argtable}
- \#1 & \texttt{0} & emits nothing\\
- & \texttt{1} emits \texttt{text}\\
+ \#1 & \texttt{0} & emits nothing\\
+ & \texttt{1} emits \texttt{text}\\
\end{argtable}
\macroname{\textbackslash gre@drawadditionalline}{\#1\#2\#3\#4\#5\#6}{gregoriotex-signs.tex}
Workhorse function behind \verb=\GreDrawAdditionalLine=.
\begin{argtable}
- \#1 & \texttt{0} & Draw an over-the-staff ledger line. \\
- & \texttt{1} & Draw an under-the-staff ledger line. \\
- \#2 & distance & The length of the line, with TeX units, excluding any left or right distances coming from the rest of the arguments. \\
- \#3 & \texttt{0} & Start the line at this point. \\
- & \texttt{1} & Start the line to the left of this point by \verb=gre@dimen@additionallineswidth=. \\
- & \texttt{2} & Start the line to the left of this point by \#4. \\
- \#4 & distance & The distance to move left before starting the line if \#3 is \texttt{2}. \\
- \#5 & \texttt{0} & End the line exactly \#2 to the right of this point. \\
- & \texttt{1} & End the line \verb=gre@dimen@additionallineswidth= to the right of \#2 from this point. \\
- & \texttt{2} & End the line \#6 to the right of \#2 from this point. \\
- \#6 & distance & The distance to end the line after \#2 from this point if \#3 is \texttt{2}. \\
+ \#1 & \texttt{0} & Draw an over-the-staff ledger line. \\
+ & \texttt{1} & Draw an under-the-staff ledger line. \\
+ \#2 & distance & The length of the line, with TeX units, excluding any left or right distances coming from the rest of the arguments. \\
+ \#3 & \texttt{0} & Start the line at this point. \\
+ & \texttt{1} & Start the line to the left of this point by \verb=gre@dimen@additionallineswidth=. \\
+ & \texttt{2} & Start the line to the left of this point by \#4. \\
+ \#4 & distance & The distance to move left before starting the line if \#3 is \texttt{2}. \\
+ \#5 & \texttt{0} & End the line exactly \#2 to the right of this point. \\
+ & \texttt{1} & End the line \verb=gre@dimen@additionallineswidth= to the right of \#2 from this point. \\
+ & \texttt{2} & End the line \#6 to the right of \#2 from this point. \\
+ \#6 & distance & The distance to end the line after \#2 from this point if \#3 is \texttt{2}. \\
\end{argtable}
\macroname{\textbackslash gre@get@unkern@aftermora}{}{gregoriotex-signs.tex}
@@ -1175,21 +1200,21 @@ Macro which kerns between a punctum mora and a bar according to the setting in \
Workhorse behind \verb=\gresetgregoriofontscaled=.
\begin{argtable}
- \#1 & \textit{(omitted)} & Use the normal font and rule set.\\
- & \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.\\
- \#3 & integer & the scaling factor\\
+ \#1 & \textit{(omitted)} & Use the normal font and rule set.\\
+ & \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.\\
+ \#3 & integer & the scaling factor\\
\end{argtable}
\macroname{\textbackslash gre@calculate@barposition}{\#1\#2}{gregoriotex-spaces.tex}
Macro for calculating the position of the elements of a bar syllable using the new bar positioning algorithm.
\begin{argtable}
- \#1 & 0 & bar is not the end of a word\\
- & 1 & bar is the end of a word\\
- \#2 & integer & alignment type of the first glyph in the next syllable. See \nameref{notesalign}\\
+ \#1 & 0 & bar is not the end of a word\\
+ & 1 & bar is the end of a word\\
+ \#2 & integer & alignment type of the first glyph in the next syllable. See \nameref{notesalign}\\
\end{argtable}
\macroname{\textbackslash gre@newlinearg}{}{gregoriotex-syllable.tex}
@@ -1205,15 +1230,15 @@ Macro for storing original behavior of \verb=\gre@newlinecommon= so that it can
Macro to typeset a punctum mora.
\begin{argtable}
- \#1 & pitch & height of the punctum mora (one of the \verb=\gre@pitch@...= macros.\\
- \#2 & 0 & general case\\
- & 1 & make the punctum mora zero-width\\
- & 2 & shift the width of one punctum to the left\\
- & 3 & same as 2 but with ambitus of one\\
- \#3 & 1 & punctum mora in the note before the last note of a podatus, porrectus, or torculus resupinus\\
- & 0 & other cases\\
- \#4 & 1 & punctum inclinatum\\
- & 0 & other cases\\
+ \#1 & pitch & height of the punctum mora (one of the \verb=\gre@pitch@...= macros.\\
+ \#2 & 0 & general case\\
+ & 1 & make the punctum mora zero-width\\
+ & 2 & shift the width of one punctum to the left\\
+ & 3 & same as 2 but with ambitus of one\\
+ \#3 & 1 & punctum mora in the note before the last note of a podatus, porrectus, or torculus resupinus\\
+ & 0 & other cases\\
+ \#4 & 1 & punctum inclinatum\\
+ & 0 & other cases\\
\end{argtable}
@@ -1233,7 +1258,7 @@ Macro for closing the auxiliary file.
Macro for writing the auxiliary file.
\begin{argtable}
- \#1 & string & contents to be written to the auxiliary file\\
+ \#1 & string & contents to be written to the auxiliary file\\
\end{argtable}
@@ -1253,7 +1278,7 @@ The font for ancient notation.
The font for the default initial format in Plain \TeX.
\macroname{\textbackslash gre@fontfactor@...}{}{gregoriotex-main.tex}
-Macro holding the factor at which the font is loaded. There is one of these macros for each chant font which has been loaded with the ending of the macro name being the name of the chant font (gregorio, parmesan, \etc).
+Macro holding the factor at which the font is loaded. There is one of these macros for each chant font which has been loaded with the ending of the macro name being the name of the chant font (gregorio, granapadano, \etc).
\subsection{Character Reference Aliases}
@@ -1521,11 +1546,17 @@ Count which indicates whether the point-and-click functionality should be implem
\macroname{\textbackslash gre@variableheightexpansion}{}{gregoriotex-main.tex}
Count to indicated if the spacing between lines should be variable (\texttt{1}) or fixed (\texttt{0}). Not a boolean because it needs to be readable by Lua.
+\macroname{\textbackslash ifgre@usecustosalteration}{}{gregoriotex-signs.tex}
+Boolean which indicates whether alterations should be printed for custodes.
+
\macroname{\textbackslash ifgre@blockeolcustos}{}{gregoriotex-main.tex}
Boolean which indicates whether the custos at the end of the line should be blocked.
\macroname{\textbackslash ifgre@blockeolcustosbeforeeuouae}{}{gregoriotex-main.tex}
Boolean which indicates whether the custos at the end of the line should be blocked if a EUOUAE block immediately follows.
+\macroname{\textbackslash ifgre@blockeolcustos}{}{gregoriotex-main.tex}
+Boolean which indicates whether the custos at the end of the line should be blocked.
+
\macroname{\textbackslash ifgre@raggedbreakbeforeeuouae}{}{gregoriotex-main.tex}
Boolean which indicates whether an automatic line break immediately before a EUOUAE block should be ragged.
@@ -1619,6 +1650,30 @@ Boolean indicating that the current syllable had a forced center in the gabc whi
\macroname{\textbackslash ifgre@nextforcedcentering}{}{gregoriotex-syllable.tex}
Boolean indicating that the next syllable had a forced center in the gabc which is to be respected.
+\macroname{\textbackslash ifgre@unbreakableendofelement}{}{gregoriotex-main.tex}
+Boolean used by \verb=\GreEndOfElement= to store whether the line may be broken at that point.
+
+\macroname{\textbackslash gre@count@syllablenotes}{}{gregoriotex-syllable.tex}
+Count containing the number of notes in the syllable.
+
+\macroname{\textbackslash gre@count@unbreakabletotalnotes}{}{gregoriotex-syllable.tex}
+Count containing the minimum number of notes in the syllable before the syllable
+may be broken across lines.
+
+\macroname{\textbackslash gre@count@unbreakableinitialnotes}{}{gregoriotex-syllable.tex}
+Count containing the minimum number of notes at the start of a syllable that
+must be kept together when the syllable is broken across lines.
+
+\macroname{\textbackslash gre@count@unbreakablefinalnotes}{}{gregoriotex-syllable.tex}
+Count containing the minimum number of notes at the end of a syllable that must
+be kept together when the syllable is broken across lines.
+
+\macroname{\textbackslash ifgre@shownotes}{}{gregoriotex-syllable.tex}
+Boolean indicating whether the notes should be shown.
+
+\macroname{\textbackslash ifgre@showlyrics}{}{gregoriotex-syllable.tex}
+Boolean indicating whether the lyrics should be shown.
+
\subsection{Boxes}
@@ -1858,21 +1913,21 @@ These are the macros that Gregorio\TeX\ uses to manipulate the penalties in orde
Top level function that aliases \verb=\gre@truepenalty= or \verb=\gre@falsepenalty= according to whether penalties should be in play or not.
\begin{argtable}
- \#1 & integer & The penalty to be applied or gobbled\\
+ \#1 & integer & The penalty to be applied or gobbled\\
\end{argtable}
\macroname{\textbackslash gre@truepenalty}{\#1}{gregoriotex-signs.tex}
Alias for \verb=\penalty=.
\begin{argtable}
- \#1 & integer & The penalty to be applied\\
+ \#1 & integer & The penalty to be applied\\
\end{argtable}
\macroname{\textbackslash gre@falsepenalty}{\#1}{gregoriotex-signs.tex}
Macro to gobble (suppress) its argument.
\begin{argtable}
- \#1 & integer & The penalty to be gobbled\\
+ \#1 & integer & The penalty to be gobbled\\
\end{argtable}
\macroname{\textbackslash gre@cancelpenalties}{}{gregoriotex-spaces.tex}
@@ -1956,25 +2011,25 @@ rather than have multiple definitions.
\subsection{Note Alignment Type}\label{notesalign}
\rowcolors{1}{lightgray}{lightgray}
\begin{tabulary}{\textwidth}{cL}
- \multicolumn{2}{c}{Integer with the following possibilities:} \\
- \hline
- \texttt{0} & one-note glyph or more than two notes glyph except porrectus : here we must put the aligncenter in the middle of the first note\\
- \texttt{1} & two notes glyph (podatus is considered as a one-note glyph) : here we put the aligncenter in the middle of the glyph\\
- \texttt{2} & porrectus : has a special align center\\
- \texttt{3} & initio-debilis : same as 1 but the first note is much smaller\\
- \texttt{4} & case of a glyph starting with a quilisma\\
- \texttt{5} & case of a glyph starting with an oriscus\\
- \texttt{6} & case of a punctum inclinatum\\
- \texttt{7} & case of a stropha\\
- \texttt{8} & flexus with an ambitus of one\\
- \texttt{9} & flexus deminutus\\
- \texttt{10} & virgula\\
- \texttt{11} & divisio minima\\
- \texttt{12} & divisio minor\\
- \texttt{13} & divisio maior\\
- \texttt{14} & dominican bar\\
- \texttt{15} & divisio finalis\\
- \texttt{16} & no note
+ \multicolumn{2}{c}{Integer with the following possibilities:} \\
+ \hline
+ \texttt{0} & one-note glyph or more than two notes glyph except porrectus : here we must put the aligncenter in the middle of the first note\\
+ \texttt{1} & two notes glyph (podatus is considered as a one-note glyph) : here we put the aligncenter in the middle of the glyph\\
+ \texttt{2} & porrectus : has a special align center\\
+ \texttt{3} & initio-debilis : same as 1 but the first note is much smaller\\
+ \texttt{4} & case of a glyph starting with a quilisma\\
+ \texttt{5} & case of a glyph starting with an oriscus\\
+ \texttt{6} & case of a punctum inclinatum\\
+ \texttt{7} & case of a stropha\\
+ \texttt{8} & flexus with an ambitus of one\\
+ \texttt{9} & flexus deminutus\\
+ \texttt{10} & virgula\\
+ \texttt{11} & divisio minima\\
+ \texttt{12} & divisio minor\\
+ \texttt{13} & divisio maior\\
+ \texttt{14} & dominican bar\\
+ \texttt{15} & divisio finalis\\
+ \texttt{16} & no note
\end{tabulary}
\subsection{Episema Special}\label{EpisemaSpecial}
@@ -1986,62 +2041,62 @@ rather than have multiple definitions.
\hrule
\vspace{-0.8\baselineskip}
\begin{description}
- \item[FinalPunctum] Last note, which is a standard punctum (works with pes).
- \item[FinalDeminutus] Same, but the last note is a deminutus.
- \item[PenultBeforePunctumWide] The note before the last note, which is a standard punctum.
- \item[PenultBeforeDeminutus] Idem, but the note is the note preceding a deminutus.
- \item[AntepenultBeforePunctum] The note before the note before the last note (for porrectus flexus).
- \item[AntepenultBeforeDeminutus] Idem, but when the two last notes are a deminutus.
- \item[InitialPunctum] The first note, if it is a standard punctum.
- \item[InitioDebilis] The first note, if it is an initio debilis.
- \item[PorrNonAuctusInitialWide] first note of a non-auctus porrectus with a second ambitus of at least two.
- \item[PorrNonAuctusInitialOne] first note of a non-auctus porrectus with a second ambitus of one
- \item[PorrAuctusInitialAny] first note of an auctus porrectus, regardless of second ambitus
- \item[FinalInclinatum] punctum inclinatum as last note
- \item[FinalInclinatumDeminutus] punctum inclinatum deminutus as last note
- \item[FinalStropha] stropha as last note
- \item[FinalQuilisma] quilisma as last note
- \item[FinalOriscus] oriscus as last note
- \item[PenultBeforePunctumOne] second-to-last note, with a second ambitus of one, when last note is a standard punctum (like the second note of ghg)
- \item[FinalUpperPunctum] “upper smaller punctum” as last note (concerning simple podatus, podatus, and torculus resupinus)
- \item[InitialOriscus] oriscus as first note, disconnected from next note
- \item[InitialQuilisma] quilisma as first note, disconnected from next note
- \item[TorcResNonAuctusSecondWideWide] second note of a non-auctus torculus resupinus starting with a punctum, with a first and second ambitus of at least two
- \item[TorcResNonAuctusSecondOneWide] second note of a non-auctus torculus resupinus starting with a punctum, with a first ambitus of one and a second ambitus of at least two
- \item[TorcResDebilisNonAuctusSecondAnyWide] second note of a non-auctus torculus resupinus initio debilis with any first ambitus and a second ambitus of at least two
- \item[FinalLineaPunctum] linea punctum (cavum) as last note
- \item[BarStandard] standard bar
- \item[BarVirgula] virgula
- \item[BarDivisioFinalis] divisio finalis
- \item[TorcResQuilismaNonAuctusSecondWideWide] second note of a non-auctus torculus resupinus starting with a quilisma, with a first and second ambitus of at least two
- \item[TorcResOriscusNonAuctusSecondWideWide] second note of a non-auctus torculus resupinus starting with an oriscus, with a first and second ambitus of at least two
- \item[TorcResQuilismaNonAuctusSecondOneWide] second note of a non-auctus torculus resupinus starting with a quilisma, with a first ambitus of one and and second ambitus of at least two
- \item[TorcResOriscusNonAuctusSecondOneWide] second note of a non-auctus torculus resupinus starting with an oriscus, with a first ambitus of one and and second ambitus of at least two
- \item[TorcResNonAuctusSecondWideOne] second note of a non-auctus torculus resupinus starting with a punctum, with a first ambitus of at least two and a second ambitus of one
- \item[TorcResDebilisNonAuctusSecondAnyOne] second note of a non-auctus torculus resupinus initio debilis with any first ambitus and a second ambitus of one
- \item[TorcResQuilismaNonAuctusSecondWideOne] second note of a non-auctus torculus resupinus starting with a quilisma, with a first ambitus of at least two and a second ambitus of one
- \item[TorcResOriscusNonAuctusSecondWideOne] second note of a non-auctus torculus resupinus starting with an oriscus, with a first ambitus of at least two and a second ambitus of one
- \item[TorcResNonAuctusSecondOneOne] second note of a non-auctus torculus resupinus starting with a punctum, with a first and second ambitus of one
- \item[TorcResQuilismaNonAuctusSecondOneOne] second note of a non-auctus torculus resupinus starting with a quilisma, with a first and second ambitus of one
- \item[TorcResOriscusNonAuctusSecondOneOne] second note of a non-auctus torculus resupinus starting with an oriscus, with a first and second ambitus of one
- \item[TorcResAuctusSecondWideAny] second note of an auctus torculus resupinus starting with a punctum, with a first ambitus of at least two and any second ambitus
- \item[TorcResDebilisAuctusSecondAnyAny] second note of an auctus torculus resupinus initio debilis with any first and second ambitus
- \item[TorcResQuilismaAuctusSecondWideAny] second note of an auctus torculus resupinus starting with a quilisma, with a first ambitus of at least two and any second ambitus
- \item[TorcResOriscusAuctusSecondWideAny] second note of an auctus torculus resupinus starting with an oriscus, with a first ambitus of at least two and any second ambitus
- \item[TorcResAuctusSecondOneAny] second note of an auctus torculus resupinus starting with a punctum, with a first ambitus of one and any second ambitus
- \item[TorcResQuilismaAuctusSecondOneAny] second note of an auctus torculus resupinus starting with a quilisma, with a first ambitus of one and any second ambitus
- \item[TorcResOriscusAuctusSecondOneAny] second note of an auctus torculus resupinus starting with an oriscus, with a first ambitus of one and any second ambitus
- \item[ConnectedPenultBeforePunctumWide] second-to-last note connected to prior note, with a second ambitus of at least two, when last note is a standard punctum (like the second note of \textit{gig})
- \item[ConnectedPenultBeforePunctumOne] second-to-last note connected to prior note, with a second ambitus of one, when last note is a standard punctum (like the second note of \textit{gih})
- \item[InitialConnectedPunctum] standard punctum as first note, connected to next higher note
- \item[InitialConnectedVirga] “virga” as first note, connected to next lower note
- \item[InitialConnectedQuilisma] quilisma as first note, connected to next higher note
- \item[InitialConnectedOriscus] oriscus as first note, connected to next higher note
- \item[FinalConnectedPunctum] punctum as last note, connected to prior higher note
- \item[FinalConnectedAuctus] auctus as last note, connected to prior lower note
- \item[FinalVirgaAuctus] virga aucta as last note
- \item[FinalConnectedVirga] “virga” as last note, connected to prior lower note
- \item[InitialVirga] “virga” as first note, disconnected from next note
+ \item[FinalPunctum] Last note, which is a standard punctum (works with pes).
+ \item[FinalDeminutus] Same, but the last note is a deminutus.
+ \item[PenultBeforePunctumWide] The note before the last note, which is a standard punctum.
+ \item[PenultBeforeDeminutus] Idem, but the note is the note preceding a deminutus.
+ \item[AntepenultBeforePunctum] The note before the note before the last note (for porrectus flexus).
+ \item[AntepenultBeforeDeminutus] Idem, but when the two last notes are a deminutus.
+ \item[InitialPunctum] The first note, if it is a standard punctum.
+ \item[InitioDebilis] The first note, if it is an initio debilis.
+ \item[PorrNonAuctusInitialWide] first note of a non-auctus porrectus with a second ambitus of at least two.
+ \item[PorrNonAuctusInitialOne] first note of a non-auctus porrectus with a second ambitus of one
+ \item[PorrAuctusInitialAny] first note of an auctus porrectus, regardless of second ambitus
+ \item[FinalInclinatum] punctum inclinatum as last note
+ \item[FinalInclinatumDeminutus] punctum inclinatum deminutus as last note
+ \item[FinalStropha] stropha as last note
+ \item[FinalQuilisma] quilisma as last note
+ \item[FinalOriscus] oriscus as last note
+ \item[PenultBeforePunctumOne] second-to-last note, with a second ambitus of one, when last note is a standard punctum (like the second note of ghg)
+ \item[FinalUpperPunctum] “upper smaller punctum” as last note (concerning simple podatus, podatus, and torculus resupinus)
+ \item[InitialOriscus] oriscus as first note, disconnected from next note
+ \item[InitialQuilisma] quilisma as first note, disconnected from next note
+ \item[TorcResNonAuctusSecondWideWide] second note of a non-auctus torculus resupinus starting with a punctum, with a first and second ambitus of at least two
+ \item[TorcResNonAuctusSecondOneWide] second note of a non-auctus torculus resupinus starting with a punctum, with a first ambitus of one and a second ambitus of at least two
+ \item[TorcResDebilisNonAuctusSecondAnyWide] second note of a non-auctus torculus resupinus initio debilis with any first ambitus and a second ambitus of at least two
+ \item[FinalLineaPunctum] linea punctum (cavum) as last note
+ \item[BarStandard] standard bar
+ \item[BarVirgula] virgula
+ \item[BarDivisioFinalis] divisio finalis
+ \item[TorcResQuilismaNonAuctusSecondWideWide] second note of a non-auctus torculus resupinus starting with a quilisma, with a first and second ambitus of at least two
+ \item[TorcResOriscusNonAuctusSecondWideWide] second note of a non-auctus torculus resupinus starting with an oriscus, with a first and second ambitus of at least two
+ \item[TorcResQuilismaNonAuctusSecondOneWide] second note of a non-auctus torculus resupinus starting with a quilisma, with a first ambitus of one and and second ambitus of at least two
+ \item[TorcResOriscusNonAuctusSecondOneWide] second note of a non-auctus torculus resupinus starting with an oriscus, with a first ambitus of one and and second ambitus of at least two
+ \item[TorcResNonAuctusSecondWideOne] second note of a non-auctus torculus resupinus starting with a punctum, with a first ambitus of at least two and a second ambitus of one
+ \item[TorcResDebilisNonAuctusSecondAnyOne] second note of a non-auctus torculus resupinus initio debilis with any first ambitus and a second ambitus of one
+ \item[TorcResQuilismaNonAuctusSecondWideOne] second note of a non-auctus torculus resupinus starting with a quilisma, with a first ambitus of at least two and a second ambitus of one
+ \item[TorcResOriscusNonAuctusSecondWideOne] second note of a non-auctus torculus resupinus starting with an oriscus, with a first ambitus of at least two and a second ambitus of one
+ \item[TorcResNonAuctusSecondOneOne] second note of a non-auctus torculus resupinus starting with a punctum, with a first and second ambitus of one
+ \item[TorcResQuilismaNonAuctusSecondOneOne] second note of a non-auctus torculus resupinus starting with a quilisma, with a first and second ambitus of one
+ \item[TorcResOriscusNonAuctusSecondOneOne] second note of a non-auctus torculus resupinus starting with an oriscus, with a first and second ambitus of one
+ \item[TorcResAuctusSecondWideAny] second note of an auctus torculus resupinus starting with a punctum, with a first ambitus of at least two and any second ambitus
+ \item[TorcResDebilisAuctusSecondAnyAny] second note of an auctus torculus resupinus initio debilis with any first and second ambitus
+ \item[TorcResQuilismaAuctusSecondWideAny] second note of an auctus torculus resupinus starting with a quilisma, with a first ambitus of at least two and any second ambitus
+ \item[TorcResOriscusAuctusSecondWideAny] second note of an auctus torculus resupinus starting with an oriscus, with a first ambitus of at least two and any second ambitus
+ \item[TorcResAuctusSecondOneAny] second note of an auctus torculus resupinus starting with a punctum, with a first ambitus of one and any second ambitus
+ \item[TorcResQuilismaAuctusSecondOneAny] second note of an auctus torculus resupinus starting with a quilisma, with a first ambitus of one and any second ambitus
+ \item[TorcResOriscusAuctusSecondOneAny] second note of an auctus torculus resupinus starting with an oriscus, with a first ambitus of one and any second ambitus
+ \item[ConnectedPenultBeforePunctumWide] second-to-last note connected to prior note, with a second ambitus of at least two, when last note is a standard punctum (like the second note of \textit{gig})
+ \item[ConnectedPenultBeforePunctumOne] second-to-last note connected to prior note, with a second ambitus of one, when last note is a standard punctum (like the second note of \textit{gih})
+ \item[InitialConnectedPunctum] standard punctum as first note, connected to next higher note
+ \item[InitialConnectedVirga] “virga” as first note, connected to next lower note
+ \item[InitialConnectedQuilisma] quilisma as first note, connected to next higher note
+ \item[InitialConnectedOriscus] oriscus as first note, connected to next higher note
+ \item[FinalConnectedPunctum] punctum as last note, connected to prior higher note
+ \item[FinalConnectedAuctus] auctus as last note, connected to prior lower note
+ \item[FinalVirgaAuctus] virga aucta as last note
+ \item[FinalConnectedVirga] “virga” as last note, connected to prior lower note
+ \item[InitialVirga] “virga” as first note, disconnected from next note
\end{description}
\end{shaded*}