Debian Codegraph @

texmf-dist/doc/luatex/gregoriotex/Command_Index_internal.tex

raw
1 % !TEX root = GregorioRef.tex
2 % !TEX program = LuaLaTeX+se
3 %
4 % Copyright (C) 2006-2025 The Gregorio Project (see CONTRIBUTORS.md)
5 %
6 % This file is part of Gregorio.
7 %
8 % Gregorio is free software: you can redistribute it and/or modify
9 % it under the terms of the GNU General Public License as published by
10 % the Free Software Foundation, either version 3 of the License, or
11 % (at your option) any later version.
12 %
13 % Gregorio is distributed in the hope that it will be useful,
14 % but WITHOUT ANY WARRANTY; without even the implied warranty of
15 % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 % GNU General Public License for more details.
17 %
18 % You should have received a copy of the GNU General Public License
19 % along with Gregorio. If not, see <http://www.gnu.org/licenses/>.
20 %
21 \section{Gregorio\TeX{} Controls}
22
23 These functions are the ones used by Gregorio\TeX{} internally as it
24 process the commands listed above. They should not appear in any user
25 document and are listed here for programmer documentation purposes
26 only.
27
28 Sometimes it is necessary to temporarily change some register or macro for the purpose of some particular operation and then restore it to its previous value. In those case we define a \verb=\gre@saved@<moment>...= register or macro associated with it (\eg \verb=\gre@dimen@constantglyphraise= is saved just before a discretionary to \verb=\gre@saved@prediscretionary@dimen@constantglyphraise= and restored from it afterwards). These registers/macros are not listed in this documentation.
29
30 \macroname{\textbackslash gre@error}{\#1}{gregoriotex.sty \textup{and} gregoriotex.tex}
31 Prints an error to the \TeX\ output log.
32
33 \begin{argtable}
34 \#1 & string & error message\\
35 \end{argtable}
36
37
38 \macroname{\textbackslash gre@warning}{\#1}{gregoriotex.sty \textup{and} gregoriotex.tex}
39 Prints a warning to the \TeX\ output log.
40
41 \begin{argtable}
42 \#1 & string & warning message\\
43 \end{argtable}
44
45 \macroname{\textbackslash gre@metapost}{\#1}{gregoriotex.sty \textup{and} gregoriotex.tex}
46 Executes \MP{} commands using luamplib.
47
48 \begin{argtable}
49 \#1 & \MP{} commands & The \MP{} commands to execute.
50 \end{argtable}
51
52 \macroname{\textbackslash gre@deprecated}{\#1\#2}{gregoriotex-common.tex}
53 Macro that handles deprecation messages. By default, deprecated macros
54 are allowed and a warning is printed. If the package option
55 \texttt{deprecated=false} is set, then deprecated macros raise a
56 package error, halting \TeX.
57
58 \begin{argtable}
59 \#1 & string & name of the deprecated macro\\
60 \#2 & string & name of the correct macro to use\\
61 \end{argtable}
62
63 \macroname{\textbackslash gre@obsolete}{\#1\#2}{gregoriotex-common.tex}
64 Macro that handles obsolescence errors.
65
66 \begin{argtable}
67 \#1 & string & name of the obsolete macro\\
68 \#2 & string & name of the correct macro to use\\
69 \end{argtable}
70
71 \macroname{\textbackslash gre@allowdeprecated@asboolean}{}{gregoriotex-main.tex}
72 Macro that evaluates \texttt{true} or \texttt{false} depending on whether
73 deprecated usage is allowed. This is used to pass the value of
74 \verb=\ifgre@allowdeprecated= to Lua.
75
76 \macroname{\textbackslash gre@loadgregoriofont}{}{gregoriotex-main.tex}
77 Loads the chosen font for the neumes at the correct size.
78
79 \macroname{\textbackslash gre@maketable}{\#1}{gregoriotex-main.tex}
80 Helper to convert a \TeX\ list into a Lua table. Used to pass \verb=\gre@input@path= to Lua.
81
82 \macroname{\textbackslash gre@input@path}{}{gregoriotex-main.tex}
83 Macro holding the list of directories to be searched for scores. \verb=\input@path= gets aliased to this list when inside \verb=\gregorioscore=.
84
85 \macroname{\textbackslash gre@calculate@constantglyphraise}{}{gregoriotex-spaces.tex}
86 Macro to calculate \verb=\gre@constantglyphraise=
87
88 \macroname{\textbackslash gre@addtranslationspace}{}{gregoriotex-spaces.tex}
89 Macro to tell Gregorio to set space for the translation.
90
91 \macroname{\textbackslash gre@removetranslationspace}{}{gregoriotexspaces.tex}
92 Macro to tell Gregorio to remove the space allocated to the translation.
93
94 \macroname{\textbackslash gre@calculate@additionalspaces}{\#1\#2\#3\#4}{gregoriotex-spaces.tex}
95 Macro which calculates \verb=\gre@additionalbottomspace= and\\
96 \verb=\gre@additionaltopspace=
97
98 \begin{argtable}
99 \#1 & integer & the height number of the top pitch, including signs\\
100 \#2 & integer & the height number of the bottom pitch, including signs\\
101 \#3 & \texttt{0} & there is no translation line\\
102 & \texttt{1} & there is a translation line\\
103 \#4 & \texttt{0} & there is no above lines text\\
104 & \texttt{1} & there is above lines text
105 \end{argtable}
106
107 \macroname{\textbackslash gre@calculate@textaligncenter}{\#1\#2\#3\#4}{gregoriotex-spaces.tex}
108 Macro for calculating \verb=\gre@textaligncenter=.
109
110 \begin{argtable}
111 \#1 & string & The carry-over letters from the previous syllable that should be moved to the current.\\
112 \#2 & string & The first part of the syllable (any preceding consonants in Latin).\\
113 \#3 & string & The middle part of the syllable (the vowel in Latin, the whole syllable in English).\\
114 \#4 & \texttt{0} & Calculation is being performed for the current syllable.\\
115 & \texttt{1} & Calculation is being performed for the next syllable.\\
116 \end{argtable}
117
118 \macroname{\textbackslash gre@calculate@annotationtrueraise}{}{gregoriotex-spaces.tex}
119 Macro to calculate \verb=\gre@dimen@annotationtrueraise=.
120
121 \macroname{\textbackslash gre@calculate@commentarytrueraise}{}{gregoriotex-spaces.tex}
122 Macro to calculate \verb=\gre@dimen@commentarytrueraise=.
123
124 \macroname{\textbackslash gre@calculate@textlower}{}{gregoriotex-spaces.tex}
125 Calculates the value of \texttt{textlower}. Default is \texttt{spacebeneathtext}.
126
127 \macroname{\textbackslash gre@calculate@linewidth}{}{gregoriotex-spaces.tex}
128 Calculates the line width. Default is the width of the printable space (\verb=\hsize=).
129
130 \macroname{\textbackslash gre@calculate@stafflinewidth}{}{gregoriotex-spaces.tex}
131 Calculates the width of the staff lines. Default is \texttt{linewidth}.
132
133 \macroname{\textbackslash gre@calculate@stafflineheight}{}{gregoriotex-spaces.tex}
134 Calculates the height (thickness) of the staff lines. Dependent on \texttt{stafflineheightfactor} and \texttt{gre@factor}.
135
136 \macroname{\textbackslash gre@calculate@interstafflinespace}{}{gregoriotex-spaces.tex}
137 Calculates the distance between the staff lines. Dependent on \texttt{stafflineheight} and \texttt{gre@factor}
138
139 \macroname{\textbackslash gre@calculate@stafflinediff}{}{gregoriotex-spaces.tex}
140 Calculates a correction factor for when the staff lines are not their default thickness. Dependent on \texttt{stafflineheight} and \texttt{gre@factor}.
141
142 \macroname{\textbackslash gre@calculate@staffheight}{}{gregoriotex-spaces.tex}
143 Calculates the total height of the staff. Dependent on \texttt{stafflineheight} and \texttt{interstafflinespace}.
144
145 \macroname{\textbackslash gre@calculate@constantglyphraise}{}{gregoriotex-spaces.tex}
146 Calculates the baseline correction for the glyphs. Dependent on \texttt{gre@factor}, \texttt{additionalbottomspace}, \texttt{spacebeneathtext}, \texttt{spacelinestext}, \texttt{interstafflinespace}, \texttt{stafflineheight}, \texttt{currenttranslationheight}, and \texttt{stafflinediff}.
147
148 \macroname{\textbackslash gre@computespaces}{}{gregoriotex-spaces.tex}
149 Aggregates all of the global distance calculations and calls them in the order needed to respect dependencies.
150
151 \macroname{\textbackslash gre@calculate@glyphraisevalue}{\#1\#2\#3}{gregoriotex-spaces.tex}
152 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.
153
154 \begin{argtable}
155 \#1 & integer & The number for where the glyph is located. \texttt{a} in gabc is \texttt{1}, \texttt{b} is \texttt{2}, \etc\\
156 \#2 & \texttt{0} & no modification\\
157 & \texttt{1} & puts the value on the interline just above if it is on a line\\
158 & \texttt{2} & puts the value on the interline just beneath if it is on a line\\
159 & \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\\
160 & \texttt{4} & case of the punctum mora, for the same reason\\
161 & \texttt{5} & case of the horizontal episema under a note, that must be placed a bit lower if the note is on a line\\
162 & \texttt{6} & case of the signs above (accentus, \etc)\\
163 & \texttt{8} & case of the punctum mora of the first note of a podatus or the 2nd note of a porrectus, \etc\\
164 & \texttt{9} & case of the horizontal episema, that must be placed a bit lower if the note is on a line\\
165 & \texttt{10} & case of the low choral sign\\
166 & \texttt{11} & case of the high choral sign\\
167 & \texttt{12} & case of the low choral sign which is lower than the note\\
168 & \texttt{13} & case of the brace above the bars\\
169 & \texttt{14} & case of the punctum mora in a space with a note on the line below it\\
170 & \texttt{15} & case of the over-the-notes slur\\
171 & \texttt{16} & case of the under-the-notes slur\\
172 & \texttt{17} & case of the bracket\\
173 \#3 & \texttt{0} & for horizontal episema cases, use automatic positioning within the space\\
174 & \texttt{1} & for horizontal episema cases, position in the middle of the space\\
175 & \texttt{2} & for horizontal episema cases, position low within the space as if the episema is over the note\\
176 & \texttt{3} & for horizontal episema cases, position high within the space as if the episema is under the note\\
177 & \texttt{4} & for horizontal episema cases, position low within the space as if the episema is over the note\\
178 & \texttt{5} & for horizontal episema cases, position high within the space as if the episema is under the note\\
179 \end{argtable}
180
181 \macroname{\textbackslash gre@stafflinefactor}{}{gregoriotex-spaces.tex}
182 A number indicating the thickness of the staff lines.
183
184 \macroname{\textbackslash gre@calculate@textaligncenter}{\#1\#2\#3}{gregoriotex-spaces.tex}
185 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.
186
187 \begin{argtable}
188 \#1 & string & the first part of the syllable\\
189 \#2 & string & the middle part of the syllable\\
190 \#3 & \texttt{0} & perform this calculation for the current syllable\\
191 & \texttt{1} & perform this calculation for the next syllable
192 \end{argtable}
193
194 \macroname{\textbackslash gre@calculate@enddifference}{\#1\#2\#3\#4\#5}{gregoriotex-spaces.tex}
195 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.
196
197 \begin{argtable}
198 \#1 & length & the total width of the notes\\
199 \#2 & length & the total width of the syllable text\\
200 \#3 & length & the alignment distance for the text (\texttt{textaligncenter})\\
201 \#4 & length & the alignment distance for the notes (\texttt{notesaligncenter})\\
202 \#5 & \texttt{0} & do not save the value for the previous syllable before calculating the new value\\
203 & \texttt{1} & save the value for the previous syllable before calculating the new value
204 \end{argtable}
205
206 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.
207
208 \macroname{\textbackslash gre@changeonedimenfactor}{\#1\#2\#3}{gregoriotex-spaces.tex}
209 Change the scale of a single distance from one factor to another.
210
211 \begin{argtable}
212 \#1 & string & name of the distance to be scaled. See \Nameref{distances}.\\
213 \#2 & integer & the factor the distance is currently in\\
214 \#3 & integer & the factor the distance is to be put into\\
215 \end{argtable}
216
217 \macroname{\textbackslash gre@changedimenfactor}{\#1\#2}{gregoriotex-spaces.tex}
218 Rescales all the distances (and \texttt{stafflinefactor}) which are supposed to scale with a change in staff size.
219
220 \begin{argtable}
221 \#1 & integer & the factor the distances are currently in\\
222 \#2 & integer & the factor the distances are to be put into\\
223 \end{argtable}
224
225 \macroname{\textbackslash gre@calculate@nextbegindifference}{\#1\#2\#3\#4\#5\#6}{gregoriotex-spaces.tex}
226 Macro to calculate \texttt{nextbegindifference}.
227
228 \begin{argtable}
229 \#1 & string & the carry-over letters for the next syllable\\
230 \#2 & string & the first letters of the next syllable\\
231 \#3 & string & the middle letters of the next syllable (the vowel in Latin, the whole syllable in English)\\
232 \#4 & string & the end letters of the next syllable\\
233 \#5 & integer & the type of notes alignment. See \Nameref{notesalign}.\\
234 \#6 & integer & the type of alteration. See \Nameref{alterationtype}.\\
235 \end{argtable}
236
237 \macroname{\textbackslash gre@strip@pt}{\#1}{gregoriotex.sty \textup{and} gregoriotex.tex}
238 Strips the units from a distance. Under \LaTeX{}, this is an alias to \verb=\strip@pt=.
239
240 \begin{argtable}
241 \#1 & control sequence & should be the control sequence for the the distance register (including the leading backslash)\\
242 \end{argtable}
243
244 \macroname{\textbackslash gre@rem@pt}{\#1}{gregoriotex.tex}
245 Strips the units from a distance. Used internally by \verb=\gre@strip@pt=. Under \LaTeX{}, this is not defined.
246
247 \begin{argtable}
248 \#1 & distance & should be in the form ``[0-9]+.[0-9]+pt’’. (\ie the result of applying \verb=\the= to a distance register)\\
249 \end{argtable}
250
251 \macroname{\textbackslash gre@count@temp@...}{}{gregoriotex-spaces.tex}
252 Temporary count used in calculations. There are currently three of these.
253
254 \macroname{\textbackslash gre@convertto}{\#1\#2}{gregoriotex-spaces.tex}
255 Macro which converts a distance into a particular set of units. Result is placed in \verb=\gre@converted= as a string.
256
257 \begin{argtable}
258 \#1 & string & two letter abbreviation for the units. Should recognize all legal \TeX\ units.\\
259 \#2 & distance & Distance to be converted.
260 \end{argtable}
261
262 \macroname{\textbackslash gre@converted}{}{gregoriotex-spaces.tex}
263 Macro holding result of last call to \verb=\gre@convertto=.
264
265 \macroname{\textbackslash gre@consistentunits}{\#1\#2}{gregoriotex-spaces.tex}
266 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=.
267
268 \begin{argtable}
269 \#1 & string & the standard whose format is to be matched.\\
270 \#2 & distance & the distance to be adjusted.
271 \end{argtable}
272
273 \macroname{\textbackslash gre@stringdist}{}{gregoriotex-spaces.tex}
274 Macro holding result of last call to \verb=\gre@consistentunits=.
275
276 \macroname{\textbackslash gre@gregorioscore}{\#1}{gregoriotex-main.tex}
277 Macro that handles \verb=\gregorioscore= calls when they do not have an
278 optional argument.
279
280 \begin{argtable}
281 \#1 & string & Relative or absolute path to the score.\\
282 \end{argtable}
283
284 \macroname{\textbackslash gre@gregorioscore@option}{[\#1]\#2}{gregoriotex-main.tex}
285 Macro that handles \verb=\gregorioscore= calls when they have an optional
286 argument.
287
288 \begin{argtable}
289 \#1 & \texttt{n} & \#2 will be included as is. \\
290 & \texttt{a} & Gregorio\TeX\ will automatically compile gabc files if necessary.\\
291 & \texttt{f} & Forces Gregorio\TeX\ to compile the gabc file.\\
292 \#2 & string & Relative or absolute path to the score.\\
293 \end{argtable}
294
295 \macroname{\textbackslash gre@writemode}{\#1\#2\#3}{gregoriotex-main.tex}
296 Macro that writes its arguments with \verb=\greannotation=. This
297 macro is typically called by \verb=\GreMode= in the gtex file.
298
299 \begin{argtable}
300 \#1 & \TeX\ code & Mode text to place above the initial of a score in the \texttt{modeline} style.\\
301 \#2 & \TeX\ code & Arbitrary code to typeset, in the \texttt{modemodifier} style, after the mode text.\\
302 \#3 & \TeX\ code & Arbitrary code to typeset, in the \texttt{modedifferentia} style, after \#2.\\
303 \end{argtable}
304
305 \macroname{\textbackslash gre@setallbracerendering}{\#1}{gregoriotex-signs.tex}
306 Macro used by \verb=\gresetbracerendering= to change all braces.
307
308 \begin{argtable}
309 \#1 & \texttt{metapost} & \MP{} will be used to render braces\\
310 & \texttt{font} & The score font will be used to render braces\\
311 \end{argtable}
312
313 \macroname{\textbackslash gre@setbracerendering}{[\#1]\#2}{gregoriotex-signs.tex}
314 Macro used by \verb=\gresetbracerendering= to change a single type of brace.
315
316 \begin{argtable}
317 \#1 & \texttt{brace} & change round braces that appear over the staff\\
318 & \texttt{underbrace} & change round braces that appear under the staff\\
319 & \texttt{curlybrace} & change curly braces\\
320 & \texttt{barbrace} & change round braces that appear over divisio bars\\
321 \#2 & \texttt{metapost} & \MP{} will be used to render braces\\
322 & \texttt{font} & The score font will be used to render braces\\
323 \end{argtable}
324
325 \macroname{\textbackslash gre@@setbracerendering}{\#1\#2}{gregoriotex-signs.tex}
326 Secondary macro used by \verb=\gre@setallbracerendering= and
327 \verb=\gre@setbracerendering= to change a single type of brace. As a
328 secondary macro, it doesn't check its first argument.
329
330 \begin{argtable}
331 \#1 & \texttt{brace} & change round braces that appear over the staff\\
332 & \texttt{underbrace} & change round braces that appear under the staff\\
333 & \texttt{curlybrace} & change curly braces\\
334 & \texttt{barbrace} & change round braces that appear over divisio bars\\
335 \#2 & \texttt{metapost} & \MP{} will be used to render braces\\
336 & \texttt{font} & The score font will be used to render braces\\
337 \end{argtable}
338
339 \macroname{\textbackslash gre@brace@common}{\#1\#2\#3\#4\#5\#6\#7}{gregoriotex-signs.tex}
340 Common macro used internally to render braces.
341
342 \begin{argtable}
343 \#1 & length & The width of the brace.\\
344 \#2 & length & A vertical shift.\\
345 \#3 & length & A horizontal shift.\\
346 \#4 & \texttt{0} & Don’t shift before starting the brace.\\
347 & \texttt{1} & Shift back a punctum’s width before starting the brace.\\
348 \#5 & \texttt{0} & No accentus above the brace.\\
349 & \texttt{1} & Typeset an accentus above the brace.\\
350 \#6 & integer & The height number for the brace.\\
351 \#7 & csname & The control sequence name representing the brace.
352 \end{argtable}
353
354 \macroname{\textbackslash gre@render@barbrace}{}{gregoriotex-signs.tex}
355 Draws a divisio brace.
356
357 \macroname{\textbackslash grebracemetapostpreamble}{\#1}{gregoriotex-signs.tex}
358 Returns the \MP{} preamble for braces. The control sequence name does
359 not have the \texttt{@} symbol because this macro is used within \MP{}.
360
361 \begin{argtable}
362 \#1 & string & the width of the brace; if \texttt{*}, use the bar brace width.
363 \end{argtable}
364
365 \macroname{\textbackslash gre@draw@curlybrace}{\#1}{gregoriotex-signs.tex}
366 Draws a curly over-brace using \MP{}.
367
368 \begin{argtable}
369 \#1 & length & the width of the brace.
370 \end{argtable}
371
372 \macroname{\textbackslash gre@draw@brace}{\#1}{gregoriotex-signs.tex}
373 Draws a round over-brace using \MP{}.
374
375 \begin{argtable}
376 \#1 & string & the width of the brace; if \texttt{*}, use the bar brace width.
377 \end{argtable}
378
379 \macroname{\textbackslash gre@draw@fontbrace}{\#1\#2}{gregoriotex-signs.tex}
380 Draws a brace using the score font.
381
382 \begin{argtable}
383 \#1 & string & the width of the brace.\\
384 \#2 & \TeX\ code & \TeX\ code that renders the brace using the score font.\\
385 \end{argtable}
386
387 \macroname{\textbackslash gre@draw@underbrace}{\#1}{gregoriotex-signs.tex}
388 Draws a round under-brace using \MP{}.
389
390 \begin{argtable}
391 \#1 & length & the width of the brace.
392 \end{argtable}
393
394 \macroname{\textbackslash gre@draw@roundbrace}{\#1\#2\#3}{gregoriotex-signs.tex}
395 Draws a round over- or under-brace using \MP{}.
396
397 \begin{argtable}
398 \#1 & length & the width of the brace.\\
399 \#2 & number & the height of the bounding box in em-relative units.\\
400 \#3 & \MP{} commands & \MP{} commands to draw the brace outline.
401 \end{argtable}
402
403 \macroname{\textbackslash gre@draw@slur}{\#1\#2\#3}{gregoriotex-signs.tex}
404 Draws a slur using \MP{}.
405
406 \begin{argtable}
407 \#1 & length & the x-dimension of the slur.\\
408 \#2 & length & the y-dimension of the slur.\\
409 \#3 & \texttt{-1} & draw an under-the-notes slur.\\
410 & \texttt{1} & draw an over-the-notes slur.\\
411 \end{argtable}
412
413
414 \macroname{\textbackslash gre@iflatex}{\#1}{gregoriotex.sty \textup{and} gregoriotex.tex}
415 Evaluates to \verb=#1= if running under \LaTeX{}.
416
417 \begin{argtable}
418 \#1 & \TeX{} code & the \TeX{} code to use if running under \LaTeX{}.
419 \end{argtable}
420
421 \macroname{\textbackslash gre@ifnotlatex}{\#1}{gregoriotex.sty \textup{and} gregoriotex.tex}
422 Evaluates to \verb=#1= if not running under \LaTeX{}.
423
424 \begin{argtable}
425 \#1 & \TeX{} code & the \TeX{} code to use if not running under \LaTeX{}.
426 \end{argtable}
427
428 \macroname{\textbackslash gre@latex@barredsymbol}{\#1\#2\#3\#4}{gregoriotex-signs.tex}
429 Internal method used by \verb=\grelatexsimpledefarredsymbol= to simplify
430 the cascading of conditionals used to implement that macro.
431
432 \bigskip\textbf{Only available in \LaTeX.}
433
434 \begin{argtable}
435 \#1 & string & the value of \verb=\f@series/\f@shape= to match.\\
436 \#2 & \TeX{} code & the \TeX{} for the base symbol (\ie, \texttt{A}, \texttt{R}, or \texttt{V}).\\
437 \#3 & string & the control sequence name created by \verb=\gredefsizedsymbol= to use for the bar.\\
438 \#4 & dimension & the amount to shift the bar to the left from the end of the base symbol.
439 \end{argtable}
440
441 \macroname{\textbackslash gre@additionalbottomcustoslineend}{}{gregoriotex-signs.tex}
442 Macro to place a bottom custos with an additional line (positions \texttt{a} and \texttt{b}) at the end of a line.
443
444 \macroname{\textbackslash gre@additionalbottomcustoslinemiddle}{}{gregoriotex-signs.tex}
445 Macro to place a bottom custos with an additional line (positions \texttt{a} and \texttt{b}) in the middle of a line.
446
447 \macroname{\textbackslash gre@additionaltopcustoslineend}{}{gregoriotex-signs.tex}
448 Macro to place a top custos with an additional line (positions \texttt{l} and \texttt{m}) at the end of a line.
449
450 \macroname{\textbackslash gre@additionaltopcustoslinemiddle}{}{gregoriotex-signs.tex}
451 Macro to place a top custos with an additional line (positions \texttt{l} and \texttt{m}) in the middle of a line.
452
453 \macroname{\textbackslash gre@pickcustos}{\#1}{gregoriotex-signs.tex}
454 Macro to pick the appropriate custos character.
455
456 \begin{argtable}
457 \#1 & integer & height of the custos character to be placed\\
458 \end{argtable}
459
460 \macroname{\textbackslash gre@nextcustospitch}{}{gregoriotex-signs.tex}
461 Macro that saves the next custos pitch (height).
462
463 \macroname{\textbackslash gre@nextcustosalteration}{}{gregoriotex-signs.tex}
464 Macro that saves the next custos alteration.
465
466 \macroname{\textbackslash gre@custosalteration}{\#1\#2}{gregoriotex-signs.tex}
467 Typesets the alteration for a custos, if enabled.
468
469 \begin{argtable}
470 \#1 & integer & The pitch (height number) of the custos.\\
471 \#2 & \texttt{Flat} & The custos should have a flat.\\
472 & \texttt{Natural} & The custos should have a natural.\\
473 & \texttt{Sharp} & The custos should have a sharp.\\
474 & \textit{empty} & The custos should not have an alteration.\\
475 \end{argtable}
476
477 \macroname{\textbackslash gre@noinitial}{}{gregoriotex-main.tex}
478 Macro called when no initial is being set.
479
480 \macroname{\textbackslash gre@setinitial}{\#1}{gregoriotex-main.tex}
481 Macro to set the initial in the score.
482
483 \macroname{\textbackslash gre@addspaceabove}{}{gregoriotex-main.tex}
484 Macro to increase the space above the lines to account for above lines text.
485
486 \macroname{\textbackslash gre@removespaceabove}{}{gregoriotex-main.tex}
487 Macro to decrease the space above the lines as there is no longer any above lines text.
488
489 \macroname{\textbackslash gre@alteration}{\#1\#2\#3\#4\#5\#6}{gregoriotex-signs.tex}
490 Macro to typeset an alteration.
491
492 \begin{argtable}
493 \#1 & integer & height of the alteration\\
494 \#2 & integer & alteration type (see Section \ref{alterationtype})\\
495 \#3 & \texttt{1} & the alteration is part of the clef\\
496 & \texttt{0} & the alteration is not part of the clef\\
497 \#4 & \TeX\ code & signs to typeset before the glyph (typically additional bars, as they must be ``behind'' the glyph)\\
498 \#5 & \TeX\ code & signs to typeset after the glyph (almost all signs)\\
499 \#6 & string & the line, byte offset, and column address for textedit links when point-and-click is enabled\\
500 \end{argtable}
501
502 \macroname{\textbackslash gre@alteration@isvisible}{\#1\#2}{gregoriotex-signs.tex}
503 Test whether an alteration should be visible or not.
504
505 \begin{argtable}
506 \#1 & integer & 0 for current alteration, 1 for next alteration\\
507 \#2 & integer & alteration type (see Section \ref{alterationtype})\\
508 \end{argtable}
509
510 \macroname{\textbackslash gre@alteration@visible}{\#1\#2\#3\#4\#5\#6}{gregoriotex-signs.tex}
511 The special case of \verb|gre@alteration| for when the alteration is visible.
512
513 \macroname{\textbackslash gre@alteration@char}{}{gregoriotex-signs.tex}
514 \vspace*{-10ex}%
515 \macroname{\textbackslash gre@alteration@type}{}{gregoriotex-signs.tex}
516 Used internally by \verb|\gre@alteration@visible|.
517
518 \macroname{\textbackslash gre@clef}{}{gregoriotex-signs.tex}
519 Macro holding the current clef type.
520
521 \macroname{\textbackslash gre@clefheight}{}{gregoriotex-signs.tex}
522 Macro holding the current clef line.
523
524 \macroname{\textbackslash gre@clefflatheight}{}{gregoriotex-signs.tex}
525 Macro to hold the height of the current flat for the clef (\texttt{3} if no flat).
526
527 \macroname{\textbackslash gre@cleftwo}{}{gregoriotex-signs.tex}
528 Macro holding the current secondary clef type.
529
530 \macroname{\textbackslash gre@cleftwoheight}{}{gregoriotex-signs.tex}
531 Macro holding the current secondary clef line (or 0 for no secondary clef).
532
533 \macroname{\textbackslash gre@cleftwoflatheight}{}{gregoriotex-signs.tex}
534 Macro to hold the height of the current flat for the secondary clef (\texttt{3} if no flat).
535
536 \macroname{\textbackslash gre@updatelinesclef}{}{gregoriotex-signs.tex}
537 Macro redrawing a key from \verb=\gre@clefnum=, useful for vertical space changes.
538
539 \macroname{\textbackslash gre@currenttextabovelines}{}{gregoriotex-main.tex}
540 Macro for storing the text which needs to be placed above the lines.
541
542 \macroname{\textbackslash gre@typesettextabovelines}{\#1\#2}{gregoriotex-main.tex}
543 Macro for typesetting the text or nabc neumes above the lines.
544
545 \begin{argtable}
546 \#1 & string & Text to be typeset\\
547 \#2 & \texttt{0} & Use alt text above the lines vertical spacing\\
548 & \texttt{1} & Use nabc neumes above the lines vertical spacing\\
549 \end{argtable}
550
551 \macroname{\textbackslash gre@dotranslationcenterend}{}{gregoriotex-main.tex}
552 Macro to typeset a centered translation.
553
554 \macroname{\textbackslash gre@generatelines}{}{gregoriotex-main.tex}
555 Macro to (re)populate the box containing the lines.
556
557 \macroname{\textbackslash gre@lastoflinecount}{}{gregoriotex-main.tex}
558 Count to track where on the line we are. Values are \texttt{0} (we are not near the end of a line), \texttt{1} (we’re at the last syllable of the line), and \texttt{2} (we just set the last syllable of the line and so are at the first syllable of a new line).
559
560 \macroname{\textbackslash gre@newlinecommon}{\#1\#2}{gregoriotex-main.tex}
561 The macro which needs to be called each time a new lines is started.
562
563 \begin{argtable}
564 \#1 & \texttt{0} & Justifying the line being ended\\
565 & \texttt{1} & Do not justify the line being ended\\
566 \#2 & \texttt{0} & Take care of eolshift\\
567 & \texttt{1} & Do not adjust end of line (when already done by the new spacing algorithm)\\
568 \end{argtable}
569
570 \macroname{\textbackslash gre@endafterbar}{\#1}{gregoriotex-main.tex}
571 Macro to call after ending a bar.
572
573 \begin{argtable}
574 \#1 & \texttt{0} & We are at the end of a line\\
575 & \texttt{1} & We not at the end of a line\\
576 \end{argtable}
577
578 \macroname{\textbackslash gre@endofsyllable}{\#1\#2\#3}{gregoriotex-syllable.tex}
579 Macro called at end of a syllable, adds a penalty and a space.
580
581 \begin{argtable}
582 \#1 & \texttt{0} & to only add the penalty\\
583 & \texttt{1} & adds both penalty and space\\
584 \#2 & \texttt{0} & if end of syllable\\
585 & \texttt{1} & if end of word\\
586 \#3 & \texttt{1} & if next syllable is a bar\\
587 & \texttt{0} & otherwise\\
588 \end{argtable}
589
590 \macroname{\textbackslash gre@endofglyphcommon}{}{gregoriotex-syllable.tex}
591 Macro called at the end of every glyph. Checks to see if glyph being ended is the last of the score and does some clean-up if it is.
592
593 \macroname{\textbackslash gre@setfirstsyllabletext}{\#1\#2\#3\#4\#5\#6}{gregoriotex-syllable.tex}
594 Internal macro to set the first syllable text after all parts are known.
595
596 \begin{argtable}
597 \#1 & \TeX\ code & First part of the syllable (before the vowel)\\
598 \#2 & \TeX\ code & Middle part of the syllable (the vowel)\\
599 \#3 & \TeX\ code & Last part of the syllable (after the vowel)\\
600 \#4 & \TeX\ code & First letter of the syllable\\
601 \#5 & \TeX\ code & Everything after the first letter of the syllable\\
602 \#6 & \TeX\ code & Macros to run after the text is emitted\\
603 \end{argtable}
604
605 \macroname{\textbackslash gre@opening@syllabletext}{}{gregoriotex-syllable.tex}
606 Macro that stores the computed \TeX\ code for rendering the text of the first syllable.
607
608 \macroname{\textbackslash gre@factor}{}{gregoriotex-main.tex}
609 Count which stores the current staff size.
610
611 Default: 17 (approximately the size found in graduals)
612
613 \macroname{\textbackslash gre@fillhole}{\#1\#2}{gregoriotex-signs.tex}
614 Macro to fill the hole in a glyph so that staff lines do not show through a hole in it.
615
616 \begin{argtable}
617 \#1 & Gregorio\TeX\ char & character to use to fill the hole\\
618 \#1 & \texttt{0} & the hole is being filled for an alteration\\
619 \#1 & \texttt{1} & the hole is being filled for a cavum glyph\\
620 \end{argtable}
621
622 \macroname{\textbackslash gre@calculate@notesaligncenter}{\#1}{gregoriotex-syllable.tex}
623 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=.
624
625 \begin{argtable}
626 \#1 & Note alignment type & See \ref{notesalign}\\
627 \end{argtable}
628
629 \macroname{\textbackslash gre@calculate@nextnotesaligncenter}{\#1\#2}{gregoriotex-syllable.tex}
630 Same as previous, but for the next syllable.
631
632 \begin{argtable}
633 \#1 & Note alignment type & See \ref{notesalign}\\
634 \#1 & Alteration type & See \ref{alterationtype}\\
635 \end{argtable}
636
637 \macroname{\textbackslash gre@calculate@simplenotesaligncenter}{\#1\#2}{gregoriotex-syllable.tex}
638 Workhorse function behind \verb=\gre@calculate@notesaligncenter= and\\ \verb=\gre@calculate@nextnotesaligncenter=.
639
640 \begin{argtable}
641 \#1 & Note alignment type & See \ref{notesalign}\\
642 \#2 & \texttt{0} & this is for the current syllable\\
643 & \texttt{1} & this is for the next syllable\\
644 \end{argtable}
645
646 \macroname{\textbackslash gre@gregoriofontname}{}{gregoriotex-main.tex}
647 Macro which stores the name of the currently selected font for the neumes.
648
649 \macroname{\textbackslash gre@handleclivisspecialalignment}{\#1\#2\#3}{gregoriotex-syllable.tex}
650 Macro for aligning clivis syllables according to the flag \verb=\gre@clivisalignment=.
651
652 \begin{argtable}
653 \#1 & Gregorio\TeX\ glyph & Glyph to use when aligning clivis on its center\\
654 \#2 & Gregorio\TeX\ glyph & Glyph to use when aligning clivis on the center of the first punctum\\
655 \#3 & \texttt{0} & this is for the current syllable\\
656 & \texttt{1} & this is for the next syllable\\
657 \end{argtable}
658
659 \macroname{\textbackslash gre@hepisorline}{\#1\#2\#3\#4\#5\#6\#7}{gregoriotex-signs.tex}
660 Macro to typeset a horizontal line (either an additional staff line or an episema).
661
662 {\small
663 \begin{argtable}
664 \#1 & character & The letter of the height of the episema (not the height of the note it corresponds to).\\
665 \#2 & \texttt{0} & go back to the beginning of the previous glyph; this starts the episema at the beginning of the previous glyph\\
666 & \texttt{1} & stay at the end of the glyph; doesn’t make much sense to use this\\
667 & \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\\
668 & \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\\
669 & \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\\
670 \#3 & integer &the ambitus for a two note episema at the diagonal stroke of a porrectus, porrectus flexus, orculus resupinus, or torculus resupinus flexus\\
671 \#4 & \texttt{0} & an horizontal episema\\
672 & \texttt{1} & an horizontal episema under a note\\
673 & \texttt{2} & a line at the top\\
674 & \texttt{3} & a line at the bottom\\
675 \#5 & \texttt{f} & a normal episema\\
676 & \texttt{l} & a small episema aligned left\\
677 & \texttt{c} & a small episema aligned center\\
678 & \texttt{r} & for a small episema aligned right\\
679 \#6 & string & a positive or negative ``nudge'' (dimension) for the vertical position of the horizontal episema\\
680 \#7 & \texttt{0} & for horizontal episema cases, use automatic positioning within the space\\
681 & \texttt{1} & for horizontal episema cases, position in the middle of the space\\
682 & \texttt{2} & for horizontal episema cases, position low within the space as if the episema is over the note\\
683 & \texttt{3} & for horizontal episema cases, position high within the space as if the episema is under the note\\
684 & \texttt{4} & for horizontal episema cases, position low within the space as if the episema is over the note\\
685 & \texttt{5} & for horizontal episema cases, position high within the space as if the episema is under the note\\
686 \end{argtable}
687 }
688
689 \macroname{\textbackslash gre@hepisorlineaux}{\#1\#2\#3\#4}{gregoriotex-signs.tex}
690 Macro that will help in the typesetting of a horizontal episema and additional lines.
691
692 \begin{argtable}
693 \#1 & Gregorio\TeX\ glyph & an offset glyph (see \#3, below)\\
694 \#2 & Gregorio\TeX\ glyph & the episema glyph\\
695 \#3 & \texttt{0} & go back to the beginning of the previous glyph; this starts the episema at the beginning of the previous glyph\\
696 & \texttt{1} & stay at the end of the glyph; doesn’t make much sense to use this\\
697 & \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\\
698 & \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\\
699 \#4 & \texttt{0} & an horizontal episema\\
700 & \texttt{1} & an horizontal episema under a note\\
701 & \texttt{2} & a line at the top\\
702 & \texttt{3} & a line at the bottom\\
703 \end{argtable}
704
705 \macroname{\textbackslash gre@vepisemaorrare}{\#1\#2\#3\#4\#5}{gregoriotex-signs.tex}
706 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=.
707
708 \begin{argtable}
709 \#1 & character & the letter of the height of the episema (not the height of the note it corresponds to.\\
710 \#2 & string & See \Nameref{NoteOffset}.\\
711 \#3 & Gregorio\TeX\ glyph & the sign glyph\\
712 \#4 & \texttt{1} & vertical episema\\
713 & \texttt{2} & rare sign\\
714 & \texttt{3} & choral sign\\
715 & \texttt{4} & brace above the bar\\
716 \#5 & string & the choral sign, if relevant\\
717 \end{argtable}
718
719 \macroname{\textbackslash gre@vepisemaorrareaux}{\#1\#2\#3\#4\#5\#6\#7}{gregoriotex-signs.tex}
720 Macro to help typesetting vertical episema.
721
722 \begin{argtable}
723 \#1 & Gregorio\TeX\ glyph & is an offset glyph (see \#3 below)\\
724 \#2 & Gregorio\TeX glyph & the glyph upon which the sign is to be centered\\
725 \#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\\
726 & \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\\
727 & \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\\
728 & \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\\
729 \#4 & dimension & a shift that we want to get applied, useful for punctum inclinatum for example\\
730 \#5 & integer & is the glyph number\\
731 \#6 & \texttt{1} & vertical episema\\
732 & \texttt{2} & rare sign\\
733 & \texttt{3} & choral sign\\
734 & \texttt{4} & brace above the bar\\
735 \#7 & string & the choral sign if relevant\\
736 \end{argtable}
737
738 \macroname{\textbackslash gre@newglyphcommon}{}{gregoriotex-syllable.tex}
739 Macro called before each glyph.
740
741 \macroname{\textbackslash greoldcatcode}{}{gregoriotex.tex}
742 Macro to store the catcode for ``@'' so that we can use said symbol in function names under Plain \TeX\ and then restore the original catcode after the package is done loading.
743
744 \macroname{\textbackslash gre@prephepisemaledgerlineheuristics}{}{gregoriotex-spaces.tex}
745 Prepares the system to accept ledger line heuristics for the horizontal episema.
746
747 \macroname{\textbackslash gre@resetledgerlineheuristics}{}{gregoriotex-spaces.tex}
748 Resets the ledger line heuristic flags.
749
750 \macroname{\textbackslash gre@setstylefont}{}{gregoriotex-main.tex}
751 Macro for opening up greextra font.
752
753 \macroname{\textbackslash gre@syllablenotes}{\#1}{gregoriotex-syllable.tex}
754 Macro for populating \verb=\gre@box@syllablenotes=.
755
756 \begin{argtable}
757 \#1 & string & The contents to be placed in the box\\
758 \end{argtable}
759
760 \macroname{\textbackslash gre@symbolfontsize}{}{gregoriotex-symbols.tex}
761 The font size at which symbols are to be loaded.
762
763 \macroname{\textbackslash gre@textnormal}{\#1}{gregoriotex-syllable.tex}
764 Macro which applies the default text format.
765
766 \macroname{\textbackslash gre@save@clef}{\#1\#2\#3\#4\#5\#6}{gregoriotex-signs.tex}
767 Saves clef information for use in \verb=gre@updatelinesclef=.
768
769 \begin{argtable}
770 \#1 & character & the type of the clef: c or f\\
771 \#2 & integer & the line of the clef (1 is the lowest)\\
772 \#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\\
773 \#4 & character & the type of the secondary clef: c or f\\
774 \#5 & integer & the line of the secondary clef (1 is the lowest, 0 for no secondary clef)\\
775 \#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\\
776 \end{argtable}
777
778 \macroname{\textbackslash gre@typeclef}{\#1\#2\#3\#4\#5\#6\#7\#8\#9}{gregoriotex-signs.tex}
779 Macro which typesets the clef.
780
781 \begin{argtable}
782 \#1 & character & the type of the clef: c or f\\
783 \#2 & integer & the line of the clef (1 is the lowest)\\
784 \#3 & \texttt{0} & no need to use small clef characters (inside a line)\\
785 & \texttt{1} & we must use small clef characters (inside a line)\\
786 \#4 & \texttt{0} & no extra space is needed after the clef\\
787 & \texttt{1} & we must type a normal space after the clef\\
788 & \texttt{2} & we must type a short space after the clef\\
789 \#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\\
790 \#6 & character & the type of the secondary clef: c or f\\
791 \#7 & integer & the line of the secondary clef (1 is the lowest, 0 for no secondary clef)\\
792 \#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\\
793 \end{argtable}
794
795 \macroname{\textbackslash gre@boxclef}{\#1\#2\#3\#4\#5\#6\#7\#8\#9}{gregoriotex-signs.tex}
796 Macro filling \verb=\gre@box@temp@width= with a clef. The arguments are the same as \verb=gre@typeclef=.
797
798
799 \macroname{\textbackslash gre@typesingleclef}{\#1\#2\#3\#4}{gregoriotex-signs.tex}
800 Macro which typesets a single clef.
801
802 \begin{argtable}
803 \#1 & character & the type of the clef: c or f\\
804 \#2 & integer & the line of the clef (1 is the lowest)\\
805 \#3 & \texttt{0} & no need to use small clef characters (inside a line)\\
806 & \texttt{1} & we must use small clef characters (inside a line)\\
807 \#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\\
808 \end{argtable}
809
810 \macroname{\textbackslash gre@updateleftbox}{}{gregoriotex-main.tex}
811 Macro to update the box printed a the left end of every line (the one which holds the staff lines).
812
813 \macroname{\textbackslash gre@useautoeolcustos}{}{gregoriotex-main.tex}
814 Macro which enables automatic custos at the end of lines.
815
816 \macroname{\textbackslash gre@usestylecommon}{}{gregoriotex-signs.tex}
817 Macro which specifies the alternate glyphs which are common to all of the styles.
818
819 \macroname{\textbackslash gre@widthof}{\#1}{gregoriotex-main.tex}
820 Macro for calculating the width of its argument and storing it in \verb=\gre@dimen@temp@three=.
821
822 \macroname{\textbackslash gre@writebar}{\#1\#2\#3\#4\#5}{gregoriotex-signs.tex}
823 Macro to write a bar.
824
825 \begin{argtable}
826 \#1 & \texttt{0} & virgula\\
827 & \texttt{1} & minima\\
828 & \texttt{2} & minor\\
829 & \texttt{3} & major\\
830 & \texttt{4} & finalis\\
831 & \texttt{5} & the last finalis\\
832 & \texttt{6}--\texttt{13} & Dominican bars\\
833 & \texttt{14} & virgula on ledger line above the staff\\
834 & \texttt{15} & minima on ledger line above the staff\\
835 & \texttt{16} & dotted major\\
836 & \texttt{17} & minimis (eighth bar)\\
837 & \texttt{18} & minimis (eighth bar) on ledger line above the staff\\
838 & \texttt{19} & parenthesized virgula\\
839 & \texttt{20} & parenthesized minima\\
840 & \texttt{21} & parenthesized virgula on ledger line above the staff\\
841 & \texttt{22} & parenthesized minima on ledger line above the staff\\
842 \#2 & \texttt{0} & in a syllable containing only this bar\\
843 & \texttt{1} & in a syllable containing other notes\\
844 \#3 & \texttt{0} & if there is no text underneath the bar\\
845 & \texttt{1} & if there is text underneath the bar\\
846 \#4 & \TeX\ code & macros that may happen before the skip after the bar (typically GreVEpisema)\\
847 \#5 & \texttt{0} & The notes around the bar are vertically close to the bar.\\
848 & \texttt{1} & The notes around the bar are far, \verb=@short= versions of spaces will be used.\\
849 \end{argtable}
850
851 \macroname{\textbackslash gre@@arg}{}{gregoriotex-syllable.tex}
852 A dummy macro which is used to store a macro which takes an argument so that it can be used in a \verb=\ifx= comparison. The value of the argument is provided at the time this macro is created.
853
854 \macroname{\textbackslash gre@nothing}{}{gregoriotex-main.tex}
855 A dummy macro which has not contents. Used for \verb=\ifx= comparisons.
856
857 \macroname{\textbackslash gre@annotation}{[\#1]\#2}{gregoriotex-main.tex}
858 Workhorse function behind \verb=\greannotation=.
859
860 \begin{argtable}
861 \#1 & \texttt{c} & center align the new line with the existing annotation content\\
862 & \texttt{l} & left align the new line with the existing annotation content\\
863 & \texttt{r} & right align the new line with the existing annotation content\\
864 \#2 & string & the new annotation content\\
865 \end{argtable}
866
867 \macroname{\textbackslash gre@commentary}{[\#1]\#2}{gregoriotex-main.tex}
868 Workhorse function behind \verb=\grecommentary=.
869
870 \begin{argtable}
871 \#1 & distance & Additional distance to be placed between the commentary and the top staff line for the next score only.\\
872 \#2 & string & the new commentary content\\
873 \end{argtable}
874
875 \macroname{\textbackslash gre@printcommentary}{}{gregoriotex-main.tex}
876 Computes the true ``raise'' and prints the commentary contained in
877 \verb=\gre@box@commentary=.
878
879 \macroname{\textbackslash gre@atletter}{}{gregoriotex-main.tex}
880 A Lua\TeX\ catcode table which makes sure that Lua\TeX\ treats `@‘ corectly.
881
882 \macroname{\textbackslash gre@baseunit}{}{gregoriotex-spaces.tex}
883 The units attached to base dimension in a string distance. These units are extracted as part of coercing one distance to have the same units as another\\ (\verb=\gre@consistentunits=).
884
885 \macroname{\textbackslash gre@stretchunit}{}{gregoriotex-spaces.tex}
886 The units attached to stretch dimension in a string distance. These units are extracted as part of coercing one distance to have the same units as another (\verb=\gre@consistentunits=).
887
888 \macroname{\textbackslash gre@shrinkunit}{}{gregoriotex-spaces.tex}
889 The units attached to shrink dimension in a string distance. These units are extracted as part of coercing one distance to have the same units as another (\verb=\gre@consistentunits=).
890
891 \macroname{\textbackslash gre@bug}{\#1}{gregoriotex.sty \textup{and} gregoriotex.tex}
892 Macro for raising a bug error when some calculation goes awry and comes up with a non-sensical result. Generally will be found in Lua code, not \TeX\ code.
893
894 \macroname{\textbackslash gre@changestyle}{\#1\#2[\#3]}{gregoriotex.sty \textup{and} gregoriotex.tex}
895 Workhorse function behind \verb=\grechangestyle=. Necessary because the internals of the definition are slightly different in \LaTeX\ and Plain \TeX.
896
897 \macroname{\textbackslash gre@bolshiftcleftypeglobal}{}{gregoriotex-spaces.tex}
898 Takes on the value \texttt{1}, \texttt{2}, or \texttt{3} depending on whether
899 to calculate the beginning-of-line shift based on the largest, current, or
900 forced clef width (\ie, directly use the value stored in
901 \verb=\gre@dimen@clefwidth@bol=), respectively. This is the ``global'' value,
902 used to initialize \verb=\gre@bolshiftcleftypelocal= at the start of a score.
903
904 \macroname{\textbackslash gre@bolshiftcleftypelocal}{}{gregoriotex-spaces.tex}
905 Takes on the value \texttt{1}, \texttt{2}, or \texttt{3} depending on whether
906 to calculate the beginning-of-line shift based on the largest, current, or
907 forced clef width (\ie, directly use the value stored in
908 \verb=\gre@dimen@clefwidth@bol=), respectively. This is the ``local'' value,
909 used in the actual computation.
910
911 \macroname{\textbackslash gre@update@clefwidth@largest}{\#1}{gregoriotex-spaces.tex}
912 Updates the ``largest'' clef width, used when \verb=\gre@bolshiftcleftypelocal=
913 is \texttt{1}.
914
915 \begin{argtable}
916 \#1 & distance & The new value to use for the ``largest'' clef width.\\
917 \end{argtable}
918
919 \macroname{\textbackslash gre@update@clefwidth@current}{\#1}{gregoriotex-spaces.tex}
920 Updates the ``current'' clef width, used when \verb=\gre@bolshiftcleftypelocal=
921 is \texttt{2}.
922
923 \begin{argtable}
924 \#1 & distance & The new value to use for the ``current'' clef width.\\
925 \end{argtable}
926
927 \macroname{\textbackslash gre@update@clefwidth@forced}{\#1}{gregoriotex-spaces.tex}
928 Updates the ``forced'' clef width, used when \verb=\gre@bolshiftcleftypelocal=
929 is \texttt{3}.
930
931 \begin{argtable}
932 \#1 & distance & The new value to use for the ``forced'' clef width.\\
933 \end{argtable}
934
935 \macroname{\textbackslash gre@calculate@bolshift}{\#1\#2}{gregoriotex-spaces.tex}
936 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.
937
938 \begin{argtable}
939 \#1 & dimension & \verb=begindifference= of the syllable\\
940 \end{argtable}
941
942 \macroname{\textbackslash gre@calculate@eolshift}{\#1}{gregoriotex-spaces.tex}
943 Macro used in \verb=\GreSyllable=. Sets \verb=\gre@dimen@eolshift= to the left kern that
944 should appear before an end of line. The improvement is tiny: when
945 text go further than notes in the last syllable of a line, the idea
946 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.
947
948 \begin{argtable}
949 \#1 & dimension & The \verb=enddifference= of the corresponding syllable\\
950 \end{argtable}
951
952 \macroname{\textbackslash gre@calculate@syllablefinalskip}{\#1\#2}{gregoriotex-spaces.tex}
953 Macro computing the skip at the end of the syllable.
954
955 \begin{argtable}
956 \#1 & \texttt{0} & if end of syllable\\
957 & \texttt{1} & if end of word\\
958 \#2 & \texttt{0} & if next syllable is normal\\
959 & \texttt{1} & if it’s a bar\\
960 \end{argtable}
961
962 \macroname{\textbackslash gre@convert}{}{gregoriotex-spaces.tex}
963 Macro to hold the original distance which is to be scaled by \verb=\gre@changeonedimenfactor=
964
965 \macroname{\textbackslash gre@debug}{}{gregoriotex.sty \textup{and} gregoriotex.tex}
966 Macro to hold the list of debug messages which should be designated as printing. Contains comma-separated values from \Nameref{DebugCategory}, set via the \texttt{debug} package keyword parameter.
967
968 \macroname{\textbackslash gre@debugmsg}{\#1\#2}{gregoriotex-common.tex}
969 Macro to print debugging messages.
970
971 \begin{argtable}
972 \#1 & string & The category of the message (used in conjunction with \verb=\gre@debug= to determine whether to print the message or not; see \Nameref{DebugCategory}\\
973 \#2 & string & The debug message\\
974 \end{argtable}
975
976 \macroname{\textbackslash gre@trace}{\#1}{gregoriotex-common.tex}
977 Macro to mark the beginning of a function in the log with a GreTrace message.
978
979 \begin{argtable}
980 \#1 & string & name and argument list of the function being identified.
981 \end{argtable}
982
983 \macroname{\textbackslash gre@trace@end}{\#1}{gregoriotex-common.tex}
984 Macro to mark the end of a function in the log with a GreTrace message.
985
986 \macroname{\textbackslash gre@trace@prefix}{gregoriotex-common.tex}
987 Macro to hold the prefix of GreTrace messages (value is manipulated to control indentation and indicate nesting).
988
989 \macroname{\textbackslash gre@declarefileversion}{\#1\#2}{gregoriotex-main.tex}
990 Macro which checks for version consistency between Gregorio\TeX\ files.
991
992 \begin{argtable}
993 \#1 & string & name of the current file\\
994 \#2 & string & version of the current file\\
995 \end{argtable}
996
997 \macroname{\textbackslash gre@def@char@he}{\#1\#2}{gregoriotex-chars.tex}
998 Macro for defining the various types of horizontal episema.
999
1000 \begin{argtable}
1001 \#1 & string & name of the horizontal episema to be defined\\
1002 \#2 & string & Camel case name of horizontal episema to be defined\\
1003 \end{argtable}
1004
1005 \macroname{\textbackslash gre@def@char@he@porr}{\#1\#2}{gregoriotex-chars.tex}
1006 Macro for defining the various types of horizontal episema porrectus.
1007
1008 \begin{argtable}
1009 \#1 & string & name of the horizontal episema porrectus to be defined\\
1010 \#2 & string & Camel case name of horizontal episema porrectus to be defined\\
1011 \end{argtable}
1012
1013 \macroname{\textbackslash gre@get@spaceskip}{\#1}{gregoriotex-signs.tex}
1014 Loads \verb=\gre@skip@temp@four= with the appropriate rubber length given the
1015 desired case.
1016
1017 \begin{argtable}
1018 \#1 & \texttt{0} & Default space.\\
1019 & \texttt{1} & Zero-width space.\\
1020 & \texttt{2} & Space between flat or natural and a note.\\
1021 & \texttt{3} & Space between two puncta inclinata, descending.\\
1022 & \texttt{4} & Space between bivirga or trivirga.\\
1023 & \texttt{5} & space between bistropha or tristropha.\\
1024 & \texttt{6} & Space after a punctum mora XXX: not used yet, not so sure it is a good idea\ldots\\
1025 & \texttt{7} & Space between a punctum inclinatum and a punctum inclinatum debilis, descending.\\
1026 & \texttt{8} & Space between two puncta inclinata debilis.\\
1027 & \texttt{9} & Space before a punctum (or something else) and a punctum inclinatum.\\
1028 & \texttt{10} & Space between puncta inclinata (also debilis for now), larger ambitus (range=3rd), descending.\\
1029 & \texttt{11} & Space between puncta inclinata (also debilis for now), larger ambitus (range=4th or 5th), descending.\\
1030 & \texttt{12} & Space between two puncta inclinata, ascending. \\
1031 & \texttt{13} & Space between a punctum inclinatum and a punctum inclinatum debilis, ascending. \\
1032 & \texttt{14} & Space between puncta inclinata (also debilis for now), larger ambitus (range=3rd), ascending. \\
1033 & \texttt{15} & Space between puncta inclinata (also debilis for now), larger ambitus (range=4th or 5th), ascending. \\
1034 & \texttt{16} & Space between a punctum inclinatum and a ``no-bar'' glyph one pitch below. \\
1035 & \texttt{17} & Space between a punctum inclinatum and a ``no-bar'' glyph two pitches below. \\
1036 & \texttt{18} & Space between a punctum inclinatum and a ``no-bar'' glyph three or four pitches below \\
1037 & \texttt{19} & Space between a punctum inclinatum and a ``no-bar'' glyph one pitch above. \\
1038 & \texttt{20} & Space between a punctum inclinatum and a ``no-bar'' glyph two pitches above. \\
1039 & \texttt{21} & Space between a punctum inclinatum and a ``no-bar'' glyph three or four pitches above \\
1040 & \texttt{22} & Half-space. \\
1041 & \texttt{23} & Space between two puncta inclinata on a unison. \\
1042 & \texttt{24} & Space before a right-leaning puncta inclinatum when the pitch is ascending (up to 4 pitches away). \\
1043 & \texttt{25} & Space before a left-leaning puncta inclinatum when the pitch is descending (up to 4 pitches away). \\
1044 & \texttt{26} & Space after after a non-punctum inclinatum and before the upright punctum inclinatum. \\
1045 \end{argtable}
1046
1047 \macroname{\textbackslash gre@nabcfontname}{}{gregoriotex-main.tex}
1048 Macro which stores the name of the currently selected font for \texttt{nabc}.
1049
1050 \macroname{\textbackslash gre@nabcfontsize}{}{gregoriotex-main.tex}
1051 Macro which stores the size of the currently selected font for \texttt{nabc}.
1052
1053 \macroname{\textbackslash gre@endsyllablepart}{}{gregoriotex-syllable.tex}
1054 Macro which stores the end part of the current syllable (that which comes after the alignment part).
1055
1056 \macroname{\textbackslash gre@firstsyllablepart}{}{gregoriotex-syllable.tex}
1057 Macro which stores the first part of the current syllable (that which comes before the alignment part).
1058
1059 \macroname{\textbackslash gre@middlesyllablepart}{}{gregoriotex-syllable.tex}
1060 Macro which stores the middle part of the current syllable (the part which aligns with the notes).
1061
1062 \macroname{\textbackslash gre@nextendsyllablepart}{}{gregoriotex-syllable.tex}
1063 Macro which stores the end part of the next syllable (that which comes after the alignment part).
1064
1065 \macroname{\textbackslash gre@nextfirstsyllablepart}{}{gregoriotex-syllable.tex}
1066 Macro which stores the first part of the next syllable (that which comes before the alignment part).
1067
1068 \macroname{\textbackslash gre@nextmiddlesyllablepart}{}{gregoriotex-syllable.tex}
1069 Macro which stores the middle part of the next syllable (the part which aligns with the notes).
1070
1071 \macroname{\textbackslash gre@fixdebug}{}{gregoriotex-common.tex}
1072 Fixes the raw \verb=\gre@debug= value for use with \verb=\gre@debugmsg=.
1073
1074 \macroname{\textbackslash gre@fixedtextformat}{\#1}{gregoriotex-syllable.tex}
1075 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.
1076
1077 \begin{argtable}
1078 \#1 & string & The syllable (usually built as \texttt{\small\pmac{gre@firstsyllablepart}\linebreak[1]\pmac{gre@middlesyllablepart}\linebreak[1]\pmac{gre@endsyllablepart}})\\
1079 \end{argtable}
1080
1081 \macroname{\textbackslash gre@fixednexttextformat}{\#1}{gregoriotex-syllable.tex}
1082 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.
1083
1084 \begin{argtable}
1085 \#1 & string & The syllable (usually built as \texttt{\small\pmac{gre@nextfirstsyllablepart}\linebreak[1]\pmac{gre@nextmiddlesyllablepart}\linebreak[1]\pmac{gre@nextendsyllablepart}})\\
1086 \end{argtable}
1087
1088 \macroname{\textbackslash gre@if@rewritesyllable}{\#1\#2}{gregoriotex-syllable.tex}
1089 Performs \#1 if the syllable should be rewritten, else \#2.
1090
1091 \begin{argtable}
1092 \#1 & \TeX\ code & Code to perform when rewriting the syllable\\
1093 \#2 & \TeX\ code & Code to perform when \emph{not} rewriting the syllable\\
1094 \end{argtable}
1095
1096 \macroname{\textbackslash gre@push@endsyllable}{\#1}{gregoriotex-syllable.tex}
1097 Sets the save aliases to push the end-syllable part of the current syllable to the next syllable if necessary.
1098
1099 \begin{argtable}
1100 \#1 & link target & line:char:column for the link to use for the pushed syllable part\\
1101 \end{argtable}
1102
1103 \macroname{\textbackslash gre@emit@syllabletext}{\#1}{gregoriotex-syllable.tex}
1104 Emits the text for the syllable, prepending the carry-over syllable part if necessary and consolidating the fixed text styles if possible.
1105
1106 \begin{argtable}
1107 \#1 & \TeX\ code & Code that emits the syllable text\\
1108 \end{argtable}
1109
1110 \macroname{\textbackslash gre@emit@endsyllablepart}{}{gregoriotex-syllable.tex}
1111 Emits the text for the end syllable part if it \emph{is not} to be moved to the next syllable.
1112
1113 \macroname{\textbackslash gre@emit@endsyllablepartfornextsyllable}{}{gregoriotex-syllable.tex}
1114 Emits the text for the end syllable part if it \emph{is} to be moved to the next syllable. This is used when projecting the next syllable text while processing some syllable.
1115
1116 \macroname{\textbackslash gre@syllable@args}{}{gregoriotex-syllable.tex}
1117 Saves the arguments to \verb=\GreSyllable=. Needed so that \verb=\GreSyllable= can look forward to see if the next token is \verb=\GreBarSyllable=.
1118
1119 \macroname{\textbackslash gre@syllable@expand}{}{gregoriotex-syllable.tex}
1120 Calls \verb=\gre@syllable@act=, passing the arguments saved in \verb=gre@syllable@args=. Needed so that \verb=\GreSyllable= can look forward to see if the next token is \verb=\GreBarSyllable=.
1121
1122 \macroname{\textbackslash gre@syllable@act}{\#1\#2\#3\#4\#5\#6\#7\#8\#9}{gregoriotex-syllable.tex}
1123 Typesets the syllable. Same arguments as \verb=\GreSyllable=. See the description of that macro for more information. Needed so that \verb=\GreSyllable= can look forward to see if the next token is \verb=\GreBarSyllable=.
1124
1125 \macroname{\textbackslash gre@gabcname}{}{gregoriotex-main.tex}
1126 Macro which holds the point-and-click file name.
1127
1128 \macroname{\textbackslash gre@gregoriotexluaversion}{}{gregoriotex-main.tex}
1129 Macro to hold the version number of \emph{gregoriotex.lua} so that it can be checked for consistency.
1130
1131 \macroname{\textbackslash gre@gregoriotexversion}{}{gregoriotex-main.tex}
1132 Macro to hold the version number of Gregorio\TeX\ so that it can be checked for consistency.
1133
1134 \macroname{\textbackslash gre@leftfill}{}{gregoriotex-main.tex}
1135 Macro set to \verb=\hfil= or \verb=\relax= depending on alignment choices.
1136
1137 \macroname{\textbackslash gre@lyriccentering}{}{gregoriotex-syllable.tex}
1138 Macro set to \verb=0= for full-syllable centering, \verb=1= for vowel centering (the default), or \verb=2= for first-letter centering.
1139
1140 \macroname{\textbackslash gre@rightfill}{}{gregoriotex-main.tex}
1141 Macro set to \verb=\hfil= or \verb=\relax= depending on alignment choices.
1142
1143 \macroname{\textbackslash gre@mark@abovelinestext}{}{gregoriotex-main.tex}
1144 Macro to set the point-and-click position for above lines text.
1145
1146 \macroname{\textbackslash gre@mark@translation}{}{gregoriotex-main.tex}
1147 Macro to set the point-and-click position for translations.
1148
1149 \macroname{\textbackslash gre@pitch@[a-n,p]}{}{gregoriotex-main.tex}
1150 Macros which map gabc pitch letters (the final part of the macro name) to the numerical value that Gregorio\TeX\ uses in processing note placement.
1151
1152 \macroname{\textbackslash gre@pitch@adjust@top}{}{gregoriotex-main.tex}
1153 If any note appears above this pitch, the space above the lines must be adjusted to account for it.
1154
1155 \macroname{\textbackslash gre@pitch@adjust@bottom}{}{gregoriotex-main.tex}
1156 If any note appears below this pitch, the space below the lines must be adjusted to account for it.
1157
1158 \macroname{\textbackslash gre@pitch@abovestaff}{}{gregoriotex-main.tex}
1159 The pitch above the staff.
1160
1161 \macroname{\textbackslash gre@pitch@belowstaff}{}{gregoriotex-main.tex}
1162 The pitch below the staff.
1163
1164 \macroname{\textbackslash gre@pitch@ledger@above}{}{gregoriotex-main.tex}
1165 The pitch of the ledger line above the staff.
1166
1167 \macroname{\textbackslash gre@pitch@ledger@below}{}{gregoriotex-main.tex}
1168 The pitch of the ledger line below the staff.
1169
1170 \macroname{\textbackslash gre@pitch@barvepisema}{}{gregoriotex-main.tex}
1171 The pitch of the bar episema.
1172
1173 \macroname{\textbackslash gre@pitch@underbrace}{}{gregoriotex-main.tex}
1174 The pitch of the under-the-staff brace.
1175
1176 \macroname{\textbackslash gre@pitch@overbrace}{}{gregoriotex-main.tex}
1177 The pitch of the over-the-staff brace.
1178
1179 \macroname{\textbackslash gre@pitch@overbraceglyph}{}{gregoriotex-main.tex}
1180 The pitch of the over-the-staff brace glyph.
1181
1182 \macroname{\textbackslash gre@pitch@bar}{}{gregoriotex-main.tex}
1183 The pitch of the bar glyph.
1184
1185 \macroname{\textbackslash gre@pitch@raresign}{}{gregoriotex-main.tex}
1186 The pitch of a rare sign (semicirculus, \etc).
1187
1188 \macroname{\textbackslash gre@pitch@dummy}{}{gregoriotex-main.tex}
1189 A meaningless (don't-care) pitch.
1190
1191 \macroname{\textbackslash gre@pitch@nominal}{}{gregoriotex-main.tex}
1192 A pitch guaranteed to be in the staff.
1193
1194 \macroname{\textbackslash gre@pitch@cleftop}{}{gregoriotex-spaces.tex}
1195 The pitch of the highest point of the current clef.
1196
1197 \macroname{\textbackslash gre@pitch@clefbottom}{}{gregoriotex-spaces.tex}
1198 The pitch of the lowest point of the current clef.
1199
1200 \macroname{\textbackslash gre@save@clefextrema}{\#1\#2}{gregoriotex-signs.tex}
1201 Computes the pitches of the lowest and highest points of a clef and saves them
1202 into \verb=\gre@pitch@cleftop= and \verb=\gre@pitch@clefbottom=.
1203
1204 \begin{argtable}
1205 \#1 & integer & the line of the primary clef (1 is the bottom line)\\
1206 \#2 & integer & the line of the secondary clef (1 is the bottom line, 0 means
1207 no secondary clef)\\
1208 \end{argtable}
1209
1210 \macroname{\textbackslash gre@pointandclick}{\#1\#2}{gregoriotex-main.tex}
1211 Macro to generate the point-and-click links.
1212
1213 \begin{argtable}
1214 \#1 & \TeX\ code & the entity which is to contain the link\\
1215 \#2 & link target & line:char:column for the link\\
1216 \end{argtable}
1217
1218 \macroname{\textbackslash gre@prefix}{}{gregoriotex-spaces.tex}
1219 Either \texttt{skip} or \texttt{dimen} according to the distance being set or changed at the given moment.
1220
1221 \macroname{\textbackslash gre@prefixII}{}{gregoriotex-spaces.tex}
1222 Same as \verb=\gre@prefix=. Used when we were dealing with two distances simultaneously.
1223
1224 \macroname{\textbackslash gre@rubberpermit}{\#1}{gregoriotex-spaces.tex}
1225 Determines whether the given distance is allowed to take a rubber length.
1226
1227 \begin{argtable}
1228 \#1 & string & the name of the distance to check\\
1229 \end{argtable}
1230
1231 \macroname{\textbackslash gre@setgregoriofont}{[\#1]\#2}{gregoriotex-main.tex}
1232 Workhorse function behind \verb=\gresetgregoriofont=.
1233
1234 \begin{argtable}
1235 \#1 & \textit{(omitted)} & Use the normal font and rule set (default).\\
1236 & \texttt{op} & Use the alternate Dominican font/rule set.\\
1237 \#2 & \texttt{greciliae} & Use the Greciliae font (default).\\
1238 & \texttt{gregorio} & Use the Gregorio font.\\
1239 & \texttt{granapadano} & Use the Grana Padano font.\\
1240 \end{argtable}
1241
1242 \macroname{\textbackslash gre@syllable@end}{\#1\#2\#3\#4}{gregoriotex-syllable.tex}
1243 Macro to make a few checks and call the right macros between \verb=\endbeforebar=, \verb=\endofword=, \verb=\endofsyllable=.
1244
1245 \begin{argtable}
1246 \#1 & integer & the type of notes alignment of next syllable, from \#7 of \verb=\GreSyllable=. See \Nameref{notesalign}.\\
1247 \#2 & integer & the type of alteration of next syllable, from \#7 of \verb=\GreSyllable=. See \Nameref{alterationtype}.\\
1248 \#3 & string & next syllable text\\
1249 \#4 & \texttt{0} & this syllable is not the end of a word\\
1250 & \texttt{1} & this syllable is the end of a word\\
1251 \end{argtable}
1252
1253 \macroname{\textbackslash gre@typeout}{\#1}{gregoriotex.sty \textup{and} gregoriotex.tex}
1254 Macro which points to \verb=\typeout= in \LaTeX\ or \verb=\message= in Plain \TeX.
1255
1256 \macroname{\textbackslash gre@unsetfixedtextformat}{}{gregoriotex-syllable.tex}
1257 Macro which changes \verb=\gre@fixedtextformat= back to normal text.
1258
1259 \macroname{\textbackslash gre@unsetfixednexttextformat}{}{gregoriotex-syllable.tex}
1260 Macro which changes \verb=\gre@fixednexttextformat= back to normal text.
1261
1262 \macroname{\textbackslash gregoriotex@symbols@loaded}{}{gregoriotex-symbols.tex}
1263 Empty macro which is used to determine if the symbols have been loaded and prevent loading them again if they have.
1264
1265 \macroname{\textbackslash gre@hskip}{}{gregoriotex-signs.tex}
1266 Alias for \verb=\hskip= or \verb=\kern=. We use this rather than those functions directly so that the same element can appear in discretionaries where \verb=\kern= is allowed but \verb=\hskip= is not by simply changing the assignment of this macro when we enter one.
1267
1268 \macroname{\textbackslash gre@localleftbox}{}{gregoriotex-main.tex}
1269 Alias for \verb=\luatexlocalleftbox= or \verb=\localleftbox=, depending on \LaTeX\ version.
1270
1271 \macroname{\textbackslash gre@localrightbox}{}{gregoriotex-main.tex}
1272 Alias for \verb=\luatexlocalrightbox= or \verb=\localrightbox=, depending on \LaTeX\ version.
1273
1274 \macroname{\textbackslash gre@resizebox}{}{gregoriotex-main.tex}
1275 Alias for \verb=\resizebox=.
1276
1277 \macroname{\textbackslash gre@dimension}{}{gregoriotex-spaces.tex}
1278 Workhorse function for setting distances in \verb=\grecreatedim= and \verb=\grechangedim=.
1279
1280 \macroname{\textbackslash gre@changedimforline}{\#1\#2\#3}{gregoriotex-spaces.tex}
1281 Saves the current value of the dimension and then changes it. The arguments
1282 are the same as \verb=\grechangedim=. Used to temporarily change the dimension
1283 for a given line, which is restored at the next beginning of the next line.
1284
1285 \macroname{\textbackslash gre@changecountforline}{\#1\#2}{gregoriotex-spaces.tex}
1286 Saves the current value of the count and then changes it. The arguments
1287 are the same as \verb=\grechangeocount=. Used to temporarily change the count
1288 for a given line, which is restored at the next beginning of the next line.
1289
1290 \macroname{\textbackslash gre@setstafflines}{\#1}{gregoriotex-main.tex}
1291 Sets the number of staff lines.
1292
1293 \begin{argtable}
1294 \#1 & integer & The number of staff lines\\
1295 \end{argtable}
1296
1297 \macroname{\textbackslash gre@romannumeral@majuscule}{\#1}{gregoriotex-main.tex}
1298 Typesets its numeric argument as an upper-case Roman numeral.
1299
1300 \begin{argtable}
1301 \#1 & integer & The number to typeset\\
1302 \end{argtable}
1303
1304 \macroname{\textbackslash gre@romannumeral@minuscule}{\#1}{gregoriotex-main.tex}
1305 Typesets its numeric argument as a lower-case Roman numeral.
1306
1307 \begin{argtable}
1308 \#1 & integer & The number to typeset\\
1309 \end{argtable}
1310
1311 \macroname{\textbackslash gre@bar@space@suffix}{\#1\#2\#3}{gregoriotex-symbols.tex}
1312 Macro used to select the corresct suffix of the \verb=bar@x= spaces.
1313
1314 \begin{argtable}
1315 \#1 & \texttt{0} & emits nothing\\
1316 & \texttt{1} & emits \verb=@standalone=\\
1317 \#2 & \texttt{0} & emits \verb=@notext= (only if standalone)\\
1318 & \texttt{1} & emits \verb=@text= (only if standalone)\\
1319 \#3 & \texttt{0} & emits nothing\\
1320 & \texttt{1} & emits \verb=@short=\\
1321 \end{argtable}
1322
1323 \macroname{\textbackslash gre@drawadditionalline}{\#1\#2\#3\#4\#5\#6}{gregoriotex-signs.tex}
1324 Workhorse function behind \verb=\GreDrawAdditionalLine=.
1325
1326 \begin{argtable}
1327 \#1 & \texttt{0} & Draw an over-the-staff ledger line. \\
1328 & \texttt{1} & Draw an under-the-staff ledger line. \\
1329 \#2 & distance & The length of the line, with TeX units, excluding any left or right distances coming from the rest of the arguments. \\
1330 \#3 & \texttt{0} & Start the line at this point. \\
1331 & \texttt{1} & Start the line to the left of this point by \verb=gre@dimen@additionallineswidth=. \\
1332 & \texttt{2} & Start the line to the left of this point by \#4. \\
1333 \#4 & distance & The distance to move left before starting the line if \#3 is \texttt{2}. \\
1334 \#5 & \texttt{0} & End the line exactly \#2 to the right of this point. \\
1335 & \texttt{1} & End the line \verb=gre@dimen@additionallineswidth= to the right of \#2 from this point. \\
1336 & \texttt{2} & End the line \#6 to the right of \#2 from this point. \\
1337 \#6 & distance & The distance to end the line after \#2 from this point if \#3 is \texttt{2}. \\
1338 \end{argtable}
1339
1340 \macroname{\textbackslash gre@get@unkern@aftermora}{}{gregoriotex-signs.tex}
1341 Calculates the amount of shift needed to take into account the presence of a punctum mora at the end of a syllable according to the setting in \verb=\gre@count@shiftaftermora=.
1342
1343 \macroname{\textbackslash gre@unkern@bar@aftermora}{}{gregoriotex-signs.tex}
1344 Macro which kerns between a punctum mora and a bar according to the setting in \verb=\gre@count@shiftaftermora=.
1345
1346 \macroname{\textbackslash gre@setgregoriofontscaled}{[\#1]\#2\#3}{gregoriotex-main.tex}
1347 Workhorse behind \verb=\gresetgregoriofontscaled=.
1348
1349 \begin{argtable}
1350 \#1 & \textit{(omitted)} & Use the normal font and rule set.\\
1351 & \texttt{op} & Use the alternate Dominican font/rule set.\\
1352 \#2 & \texttt{greciliae} & Use the Greciliae font (default).\\
1353 & \texttt{gregorio} & Use the Gregorio font.\\
1354 & \texttt{granapadano} & Use the Grana Padano font.\\
1355 \#3 & integer & the scaling factor\\
1356 \end{argtable}
1357
1358 \macroname{\textbackslash gre@calculate@barposition}{\#1\#2}{gregoriotex-spaces.tex}
1359 Macro for calculating the position of the elements of a bar syllable using the new bar positioning algorithm.
1360
1361 \begin{argtable}
1362 \#1 & 0 & bar is not the end of a word\\
1363 & 1 & bar is the end of a word\\
1364 \#2 & integer & alteration type of the first glyph in the next syllable. See \Nameref{alterationtype}\\
1365 \end{argtable}
1366
1367 \macroname{\textbackslash gre@newlinearg}{}{gregoriotex-syllable.tex}
1368 Macro for storing the argument for \verb=\gre@newlinecommon= when the line break must be delayed (i.e. in the new bar spacing algorithm).
1369
1370 \macroname{\textbackslash gre@newlinecommondelayed}{}{gregoriotex-syllable.tex}
1371 Macro used in place of \verb=\gre@newlinecommon= when the line break must be delayed.
1372
1373 \macroname{\textbackslash gre@punctum@mora}{\#1\#2\#3\#4}{gregoriotex-signs.tex}
1374 Macro to typeset a punctum mora.
1375
1376 \begin{argtable}
1377 \#1 & pitch & height of the punctum mora (one of the \verb=\gre@pitch@...= macros.\\
1378 \#2 & 0 & general case\\
1379 & 1 & make the punctum mora zero-width\\
1380 & 2 & shift the width of one punctum to the left\\
1381 & 3 & same as 2 but with ambitus of one\\
1382 \#3 & 1 & punctum mora in the note before the last note of a podatus, porrectus, or torculus resupinus\\
1383 & 0 & other cases\\
1384 \#4 & 1 & punctum inclinatum\\
1385 & 0 & other cases\\
1386 \end{argtable}
1387
1388 \macroname{\textbackslash gre@changecavumhole}{\#1[\#2][\#3]}{gregoriotex-main.tex}
1389 Macro used by \verb=\grechangecavumglyph= to handle the optional arguments.
1390
1391 \macroname{\textbackslash gre@alterationadjustment}{\#1}{gregoriotex-spaces.tex}
1392 Macro to make adjustments to \verb=nextbegindifference= in order to account for an alteration at the begining of the next syllable.
1393
1394 \macroname{\textbackslash gre@punctummoraadjustment}{}{gregoriotex-spaces.tex}
1395 Macro to make adjustments to cursor position and \verb=previousenddifference= based on the presence of a punctum mora at the end of the last syllable.
1396
1397 \macroname{\textbackslash gre@num@min}{\#1\#2}{gregoriotex-spaces.tex}
1398 Puts the lower of its two integer arguments into \verb=\gre@count@temp@one=.
1399
1400 \begin{argtable}
1401 \#1 & integer & the first value to compare\\
1402 \#2 & integer & the second value to compare\\
1403 \end{argtable}
1404
1405 \macroname{\textbackslash gre@num@max}{\#1\#2}{gregoriotex-spaces.tex}
1406 Puts the greater of its two integer arguments into \verb=\gre@count@temp@one=.
1407
1408 \begin{argtable}
1409 \#1 & integer & the first value to compare\\
1410 \#2 & integer & the second value to compare\\
1411 \end{argtable}
1412
1413 \macroname{\textbackslash gre@evaluatenextsyllable}{\#1}{gregoriotex-syllable.tex}
1414 Evaluates its first argument as an advance computation against the next syllable. Twiddles the \verb=ifgre@evaluatingnextsyllable= flag around evaluation of the macro argument.
1415
1416 \macroname{\textbackslash gre@save@additionalspaces}{}{gregoriotex-spaces.tex}
1417 Macro to save the additional vertical spaces associated with the line (\texttt{additionalbottomspace}, \texttt{additionaltopspace}, \texttt{additionaltopspacealt}, \texttt{additionaltopspacenabc}, \texttt{currenttranslationheight}, \texttt{textlower}, \texttt{currentabovelinestextheight}, and \texttt{constantglyphraise}) so that they can be restored later.
1418
1419 \macroname{\textbackslash gre@restore@additionalspaces}{}{gregoriotex-spaces.tex}
1420 Macro to restore the additional vertical spaces associated with the line from their saved values.
1421
1422 \macroname{\textbackslash gre@clearsyllable}{\#1}{gregoriotex-spaces.tex}
1423 Prevents the current syllable from overlapping with the previous syllable.
1424
1425 \begin{argtable}
1426 \#1 & bar & the current syllable is a bar syllable.\\
1427 & note & the current syllable is a note syllable.\\
1428 \end{argtable}
1429
1430 \macroname{\textbackslash gre@read@temp}{}{gregoriotex-main.tex}
1431 File handle used to mark auto-compiled gabc files as dependencies for tools
1432 like latexmk.
1433
1434 \macroname{\textbackslash gre@arg@oftwo@first}{\#1\#2}{gregoriotex-syllable.tex}
1435 Evaluates to the first of its arguments.
1436
1437 \begin{argtable}
1438 \#1 & any & the first argument\\
1439 \#2 & any & the second argument\\
1440 \end{argtable}
1441
1442 \macroname{\textbackslash gre@arg@oftwo@second}{\#1\#2}{gregoriotex-syllable.tex}
1443 Evaluates to the second of its arguments.
1444
1445 \begin{argtable}
1446 \#1 & any & the first argument\\
1447 \#2 & any & the second argument\\
1448 \end{argtable}
1449
1450 \macroname{\textbackslash gre@parsecommas}{\#1\#2}{gregoriotex-common.tex}
1451 Runs a command for each string in a comma-separated list of strings.
1452
1453 \begin{argtable}
1454 \#1 & string & a comma-separated list of strings\\
1455 \#2 & control sequence & a command that takes one argument\\
1456 \end{argtable}
1457
1458 \macroname{\textbackslash gre@parsecommas@options}{}{gregoriotex-common.tex}
1459 Internal to \verb|\gre@parsecommas|.
1460
1461 \macroname{\textbackslash gre@makeparshape}{}{gregoriotex-main.tex}
1462 Sets the shape of the paragraph shape using \verb|\parshape|.
1463
1464 \begin{argtable}
1465 \#1 & integer & How many lines are indented \\
1466 \#2 & dimen & The amount of the indentation \\
1467 \end{argtable}
1468
1469 \macroname{\textbackslash gre@parshape@dims}{}{gregoriotex-main.tex}
1470 Used inside \verb|\gre@makeparshape| to hold the \verb=\parshape= information needed to shape the score around the initial.
1471
1472 \subsection{Auxiliary File}
1473 Gregorio\TeX\ creates its own auxiliary file (extension \texttt{gaux}) which it uses to store information between successive typesetting runs. This allows for such features as the dynamic interline spacing. The following functions are used to interact with that auxiliary file.
1474
1475 \macroname{\textbackslash gre@gaux}{}{gregoriotex-main.tex}
1476 The handle for the auxiliary file.
1477
1478 \macroname{\textbackslash gre@open@gaux}{}{gregoriotex-main.tex}
1479 Macro for opening the auxiliary file.
1480
1481 \macroname{\textbackslash gre@close@gaux}{}{gregoriotex-main.tex}
1482 Macro for closing the auxiliary file.
1483
1484 \macroname{\textbackslash gre@write@gaux}{\#1}{gregoriotex-main.tex}
1485 Macro for writing the auxiliary file.
1486
1487 \begin{argtable}
1488 \#1 & string & contents to be written to the auxiliary file\\
1489 \end{argtable}
1490
1491
1492 \subsection{Fonts}
1493 Gregorio\TeX\ loads a number of fonts which are referred to by the following macros.
1494
1495 \macroname{\textbackslash gre@font@music}{}{gregoriotex-main.tex}
1496 The font for the neumes and other principle score elements.
1497
1498 \macroname{\textbackslash gre@font@music@hollow}{}{gregoriotex-main.tex}
1499 The font for cavum neumes.
1500
1501 \macroname{\textbackslash gre@font@music@hole}{}{gregoriotex-main.tex}
1502 The font for cavum neume holes.
1503
1504 \macroname{\textbackslash gre@font@style}{}{gregoriotex-main.tex}
1505 The font for some of the extra characters, such as the bar for barred letters.
1506
1507 \macroname{\textbackslash gre@font@nabc}{}{gregoriotex-nabc.tex}
1508 The font for ancient notation.
1509
1510 \macroname{\textbackslash gre@font@initial}{}{gregoriotex.tex}
1511 The font for the default initial format in Plain \TeX.
1512
1513 \macroname{\textbackslash gre@fontfactor@...}{}{gregoriotex-main.tex}
1514 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).
1515
1516
1517 \subsection{Character Reference Aliases}
1518 To make referencing and changing them easier, Gregorio\TeX\ stores reference information for certain characters using the following macros.
1519
1520 \macroname{\textbackslash gre@fontchar@abovebarbrace}{}{gregoriotex-chars.tex}
1521 The above bar brace.
1522
1523 \macroname{\textbackslash gre@fontchar@flat}{}{gregoriotex-chars.tex}
1524 The flat character.
1525
1526 \macroname{\textbackslash gre@fontchar@flathole}{}{gregoriotex-chars.tex}
1527 The flat hole character (\ie, the character needed to prevent lines from showing through the center of the flat).
1528
1529 \macroname{\textbackslash gre@fontchar@flatparen}{}{gregoriotex-chars.tex}
1530 The parenthesized flat character.
1531
1532 \macroname{\textbackslash gre@fontchar@flatparenhole}{}{gregoriotex-chars.tex}
1533 The parenthesized flat hole character (\ie, the character needed to prevent lines from showing through the center of the flat).
1534
1535 \macroname{\textbackslash gre@fontchar@natural}{}{gregoriotex-chars.tex}
1536 The natural character.
1537
1538 \macroname{\textbackslash gre@fontchar@naturalhole}{}{gregoriotex-chars.tex}
1539 The natural hole character (\ie, the character needed to prevent lines from showing through the center of the natural).
1540
1541 \macroname{\textbackslash gre@fontchar@naturalparen}{}{gregoriotex-chars.tex}
1542 The parenthesized natural character.
1543
1544 \macroname{\textbackslash gre@fontchar@naturalparenhole}{}{gregoriotex-chars.tex}
1545 The parenthesized natural hole character (\ie, the character needed to prevent lines from showing through the center of the natural).
1546
1547 \macroname{\textbackslash gre@fontchar@sharp}{}{gregoriotex-chars.tex}
1548 The sharp character.
1549
1550 \macroname{\textbackslash gre@fontchar@sharphole}{}{gregoriotex-chars.tex}
1551 The sharp hole character (\ie, the character needed to prevent lines from showing through the center of the sharp).
1552
1553 \macroname{\textbackslash gre@fontchar@sharpparen}{}{gregoriotex-chars.tex}
1554 The parenthesized sharp character.
1555
1556 \macroname{\textbackslash gre@fontchar@sharpparenhole}{}{gregoriotex-chars.tex}
1557 The parenthesized sharp hole character (\ie, the character needed to prevent lines from showing through the center of the sharp).
1558
1559 \macroname{\textbackslash gre@fontchar@incclef}{}{gregoriotex-chars.tex}
1560 The \texttt{c}-clef which appears in the middle of a line.
1561
1562 \macroname{\textbackslash gre@fontchar@infclef}{}{gregoriotex-chars.tex}
1563 The \texttt{f}-clef which appears in the middle of a line.
1564
1565 \macroname{\textbackslash gre@fontchar@cclef}{}{gregoriotex-chars.tex}
1566 The \texttt{c}-clef which appears at the beginning of a line.
1567
1568 \macroname{\textbackslash gre@fontchar@fclef}{}{gregoriotex-chars.tex}
1569 The \texttt{f}-clef which appears at the beginning of a line.
1570
1571 \macroname{\textbackslash gre@fontchar@punctum}{}{gregoriotex-chars.tex}
1572 The punctum character.
1573
1574 \macroname{\textbackslash gre@fontchar@punctummora}{}{gregoriotex-chars.tex}
1575 The punctum mora character.
1576
1577 \macroname{\textbackslash gre@fontchar@underbrace}{}{gregoriotex-signs.tex}
1578 The under brace character.
1579
1580 \macroname{\textbackslash gre@fontchar@verticalepisema}{}{gregoriotex-chars.tex}
1581 The vertical episema character.
1582
1583 \macroname{\textbackslash gre@fontchar@brace}{}{gregoriotex-signs.tex}
1584 The (rounded) brace character.
1585
1586 \macroname{\textbackslash gre@fontchar@curlybrace}{}{gregoriotex-signs.tex}
1587 The curly brace character.
1588
1589 \macroname{\textbackslash gre@fontchar@custosbottomlong}{}{gregoriotex-chars.tex}
1590 The custos character with a long upwards directed vigra.
1591
1592 \macroname{\textbackslash gre@fontchar@custosbottommiddle}{}{gregoriotex-chars.tex}
1593 The custos character with a middle upwards directed vigra.
1594
1595 \macroname{\textbackslash gre@fontchar@custosbottomshort}{}{gregoriotex-chars.tex}
1596 The custos character with a short upwards directed vigra.
1597
1598 \macroname{\textbackslash gre@fontchar@custostoplong}{}{gregoriotex-chars.tex}
1599 The custos character with a long downwards directed vigra.
1600
1601 \macroname{\textbackslash gre@fontchar@custostopmiddle}{}{gregoriotex-chars.tex}
1602 The custos character with a middle downwards directed vigra.
1603
1604 \macroname{\textbackslash gre@fontchar@custostopshort}{}{gregoriotex-chars.tex}
1605 The custos character with a short downwards directed vigra.
1606
1607 \macroname{\textbackslash gre@fontchar@divisiofinalis}{}{gregoriotex-signs.tex}
1608 The divisio finalis.
1609
1610 \macroname{\textbackslash gre@fontchar@divisiomaior}{}{gregoriotex-signs.tex}
1611 The divisio maior.
1612
1613 \macroname{\textbackslash gre@char@normalhyphen}{}{gregoriotex-main.tex}
1614 A normal hyphen in the text font.
1615
1616 \macroname{\textbackslash gre@char@zerohyph}{}{gregoriotex-main.tex}
1617 Macro to typeset a zero-width hyphen (the hyphen is visible, it is only
1618 treated as if it had 0 width when calculating spaces). Used for fine tuning spacing
1619 (especially at line endings).
1620
1621 \macroname{\textbackslash gre@char@fuse@debilis}{}{gregoriotex-chars.tex}
1622 A fused character consisting of a leading punctum initio debilis (of ambitus one) and a regular punctum.
1623
1624 \macroname{\textbackslash gre@char@fuse@oriscus@one}{}{gregoriotex-chars.tex}
1625 A fused character consisting of a leading oriscus (of ambitus one) and a regular punctum.
1626
1627 \macroname{\textbackslash gre@char@fuse@oriscus@two}{}{gregoriotex-chars.tex}
1628 A fused character consisting of a leading oriscus (of ambitus two) and a regular punctum.
1629
1630 \macroname{\textbackslash gre@char@fuse@punctum@one}{}{gregoriotex-chars.tex}
1631 A fused character consisting of a leading punctum (of ambitus one) and a regular punctum.
1632
1633 \macroname{\textbackslash gre@char@fuse@punctum@two}{}{gregoriotex-chars.tex}
1634 A fused character consisting of a leading punctum (of ambitus two) and a regular punctum.
1635
1636 \macroname{\textbackslash gre@char@fuse@quilisma@one}{}{gregoriotex-chars.tex}
1637 A fused character consisting of a leading quilisma (of ambitus one) and a regular punctum.
1638
1639 \macroname{\textbackslash gre@char@fuse@quilisma@two}{}{gregoriotex-chars.tex}
1640 A fused character consisting of a leading quilisma (of ambitus two) and a regular punctum.
1641
1642 \macroname{\textbackslash gre@char@he@...}{\#1}{gregoriotex-chars.tex}
1643 A class of macros for the horizontal episema which populates the \verb=\gre@box@hep= box.
1644
1645 \macroname{\textbackslash gre@char@bar@virgula}{}{gregoriotex-main.tex}
1646 Alias that will hold the character for the virgula for the current number of
1647 lines for the staff.
1648
1649 \macroname{\textbackslash gre@char@bar@virgulahigh}{}{gregoriotex-main.tex}
1650 Alias that will hold the character for the high virgula for the current number
1651 of lines for the staff.
1652
1653 \macroname{\textbackslash gre@char@bar@virgulaparen}{}{gregoriotex-main.tex}
1654 Alias that will hold the character for the parenthesized virgula for the current
1655 number of lines for the staff.
1656
1657 \macroname{\textbackslash gre@char@bar@virgulaparenhigh}{}{gregoriotex-main.tex}
1658 Alias that will hold the character for the parenthesized high virgula for the
1659 current number of lines for the staff.
1660
1661 \macroname{\textbackslash gre@char@bar@divisiominimis}{}{gregoriotex-main.tex}
1662 Alias that will hold the character for the divisio ``minimis'' (eighth bar) for
1663 the current number of lines for the staff.
1664
1665 \macroname{\textbackslash gre@char@bar@divisiominimishigh}{}{gregoriotex-main.tex}
1666 Alias that will hold the character for the high divisio ``minimis'' (eighth bar)
1667 for the current number of lines for the staff.
1668
1669 \macroname{\textbackslash gre@char@bar@divisiominima}{}{gregoriotex-main.tex}
1670 Alias that will hold the character for the divisio minima for the current
1671 number of lines for the staff.
1672
1673 \macroname{\textbackslash gre@char@bar@divisiominimahigh}{}{gregoriotex-main.tex}
1674 Alias that will hold the character for the high divisio minima for the current
1675 number of lines for the staff.
1676
1677 \macroname{\textbackslash gre@char@bar@divisiominimaparen}{}{gregoriotex-main.tex}
1678 Alias that will hold the character for the parenthesized divisio minima for the
1679 current number of lines for the staff.
1680
1681 \macroname{\textbackslash gre@char@bar@divisiominimaparenhigh}{}{gregoriotex-main.tex}
1682 Alias that will hold the character for the parenthesized high divisio minima for
1683 the current number of lines for the staff.
1684
1685 \macroname{\textbackslash gre@char@bar@divisiominor}{}{gregoriotex-main.tex}
1686 Alias that will hold the character for the divisio minor for the current
1687 number of lines for the staff.
1688
1689 \macroname{\textbackslash gre@char@bar@divisiomaior}{}{gregoriotex-main.tex}
1690 Alias that will hold the character for the divisio maior for the current
1691 number of lines for the staff.
1692
1693 \macroname{\textbackslash gre@char@bar@divisiomaiordotted}{}{gregoriotex-main.tex}
1694 Alias that will hold the character for the dotted divisio maior for the current
1695 number of lines for the staff.
1696
1697 \macroname{\textbackslash gre@char@bar@divisiomaiordottedbacking}{}{gregoriotex-main.tex}
1698 Alias that will hold the character for the dotted divisio maior backing for the
1699 current number of lines for the staff.
1700
1701 \macroname{\textbackslash gre@nabccharno}{\#1\#2\#3}{gregoriotex-nabc.tex}
1702 Prints the nabc glyphs for the given nabc string.
1703
1704 \begin{argtable}
1705 \#1 & string & nabc code representing the character\\
1706 \#2 & string & name of nabc font to use\\
1707 \#3 & integer & scaling factor\\
1708 \end{argtable}
1709
1710
1711 \subsection{Flags}
1712
1713 Flags are either boolean (defined with \verb=\newif=), Lua\TeX\ attributes, or counts (defined with \verb=\newcount=). They store settings and/or the current state of something so that Gregorio\TeX\ can typeset things in the desired manner.
1714
1715 All distances in \nameref{distances} and \texttt{stafflinefactor} have a boolean associated with them, of the form \verb=\ifgre@scale@*=. This boolean
1716 indicates if the distance should scale when the staff size changes (true)
1717 or not (false).
1718
1719 \macroname{\textbackslash ifgre@annotationbottomline}{}{gregoriotex-main.tex}
1720 Boolean used to indicate if the bottom line of the annotation should be used as the control line for its initial vertical alignment.
1721
1722 \macroname{\textbackslash gre@count@annotationvalign}{}{gregoriotex-main.tex}
1723 Count used to indicate which part of the annotation control line should be initially aligned with the top line of the staff. Values: \texttt{0}, top; \texttt{1}, baseline; or \texttt{2}, bottom.
1724
1725 \macroname{\textbackslash ifgre@forcehyphen}{}{gregoriotex-main.tex}
1726 Boolean used to indicate if hyphens should be forced between all syllables in a polysyllabic word.
1727
1728 \macroname{\textbackslash ifgre@checklength}{}{gregoriotex-spaces.tex}
1729 Boolean used in \verb=\gresetdim= to indicate if we are attempting to set a rubber length.
1730
1731 \macroname{\textbackslash ifgre@rubber}{}{gregoriotex-spaces.tex}
1732 Boolean used in \verb=\gre@changeonedimenfactor= to indicate if we are dealing with one of the distances which can accept a rubber length.
1733
1734 \macroname{\textbackslash ifgre@stretch}{}{gregoriotex-spaces.tex}
1735 Boolean used in \verb=\gre@changeonedimenfactor= as we test for the presence of a stretch.
1736
1737 \macroname{\textbackslash ifgre@shrink}{}{gregoriotex-spaces.tex}
1738 Boolean used in \verb=\gre@changeonedimenfactor= as we test for the presence of a shrink.
1739
1740 \macroname{\textbackslash ifgre@translationcentering}{}{gregoriotex-main.tex}
1741 Boolean used to specify whether the translation text should be centered below its respective syllable.
1742
1743 \macroname{\textbackslash ifgre@showlines}{}{gregoriotex-main.tex}
1744 Boolean used to specify whether the staff lines should be shown or not.
1745
1746 \macroname{\textbackslash ifgre@hidepclines}{}{gregoriotex-signs.tex}
1747 Boolean used to specify whether the staff lines behind a punctum cavum should be hidden.
1748
1749 \macroname{\textbackslash ifgre@hidealtlines}{}{gregoriotex-signs.tex}
1750 Boolean used to specify whether the staff lines behind an alteration should be hidden.
1751
1752 \macroname{\textbackslash ifgre@hidedottedbarlines}{}{gregoriotex-signs.tex}
1753 Boolean used to specify whether the staff lines behind a dotted bar should be hidden.
1754
1755 \macroname{\textbackslash ifgre@hepisemabridge}{}{gregoriotex-signs.tex}
1756 Boolean used to specify whether adjacent horizontal episemata should be joined together.
1757
1758 \macroname{\textbackslash ifgre@metapost@brace}{}{gregoriotex-signs.tex}
1759 Boolean used to specify whether round over-the-staff braces should be drawn by
1760 \MP{} as opposed to rendered via the score font.
1761
1762 \macroname{\textbackslash ifgre@metapost@underbrace}{}{gregoriotex-signs.tex}
1763 Boolean used to specify whether round under-the-staff braces should be drawn by
1764 \MP{} as opposed to rendered via the score font.
1765
1766 \macroname{\textbackslash ifgre@metapost@curlybrace}{}{gregoriotex-signs.tex}
1767 Boolean used to specify whether curly braces should be drawn by \MP{} as
1768 opposed to rendered via the score font.
1769
1770 \macroname{\textbackslash ifgre@metapost@barbrace}{}{gregoriotex-signs.tex}
1771 Boolean used to specify whether divisio braces should be drawn by \MP{} as
1772 opposed to rendered via the score font.
1773
1774 \macroname{\textbackslash ifgre@boxing}{}{gregoriotex-syllable.tex}
1775 Boolean to track whether we’re placing the contents of syllable notes into their box or actually printing that box (helps prevent spurious spaces from occurring when the box is being filled but not printed).
1776
1777 \macroname{\textbackslash ifgre@mustdotranslationcenterend}{}{gregoriotex-main.tex}
1778 Boolean to track whether we must do translation centering.
1779
1780 \macroname{\textbackslash ifgre@beginningofscore}{}{gregoriotex-main.tex}
1781 Boolean to mark the first syllable of the score (set to true until we start work on the first syllable, false afterwards).
1782
1783 \macroname{\textbackslash ifgre@endofscore}{}{gregoriotex-syllable.tex}
1784 Boolean to mark the last syllable of the score.
1785
1786 \macroname{\textbackslash ifgre@firstglyph}{}{gregoriotex-syllable.tex}
1787 Boolean that tells us if the current glyph is the first glyph or not.
1788
1789 \macroname{\textbackslash ifgre@rewritesyllables}{}{gregoriotex-syllable.tex}
1790 Boolean that enables moving the last part of a syllable to the next if there is no hyphen.
1791
1792 \macroname{\textbackslash gre@attr@dash}{}{gregoriotex-main.tex}
1793 A Lua\TeX\ attribute which indicates whether a syllable takes a dash if it ends a line.
1794
1795 \macroname{\textbackslash gre@attr@center}{}{gregoriotex-main.tex}
1796 A Lua\TeX\ attribute which indicates the type of translation centering.
1797
1798 \macroname{\textbackslash gre@attr@glyph@id}{}{gregoriotex-main.tex}
1799 A Lua\TeX\ attribute which identifies the glyph we are at. Used for dynamic line spacing.
1800
1801 \macroname{\textbackslash gre@attr@glyph@top}{}{gregoriotex-main.tex}
1802 A Lua\TeX\ attribute which identifies the high point of the glyph. Used for dynamic line spacing.
1803
1804 \macroname{\textbackslash gre@attr@glyph@bottom}{}{gregoriotex-main.tex}
1805 A Lua\TeX\ attribute which identifies the low point of the glyph. Used for dynamic line spacing.
1806
1807 \macroname{\textbackslash gre@attr@syllable@id}{}{gregoriotex-main.tex}
1808 A Lua\TeX\ attribute which identifies one syllable from the next. Used to position the text after the center of a syllable on the next syllable if the text flows properly, in order to improve ligaturing.
1809
1810 \macroname{\textbackslash gre@clivisalignment}{}{gregoriotex-syllable.tex}
1811 Count to indicate how the clivis is to be aligned with its respective syllable text. Values: \texttt{0}) always align clivis on its center; \texttt{1}) align clivis on first punctum; \texttt{2}) align clivis on its center, except if notes would go left of text or consonants after vowels are larger than \verb=\gre@dimen@clivisalignmentmin=.
1812
1813 \macroname{\textbackslash gre@insidediscretionary}{}{gregoriotex-signs.tex}
1814 Macro which indicates whether we are currently inside a discretionary (\texttt{1}) or not (\texttt{0}). Cannot be converted to a \TeX\ boolean because it’s value needs to be passed to Lua.
1815
1816 \macroname{\textbackslash ifgre@in@custos}{}{gregoriotex-signs.tex}
1817 Boolean which indicates whether typesetting is currently in the context of a custos.
1818
1819 \macroname{\textbackslash ifgre@isonaline}{}{gregoriotex-syllable.tex}
1820 Boolean which indicates whether the current note is on a line or not (used to adjust the height of some symbols so they won’t print on a line).
1821
1822 \macroname{\textbackslash ifgre@lastendswithmora}{}{gregoriotex-syllable.tex}
1823 Boolean which indicates if the previous syllable ends with a punctum mora (set glyph by glyph, do not rely on it when typesetting glyph).
1824
1825 \macroname{\textbackslash ifgre@thisendswithmora}{}{gregoriotex-syllable.tex}
1826 Same as previous one but for current syllable.
1827
1828 \macroname{\textbackslash ifgre@ledgerline@above}{}{gregoriotex-spaces.tex}
1829 Boolean which indicates whether the system should act as if there is a ledger line above the staff.
1830
1831 \macroname{\textbackslash ifgre@ledgerline@below}{}{gregoriotex-spaces.tex}
1832 Boolean which indicates whether the system should act as if there is a ledger line below the staff.
1833
1834 \macroname{\textbackslash gre@nlbstate}{}{gregoriotex-main.tex}
1835 Macro which indicates if we are in a no line break area due to translation centering (\texttt{1}), an explicit no line break designation in the gabc (\texttt{2}), or not at all (\texttt{0}).
1836
1837 \macroname{\textbackslash gre@nlbinitialstate}{}{gregoriotex-main.tex}
1838 Macro to store \verb=\gre@nlbstate= as we initialize or end a no line break area so that we can manipulate said flag as part of the process.
1839
1840 \macroname{\textbackslash ifgre@useledgerlineheuristic}{}{gregoriotex-spaces.tex}
1841 Boolean which specifies whether ledger line heuristics will be used or not.
1842
1843 \macroname{\textbackslash ifgre@usestylefont}{}{gregoriotex-main.tex}
1844 Boolean which specifies whether the style font should be loaded or not.
1845
1846 \macroname{\textbackslash ifgre@loadholehollowfonts}{}{gregoriotex-main.tex}
1847 Boolean which specifies whether the hole and hollow fonts should be loaded or not.
1848
1849 \macroname{\textbackslash ifgre@keeprightbox}{}{gregoriotex-signs.tex}
1850 Boolean which specifies if we have to keep the localrightbox until the end.
1851
1852 \macroname{\textbackslash gre@compilegabc}{}{gregoriotex-main.tex}
1853 Macro which specifies the default compilation behavior: never compile (\texttt{0}), auto compile (\texttt{1}), or always compile (\texttt{2}).
1854
1855 \macroname{\textbackslash ifgre@nabcfontloaded}{}{gregoriotex-nabc.tex}
1856 Boolean which indicates whether the \texttt{nabc} font has been loaded.
1857
1858 \macroname{\textbackslash gre@generate@pointandclick}{}{gregoriotex-syllable.tex}
1859 Count which indicates whether the point-and-click functionality should be implemented (\texttt{1}) or not (\texttt{0}). Not a boolean because it needs to be readable by Lua.
1860
1861 \macroname{\textbackslash gre@variableheightexpansion}{}{gregoriotex-main.tex}
1862 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.
1863
1864 \macroname{\textbackslash ifgre@usecustosalteration}{}{gregoriotex-signs.tex}
1865 Boolean which indicates whether alterations should be printed for custodes.
1866
1867 \macroname{\textbackslash ifgre@blockeolcustos}{}{gregoriotex-main.tex}
1868 Boolean which indicates whether the custos at the end of the line should be blocked.
1869
1870 \macroname{\textbackslash ifgre@blockeolcustosbeforeeuouae}{}{gregoriotex-main.tex}
1871 Boolean which indicates whether the custos at the end of the line should be blocked if a EUOUAE block immediately follows.
1872 \macroname{\textbackslash ifgre@blockeolcustos}{}{gregoriotex-main.tex}
1873 Boolean which indicates whether the custos at the end of the line should be blocked.
1874
1875
1876 \macroname{\textbackslash ifgre@raggedbreakbeforeeuouae}{}{gregoriotex-main.tex}
1877 Boolean which indicates whether an automatic line break immediately before a EUOUAE block should be ragged.
1878
1879 \macroname{\textbackslash ifgre@breakintranslation}{}{gregoriotex-main.tex}
1880 Boolean which indicates if line breaks are allowed inside a translation.
1881
1882 \macroname{\textbackslash ifgre@bolshiftsenabled}{}{gregoriotex-main.tex}
1883 Boolean which indicates if the left shift for the first syllables of lines is enabled.
1884
1885 \macroname{\textbackslash ifgre@eolshiftsenabled}{}{gregoriotex-main.tex}
1886 Boolean which indicates if the left shift for the last syllables of lines is enabled.
1887
1888 \macroname{\textbackslash ifgre@euouae@implies@nlba}{}{gregoriotex-main.tex}
1889 Boolean which indicates if line breaks are prohibited in an \texttt{euouae} area.
1890
1891 \macroname{\textbackslash ifgre@in@euouae}{}{gregoriotex-main.tex}
1892 Boolean which indicates that we are in an \texttt{euouae} area.
1893
1894 \macroname{\textbackslash ifgre@justifylastline}{}{gregoriotex-main.tex}
1895 Boolean which indicates that the last line of the score should be justified.
1896
1897 \macroname{\textbackslash ifgre@showclef}{}{gregoriotex-main.tex}
1898 Boolean which indicates that the clef should be visible.
1899
1900 \macroname{\textbackslash ifgre@forceemptyfirstsyllablehyphen}{}{gregoriotex-syllable.tex}
1901 Boolean which indicates that a hyphen after an empty first syllable should be forced.
1902
1903 \macroname{\textbackslash ifgre@showhyphenafterthissyllable}{}{gregoriotex-syllable.tex}
1904 Boolean set and used by \verb=\GreSyllable= to decide if a hyphen should be shown after the syllable.
1905
1906 \macroname{\textbackslash ifgre@possibleluahyphenafterthissyllable}{}{gregoriotex-syllable.tex}
1907 Boolean set by \verb=\GreSyllable= indicating if the Lua pass may add an hyphen after the syllable, used by \verb=\gre@calculate@eolshift= for protrusion calculation.
1908
1909 \macroname{\textbackslash ifgre@scale@stafflinefactor}{}{gregoriotex-spaces.tex}
1910 Boolean indicating whether the stafflinefactor should scale with changes of \texttt{grefactor}, or not.
1911
1912 \macroname{\textbackslash gre@count@shiftaftermora}{}{gregoriotex-signs.tex}
1913 Count indicating when the presence of a punctum mora at the end of a syllable should affect the spacing with the next syllable.
1914
1915 \macroname{\textbackslash gre@count@lastglyphiscavum}{}{gregoriotex-spaces.tex}
1916 Count indicating if the last glyph has a cavum (this includes flats, naturals, punctum cavum, etc.), when staff line shouldn't appear underneath this empty part. Can be:
1917 \begin{itemize}
1918 \item 0: previous and current glyph are not cavum
1919 \item 1: current glyph is (set when line is hidden, at the end of the glyph)
1920 \item 2: previous glyph is (set at beginning of glyph)
1921 \end{itemize}
1922
1923 \macroname{\textbackslash ifgre@allowdeprecated}{}{gregoriotex.sty \textup{and} gregoriotex.tex}
1924 Boolean which controls whether deprecated functions raise a warning (true) or an error (false).
1925
1926 \macroname{\textbackslash ifgre@newbarspacing}{}{gregoriotex-syllable.tex}
1927 Boolean which controls whether the new bar spacing algorithm is activated.
1928
1929 \macroname{\textbackslash ifgre@disablehepisema}{}{gregoriotex-signs.tex}
1930 Boolean to disable the printing of horizontal episemata.
1931
1932 \macroname{\textbackslash ifgre@disablemora}{}{gregoriotex-signs.tex}
1933 Boolean to disable the printing of punctum morae.
1934
1935 \macroname{\textbackslash ifgre@disablevepisema}{}{gregoriotex-signs.tex}
1936 Boolean to disable the printing of vertical episemata.
1937
1938 \macroname{\textbackslash gre@lasteuouaeindex}{}{gregoriotex-main.tex}
1939 Count which keeps track of the most recent euouae area.
1940
1941 \macroname{\textbackslash ifgre@firstin@euouae}{}{gregoriotex-main.tex}
1942 Boolean indicating we're dealing with the first syllable in an euouae area.
1943
1944 \macroname{\textbackslash ifgre@gabcforcecenters}{}{gregoriotex-syllable.tex}
1945 Boolean for determining whether forced centers in gabc are allowed to determine syllable alignment in \texttt{syllable} and \texttt{firstletter} alignment modes.
1946
1947 \macroname{\textbackslash ifgre@forcedcentering}{}{gregoriotex-syllable.tex}
1948 Boolean indicating that the current syllable had a forced center in the gabc which is to be respected.
1949
1950 \macroname{\textbackslash ifgre@nextforcedcentering}{}{gregoriotex-syllable.tex}
1951 Boolean indicating that the next syllable had a forced center in the gabc which is to be respected.
1952
1953 \macroname{\textbackslash ifgre@unbreakableendofelement}{}{gregoriotex-main.tex}
1954 Boolean used by \verb=\GreEndOfElement= to store whether the line may be broken at that point.
1955
1956 \macroname{\textbackslash gre@unbreakableendofelement@unison}{}{gregoriotex-main.tex}
1957 Alias that sets \verb=\ifgre@unbreakableendofelement= according to the
1958 \verb=\setunisonbreakbehavior= preference.
1959
1960 \macroname{\textbackslash gre@count@syllablenotes}{}{gregoriotex-syllable.tex}
1961 Count containing the number of notes in the syllable.
1962
1963 \macroname{\textbackslash gre@count@unbreakabletotalnotes}{}{gregoriotex-syllable.tex}
1964 Count containing the minimum number of notes in the syllable before the syllable
1965 may be broken across lines.
1966
1967 \macroname{\textbackslash gre@count@unbreakableinitialnotes}{}{gregoriotex-syllable.tex}
1968 Count containing the minimum number of notes at the start of a syllable that
1969 must be kept together when the syllable is broken across lines.
1970
1971 \macroname{\textbackslash gre@count@unbreakablefinalnotes}{}{gregoriotex-syllable.tex}
1972 Count containing the minimum number of notes at the end of a syllable that must
1973 be kept together when the syllable is broken across lines.
1974
1975 \macroname{\textbackslash ifgre@shownotes}{}{gregoriotex-syllable.tex}
1976 Boolean indicating whether the notes should be shown.
1977
1978 \macroname{\textbackslash ifgre@nabcvoice@i@visible}{}{gregoriotex-nabc.tex}
1979 Boolean indicating whether the first nabc voice should be shown.
1980
1981 \macroname{\textbackslash ifgre@showlyrics}{}{gregoriotex-syllable.tex}
1982 Boolean indicating whether the lyrics should be shown.
1983
1984 \macroname{\textbackslash ifgre@showtranslation}{}{gregoriotex-main.tex}
1985 Boolean indicating whether the translation should be shown.
1986
1987 \macroname{\textbackslash ifgre@showabovelinestext}{}{gregoriotex-main.tex}
1988 Boolean indicating whether the above lines text should be shown.
1989
1990 \macroname{\textbackslash gre@count@initiallines}{}{gregoriotex-syllable.tex}
1991 Number of lines the initial takes up.
1992
1993 \macroname{\textbackslash gre@count@initialanchor}{}{gregoriotex-main.tex}
1994
1995 What part of the initial is aligned to \verb|\gre@count@initialposition|:
1996 0 = top of initial (\texttt{top}); 1 = baseline of initial (\texttt{baseline}); 2 = bottom of initial (\texttt{bottom}).
1997
1998 \macroname{\textbackslash gre@count@initialposition}{}{gregoriotex-main.tex}
1999
2000 The position where the initial appears.
2001 0 = top of first line (\texttt{firsttop}), that is, the top staff-line; 1 = baseline of first line (\texttt{firstbaseline}); 2 = baseline of last indented line (\texttt{lastbaseline}); 3 = bottom of last indented line (\texttt{lastbottom}).
2002
2003 \macroname{\textbackslash ifgre@rewritethissyllable}{}{gregoriotex-syllable.tex}
2004 Boolean indicating that a syllable should be rewritten to improve ligature rendering.
2005
2006 \macroname{\textbackslash ifgre@textcleared}{}{gregoriotex-syllable.tex}
2007 Boolean indicating that the text of this syllable should not overlap any previous syllable.
2008
2009 \macroname{\textbackslash ifgre@evaluatingnextsyllable}{}{gregoriotex-syllable.tex}
2010 Boolean indicating that some aspect of the next syllable is being evaluated in advance.
2011
2012 \macroname{\textbackslash ifgre@noteadditionalspacelinestext}{}{gregoriotex-main.tex}
2013 Boolean indicating that the additional space needed between the notes and the lyrics due to really low notes should follow the user setting of noteadditionalspacelinestext (as opposed to being calculated automatically, the default).
2014
2015 \macroname{\textbackslash gre@count@stafflines}{}{gregoriotex-main.tex}
2016 Count containing the number of staff lines.
2017
2018 \macroname{\textbackslash ifgre@alteration@effect@note}{}{gregoriotex-signs.tex}
2019 Boolean indicating that soft alterations should last until they apply to a single note (i.e. all soft alterations will be printed).
2020
2021 \macroname{\textbackslash gre@attr@alteration@id}{}{gregoriotex-main.tex}
2022 Unique identifier of an alteration, numbered consecutively starting from 1. If an
2023 alteration is set twice, once for measurement and once for printing,
2024 they have the same id (unlike glyph ids).
2025
2026 \macroname{\textbackslash gre@attr@alteration@pitch}{}{gregoriotex-main.tex}
2027 \vspace*{-10ex}%
2028 \macroname{\textbackslash gre@attrid@alteration@pitch}{}{gregoriotex-main.tex}
2029 \vspace*{-10ex}%
2030 \macroname{\textbackslash gre@attr@alteration@type}{}{gregoriotex-main.tex}
2031 \vspace*{-10ex}%
2032 \macroname{\textbackslash gre@attrid@alteration@type}{}{gregoriotex-main.tex}
2033 The pitch and type of an alteration. For alteration types, please see Section~\ref{alterationtype}. The control sequences with \verb|attr| in their name are attributes, while those with \verb|attrid| in their names are attribute numbers (for use with \verb|\hbox attr|).
2034
2035 \macroname{\textbackslash ifgre@alteration@isvisible}{}{gregoriotex-signs.tex}
2036 Flag returned by \verb|gre@alteration@isvisible|.
2037
2038 \macroname{\textbackslash ifgre@alteration@effect@line}{}{gregoriotex-signs.tex}
2039 Boolean indicating that soft alterations should last until the end of line.
2040
2041 \macroname{\textbackslash gre@count@parsecommas@cur}{}{gregoriotex-common.tex}
2042 Internal to \verb|\gre@parsecommas|.
2043
2044 \macroname{\textbackslash gre@alteration@effect@process}{}{gregoriotex-signs.tex}
2045 Internal to \verb|\gresetalterationeffect|.
2046
2047 \macroname{\textbackslash gre@nextalteration}{}{gregoriotex-syllable.tex}
2048 \vspace*{-10ex}%
2049 \macroname{\textbackslash gre@nextalignment}{}{gregoriotex-syllable.tex}
2050 Internal to \verb|\gre@syllable@act|.
2051
2052 \macroname{\textbackslash gre@attr@part}{}{gregoriotex-main.tex}
2053 \vspace*{-10ex}%
2054 \macroname{\textbackslash gre@attrid@part}{}{gregoriotex-main.tex}
2055 An attribute to mark various parts of the score. \verb|gre@attr@part| is the attribute, while \verb|gre@attrid@part| is the attribute number (to be used with \verb|\hbox attr|).
2056 1 = commentary, 2 = stafflines, 3 = initial.
2057
2058 \subsection{Boxes}
2059
2060 Boxes are used to store elements of the score before they are printed for the purposes of reusing them and/or measuring them in order to determine their appropriate placement.
2061
2062 \macroname{\textbackslash gre@box@hep}{}{gregoriotex-chars.tex}
2063 Box for horizontal episemi.
2064
2065 \macroname{\textbackslash gre@box@temp@width}{}{gregoriotex-main.tex}
2066 Box for holding an element in order to determine its width.
2067
2068 \macroname{\textbackslash gre@box@initial}{}{gregoriotex-main.tex}
2069 Box which holds the initial of the score.
2070
2071 \macroname{\textbackslash gre@box@annotation}{}{gregoriotex-main.tex}
2072 Box holding the annotation which goes above the initial.
2073
2074 \macroname{\textbackslash gre@box@commentary}{}{gregoriotex-main.tex}
2075 Box holding the commentary which goes above the first staff line on the right.
2076
2077 \macroname{\textbackslash gre@box@add}{}{gregoriotex-main.tex}
2078 Box used for the new line to be added to the box being built (used in multi-line commentaries and annotations).
2079
2080 \macroname{\textbackslash gre@box@old}{}{gregoriotex-main.tex}
2081 Box used for the existing lines in the box being build when a new line is being added (used in multi-line commentaries and annotations).
2082
2083 \macroname{\textbackslash gre@box@lines}{}{gregoriotex-main.tex}
2084 Box holding the staff lines.
2085
2086 \macroname{\textbackslash gre@box@temp@sign}{}{gregoriotex-signs.tex}
2087 Box to hold a sign so we can measure it for placement.
2088
2089 \macroname{\textbackslash gre@box@temp@clef}{}{gregoriotex-signs.tex}
2090 Box for holding (and measuring) the clef when stacking non-overlapping clefs.
2091
2092 \macroname{\textbackslash gre@box@temp@cleftwo}{}{gregoriotex-signs.tex}
2093 Box for holding (and measuring) the secondary clef when stacking non-overlapping clefs.
2094
2095 \macroname{\textbackslash gre@box@syllablenotes}{}{gregoriotex-syllable.tex}
2096 Box holding the notes associated with a syllable.
2097
2098 \macroname{\textbackslash gre@box@syllabletext}{}{gregoriotex-syllable.tex}
2099 Box holding the text associated with a syllable.
2100
2101 \macroname{\textbackslash gre@box@hep}{}{gregoriotex-chars.tex}
2102 Box holding the horizontal episema.
2103
2104
2105 \subsection{Protrusion factors}
2106
2107
2108 \macroname{\textbackslash gre@protrusionfactor@...}{}{gregoriotex-spaces.tex}
2109 Macros that store the protrusion factors created by
2110 \verb=\gresetprotrusionfactor=.
2111
2112
2113 \subsection{Distances}
2114
2115 \macroname{\textbackslash gre@createdim}{\{\#1\}\{\#2\}\{\#3\}}{gregoriotex-spaces.tex}
2116 Macro to create one of Gregorio\TeX’s distances. Used to initialize distances in \textit{gregoriotex-gsp-default.tex}.
2117
2118 \begin{argtable}
2119 \#1 & string & The name of the distance to be changed. See \nameref{distances} below.\\
2120 \#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.\\
2121 \#3 & \texttt{fixed} & Distance will not scale when staff size is changed.\\
2122 & \texttt{scalable} & Distance will scale when staff size is changed.\\
2123 & \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.
2124 \end{argtable}
2125
2126
2127
2128 All of the distances listed in \nameref{distances} have an internal associated
2129 with them, of the form of \verb=\gre@space@*@*=, which stores the value of the
2130 distance (in string representation). The first wildcard is either
2131 \texttt{skip} or \texttt{dimen} according to the distance type, while the
2132 second is the name of the distance.
2133
2134 These additional distances are calculated by Gregorio based on the values for the user customizable distances and what may be going on in the score at the time of their use.
2135
2136 \macroname{\textbackslash gre@dimen@morawidth}{}{gregoriotex-spaces.tex}
2137 Width of a punctum mora (reinitialized at each score, lazily recomputed).
2138
2139 \macroname{\textbackslash gre@dimen@clefwidth@current}{}{gregoriotex-spaces.tex}
2140 Width of the current clef.
2141
2142 \macroname{\textbackslash gre@dimen@clefwidth@largest}{}{gregoriotex-spaces.tex}
2143 Width of the largest clef in the score.
2144
2145 \macroname{\textbackslash gre@dimen@clefwidth@bol}{}{gregoriotex-spaces.tex}
2146 Width of the clef used to compute bolshift.
2147
2148 \macroname{\textbackslash gre@dimen@constantglyphraise}{}{gregoriotex-spaces.tex}
2149 Dimension representing the space between the 0 of the gregorian fonts and the effective 0 of the TeX score.
2150
2151 \macroname{\textbackslash gre@dimen@currenttranslationheight}{}{gregoriotex-spaces.tex}
2152 Dimension representing the space for the translation beneath the text.
2153
2154 \macroname{\textbackslash gre@dimen@stafflinewidth}{}{gregoriotex-spaces.tex}
2155 Dimension representing the width of a line of staff. Can vary, for
2156 example, at the first line.
2157
2158 \macroname{\textbackslash gre@dimen@linewidth}{}{gregoriotex-spaces.tex}
2159 Dimension representing the width of the score (including initial).
2160
2161 \macroname{\textbackslash gre@dimen@additionalbottomspace}{}{gregoriotex-spaces.tex}
2162 Dimension representing extra space below the staff needed for low notes.
2163
2164 \macroname{\textbackslash gre@dimen@additionaltopspace}{}{gregoriotex-spaces.tex}
2165 Dimension representing extra space above the staff needed for high notes.
2166
2167 \macroname{\textbackslash gre@dimen@additionaltopspacealt}{}{gregoriotex-spaces.tex}
2168 Dimension representing extra space above the staff needed for above lines text.
2169
2170 \macroname{\textbackslash gre@dimen@additionaltopspacenabc}{}{gregoriotex-spaces.tex}
2171 Dimension representing extra space above the staff needed for nabc notation.
2172
2173 \macroname{\textbackslash gre@dimen@textlower}{}{gregoriotex-spaces.tex}
2174 Dimension representing the height of the separation between the 0th
2175 line (which is invisible except for notes in the a or b position) and
2176 the bottom of the text.
2177
2178 \macroname{\textbackslash gre@dimen@textaligncenter}{}{gregoriotex-spaces.tex}
2179 Dimension representing the width from the beginning of the letters in
2180 a syllable to the middle of the middle letters. Used for lining up
2181 neumes and syllables.
2182
2183 \macroname{\textbackslash gre@dimen@initialwidth}{}{gregoriotex-spaces.tex}
2184 Dimension representing the width of the initial (and the space after).
2185
2186 \macroname{\textbackslash gre@dimen@currentabovelinestextheight}{}{gregoriotex-spaces.tex}
2187 Dimension representing the space allocated above the lines for text.
2188
2189 \macroname{\textbackslash gre@dimen@staffheight}{}{gregoriotex-spaces.tex}
2190 The total height of the staff including the width of the lines and the spaces between them.
2191
2192 \macroname{\textbackslash gre@dimen@stafflinediff}{}{gregoriotex-spaces.tex}
2193 Distance representing the difference between the actual size of the staff lines and the ``standard’’ size.
2194
2195 \macroname{\textbackslash gre@dimen@stafflineheight}{}{gregoriotex-spaces.tex}
2196 The height of the staff line.
2197
2198 \macroname{\textbackslash gre@dimen@interstafflinespace}{}{gregoriotex-spaces.tex}
2199 The space between the lines.
2200
2201 \macroname{\textbackslash gre@dimen@glyphraisevalue}{}{gregoriotex-spaces.tex}
2202 The value that a particular glyph must be raised to be set in the correct position.
2203
2204 \macroname{\textbackslash gre@dimen@enddifference}{}{gregoriotex-spaces.tex}
2205 Distance from the end of the notes to the end of the text for the previous syllable. Positive values when notes go further than text, negative in the other case. This means that \verb=\kern\gre@dimen@enddifference= will take you from the end of the text to the end of the notes.
2206
2207 For regular syllables and bar syllables using the old bar spacing algorithm this is calculated using \verb=\gre@calculate@enddifference=. For bar syllables using the new bar spacing algorithm the calculation is \texttt{\small-\pmac{wd}\pmac{gre@box@syllabletext} - \pmac{gre@dimen@begindifference} + \pmac{wd}\pmac{gre@box@syllablenotes}}
2208
2209 \macroname{\textbackslash gre@dimen@previousenddifference}{}{gregoriotex-spaces.tex}
2210 Stored value of enddifference prior to the current one.
2211
2212 \macroname{\textbackslash gre@dimen@adjustedpreviousenddifference}{}{gregoriotex-spaces.tex}
2213 Stored value of enddifference prior to the current one after adjusting for the possibility of a punctum mora at the end of the last syllable (and the setting of \verb=\gre@count@aftermorashift=.
2214
2215 \macroname{\textbackslash gre@skip@nextbegindifference}{}{gregoriotex-spaces.tex}
2216 The difference between the start of the notes and the start of the text for the next syllable. Positive when when text begins first, negative in other case.
2217
2218 \macroname{\textbackslash gre@skip@adjustednextbegindifference}{}{gregoriotex-spaces.tex}
2219 Only used in new bar spacing algorithm. It is \verb=grebegindifference= adjusted with \verb=alterationadjustmentbar= if relevant.
2220
2221 \macroname{\textbackslash gre@dimen@begindifference}{}{gregoriotex-spaces.tex}
2222 The difference between the start of the notes and the start of the text for the current syllable. Positive when when text begins first, negative in other case. This means that \verb=\kern\gre@dimen@begindifference= will take you from the start of the notes to the start of the text.
2223
2224 For regular syllables and bar syllables using the old bar spacing algorithm this is calculated as \texttt{\small\pmac{gre@dimen@notesaligncenter} - \pmac{gre@dimen@textaligncenter}}. For bar syllables using the new bar spacing algorithm the calculation is \linebreak\texttt{\small-\pmac{wd}\pmac{gre@box@syllablenotes}/2 - \pmac{gre@dimen@bar@shift} - \pmac{gre@skip@bar@allocation} - \pmac{gre@dimen@adjustedpreviousenddifference} + \pmac{gre@skip@text@allocation} + \pmac{gre@dimen@text@shift} - \pmac{wd}\pmac{gre@box@syllabletext}/2}.
2225
2226 \macroname{\textbackslash gre@dimen@lastglyphwidth}{}{gregoriotex-spaces.tex}
2227 The width of the last glyph.
2228
2229 \macroname{\textbackslash gre@dimen@notesaligncenter}{}{gregoriotex-spaces.tex}
2230 Distance from beginning of notes to their point of alignment.
2231
2232 \macroname{\textbackslash gre@dimen@temp@...}{}{gregoriotex-spaces.tex}
2233 Temporary dimensions used in calculations. There are currently five of these.
2234
2235 \macroname{\textbackslash gre@skip@temp@...}{}{gregoriotex-spaces.tex}
2236 Temporary skips used in calculations. There are currently four of these.
2237
2238 \macroname{\textbackslash gre@dimen@eolshift}{}{gregoriotex-spaces.tex}
2239 The left kern that should appear before an end of line.
2240
2241 \macroname{\textbackslash gre@dimen@bolshift}{}{gregoriotex-spaces.tex}
2242 The left kern that should appear at the beginning of line in case of a forced line break.
2243
2244 \macroname{\textbackslash gre@dimen@bolextra}{}{gregoriotex-spaces.tex}
2245 An extra space that is added to \verb=\gre@dimen@bolshift= when the first glyph is a flat or a natural.
2246
2247 \macroname{\textbackslash gre@dimen@annotationtrueraise}{}{gregoriotex-spaces.tex}
2248 The distance from the baseline of the initial to the baseline of the annotation.
2249
2250 \macroname{\textbackslash gre@dimen@commentarytrueraise}{}{gregoriotex-spaces.tex}
2251 The distance from the baseline of the initial to the baseline of the commentary.
2252
2253 \macroname{\textbackslash gre@skip@minTextDistance}{}{gregoriotex-spaces.tex}
2254 Minimum distance between text.
2255
2256 \macroname{\textbackslash gre@skip@minNotesDistance}{}{gregoriotex-spaces.tex}
2257 Minimum distance between notes.
2258
2259 \macroname{\textbackslash gre@dimen@curTextDistance}{}{gregoriotex-spaces.tex}
2260 Current distance between text.
2261
2262 \macroname{\textbackslash gre@dimen@curNotesDistance}{}{gregoriotex-spaces.tex}
2263 Current distance between notes.
2264
2265 \macroname{\textbackslash gre@skip@minShiftText}{}{gregoriotex-spaces.tex}
2266 Minimum shift required for the text.
2267
2268 \macroname{\textbackslash gre@skip@minShiftNotes}{}{gregoriotex-spaces.tex}
2269 Minimum shift required for the notes.
2270
2271 \macroname{\textbackslash gre@scaledist}{}{gregoriotex-spaces.tex}
2272 Working alias for \verb=\gre@skip@temp@one= or \verb=\gre@dimen@temp@one=, as appropriate, used when rescaling a distance due to a change in \verb=\gre@factor=.
2273
2274 \macroname{\textbackslash gre@skip@syllablefinalskip}{}{gregoriotex-spaces.tex}
2275 The final distance to skip at the end of a syllable.
2276
2277 \macroname{\textbackslash greslurheight}{}{gregoriotex-signs.tex}
2278 Stores the computed height of a variable-length slur. The control sequence name
2279 does not have the \texttt{@} symbol because this dimension is used within \MP{}.
2280
2281 \macroname{\textbackslash gre@dimen@bar@shift}{}{gregoriotex-spaces.tex}
2282 Shift of the bar away from its center position to account for the offset limits in the new bar spacing algorithm.
2283
2284 \macroname{\textbackslash gre@dimen@text@shift}{}{gregoriotex-spaces.tex}
2285 Shift of the text away from its center position to account for the offset limits in the new bar spacing algorithm.
2286
2287 \macroname{\textbackslash gre@skip@bar@allocation}{}{gregoriotex-spaces.tex}
2288 Space allocated to the bar in the new bar spacing algorithm.
2289
2290 \macroname{\textbackslash gre@skip@bar@requirement}{}{gregoriotex-spaces.tex}
2291 Space required by the bar in the new bar spacing algorithm.
2292
2293 \macroname{\textbackslash gre@skip@text@allocation}{}{gregoriotex-spaces.tex}
2294 Space allocated to the text in the new bar spacing algorithm.
2295
2296 \macroname{\textbackslash gre@skip@text@requirement}{}{gregoriotex-spaces.tex}
2297 Space required by the text in the new bar spacing algorithm.
2298
2299 \macroname{\textbackslash gre@skip@bar@lastskip}{}{gregoriotex-signs.tex}
2300 Skip after the most recent bar.
2301
2302 \macroname{\textbackslash gre@skip@punctummorashift}{}{gregoriotex-spaces.tex}
2303 Displacement of whole syllable to account for the presence of a punctum mora at the end of the previous syllable.
2304
2305 \macroname{\textbackslash gre@skip@alterationshift}{}{gregoriotex-spaces.tex}
2306 Displacement of whole syllable to account for the presence of an alteration at the beginning of the next syllable.
2307
2308 \macroname{\textbackslash gre@dimen@stafflinethicknessbase}{}{gregoriotex-main.tex}%
2309 \vspace*{-10ex}%
2310 \macroname{\textbackslash gre@dimen@glyphraisebase}{}{gregoriotex-main.tex}%
2311 \vspace*{-10ex}%
2312 \macroname{\textbackslash gre@dimen@interstafflinedistancebase}{}{gregoriotex-main.tex}%
2313 \vspace*{-10ex}%
2314 \macroname{\textbackslash gre@dimen@inclinatumonlinemoravshiftbase}{}{gregoriotex-main.tex}%
2315 \vspace*{-10ex}%
2316 \macroname{\textbackslash gre@dimen@inclinatumonlinemorahshiftbase}{}{gregoriotex-main.tex}%
2317 \vspace*{-10ex}%
2318 \macroname{\textbackslash gre@dimen@inclinatumofflinemorahshiftbase}{}{gregoriotex-main.tex}%
2319 These distances are used to calibrate a font for use with Gregorio\TeX. Currently all of our fonts are made in house and thus use the same values for these distances, but font designers might find it useful to adjust these values to make their font compatible with Gregorio\TeX.
2320
2321
2322 \subsection{Penalties}
2323 These are the macros that Gregorio\TeX\ uses to manipulate the penalties in order to control line and page breaks within a score without affect the surrounding text.
2324
2325 \macroname{\textbackslash gre@penalty}{\#1}{gregoriotex-signs.tex}
2326 Top level function that aliases \verb=\gre@truepenalty= or \verb=\gre@falsepenalty= according to whether penalties should be in play or not.
2327
2328 \begin{argtable}
2329 \#1 & integer & The penalty to be applied or gobbled\\
2330 \end{argtable}
2331
2332 \macroname{\textbackslash gre@truepenalty}{\#1}{gregoriotex-signs.tex}
2333 Alias for \verb=\penalty=.
2334
2335 \begin{argtable}
2336 \#1 & integer & The penalty to be applied\\
2337 \end{argtable}
2338
2339 \macroname{\textbackslash gre@falsepenalty}{\#1}{gregoriotex-signs.tex}
2340 Macro to gobble (suppress) its argument.
2341
2342 \begin{argtable}
2343 \#1 & integer & The penalty to be gobbled\\
2344 \end{argtable}
2345
2346 \macroname{\textbackslash gre@cancelpenalties}{}{gregoriotex-spaces.tex}
2347 Macro called at the beginning of the score to swap text penalties for score penalties.
2348
2349 \macroname{\textbackslash gre@restorepenalties}{}{gregoriotex-spaces.tex}
2350 Macro called at the end of the score to restore the text penalties.
2351
2352 \subsection{Backwards compatibility}
2353 Depending on version of Lua\TeX / \LaTeX, some primitives have different names
2354 We define the following local aliases to account for this eventuality.
2355
2356 \macroname{\textbackslash gre@localleftbox}{}{gregoriotex-main.tex}
2357 Current primitive: \verb=\localleftbox=
2358 Legacy primitive: \verb=\luatexlocalleftbox=
2359
2360 \macroname{\textbackslash gre@localrightbox}{}{gregoriotex-main.tex}
2361 Current primitive: \verb=\localrightbox=
2362 Legacy primitive: \verb=\luatexlocalrightbox=
2363
2364 \macroname{\textbackslash gre@startlink}{}{gregoriotex-main.tex}
2365 Current primitive: \verb=\pdfextension startlink=
2366 Legacy primitive: \verb=\pdfstartlink=
2367
2368 \macroname{\textbackslash gre@endlink}{}{gregoriotex-main.tex}
2369 Current primitive: \verb=\pdfextension endlink=
2370 Legacy primitive: \verb=\pdfendlink=
2371
2372 \macroname{\textbackslash gre@savepos}{}{gregoriotex-main.tex}
2373 Current primitive: \verb=\savepos=
2374 Legacy primitive: \verb=\pdfsavepos=
2375
2376 \macroname{\textbackslash gre@lastxpos}{}{gregoriotex-main.tex}
2377 Current primitive: \verb=\lastxpos=
2378 Legacy primitive: \verb=\pdflastxpos=
2379
2380 \macroname{\textbackslash gre@lastypos}{}{gregoriotex-main.tex}
2381 Current primitive: \verb=\lastypos=
2382 Legacy primitive: \verb=\pdflastypos=
2383
2384
2385 \subsection{\LaTeX/Plain \TeX\ compatibility}
2386 While every effort has been made to use only primitives which are compatible with both \LaTeX\ and Plain \TeX, it is sometimes necessary to use primitives which are defined for one but not the other (usually its \LaTeX\ that has what we need built in). In these cases we have to provide an equivalent macro to the \TeX\ version which is lacking.
2387
2388 \macroname{\textbackslash MessageBreak}{}{gregoriotex.tex}
2389 Creates a line break in typeout, warning, bug, and error messages. Copied from \LaTeX\ source.
2390
2391 \macroname{\textbackslash protect}{}{gregoriotex.tex}
2392 Prints the name of the macro, rather than its contents in typeout, warning, bug, and error messages. Copied from \LaTeX\ source.
2393
2394 \macroname{\textbackslash f@size}{}{gregoriotex.tex}
2395 Macro which stores the current font size.
2396
2397
2398 \section{Special arguments}
2399
2400 These arguments are used by multiple functions and take a lot of space
2401 to describe so we describe them once here and refer to this section
2402 rather than have multiple definitions.
2403
2404 \subsection{Note Alignment Type}\label{notesalign}
2405 \rowcolors{1}{lightgray}{lightgray}
2406 \begin{tabulary}{\textwidth}{cL}
2407 \multicolumn{2}{c}{Integer with the following possibilities:} \\
2408 \hline
2409 \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\\
2410 \texttt{1} & two notes glyph (podatus is considered as a one-note glyph) : here we put the aligncenter in the middle of the glyph\\
2411 \texttt{2} & porrectus : has a special align center\\
2412 \texttt{3} & initio-debilis : same as 1 but the first note is much smaller\\
2413 \texttt{4} & case of a glyph starting with a quilisma\\
2414 \texttt{5} & case of a glyph starting with an oriscus\\
2415 \texttt{6} & case of a punctum inclinatum\\
2416 \texttt{7} & case of a stropha\\
2417 \texttt{8} & flexus with an ambitus of one\\
2418 \texttt{9} & flexus deminutus\\
2419 \texttt{10} & virgula\\
2420 \texttt{11} & divisio minima/minimis\\
2421 \texttt{12} & divisio minor\\
2422 \texttt{13} & divisio maior\\
2423 \texttt{14} & dominican bar\\
2424 \texttt{15} & parenthesized virgula\\
2425 \texttt{16} & parenthesized divisio minima\\
2426 \texttt{17} & divisio finalis\\
2427 \texttt{18} & no note
2428 \end{tabulary}
2429
2430 \subsection{Alteration Type}\label{alterationtype}
2431 \rowcolors{1}{lightgray}{lightgray}
2432 \begin{tabulary}{\textwidth}{cL}
2433 \multicolumn{2}{c}{Integer with the following possibilities:} \\
2434 \hline
2435 \texttt{0} & no alteration\\
2436 \texttt{1} & flat\\
2437 \texttt{2} & natural\\
2438 \texttt{3} & sharp\\
2439 \texttt{4} & parenthesized flat\\
2440 \texttt{5} & parenthesized natural\\
2441 \texttt{6} & parenthesized sharp \\
2442 \texttt{7} & soft flat\\
2443 \texttt{8} & soft natural\\
2444 \texttt{9} & soft sharp\\
2445 \end{tabulary}
2446
2447 \subsection{Note Offset Specifier}\label{NoteOffset}
2448 \definecolor{shadecolor}{named}{lightgray}%
2449 \begin{shaded*}%
2450 \vspace{-1.4\baselineskip}
2451 \begin{center}String with the following possibilities:\end{center}
2452 \vspace{-0.8\baselineskip}
2453 \hrule
2454 \vspace{-0.8\baselineskip}
2455 \begin{description}
2456 \item[FinalPunctum] Last note, which is a standard punctum (works with pes).
2457 \item[FinalDeminutus] Same, but the last note is a deminutus.
2458 \item[PenultBeforePunctumWide] The note before the last note, which is a standard punctum.
2459 \item[PenultBeforeDeminutus] Idem, but the note is the note preceding a deminutus.
2460 \item[AntepenultBeforePunctum] The note before the note before the last note (for porrectus flexus).
2461 \item[AntepenultBeforeDeminutus] Idem, but when the two last notes are a deminutus.
2462 \item[InitialPunctum] The first note, if it is a standard punctum.
2463 \item[InitioDebilis] The first note, if it is an initio debilis.
2464 \item[PorrNonAuctusInitialWide] first note of a non-auctus porrectus with a second ambitus of at least two.
2465 \item[PorrNonAuctusInitialOne] first note of a non-auctus porrectus with a second ambitus of one
2466 \item[PorrAuctusInitialAny] first note of an auctus porrectus, regardless of second ambitus
2467 \item[FinalInclinatum] punctum inclinatum as last note
2468 \item[FinalInclinatumDeminutus] punctum inclinatum deminutus as last note
2469 \item[FinalStropha] stropha as last note
2470 \item[FinalQuilisma] quilisma as last note
2471 \item[FinalOriscus] oriscus as last note
2472 \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)
2473 \item[FinalUpperPunctum] “upper smaller punctum” as last note (concerning simple podatus, podatus, and torculus resupinus)
2474 \item[InitialOriscus] oriscus as first note, disconnected from next note
2475 \item[InitialQuilisma] quilisma as first note, disconnected from next note
2476 \item[TorcResNonAuctusSecondWideWide] second note of a non-auctus torculus resupinus starting with a punctum, with a first and second ambitus of at least two
2477 \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
2478 \item[TorcResDebilisNonAuctusSecondAnyWide] second note of a non-auctus torculus resupinus initio debilis with any first ambitus and a second ambitus of at least two
2479 \item[FinalLineaPunctum] linea punctum (cavum) as last note
2480 \item[BarStandard] standard bar
2481 \item[BarParen] parenthesized bar
2482 \item[BarVirgula] virgula
2483 \item[BarVirgulaParen] parenthesized virgula
2484 \item[BarDivisioFinalis] divisio finalis
2485 \item[TorcResQuilismaNonAuctusSecondWideWide] second note of a non-auctus torculus resupinus starting with a quilisma, with a first and second ambitus of at least two
2486 \item[TorcResOriscusNonAuctusSecondWideWide] second note of a non-auctus torculus resupinus starting with an oriscus, with a first and second ambitus of at least two
2487 \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
2488 \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
2489 \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
2490 \item[TorcResDebilisNonAuctusSecondAnyOne] second note of a non-auctus torculus resupinus initio debilis with any first ambitus and a second ambitus of one
2491 \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
2492 \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
2493 \item[TorcResNonAuctusSecondOneOne] second note of a non-auctus torculus resupinus starting with a punctum, with a first and second ambitus of one
2494 \item[TorcResQuilismaNonAuctusSecondOneOne] second note of a non-auctus torculus resupinus starting with a quilisma, with a first and second ambitus of one
2495 \item[TorcResOriscusNonAuctusSecondOneOne] second note of a non-auctus torculus resupinus starting with an oriscus, with a first and second ambitus of one
2496 \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
2497 \item[TorcResDebilisAuctusSecondAnyAny] second note of an auctus torculus resupinus initio debilis with any first and second ambitus
2498 \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
2499 \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
2500 \item[TorcResAuctusSecondOneAny] second note of an auctus torculus resupinus starting with a punctum, with a first ambitus of one and any second ambitus
2501 \item[TorcResQuilismaAuctusSecondOneAny] second note of an auctus torculus resupinus starting with a quilisma, with a first ambitus of one and any second ambitus
2502 \item[TorcResOriscusAuctusSecondOneAny] second note of an auctus torculus resupinus starting with an oriscus, with a first ambitus of one and any second ambitus
2503 \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})
2504 \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})
2505 \item[InitialConnectedPunctum] standard punctum as first note, connected to next higher note
2506 \item[InitialConnectedVirga] “virga” as first note, connected to next lower note
2507 \item[InitialConnectedQuilisma] quilisma as first note, connected to next higher note
2508 \item[InitialConnectedOriscus] oriscus as first note, connected to next higher note
2509 \item[FinalConnectedPunctum] punctum as last note, connected to prior higher note
2510 \item[FinalConnectedAuctus] auctus as last note, connected to prior lower note
2511 \item[FinalVirgaAuctus] virga aucta as last note
2512 \item[FinalConnectedVirga] “virga” as last note, connected to prior lower note
2513 \item[InitialVirga] “virga” as first note, disconnected from next note
2514 \end{description}
2515 \end{shaded*}
2516
2517 \subsection{Debug Category}\label{DebugCategory}
2518 \definecolor{shadecolor}{named}{lightgray}%
2519 \begin{shaded*}%
2520 \vspace{-1.4\baselineskip}
2521 \begin{center}String with the following possibilities:\end{center}
2522 \vspace{-0.8\baselineskip}
2523 \hrule
2524 \vspace{-0.8\baselineskip}
2525 \begin{description}
2526 \item[annotation] Annotation-related (text above the score initial) messages.
2527 \item[barspacing] Bar spacing computations.
2528 \item[bolshift] Beginning-of-line shift computations.
2529 \item[clear] Syllable clearing messages. Generated when handling the \texttt{<clear>} gabc directive.
2530 \item[changeglyph] Glyph changes. Generated when glyph substitutions are made.
2531 \item[commentary] Commentary-related messages.
2532 \item[compile] Auto-compile messages. Generating when handing \verb=\gregorioscore=
2533 \item[custos] Custos-related messages. Generating when computing and handling custodes.
2534 \item[eolshift] End-of-line shift computations.
2535 \item[general] Non-specific messages.
2536 \item[hyphen] Hyphen-related messages. Generated when computing and handling automatic hyphens.
2537 \item[ifdim] Dimension comparisons.
2538 \item[initial] Score-initial-related messages.
2539 \item[lineheight] Line height events. Generated when line heights are computed or exercised.
2540 \item[linesglue] Messages about line glue. Generated during line break processing in Lua.
2541 \item[mapfont] Font mapping messages. Generated when analyzing score fonts.
2542 \item[offsetcase] Offset case messages. Generated when the offset cases (for \Nameref{NoteOffset}) are generated in Lua.
2543 \item[spacing] Random spacing-related messages.
2544 \item[syllablerewriting] Syllable rewrite messages. Generated when rewriting syllables for better kerning and ligaturing.
2545 \item[syllablespacing] Syllable spacing computations.
2546 \item[trace] Messages to trace the calling of functions.
2547 \end{description}
2548 \end{shaded*}
2549
2550 %%% Local Variables:
2551 %%% mode: latex
2552 %%% TeX-master: “GregorioRef”
2553 %%% End: