forked from gregorio-project/gregorio
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathCommand_Index_internal.tex
2553 lines (1912 loc) · 131 KB
/
Command_Index_internal.tex
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
% !TEX root = GregorioRef.tex
% !TEX program = LuaLaTeX+se
%
% Copyright (C) 2006-2025 The Gregorio Project (see CONTRIBUTORS.md)
%
% This file is part of Gregorio.
%
% Gregorio is free software: you can redistribute it and/or modify
% it under the terms of the GNU General Public License as published by
% the Free Software Foundation, either version 3 of the License, or
% (at your option) any later version.
%
% Gregorio is distributed in the hope that it will be useful,
% but WITHOUT ANY WARRANTY; without even the implied warranty of
% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
% GNU General Public License for more details.
%
% You should have received a copy of the GNU General Public License
% along with Gregorio. If not, see <http://www.gnu.org/licenses/>.
%
\section{Gregorio\TeX{} Controls}
These functions are the ones used by Gregorio\TeX{} internally as it
process the commands listed above. They should not appear in any user
document and are listed here for programmer documentation purposes
only.
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.
\macroname{\textbackslash gre@error}{\#1}{gregoriotex.sty \textup{and} gregoriotex.tex}
Prints an error to the \TeX\ output log.
\begin{argtable}
\#1 & string & error message\\
\end{argtable}
\macroname{\textbackslash gre@warning}{\#1}{gregoriotex.sty \textup{and} gregoriotex.tex}
Prints a warning to the \TeX\ output log.
\begin{argtable}
\#1 & string & warning message\\
\end{argtable}
\macroname{\textbackslash gre@metapost}{\#1}{gregoriotex.sty \textup{and} gregoriotex.tex}
Executes \MP{} commands using luamplib.
\begin{argtable}
\#1 & \MP{} commands & The \MP{} commands to execute.
\end{argtable}
\macroname{\textbackslash gre@deprecated}{\#1\#2}{gregoriotex-common.tex}
Macro that handles deprecation messages. By default, deprecated macros
are allowed and a warning is printed. If the package option
\texttt{deprecated=false} is set, then deprecated macros raise a
package error, halting \TeX.
\begin{argtable}
\#1 & string & name of the deprecated macro\\
\#2 & string & name of the correct macro to use\\
\end{argtable}
\macroname{\textbackslash gre@obsolete}{\#1\#2}{gregoriotex-common.tex}
Macro that handles obsolescence errors.
\begin{argtable}
\#1 & string & name of the obsolete macro\\
\#2 & string & name of the correct macro to use\\
\end{argtable}
\macroname{\textbackslash gre@allowdeprecated@asboolean}{}{gregoriotex-main.tex}
Macro that evaluates \texttt{true} or \texttt{false} depending on whether
deprecated usage is allowed. This is used to pass the value of
\verb=\ifgre@allowdeprecated= to Lua.
\macroname{\textbackslash gre@loadgregoriofont}{}{gregoriotex-main.tex}
Loads the chosen font for the neumes at the correct size.
\macroname{\textbackslash gre@maketable}{\#1}{gregoriotex-main.tex}
Helper to convert a \TeX\ list into a Lua table. Used to pass \verb=\gre@input@path= to Lua.
\macroname{\textbackslash gre@input@path}{}{gregoriotex-main.tex}
Macro holding the list of directories to be searched for scores. \verb=\input@path= gets aliased to this list when inside \verb=\gregorioscore=.
\macroname{\textbackslash gre@calculate@constantglyphraise}{}{gregoriotex-spaces.tex}
Macro to calculate \verb=\gre@constantglyphraise=
\macroname{\textbackslash gre@addtranslationspace}{}{gregoriotex-spaces.tex}
Macro to tell Gregorio to set space for the translation.
\macroname{\textbackslash gre@removetranslationspace}{}{gregoriotexspaces.tex}
Macro to tell Gregorio to remove the space allocated to the translation.
\macroname{\textbackslash gre@calculate@additionalspaces}{\#1\#2\#3\#4}{gregoriotex-spaces.tex}
Macro which calculates \verb=\gre@additionalbottomspace= and\\
\verb=\gre@additionaltopspace=
\begin{argtable}
\#1 & integer & the height number of the top pitch, including signs\\
\#2 & integer & the height number of the bottom pitch, including signs\\
\#3 & \texttt{0} & there is no translation line\\
& \texttt{1} & there is a translation line\\
\#4 & \texttt{0} & there is no above lines text\\
& \texttt{1} & there is above lines text
\end{argtable}
\macroname{\textbackslash gre@calculate@textaligncenter}{\#1\#2\#3\#4}{gregoriotex-spaces.tex}
Macro for calculating \verb=\gre@textaligncenter=.
\begin{argtable}
\#1 & string & The carry-over letters from the previous syllable that should be moved to the current.\\
\#2 & string & The first part of the syllable (any preceding consonants in Latin).\\
\#3 & string & The middle part of the syllable (the vowel in Latin, the whole syllable in English).\\
\#4 & \texttt{0} & Calculation is being performed for the current syllable.\\
& \texttt{1} & Calculation is being performed for the next syllable.\\
\end{argtable}
\macroname{\textbackslash gre@calculate@annotationtrueraise}{}{gregoriotex-spaces.tex}
Macro to calculate \verb=\gre@dimen@annotationtrueraise=.
\macroname{\textbackslash gre@calculate@commentarytrueraise}{}{gregoriotex-spaces.tex}
Macro to calculate \verb=\gre@dimen@commentarytrueraise=.
\macroname{\textbackslash gre@calculate@textlower}{}{gregoriotex-spaces.tex}
Calculates the value of \texttt{textlower}. Default is \texttt{spacebeneathtext}.
\macroname{\textbackslash gre@calculate@linewidth}{}{gregoriotex-spaces.tex}
Calculates the line width. Default is the width of the printable space (\verb=\hsize=).
\macroname{\textbackslash gre@calculate@stafflinewidth}{}{gregoriotex-spaces.tex}
Calculates the width of the staff lines. Default is \texttt{linewidth}.
\macroname{\textbackslash gre@calculate@stafflineheight}{}{gregoriotex-spaces.tex}
Calculates the height (thickness) of the staff lines. Dependent on \texttt{stafflineheightfactor} and \texttt{gre@factor}.
\macroname{\textbackslash gre@calculate@interstafflinespace}{}{gregoriotex-spaces.tex}
Calculates the distance between the staff lines. Dependent on \texttt{stafflineheight} and \texttt{gre@factor}
\macroname{\textbackslash gre@calculate@stafflinediff}{}{gregoriotex-spaces.tex}
Calculates a correction factor for when the staff lines are not their default thickness. Dependent on \texttt{stafflineheight} and \texttt{gre@factor}.
\macroname{\textbackslash gre@calculate@staffheight}{}{gregoriotex-spaces.tex}
Calculates the total height of the staff. Dependent on \texttt{stafflineheight} and \texttt{interstafflinespace}.
\macroname{\textbackslash gre@calculate@constantglyphraise}{}{gregoriotex-spaces.tex}
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}.
\macroname{\textbackslash gre@computespaces}{}{gregoriotex-spaces.tex}
Aggregates all of the global distance calculations and calls them in the order needed to respect dependencies.
\macroname{\textbackslash gre@calculate@glyphraisevalue}{\#1\#2\#3}{gregoriotex-spaces.tex}
Calculates the raise value for a glyph (glyphraisevalue) based on where it is to be placed and what kind of a glyph it is. This is a time of use calculation.
\begin{argtable}
\#1 & integer & The number for where the glyph is located. \texttt{a} in gabc is \texttt{1}, \texttt{b} is \texttt{2}, \etc\\
\#2 & \texttt{0} & no modification\\
& \texttt{1} & puts the value on the interline just above if it is on a line\\
& \texttt{2} & puts the value on the interline just beneath if it is on a line\\
& \texttt{3} & case of the vertical episema, which is not placed at the same place if the corresponding note is on a line or not\\
& \texttt{4} & case of the punctum mora, for the same reason\\
& \texttt{5} & case of the horizontal episema under a note, that must be placed a bit lower if the note is on a line\\
& \texttt{6} & case of the signs above (accentus, \etc)\\
& \texttt{8} & case of the punctum mora of the first note of a podatus or the 2nd note of a porrectus, \etc\\
& \texttt{9} & case of the horizontal episema, that must be placed a bit lower if the note is on a line\\
& \texttt{10} & case of the low choral sign\\
& \texttt{11} & case of the high choral sign\\
& \texttt{12} & case of the low choral sign which is lower than the note\\
& \texttt{13} & case of the brace above the bars\\
& \texttt{14} & case of the punctum mora in a space with a note on the line below it\\
& \texttt{15} & case of the over-the-notes slur\\
& \texttt{16} & case of the under-the-notes slur\\
& \texttt{17} & case of the bracket\\
\#3 & \texttt{0} & for horizontal episema cases, use automatic positioning within the space\\
& \texttt{1} & for horizontal episema cases, position in the middle of the space\\
& \texttt{2} & for horizontal episema cases, position low within the space as if the episema is over the note\\
& \texttt{3} & for horizontal episema cases, position high within the space as if the episema is under the note\\
& \texttt{4} & for horizontal episema cases, position low within the space as if the episema is over the note\\
& \texttt{5} & for horizontal episema cases, position high within the space as if the episema is under the note\\
\end{argtable}
\macroname{\textbackslash gre@stafflinefactor}{}{gregoriotex-spaces.tex}
A number indicating the thickness of the staff lines.
\macroname{\textbackslash gre@calculate@textaligncenter}{\#1\#2\#3}{gregoriotex-spaces.tex}
Macro to calculate the distance from the beginning of the text of a syllable to its alignment point (the center of the vowel for Latin centering, the center of the syllable for English centering). This is a time of use calculation.
\begin{argtable}
\#1 & string & the first part of the syllable\\
\#2 & string & the middle part of the syllable\\
\#3 & \texttt{0} & perform this calculation for the current syllable\\
& \texttt{1} & perform this calculation for the next syllable
\end{argtable}
\macroname{\textbackslash gre@calculate@enddifference}{\#1\#2\#3\#4\#5}{gregoriotex-spaces.tex}
Calculates the difference between the end of the notes and the end of the syllable text. Also stores the value for the previous syllable if needed. This is a time of use calculation.
\begin{argtable}
\#1 & length & the total width of the notes\\
\#2 & length & the total width of the syllable text\\
\#3 & length & the alignment distance for the text (\texttt{textaligncenter})\\
\#4 & length & the alignment distance for the notes (\texttt{notesaligncenter})\\
\#5 & \texttt{0} & do not save the value for the previous syllable before calculating the new value\\
& \texttt{1} & save the value for the previous syllable before calculating the new value
\end{argtable}
The formula used is \verb=#1 - #2 + #3 - #4= or (more sensibly) \verb=(#1 - #4) - (#2 - #3)=. This is also equivalent to \verb=-#4 - \gre@dimen@begindifference + #3=, a fact we take advantage of when calculating the end difference for a bar syllable under the new bar spacing algorithm.
\macroname{\textbackslash gre@changeonedimenfactor}{\#1\#2\#3}{gregoriotex-spaces.tex}
Change the scale of a single distance from one factor to another.
\begin{argtable}
\#1 & string & name of the distance to be scaled. See \Nameref{distances}.\\
\#2 & integer & the factor the distance is currently in\\
\#3 & integer & the factor the distance is to be put into\\
\end{argtable}
\macroname{\textbackslash gre@changedimenfactor}{\#1\#2}{gregoriotex-spaces.tex}
Rescales all the distances (and \texttt{stafflinefactor}) which are supposed to scale with a change in staff size.
\begin{argtable}
\#1 & integer & the factor the distances are currently in\\
\#2 & integer & the factor the distances are to be put into\\
\end{argtable}
\macroname{\textbackslash gre@calculate@nextbegindifference}{\#1\#2\#3\#4\#5\#6}{gregoriotex-spaces.tex}
Macro to calculate \texttt{nextbegindifference}.
\begin{argtable}
\#1 & string & the carry-over letters for the next syllable\\
\#2 & string & the first letters of the next syllable\\
\#3 & string & the middle letters of the next syllable (the vowel in Latin, the whole syllable in English)\\
\#4 & string & the end letters of the next syllable\\
\#5 & integer & the type of notes alignment. See \Nameref{notesalign}.\\
\#6 & integer & the type of alteration. See \Nameref{alterationtype}.\\
\end{argtable}
\macroname{\textbackslash gre@strip@pt}{\#1}{gregoriotex.sty \textup{and} gregoriotex.tex}
Strips the units from a distance. Under \LaTeX{}, this is an alias to \verb=\strip@pt=.
\begin{argtable}
\#1 & control sequence & should be the control sequence for the the distance register (including the leading backslash)\\
\end{argtable}
\macroname{\textbackslash gre@rem@pt}{\#1}{gregoriotex.tex}
Strips the units from a distance. Used internally by \verb=\gre@strip@pt=. Under \LaTeX{}, this is not defined.
\begin{argtable}
\#1 & distance & should be in the form ``[0-9]+.[0-9]+pt’’. (\ie the result of applying \verb=\the= to a distance register)\\
\end{argtable}
\macroname{\textbackslash gre@count@temp@...}{}{gregoriotex-spaces.tex}
Temporary count used in calculations. There are currently three of these.
\macroname{\textbackslash gre@convertto}{\#1\#2}{gregoriotex-spaces.tex}
Macro which converts a distance into a particular set of units. Result is placed in \verb=\gre@converted= as a string.
\begin{argtable}
\#1 & string & two letter abbreviation for the units. Should recognize all legal \TeX\ units.\\
\#2 & distance & Distance to be converted.
\end{argtable}
\macroname{\textbackslash gre@converted}{}{gregoriotex-spaces.tex}
Macro holding result of last call to \verb=\gre@convertto=.
\macroname{\textbackslash gre@consistentunits}{\#1\#2}{gregoriotex-spaces.tex}
This function takes a distance and formats it as a string so that its units conform to the pattern set by a string representation of a distance. Result is placed in \verb=\gre@stringdist=.
\begin{argtable}
\#1 & string & the standard whose format is to be matched.\\
\#2 & distance & the distance to be adjusted.
\end{argtable}
\macroname{\textbackslash gre@stringdist}{}{gregoriotex-spaces.tex}
Macro holding result of last call to \verb=\gre@consistentunits=.
\macroname{\textbackslash gre@gregorioscore}{\#1}{gregoriotex-main.tex}
Macro that handles \verb=\gregorioscore= calls when they do not have an
optional argument.
\begin{argtable}
\#1 & string & Relative or absolute path to the score.\\
\end{argtable}
\macroname{\textbackslash gre@gregorioscore@option}{[\#1]\#2}{gregoriotex-main.tex}
Macro that handles \verb=\gregorioscore= calls when they have an optional
argument.
\begin{argtable}
\#1 & \texttt{n} & \#2 will be included as is. \\
& \texttt{a} & Gregorio\TeX\ will automatically compile gabc files if necessary.\\
& \texttt{f} & Forces Gregorio\TeX\ to compile the gabc file.\\
\#2 & string & Relative or absolute path to the score.\\
\end{argtable}
\macroname{\textbackslash gre@writemode}{\#1\#2\#3}{gregoriotex-main.tex}
Macro that writes its arguments with \verb=\greannotation=. This
macro is typically called by \verb=\GreMode= in the gtex file.
\begin{argtable}
\#1 & \TeX\ code & Mode text to place above the initial of a score in the \texttt{modeline} style.\\
\#2 & \TeX\ code & Arbitrary code to typeset, in the \texttt{modemodifier} style, after the mode text.\\
\#3 & \TeX\ code & Arbitrary code to typeset, in the \texttt{modedifferentia} style, after \#2.\\
\end{argtable}
\macroname{\textbackslash gre@setallbracerendering}{\#1}{gregoriotex-signs.tex}
Macro used by \verb=\gresetbracerendering= to change all braces.
\begin{argtable}
\#1 & \texttt{metapost} & \MP{} will be used to render braces\\
& \texttt{font} & The score font will be used to render braces\\
\end{argtable}
\macroname{\textbackslash gre@setbracerendering}{[\#1]\#2}{gregoriotex-signs.tex}
Macro used by \verb=\gresetbracerendering= to change a single type of brace.
\begin{argtable}
\#1 & \texttt{brace} & change round braces that appear over the staff\\
& \texttt{underbrace} & change round braces that appear under the staff\\
& \texttt{curlybrace} & change curly braces\\
& \texttt{barbrace} & change round braces that appear over divisio bars\\
\#2 & \texttt{metapost} & \MP{} will be used to render braces\\
& \texttt{font} & The score font will be used to render braces\\
\end{argtable}
\macroname{\textbackslash gre@@setbracerendering}{\#1\#2}{gregoriotex-signs.tex}
Secondary macro used by \verb=\gre@setallbracerendering= and
\verb=\gre@setbracerendering= to change a single type of brace. As a
secondary macro, it doesn't check its first argument.
\begin{argtable}
\#1 & \texttt{brace} & change round braces that appear over the staff\\
& \texttt{underbrace} & change round braces that appear under the staff\\
& \texttt{curlybrace} & change curly braces\\
& \texttt{barbrace} & change round braces that appear over divisio bars\\
\#2 & \texttt{metapost} & \MP{} will be used to render braces\\
& \texttt{font} & The score font will be used to render braces\\
\end{argtable}
\macroname{\textbackslash gre@brace@common}{\#1\#2\#3\#4\#5\#6\#7}{gregoriotex-signs.tex}
Common macro used internally to render braces.
\begin{argtable}
\#1 & length & The width of the brace.\\
\#2 & length & A vertical shift.\\
\#3 & length & A horizontal shift.\\
\#4 & \texttt{0} & Don’t shift before starting the brace.\\
& \texttt{1} & Shift back a punctum’s width before starting the brace.\\
\#5 & \texttt{0} & No accentus above the brace.\\
& \texttt{1} & Typeset an accentus above the brace.\\
\#6 & integer & The height number for the brace.\\
\#7 & csname & The control sequence name representing the brace.
\end{argtable}
\macroname{\textbackslash gre@render@barbrace}{}{gregoriotex-signs.tex}
Draws a divisio brace.
\macroname{\textbackslash grebracemetapostpreamble}{\#1}{gregoriotex-signs.tex}
Returns the \MP{} preamble for braces. The control sequence name does
not have the \texttt{@} symbol because this macro is used within \MP{}.
\begin{argtable}
\#1 & string & the width of the brace; if \texttt{*}, use the bar brace width.
\end{argtable}
\macroname{\textbackslash gre@draw@curlybrace}{\#1}{gregoriotex-signs.tex}
Draws a curly over-brace using \MP{}.
\begin{argtable}
\#1 & length & the width of the brace.
\end{argtable}
\macroname{\textbackslash gre@draw@brace}{\#1}{gregoriotex-signs.tex}
Draws a round over-brace using \MP{}.
\begin{argtable}
\#1 & string & the width of the brace; if \texttt{*}, use the bar brace width.
\end{argtable}
\macroname{\textbackslash gre@draw@fontbrace}{\#1\#2}{gregoriotex-signs.tex}
Draws a brace using the score font.
\begin{argtable}
\#1 & string & the width of the brace.\\
\#2 & \TeX\ code & \TeX\ code that renders the brace using the score font.\\
\end{argtable}
\macroname{\textbackslash gre@draw@underbrace}{\#1}{gregoriotex-signs.tex}
Draws a round under-brace using \MP{}.
\begin{argtable}
\#1 & length & the width of the brace.
\end{argtable}
\macroname{\textbackslash gre@draw@roundbrace}{\#1\#2\#3}{gregoriotex-signs.tex}
Draws a round over- or under-brace using \MP{}.
\begin{argtable}
\#1 & length & the width of the brace.\\
\#2 & number & the height of the bounding box in em-relative units.\\
\#3 & \MP{} commands & \MP{} commands to draw the brace outline.
\end{argtable}
\macroname{\textbackslash gre@draw@slur}{\#1\#2\#3}{gregoriotex-signs.tex}
Draws a slur using \MP{}.
\begin{argtable}
\#1 & length & the x-dimension of the slur.\\
\#2 & length & the y-dimension of the slur.\\
\#3 & \texttt{-1} & draw an under-the-notes slur.\\
& \texttt{1} & draw an over-the-notes slur.\\
\end{argtable}
\macroname{\textbackslash gre@iflatex}{\#1}{gregoriotex.sty \textup{and} gregoriotex.tex}
Evaluates to \verb=#1= if running under \LaTeX{}.
\begin{argtable}
\#1 & \TeX{} code & the \TeX{} code to use if running under \LaTeX{}.
\end{argtable}
\macroname{\textbackslash gre@ifnotlatex}{\#1}{gregoriotex.sty \textup{and} gregoriotex.tex}
Evaluates to \verb=#1= if not running under \LaTeX{}.
\begin{argtable}
\#1 & \TeX{} code & the \TeX{} code to use if not running under \LaTeX{}.
\end{argtable}
\macroname{\textbackslash gre@latex@barredsymbol}{\#1\#2\#3\#4}{gregoriotex-signs.tex}
Internal method used by \verb=\grelatexsimpledefarredsymbol= to simplify
the cascading of conditionals used to implement that macro.
\bigskip\textbf{Only available in \LaTeX.}
\begin{argtable}
\#1 & string & the value of \verb=\f@series/\f@shape= to match.\\
\#2 & \TeX{} code & the \TeX{} for the base symbol (\ie, \texttt{A}, \texttt{R}, or \texttt{V}).\\
\#3 & string & the control sequence name created by \verb=\gredefsizedsymbol= to use for the bar.\\
\#4 & dimension & the amount to shift the bar to the left from the end of the base symbol.
\end{argtable}
\macroname{\textbackslash gre@additionalbottomcustoslineend}{}{gregoriotex-signs.tex}
Macro to place a bottom custos with an additional line (positions \texttt{a} and \texttt{b}) at the end of a line.
\macroname{\textbackslash gre@additionalbottomcustoslinemiddle}{}{gregoriotex-signs.tex}
Macro to place a bottom custos with an additional line (positions \texttt{a} and \texttt{b}) in the middle of a line.
\macroname{\textbackslash gre@additionaltopcustoslineend}{}{gregoriotex-signs.tex}
Macro to place a top custos with an additional line (positions \texttt{l} and \texttt{m}) at the end of a line.
\macroname{\textbackslash gre@additionaltopcustoslinemiddle}{}{gregoriotex-signs.tex}
Macro to place a top custos with an additional line (positions \texttt{l} and \texttt{m}) in the middle of a line.
\macroname{\textbackslash gre@pickcustos}{\#1}{gregoriotex-signs.tex}
Macro to pick the appropriate custos character.
\begin{argtable}
\#1 & integer & height of the custos character to be placed\\
\end{argtable}
\macroname{\textbackslash gre@nextcustospitch}{}{gregoriotex-signs.tex}
Macro that saves the next custos pitch (height).
\macroname{\textbackslash gre@nextcustosalteration}{}{gregoriotex-signs.tex}
Macro that saves the next custos alteration.
\macroname{\textbackslash gre@custosalteration}{\#1\#2}{gregoriotex-signs.tex}
Typesets the alteration for a custos, if enabled.
\begin{argtable}
\#1 & integer & The pitch (height number) of the custos.\\
\#2 & \texttt{Flat} & The custos should have a flat.\\
& \texttt{Natural} & The custos should have a natural.\\
& \texttt{Sharp} & The custos should have a sharp.\\
& \textit{empty} & The custos should not have an alteration.\\
\end{argtable}
\macroname{\textbackslash gre@noinitial}{}{gregoriotex-main.tex}
Macro called when no initial is being set.
\macroname{\textbackslash gre@setinitial}{\#1}{gregoriotex-main.tex}
Macro to set the initial in the score.
\macroname{\textbackslash gre@addspaceabove}{}{gregoriotex-main.tex}
Macro to increase the space above the lines to account for above lines text.
\macroname{\textbackslash gre@removespaceabove}{}{gregoriotex-main.tex}
Macro to decrease the space above the lines as there is no longer any above lines text.
\macroname{\textbackslash gre@alteration}{\#1\#2\#3\#4\#5\#6}{gregoriotex-signs.tex}
Macro to typeset an alteration.
\begin{argtable}
\#1 & integer & height of the alteration\\
\#2 & integer & alteration type (see Section \ref{alterationtype})\\
\#3 & \texttt{1} & the alteration is part of the clef\\
& \texttt{0} & the alteration is not part of the clef\\
\#4 & \TeX\ code & signs to typeset before the glyph (typically additional bars, as they must be ``behind'' the glyph)\\
\#5 & \TeX\ code & signs to typeset after the glyph (almost all signs)\\
\#6 & string & the line, byte offset, and column address for textedit links when point-and-click is enabled\\
\end{argtable}
\macroname{\textbackslash gre@alteration@isvisible}{\#1\#2}{gregoriotex-signs.tex}
Test whether an alteration should be visible or not.
\begin{argtable}
\#1 & integer & 0 for current alteration, 1 for next alteration\\
\#2 & integer & alteration type (see Section \ref{alterationtype})\\
\end{argtable}
\macroname{\textbackslash gre@alteration@visible}{\#1\#2\#3\#4\#5\#6}{gregoriotex-signs.tex}
The special case of \verb|gre@alteration| for when the alteration is visible.
\macroname{\textbackslash gre@alteration@char}{}{gregoriotex-signs.tex}
\vspace*{-10ex}%
\macroname{\textbackslash gre@alteration@type}{}{gregoriotex-signs.tex}
Used internally by \verb|\gre@alteration@visible|.
\macroname{\textbackslash gre@clef}{}{gregoriotex-signs.tex}
Macro holding the current clef type.
\macroname{\textbackslash gre@clefheight}{}{gregoriotex-signs.tex}
Macro holding the current clef line.
\macroname{\textbackslash gre@clefflatheight}{}{gregoriotex-signs.tex}
Macro to hold the height of the current flat for the clef (\texttt{3} if no flat).
\macroname{\textbackslash gre@cleftwo}{}{gregoriotex-signs.tex}
Macro holding the current secondary clef type.
\macroname{\textbackslash gre@cleftwoheight}{}{gregoriotex-signs.tex}
Macro holding the current secondary clef line (or 0 for no secondary clef).
\macroname{\textbackslash gre@cleftwoflatheight}{}{gregoriotex-signs.tex}
Macro to hold the height of the current flat for the secondary clef (\texttt{3} if no flat).
\macroname{\textbackslash gre@updatelinesclef}{}{gregoriotex-signs.tex}
Macro redrawing a key from \verb=\gre@clefnum=, useful for vertical space changes.
\macroname{\textbackslash gre@currenttextabovelines}{}{gregoriotex-main.tex}
Macro for storing the text which needs to be placed above the lines.
\macroname{\textbackslash gre@typesettextabovelines}{\#1\#2}{gregoriotex-main.tex}
Macro for typesetting the text or nabc neumes above the lines.
\begin{argtable}
\#1 & string & Text to be typeset\\
\#2 & \texttt{0} & Use alt text above the lines vertical spacing\\
& \texttt{1} & Use nabc neumes above the lines vertical spacing\\
\end{argtable}
\macroname{\textbackslash gre@dotranslationcenterend}{}{gregoriotex-main.tex}
Macro to typeset a centered translation.
\macroname{\textbackslash gre@generatelines}{}{gregoriotex-main.tex}
Macro to (re)populate the box containing the lines.
\macroname{\textbackslash gre@lastoflinecount}{}{gregoriotex-main.tex}
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).
\macroname{\textbackslash gre@newlinecommon}{\#1\#2}{gregoriotex-main.tex}
The macro which needs to be called each time a new lines is started.
\begin{argtable}
\#1 & \texttt{0} & Justifying the line being ended\\
& \texttt{1} & Do not justify the line being ended\\
\#2 & \texttt{0} & Take care of eolshift\\
& \texttt{1} & Do not adjust end of line (when already done by the new spacing algorithm)\\
\end{argtable}
\macroname{\textbackslash gre@endafterbar}{\#1}{gregoriotex-main.tex}
Macro to call after ending a bar.
\begin{argtable}
\#1 & \texttt{0} & We are at the end of a line\\
& \texttt{1} & We not at the end of a line\\
\end{argtable}
\macroname{\textbackslash gre@endofsyllable}{\#1\#2\#3}{gregoriotex-syllable.tex}
Macro called at end of a syllable, adds a penalty and a space.
\begin{argtable}
\#1 & \texttt{0} & to only add the penalty\\
& \texttt{1} & adds both penalty and space\\
\#2 & \texttt{0} & if end of syllable\\
& \texttt{1} & if end of word\\
\#3 & \texttt{1} & if next syllable is a bar\\
& \texttt{0} & otherwise\\
\end{argtable}
\macroname{\textbackslash gre@endofglyphcommon}{}{gregoriotex-syllable.tex}
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.
\macroname{\textbackslash gre@setfirstsyllabletext}{\#1\#2\#3\#4\#5\#6}{gregoriotex-syllable.tex}
Internal macro to set the first syllable text after all parts are known.
\begin{argtable}
\#1 & \TeX\ code & First part of the syllable (before the vowel)\\
\#2 & \TeX\ code & Middle part of the syllable (the vowel)\\
\#3 & \TeX\ code & Last part of the syllable (after the vowel)\\
\#4 & \TeX\ code & First letter of the syllable\\
\#5 & \TeX\ code & Everything after the first letter of the syllable\\
\#6 & \TeX\ code & Macros to run after the text is emitted\\
\end{argtable}
\macroname{\textbackslash gre@opening@syllabletext}{}{gregoriotex-syllable.tex}
Macro that stores the computed \TeX\ code for rendering the text of the first syllable.
\macroname{\textbackslash gre@factor}{}{gregoriotex-main.tex}
Count which stores the current staff size.
Default: 17 (approximately the size found in graduals)
\macroname{\textbackslash gre@fillhole}{\#1\#2}{gregoriotex-signs.tex}
Macro to fill the hole in a glyph so that staff lines do not show through a hole in it.
\begin{argtable}
\#1 & Gregorio\TeX\ char & character to use to fill the hole\\
\#1 & \texttt{0} & the hole is being filled for an alteration\\
\#1 & \texttt{1} & the hole is being filled for a cavum glyph\\
\end{argtable}
\macroname{\textbackslash gre@calculate@notesaligncenter}{\#1}{gregoriotex-syllable.tex}
Macro to find the alignment center for a group of notes. The value is the distance from the left edge of the group to the alignment point and is stored in \verb=\gre@dimen@notesaligncenter=.
\begin{argtable}
\#1 & Note alignment type & See \ref{notesalign}\\
\end{argtable}
\macroname{\textbackslash gre@calculate@nextnotesaligncenter}{\#1\#2}{gregoriotex-syllable.tex}
Same as previous, but for the next syllable.
\begin{argtable}
\#1 & Note alignment type & See \ref{notesalign}\\
\#1 & Alteration type & See \ref{alterationtype}\\
\end{argtable}
\macroname{\textbackslash gre@calculate@simplenotesaligncenter}{\#1\#2}{gregoriotex-syllable.tex}
Workhorse function behind \verb=\gre@calculate@notesaligncenter= and\\ \verb=\gre@calculate@nextnotesaligncenter=.
\begin{argtable}
\#1 & Note alignment type & See \ref{notesalign}\\
\#2 & \texttt{0} & this is for the current syllable\\
& \texttt{1} & this is for the next syllable\\
\end{argtable}
\macroname{\textbackslash gre@gregoriofontname}{}{gregoriotex-main.tex}
Macro which stores the name of the currently selected font for the neumes.
\macroname{\textbackslash gre@handleclivisspecialalignment}{\#1\#2\#3}{gregoriotex-syllable.tex}
Macro for aligning clivis syllables according to the flag \verb=\gre@clivisalignment=.
\begin{argtable}
\#1 & Gregorio\TeX\ glyph & Glyph to use when aligning clivis on its center\\
\#2 & Gregorio\TeX\ glyph & Glyph to use when aligning clivis on the center of the first punctum\\
\#3 & \texttt{0} & this is for the current syllable\\
& \texttt{1} & this is for the next syllable\\
\end{argtable}
\macroname{\textbackslash gre@hepisorline}{\#1\#2\#3\#4\#5\#6\#7}{gregoriotex-signs.tex}
Macro to typeset a horizontal line (either an additional staff line or an episema).
{\small
\begin{argtable}
\#1 & character & The letter of the height of the episema (not the height of the note it corresponds to).\\
\#2 & \texttt{0} & go back to the beginning of the previous glyph; this starts the episema at the beginning of the previous glyph\\
& \texttt{1} & stay at the end of the glyph; doesn’t make much sense to use this\\
& \texttt{2} & go back the width of \#1; this starts the episema at the glyph from the end that starts at \#1’s width from the end\\
& \texttt{3} & go back to the beginning of the previous glyph and then forward the width of \#1; this starts the episema at the glyph from the start that starts just after \#1’s width from the start\\
& \texttt{4} & go back to the beginning of the previous glyph and then forward the width of \#1, then back the width of \#2; this ends the episema at the end of \#1\\
\#3 & integer &the ambitus for a two note episema at the diagonal stroke of a porrectus, porrectus flexus, orculus resupinus, or torculus resupinus flexus\\
\#4 & \texttt{0} & an horizontal episema\\
& \texttt{1} & an horizontal episema under a note\\
& \texttt{2} & a line at the top\\
& \texttt{3} & a line at the bottom\\
\#5 & \texttt{f} & a normal episema\\
& \texttt{l} & a small episema aligned left\\
& \texttt{c} & a small episema aligned center\\
& \texttt{r} & for a small episema aligned right\\
\#6 & string & a positive or negative ``nudge'' (dimension) for the vertical position of the horizontal episema\\
\#7 & \texttt{0} & for horizontal episema cases, use automatic positioning within the space\\
& \texttt{1} & for horizontal episema cases, position in the middle of the space\\
& \texttt{2} & for horizontal episema cases, position low within the space as if the episema is over the note\\
& \texttt{3} & for horizontal episema cases, position high within the space as if the episema is under the note\\
& \texttt{4} & for horizontal episema cases, position low within the space as if the episema is over the note\\
& \texttt{5} & for horizontal episema cases, position high within the space as if the episema is under the note\\
\end{argtable}
}
\macroname{\textbackslash gre@hepisorlineaux}{\#1\#2\#3\#4}{gregoriotex-signs.tex}
Macro that will help in the typesetting of a horizontal episema and additional lines.
\begin{argtable}
\#1 & Gregorio\TeX\ glyph & an offset glyph (see \#3, below)\\
\#2 & Gregorio\TeX\ glyph & the episema glyph\\
\#3 & \texttt{0} & go back to the beginning of the previous glyph; this starts the episema at the beginning of the previous glyph\\
& \texttt{1} & stay at the end of the glyph; doesn’t make much sense to use this\\
& \texttt{2} & go back the width of \#1; this starts the episema at the glyph from the end that starts at \#1’s width from the end\\
& \texttt{3} & go back to the beginning of the previous glyph and then forward the width of \#1; this starts the episema at the glyph from the start that starts just after \#1’s width from the start\\
\#4 & \texttt{0} & an horizontal episema\\
& \texttt{1} & an horizontal episema under a note\\
& \texttt{2} & a line at the top\\
& \texttt{3} & a line at the bottom\\
\end{argtable}
\macroname{\textbackslash gre@vepisemaorrare}{\#1\#2\#3\#4\#5}{gregoriotex-signs.tex}
Macro to typeset a vertical episema or a rare accent (like accentus, circulus, etc.). This function must be called after a call to \verb=\GreGlyph=.
\begin{argtable}
\#1 & character & the letter of the height of the episema (not the height of the note it corresponds to.\\
\#2 & string & See \Nameref{NoteOffset}.\\
\#3 & Gregorio\TeX\ glyph & the sign glyph\\
\#4 & \texttt{1} & vertical episema\\
& \texttt{2} & rare sign\\
& \texttt{3} & choral sign\\
& \texttt{4} & brace above the bar\\
\#5 & string & the choral sign, if relevant\\
\end{argtable}
\macroname{\textbackslash gre@vepisemaorrareaux}{\#1\#2\#3\#4\#5\#6\#7}{gregoriotex-signs.tex}
Macro to help typesetting vertical episema.
\begin{argtable}
\#1 & Gregorio\TeX\ glyph & is an offset glyph (see \#3 below)\\
\#2 & Gregorio\TeX glyph & the glyph upon which the sign is to be centered\\
\#3 & \texttt{0} & go back to the beginning of the previous glyph and then forward half the width of \#2; this puts the sign at the beginning of the previous glyph, whose first note is the size of \#2\\
& \texttt{1} & go back half the width of \#2; this puts the sign at the end of the previous glyph, whose last note is the size of \#2\\
& \texttt{2} & go back the width of \#1 and then forward half the width of \#2; this puts the sign at the glyph from the end that starts at \#1’s width from the end\\
& \texttt{3} & go back to the beginning of the previous glyph and then forward the width of \#1 and then back half the width of \#2; this puts the sign at the glyph from the start that ends at \#1’s width from the start\\
\#4 & dimension & a shift that we want to get applied, useful for punctum inclinatum for example\\
\#5 & integer & is the glyph number\\
\#6 & \texttt{1} & vertical episema\\
& \texttt{2} & rare sign\\
& \texttt{3} & choral sign\\
& \texttt{4} & brace above the bar\\
\#7 & string & the choral sign if relevant\\
\end{argtable}
\macroname{\textbackslash gre@newglyphcommon}{}{gregoriotex-syllable.tex}
Macro called before each glyph.
\macroname{\textbackslash greoldcatcode}{}{gregoriotex.tex}
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.
\macroname{\textbackslash gre@prephepisemaledgerlineheuristics}{}{gregoriotex-spaces.tex}
Prepares the system to accept ledger line heuristics for the horizontal episema.
\macroname{\textbackslash gre@resetledgerlineheuristics}{}{gregoriotex-spaces.tex}
Resets the ledger line heuristic flags.
\macroname{\textbackslash gre@setstylefont}{}{gregoriotex-main.tex}
Macro for opening up greextra font.
\macroname{\textbackslash gre@syllablenotes}{\#1}{gregoriotex-syllable.tex}
Macro for populating \verb=\gre@box@syllablenotes=.
\begin{argtable}
\#1 & string & The contents to be placed in the box\\
\end{argtable}
\macroname{\textbackslash gre@symbolfontsize}{}{gregoriotex-symbols.tex}
The font size at which symbols are to be loaded.
\macroname{\textbackslash gre@textnormal}{\#1}{gregoriotex-syllable.tex}
Macro which applies the default text format.
\macroname{\textbackslash gre@save@clef}{\#1\#2\#3\#4\#5\#6}{gregoriotex-signs.tex}
Saves clef information for use in \verb=gre@updatelinesclef=.
\begin{argtable}
\#1 & character & the type of the clef: c or f\\
\#2 & integer & the line of the clef (1 is the lowest)\\
\#3 & integer & if \texttt{3}, it means that we must not put a flat after the clef, otherwise it’s the height of the flat\\
\#4 & character & the type of the secondary clef: c or f\\
\#5 & integer & the line of the secondary clef (1 is the lowest, 0 for no secondary clef)\\
\#6 & integer & if \texttt{3}, it means that we must not put a flat after the secondary clef, otherwise it’s the height of the flat\\
\end{argtable}
\macroname{\textbackslash gre@typeclef}{\#1\#2\#3\#4\#5\#6\#7\#8\#9}{gregoriotex-signs.tex}
Macro which typesets the clef.
\begin{argtable}
\#1 & character & the type of the clef: c or f\\
\#2 & integer & the line of the clef (1 is the lowest)\\
\#3 & \texttt{0} & no need to use small clef characters (inside a line)\\
& \texttt{1} & we must use small clef characters (inside a line)\\
\#4 & \texttt{0} & no extra space is needed after the clef\\
& \texttt{1} & we must type a normal space after the clef\\
& \texttt{2} & we must type a short space after the clef\\
\#5 & integer & if \texttt{3}, it means that we must not put a flat after the clef, otherwise it’s the height of the flat\\
\#6 & character & the type of the secondary clef: c or f\\
\#7 & integer & the line of the secondary clef (1 is the lowest, 0 for no secondary clef)\\
\#8 & integer & if \texttt{3}, it means that we must not put a flat after the secondary clef, otherwise it’s the height of the flat\\
\end{argtable}
\macroname{\textbackslash gre@boxclef}{\#1\#2\#3\#4\#5\#6\#7\#8\#9}{gregoriotex-signs.tex}
Macro filling \verb=\gre@box@temp@width= with a clef. The arguments are the same as \verb=gre@typeclef=.
\macroname{\textbackslash gre@typesingleclef}{\#1\#2\#3\#4}{gregoriotex-signs.tex}
Macro which typesets a single clef.
\begin{argtable}
\#1 & character & the type of the clef: c or f\\
\#2 & integer & the line of the clef (1 is the lowest)\\
\#3 & \texttt{0} & no need to use small clef characters (inside a line)\\
& \texttt{1} & we must use small clef characters (inside a line)\\
\#4 & integer & if \texttt{3}, it means that we must not put a flat after the clef, otherwise it’s the height of the flat\\
\end{argtable}
\macroname{\textbackslash gre@updateleftbox}{}{gregoriotex-main.tex}
Macro to update the box printed a the left end of every line (the one which holds the staff lines).
\macroname{\textbackslash gre@useautoeolcustos}{}{gregoriotex-main.tex}
Macro which enables automatic custos at the end of lines.
\macroname{\textbackslash gre@usestylecommon}{}{gregoriotex-signs.tex}
Macro which specifies the alternate glyphs which are common to all of the styles.
\macroname{\textbackslash gre@widthof}{\#1}{gregoriotex-main.tex}
Macro for calculating the width of its argument and storing it in \verb=\gre@dimen@temp@three=.
\macroname{\textbackslash gre@writebar}{\#1\#2\#3\#4\#5}{gregoriotex-signs.tex}
Macro to write a bar.
\begin{argtable}
\#1 & \texttt{0} & virgula\\
& \texttt{1} & minima\\
& \texttt{2} & minor\\
& \texttt{3} & major\\
& \texttt{4} & finalis\\
& \texttt{5} & the last finalis\\
& \texttt{6}--\texttt{13} & Dominican bars\\
& \texttt{14} & virgula on ledger line above the staff\\
& \texttt{15} & minima on ledger line above the staff\\
& \texttt{16} & dotted major\\
& \texttt{17} & minimis (eighth bar)\\
& \texttt{18} & minimis (eighth bar) on ledger line above the staff\\
& \texttt{19} & parenthesized virgula\\
& \texttt{20} & parenthesized minima\\
& \texttt{21} & parenthesized virgula on ledger line above the staff\\
& \texttt{22} & parenthesized minima on ledger line above the staff\\
\#2 & \texttt{0} & in a syllable containing only this bar\\
& \texttt{1} & in a syllable containing other notes\\
\#3 & \texttt{0} & if there is no text underneath the bar\\
& \texttt{1} & if there is text underneath the bar\\
\#4 & \TeX\ code & macros that may happen before the skip after the bar (typically GreVEpisema)\\
\#5 & \texttt{0} & The notes around the bar are vertically close to the bar.\\
& \texttt{1} & The notes around the bar are far, \verb=@short= versions of spaces will be used.\\
\end{argtable}
\macroname{\textbackslash gre@@arg}{}{gregoriotex-syllable.tex}
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.
\macroname{\textbackslash gre@nothing}{}{gregoriotex-main.tex}
A dummy macro which has not contents. Used for \verb=\ifx= comparisons.
\macroname{\textbackslash gre@annotation}{[\#1]\#2}{gregoriotex-main.tex}
Workhorse function behind \verb=\greannotation=.
\begin{argtable}
\#1 & \texttt{c} & center align the new line with the existing annotation content\\
& \texttt{l} & left align the new line with the existing annotation content\\
& \texttt{r} & right align the new line with the existing annotation content\\
\#2 & string & the new annotation content\\
\end{argtable}
\macroname{\textbackslash gre@commentary}{[\#1]\#2}{gregoriotex-main.tex}
Workhorse function behind \verb=\grecommentary=.
\begin{argtable}
\#1 & distance & Additional distance to be placed between the commentary and the top staff line for the next score only.\\
\#2 & string & the new commentary content\\
\end{argtable}
\macroname{\textbackslash gre@printcommentary}{}{gregoriotex-main.tex}
Computes the true ``raise'' and prints the commentary contained in
\verb=\gre@box@commentary=.
\macroname{\textbackslash gre@atletter}{}{gregoriotex-main.tex}
A Lua\TeX\ catcode table which makes sure that Lua\TeX\ treats `@‘ corectly.
\macroname{\textbackslash gre@baseunit}{}{gregoriotex-spaces.tex}
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=).
\macroname{\textbackslash gre@stretchunit}{}{gregoriotex-spaces.tex}
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=).
\macroname{\textbackslash gre@shrinkunit}{}{gregoriotex-spaces.tex}
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=).
\macroname{\textbackslash gre@bug}{\#1}{gregoriotex.sty \textup{and} gregoriotex.tex}
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.
\macroname{\textbackslash gre@changestyle}{\#1\#2[\#3]}{gregoriotex.sty \textup{and} gregoriotex.tex}
Workhorse function behind \verb=\grechangestyle=. Necessary because the internals of the definition are slightly different in \LaTeX\ and Plain \TeX.
\macroname{\textbackslash gre@bolshiftcleftypeglobal}{}{gregoriotex-spaces.tex}
Takes on the value \texttt{1}, \texttt{2}, or \texttt{3} depending on whether
to calculate the beginning-of-line shift based on the largest, current, or
forced clef width (\ie, directly use the value stored in
\verb=\gre@dimen@clefwidth@bol=), respectively. This is the ``global'' value,
used to initialize \verb=\gre@bolshiftcleftypelocal= at the start of a score.
\macroname{\textbackslash gre@bolshiftcleftypelocal}{}{gregoriotex-spaces.tex}
Takes on the value \texttt{1}, \texttt{2}, or \texttt{3} depending on whether
to calculate the beginning-of-line shift based on the largest, current, or
forced clef width (\ie, directly use the value stored in
\verb=\gre@dimen@clefwidth@bol=), respectively. This is the ``local'' value,
used in the actual computation.
\macroname{\textbackslash gre@update@clefwidth@largest}{\#1}{gregoriotex-spaces.tex}
Updates the ``largest'' clef width, used when \verb=\gre@bolshiftcleftypelocal=
is \texttt{1}.
\begin{argtable}
\#1 & distance & The new value to use for the ``largest'' clef width.\\
\end{argtable}
\macroname{\textbackslash gre@update@clefwidth@current}{\#1}{gregoriotex-spaces.tex}
Updates the ``current'' clef width, used when \verb=\gre@bolshiftcleftypelocal=
is \texttt{2}.
\begin{argtable}
\#1 & distance & The new value to use for the ``current'' clef width.\\
\end{argtable}
\macroname{\textbackslash gre@update@clefwidth@forced}{\#1}{gregoriotex-spaces.tex}
Updates the ``forced'' clef width, used when \verb=\gre@bolshiftcleftypelocal=
is \texttt{3}.
\begin{argtable}
\#1 & distance & The new value to use for the ``forced'' clef width.\\
\end{argtable}
\macroname{\textbackslash gre@calculate@bolshift}{\#1\#2}{gregoriotex-spaces.tex}
Macro used in \verb=\GreSyllable=. Sets \verb=\gre@skip@bolshift= to the left kern that should appear at the beginning of a line in case of a forced linebreak. The goal of this left kern is to have all lines aligned on notes. This shift is applied to the right before every syllable and then to the left after placing an empty box. At the beginning of the line the shift to the right is ignored by \TeX\ as leading white space, but the shift left is not because of the presence of the “character” of the empty box.
\begin{argtable}
\#1 & dimension & \verb=begindifference= of the syllable\\
\end{argtable}
\macroname{\textbackslash gre@calculate@eolshift}{\#1}{gregoriotex-spaces.tex}
Macro used in \verb=\GreSyllable=. Sets \verb=\gre@dimen@eolshift= to the left kern that
should appear before an end of line. The improvement is tiny: when
text go further than notes in the last syllable of a line, the idea
is to allow text to go a bit further right, under the custos. This shift is applied to the left after every syllable and then to the right after setting the line break penalty. If the line break occurs after this syllable, it will occur between the two shifts, pushing the shift right to the beginning of the next line where \TeX\ will ignore it as leading white space.
\begin{argtable}
\#1 & dimension & The \verb=enddifference= of the corresponding syllable\\
\end{argtable}
\macroname{\textbackslash gre@calculate@syllablefinalskip}{\#1\#2}{gregoriotex-spaces.tex}
Macro computing the skip at the end of the syllable.
\begin{argtable}
\#1 & \texttt{0} & if end of syllable\\
& \texttt{1} & if end of word\\
\#2 & \texttt{0} & if next syllable is normal\\
& \texttt{1} & if it’s a bar\\
\end{argtable}
\macroname{\textbackslash gre@convert}{}{gregoriotex-spaces.tex}
Macro to hold the original distance which is to be scaled by \verb=\gre@changeonedimenfactor=
\macroname{\textbackslash gre@debug}{}{gregoriotex.sty \textup{and} gregoriotex.tex}
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.
\macroname{\textbackslash gre@debugmsg}{\#1\#2}{gregoriotex-common.tex}
Macro to print debugging messages.
\begin{argtable}
\#1 & string & The category of the message (used in conjunction with \verb=\gre@debug= to determine whether to print the message or not; see \Nameref{DebugCategory}\\
\#2 & string & The debug message\\
\end{argtable}
\macroname{\textbackslash gre@trace}{\#1}{gregoriotex-common.tex}
Macro to mark the beginning of a function in the log with a GreTrace message.
\begin{argtable}
\#1 & string & name and argument list of the function being identified.
\end{argtable}
\macroname{\textbackslash gre@trace@end}{\#1}{gregoriotex-common.tex}
Macro to mark the end of a function in the log with a GreTrace message.
\macroname{\textbackslash gre@trace@prefix}{gregoriotex-common.tex}
Macro to hold the prefix of GreTrace messages (value is manipulated to control indentation and indicate nesting).
\macroname{\textbackslash gre@declarefileversion}{\#1\#2}{gregoriotex-main.tex}
Macro which checks for version consistency between Gregorio\TeX\ files.
\begin{argtable}
\#1 & string & name of the current file\\
\#2 & string & version of the current file\\
\end{argtable}
\macroname{\textbackslash gre@def@char@he}{\#1\#2}{gregoriotex-chars.tex}
Macro for defining the various types of horizontal episema.
\begin{argtable}