forked from gregorio-project/gregorio
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Command_Index_User.tex
2170 lines (1640 loc) · 97.6 KB
/
Command_Index_User.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-2021 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{User Controls}
These functions are available to the user to customize elements of the
score which cannot be controlled from the gabc file. They can be added
to any \verb=.tex= file. Do not add them to any \verb=.gtex= or
\verb=.gabc= file.
\subsection{Using the Package}
To use the Gregorio\TeX\ package in a \LaTeX\ document, include \verb=\usepackage{gregoriotex}=
in the document preamble. This macro has the following form:
\macroname{\textbackslash usepackage}{[\optional{(options)}]\{gregoriotex\}}{gregoriotex.sty}
The optional arguments are:
\bigskip\rowcolors{1}{lightgray}{lightgray}
\begin{tabular}{lp{10cm plus .5cm}}
Argument & Description \\
\hline
\texttt{debug} & Debug messages will be printed to the output log. Can also be specified as \verb:debug={<types>}:, in which case only messages of the categories (see \nameref{DebugCategory}) listed will be printed to the output log.\\
\hline
\texttt{nevercompile} & Default. The classic behavior of Gregorio\TeX. The user is %
responsible for compiling gabc scores into gtex files.\\
\texttt{autocompile} & Gregorio\TeX\ will automatically compile gtex files from gabc %
files when necessary. If the gabc has been modified, or the %
gtex has an outdated version, or the gtex file does not exist, %
THEN Gregorio\TeX\ will compile a new gtex file.\\
\texttt{forcecompile} & Gregorio\TeX\ will compile all scores from their gabc files.\\
\hline
\texttt{allowdeprecated=false} & Force all deprecated commands to raise a package error %
rather than a warning. This allows the user to ensure that their file is %
compliant with the current version of Gregorio\TeX.\\
\end{tabular}\bigskip
\textbf{Note:} \verb=nevercompile=, \verb=autocompile=, and
\verb=forcecompile= conflict with eachother. Only one should be
specified in the options list.\bigskip
To use the package in a Plain \TeX\ document, include \verb=\input gregoriotex.tex= near the top of the document (the area which would correspond to the preamble in \LaTeX).
To use the \texttt{debug} option in Plain \TeX, you'll need to define \verb=\gre@debug= manually as a string listing the kinds of messages you want printed (or as \verb=all= if you want all messages printed).
To use the \texttt{allowdeprecated=false} option, you'll need \verb=\gre@allowdeprecatedfalse=.
The compilation options can be set using \verb=\gresetcompilegabc= (see below).
\textbf{Important:} Gregorio\TeX{} may require up to two passes (runs of
\texttt{lualatex} or \texttt{luatex}) to compute the line heights correctly. If a second
pass is required, Gregorio\TeX{} will emit the following
warning:\par\medskip
\begin{scriptsize}
\begin{latexcode}
Module gregoriotex warning: Line heights or variable brace lengths may have changed. Rerun to fix.
\end{latexcode}
\end{scriptsize}
Gregorio\TeX{} two-pass processing is compatible with \texttt{latexmk}.
If you only need the special symbols which Gregorio\TeX\ contains, and not the ability to include scores or musical glyphs, then you can load \texttt{gregoriosyms} instead of \texttt{gregoriotex}. It supports all of the above options except those specifically related to scores. \textbf{You should not try to load both packages}.
\subsubsection{Gregorio\TeX{} and \texttt{microtype}}
If you are using the \texttt{microtype} package or a package that itself uses
\texttt{microtype}, please load it after \texttt{gregoriotex}. If you load
\texttt{microtype} before \texttt{gregoriotex}, you may receive an error about
an ``undefined control sequence'' if you use certain Gregorio\TeX{} features.
\subsection{Commands}
Once you've included the package in your document (as explained above) the following commands allow you to insert scores and manipulate the way they appear in the document.
\subsubsection{Including scores}
\macroname{\textbackslash gregorioscore}{[\optional{\#1}]\{\#2\}}{gregoriotex-main.tex}
Macro for including scores. Works on both gabc and gtex files.
\begin{argtable}
\#1 & \texttt{n} & Optional. \#2 will be included as is. \\
& \texttt{a} & Optional. Gregorio\TeX\ will automatically compile gabc files if necessary.\\
& \texttt{f} & Optional. Forces Gregorio\TeX\ to compile the gabc file.\\
\#2 & string & Relative or absolute path to the score.\\
\end{argtable}
Example:\par\medskip
\begin{latexcode}
\gregorioscore[n]{TecumPrincipium.gtex}
\gregorioscore{Chant/VirgoVirginum.gabc}
\gregorioscore{/home/user/chant/AdTeLevavi}
\gregorioscore[a]{AveMaria}
%The following lines include the same score:
\gregorioscore{Christus}
\gregorioscore{Christus.gtex}
\gregorioscore{./Christus}
\gregorioscore{./Christus.gabc}
%With the optional arg [f], #2 must be a file usable by \TeX.
\gregorioscore[f]{TecumPrincipium.gabc} % Wrong
\end{latexcode}
\textbf{Important:} For the sake of clarity it is recommended that the
file extension be omitted from \texttt{\#2} unless using the \texttt{nevercompile} option. When the \texttt{nevercompile}
option is in effect (either via package option
\texttt{[nevercompile]}, or \verb=\gresetcompilegabc{never}=, or
\verb=\gregorioscore[n]=) \#2 must be a \TeX\ file that exists and
the file extension (normally gtex) must be given.
When called with the optional argument \texttt{[a]} Gregorio\TeX\ will
automatically generate a \texttt{gtex} file in this format:
\texttt{\textit{scorename}-x\_x\_x.gtex} where \texttt{x\_x\_x} is the
gregorio version. This resulting file is not intended to be modified
by the user and will be removed when the gabc file is recompiled. The
rules that Gregorio\TeX\ uses to determine if a gabc file needs to be
compiled are:
\begin{itemize}
\item If a gtex file does not exist.
\item If the modification time of the gabc file is newer than its
corresponding gtex file.
\item If the version of the gtex file is outdated.
\end{itemize}
When called with the optional argument \texttt{[n]} Gregorio\TeX\ will
include the score without doing anything else. This is the same as the
old behavior of Gregorio\TeX\ and therefore the default behavior.
When called with the optional argument \texttt{[f]} Gregorio\TeX\ will
compile the gabc file into a gtex file. This is similar to
\texttt{[a]} except the gabc is compiled every time.
\macroname{\textbackslash gresetgregpath}{\{\#1\}}{gregoriotex-main.tex}
Set a list of additional directories which should be searched for scores. Directories may be absolute or relative, but must end with a slash (\verb=/=) and enclosed in braces (\verb={}=), even if there is only one additional directory. For example, to look in a directory called “Scores” which is alongside the main project directory, one could use the following:
\begin{latexcode}
\gresetgregpath{{../Scores/}}
\end{latexcode}
Note that these directories are not searched recursively. If you want to include subdirectories, then each subdirectory must be included individually.
\macroname{\textbackslash gresetcompilegabc}{\{\#1\}}{gregoriotex-main.tex}
A macro to change the behavior of the way Gregorio\TeX\ includes scores. This is similar to using the package options \verb=[forcecompile]=, \verb=[autocompile]=, and \verb=[nevercompile]=, but does not necessarly apply to the entire document.
\begin{argtable}
\#1 & \texttt{force} & all later calls of \verb=\gregorioscore= will compile the gabc
file into a gtex file.\\
& \texttt{auto} & all later calls of \verb=\gregorioscore= will use Gregorio\TeX's
automatic compilation of gabc files.\\
& \texttt{never} & all later calls of \verb=\gregorioscore= will include the score
without doing anything else.
\end{argtable}
\medskip This macro can be combined in the same document with different arguments to
switch between different behaviors: \par\medskip
\begin{latexcode}
\usepackage{gregoriotex} % [autocompile] is the default.
----
\gregorioscore{TecumPrincipium} % gabc auto compiled.
\gregorioscore[n]{TecumPrincipium} % gabc never compiled.
\gregorioscore[f]{TecumPrincipium} % gabc always compiled.
\gresetcompilegabc{never}
\gregorioscore{TecumPrincipium} % gabc never compiled.
\gregorioscore[f]{TecumPrincipium} % gabc always compiled.
\gregorioscore[a]{TecumPrincipium} % gabc auto compiled.
\gresetcompilegabc{force}
\gregorioscore{TecumPrincipium} % gabc always compiled.
\gregorioscore[n]{TecumPrincipium} % gabc never compiled.
\gregorioscore[a]{TecumPrincipium} % gabc auto compiled.
\end{latexcode}
\macroname{\textbackslash gabcsnippet}{\{\#1\}}{gregoriotex-main.tex}
Converts the gabc notation specified in \texttt{\#1} to Gregorio\TeX\ and
includes it directly in the document.
\begin{argtable}
\#1 & string & The gabc to insert into the document.\\
\end{argtable}
\medskip For example:\par\medskip
\begin{latexcode}
\gabcsnippet{(c3) Al(eg~)le(gv.fhg)lu(efe___)ia(e.) (::)}
\end{latexcode}
\subsubsection{Point-and-click}
Gregorio can add Lilypond-like point-and-click links into the output PDF
file. The URLs added to the PDF conform with Lilypond and will use the
Lilypond scripts if they are enabled on your system. To configure your
system for this feature, please see the documentation for Lilypond since
they established the feature.\bigskip
In addition to switching this feature on in \TeX{}, you must also pass the
\texttt{-p} option to \texttt{gregorio} when converting your gabc files to
Gregorio\TeX{} for inclusion. This will automatically be done for auto- and
force-compiled scores, but if an auto-compiled score was compiled without the
option, Gregorio\TeX{} will not realize it has changed to recompile it. In
this case, remove the corresponding \texttt{.gtex} file to force it to
recompile.\bigskip
\textbf{Important:} As with LilyPond, you should always turn off
point-and-click before producing gtex and/or PDF files for distribution.
This feature embeds absolute filenames from your computer as links in
the PDF, which can pose a security risk. This is why this feature is
disabled by default.
\macroname{\textbackslash gresetpointandclick}{\{\#1\}}{gregoriotex-syllable.tex}
Macro to enable or disable the point-and-click feature.
\begin{argtable}
\#1 & \texttt{on} & Enable point-and-click link generation.\\
& \texttt{off} & Disable point-and-click link generation (default).
\end{argtable}
This feature may be switched on and off as desired between scores.
\subsubsection{Overall Size}
While the default size for Gregorio scores is designed to approximate that found in most liturgical books, Gregorio\TeX\ also provides mechanisms for changing the size of your scores for use in any application.
\macroname{\textbackslash grechangestaffsize}{\{\#1\}}{gregoriotex-main.tex}
Macro to adjust the size of the staff.
\begin{argtable}
\#1 & integer & The size of the staff lines. Default value is 17. Higher numbers yield larger staves.
\end{argtable}
\macroname{\textbackslash grechangestafflinethickness}{\{\#1\}}{gregoriotex-spaces.tex}
Macro to adjust the thickness of the staff lines.
\begin{argtable}
\#1 & integer & The thickness of the staff lines. The default value is same as staff size.
\end{argtable}
\subsubsection{Fine Tuning Dimensions}
In addition to providing control over the overall size of your scores, Gregorio\TeX\ allows you to fine tune the spacings around and between the various elements using the following functions.
\macroname{\textbackslash grechangedim}{\{\#1\}\{\#2\}\{\#3\}}{gregoriotex-spaces.tex}
Macro to change one of Gregorio\TeX’s distances. This function will check to make sure the distance you are trying to change exists first.
\begin{argtable}
\#1 & string & The name of the distance to be changed. See \nameref{distances} below.\\
\#2 & string & The distance in string format. \textbf{Note:} You cannot use a length register for this argument. You \emph{must} use a string because of the way that Gregorio\TeX\ handles spaces.\\
\#3 & \texttt{fixed} & Distance will not scale when staff size is changed.\\
& \texttt{scalable} & Distance will scale when staff size is changed.\\
& \texttt{inherited} & Distance will inherit its value from another distance. When this argument is used, then \#2 should be the name of another Gregorio\TeX\ distance.
\end{argtable}
\macroname{\textbackslash grechangenextscorelinedim}{\{\#1\}\{\#2\}\{\#3\}\{\#4\}}{gregoriotex-spaces.tex}
Changes one of Gregorio\TeX’s distances for a given line in the next included score. This works with \texttt{spaceabovelines}, \texttt{spacebeneathtext}, and \texttt{spacelinestext}.
\begin{argtable}
\#1 & list of integers & A comma-separated list of line numbers in the next
score to be adjusted.\\
\#2 & string & The name of the distance to be changed. See
\nameref{distances} below.\\
\#3 & 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.\\
\#4 & \texttt{fixed} & Distance will not scale when staff size is changed.\\
& \texttt{scalable} & Distance will scale when staff size is changed.\\
& \texttt{inherited} & Distance will inherit its value from another
distance. When this argument is used, then \#3 should
be the name of another Gregorio\TeX\ distance.
\end{argtable}
\macroname{\textbackslash grescaledim}{\{\#1\}\{\#2\}}{gregoriotex-spaces.tex}
Macro to turn on or off scaling with the staff size for a particular distance.
\begin{argtable}
\#1 & string & The name of the distance for which scaling is to changed. See \nameref{distances} below.\\
\#2 & \texttt{yes}/\texttt{true}/\texttt{on}/\texttt{scalable} & Choose just one of the given keywords. Scale the distance when changing the size of the staff.\\
& string not in list above & Do not scale the distance when changing the size of the staff.
\end{argtable}
\textbf{Nota bene:} This macro also can be used to change whether or not the staff line thickness scales with the staff size by specifying \texttt{stafflinefactor} for the first argument.
\macroname{\textbackslash grechangecount}{\{\#1\}\{\#2\}}{gregoriotex-spaces.tex}
Macro to change one of Gregorio\TeX’s counts or penalities (numeric values).
\begin{argtable}
\#1 & string & The name of the count to be changed. See \nameref{counts} and \nameref{penalties} below.\\
\#2 & integer & The new value.\\
\end{argtable}
\macroname{\textbackslash grechangenextscorelinecount}{\{\#1\}\{\#2\}\{\#3\}}{gregoriotex-spaces.tex}
Changes one of Gregorio\TeX’s counts or penalties for a given line in the next included score.
\begin{argtable}
\#1 & list of integers & A comma-separated list of line numbers in the next
score to be adjusted.\\
\#2 & string & The name of the count to be changed. See \nameref{counts} and
\nameref{penalties} below.\\
\#3 & integer & The new value.\\
\end{argtable}
\macroname{\textbackslash greloadspaceconf}{\{\#1\}}{gregoriotex-spaces.tex}
Macro to load a space configuration file. Space configuration file names have the format \verb=gsp-identifier.tex= and must be in the same directory as your project or in your texmf directory. See \verb=gsp-sample.tex= for an example file.
\begin{argtable}
\#1 & string & The identifier of the space configuration file.
\end{argtable}
Example:\par\medskip
\begin{latexcode}
% loads gregoriotex-gsp-default.tex, the default configuration file
\greloadspaceconf{default}
% loads a custom configuration called gsp-myspaces.tex
\greloadspaceconf{myspaces}
\end{latexcode}
\macroname{\textbackslash greconffactor}{}{gregoriotex-gsp-default.tex}
A count which indicates the staff size that a space configuration file is designed for. Each space configuration file must have this value set as Gregorio\TeX\ will compare it to the current staff size to determine if the configuration file being loaded needs to be rescaled.
\macroname{\textbackslash gresetlineheightexpansion}{\{\#1\}}{gregoriotex-main.tex}
Macro to configure line height expansion behavior when notes appear
above or below the staff lines.
\begin{argtable}
\#1 & \texttt{variable} & Expand lines within a score independently
of each other \\
& \texttt{uniform} & Expand all lines within a score uniformly
\end{argtable}
By default, Gregorio\TeX{} uses \texttt{variable} line expansion. This
produces output similar to modern liturgical books. However, this
feature imposes a slight performance impact and typically requires a
second pass (run of \texttt{lualatex}) to get the heights right.\bigskip
The older behavior of Gregorio\TeX{}, \texttt{uniform} line expansion,
does not have this performance impact. However, the extra space it adds
below the staff lines may look out-of-place in a section where there are
no notes below the staff lines.\bigskip
This behavior may be switched as needed within a \TeX{} document and
affects all the scores which follow. However, if \texttt{variable} line
expansion is enabled anywhere in the document, the second pass will be
necessary.
\begin{small}
\begin{framed}
\textit{For experts only:}\bigskip
It is possible to suppress the line height computation and just use
whatever has been computed from the previous run. If you are sure
that the score line heights haven't changed from the previous run,
define the \verb=\greskipheightcomputation= control sequence before
including the Gregorio\TeX{} package. This will save a little bit
of time per run.
\end{framed}
\end{small}
\macroname{\textbackslash gresetledgerlineheuristic}{\{\#1\}}{gregoriotex-spaces.tex}
Macro which enables or disables ledger line heuristics. Currently, ledger
line heuristics allow Gregorio to reduce the space between a note and a
horizontal episema that surround a line on which a ledger line may appear
when the ledger line \textit{does not} appear.
\begin{argtable}
\#1 & \texttt{enable} & Ledger line heuristics will be used in placing
the horizontal episema \\
& \texttt{disable} & Ledger line heuristics will not be used in
placing the horizontal episema \\
\end{argtable}
Because of the complexity of computing distances exactly, the heuristic may
guess incorrectly, causing the horizontal episema to be placed incorrectly.
This may be overridden on a note-by-note basic by using the
\texttt{[hl:\textit{n}]} and \texttt{[ll:\textit{n}]} gabc directives. The
\texttt{hl} directive sets an explicit high ledger line (above the staff),
and the \texttt{ll} directive sets an explicit low ledger line (below the
staff). The \texttt{\textit{n}} should be set to indicate whether the
system should act as if the ledger line exists (\texttt{1}) or not
(\texttt{0}).
\macroname{\textbackslash gresetnoteadditionalspacelinestext}{\{\#1\}}{gregoriotex-main.tex}
Macro which determines how much additional space between the notes and the lyrics for really low notes.
\begin{argtable}
\#1 & \texttt{automatic} & additional space between the notes and the lyrics is computed automatically (default)\\
& \texttt{manual} & additional space between the notes and the lyrics is based on the user setting of \texttt{noteadditionalspacelinestext} (a spacing adjustable using \verb=\grechangedim=)
\end{argtable}
\subsubsection{Staff Lines}
\macroname{\textbackslash gresetlinecolor}{\{\#1\}}{gregoriotex.sty \textup{and} gregoriotex.tex}
Macro for changing the color of the staff lines. The two most common colors you're going to want to use are \texttt{gregoriocolor} (see \nameref{colors}) and \texttt{black} (the default).
\begin{argtable}
\#1 & color name & The color of the staff lines
\end{argtable}
\macroname{\textbackslash gresetlines}{\{\#1\}}{gregoriotex-main.tex}
Macro for setting whether the staff lines should be rendered or not.
\begin{argtable}
\#1 & \texttt{visible} & The staff lines should be printed (default)\\
& \texttt{invisible} & The staff lines should not be printed
\end{argtable}
\macroname{\textbackslash gresetlinesbehindpunctumcavum}{\{\#1\}}{gregoriotex-signs.tex}
Macro for setting whether the staff lines behind a punctum cavum should be shown or not.
\begin{argtable}
\#1 & \texttt{visible} & The staff lines behind a punctum cavum should be printed (Plain \TeX\ default)\\
& \texttt{invisible} & The staff lines behind a punctum cavum should not be printed (\LaTeX\ default)
\end{argtable}
\macroname{\textbackslash gresetlinesbehindalteration}{\{\#1\}}{gregoriotex-signs.tex}
Macro for setting whether the staff lines behind an alternation (\ie, an accidental) should be shown or not.
\begin{argtable}
\#1 & \texttt{visible} & The staff lines behind an alteration should be printed (Plain \TeX\ default)\\
& \texttt{invisible} & The staff lines behind an alteration should not be printed (\LaTeX\ default)
\end{argtable}
\macroname{\textbackslash gresetlinesbehinddottedbar}{\{\#1\}}{gregoriotex-signs.tex}
Macro for setting whether the staff lines behind a dotted bar should be shown or not.
\begin{argtable}
\#1 & \texttt{visible} & The staff lines behind a dotted bar should be printed\\
& \texttt{invisible} & The staff lines behind a dotted bar should not be printed (default)
\end{argtable}
\subsubsection{Score Font}
Gregorio\TeX\ currently supports 3 different fonts for the glyphs in a score (neumes, clefs, alterations, \etc): Greciliae (a customized version of Caeciliae by Fr.\ Matthew Spencer, OSJ), Gregorio, and Grana Padano (née Parmesan, developed for Lilypond by Juergen Reuter).
\macroname{\textbackslash gresetgregoriofont}{[\optional{\#1}]\{\#2\}}{gregoriotex-main.tex}
Set the font used for the neumes. The optional argument \texttt{[\#1]}
may be used to specify an alternate font/rule set. Currently, the only
available alternate font/rule set is \texttt{op} for Dominican neumes.
Note that the font will be looked up by name through luaotfload, see the documentation of luaotfload for what it implies.
\begin{argtable}
\#1 & \textit{(omitted)} & Use the normal font and rule set (default).\\
& \texttt{op} & Use the alternate Dominican font/rule set.\\
\#2 & \texttt{greciliae} & Use the Greciliae font (default).\\
& \texttt{gregorio} & Use the Gregorio font.\\
& \texttt{granapadano} & Use the Grana Padano font.\\
\end{argtable}
\textbf{Nota Bene:} The Gregorio and Grana Padano fonts are not included by default in a basic installation. To get them you need to download and install them from the \verb=supp-fonts-##.zip= file (where \#\# is the version number of your release). See \url{https://github.com/gregorio-project/gregorio/releases} for the list of releases.
\macroname{\textbackslash gresetgregoriofontscaled}{[\optional{\#1}]\{\#2\}\{\#3\}}{gregoriotex-main.tex}
This function is the same as above, with a third argument to scale the font. The fonts shipped with Gregorio do not need to use this function, but some custom fonts do. Note that you cannot use this to scale glyphs up or down, as they would not be placed correctly on the staff.
The two first arguments are the same as \texttt{\textbackslash gresetgregoriofont}. The third argument is an integer representing the scaling factor, where the one used by \texttt{\textbackslash gresetgregoriofont} is 100000.
\macroname{\textbackslash greloadholehollowfonts}{\{\#1\}}{gregoriotex-main.tex}
If set to false, will not load the \texttt{hollow} and \texttt{hole} variants of the next font to load. Use it before loading third party fonts not having these variants (rare case).
\begin{argtable}
\#1 & string & \texttt{true} or \texttt{false}.\\
\end{argtable}
\subsubsection{Glyph Alteration}
In addition to the normal glyphs loaded by the choice of font, Gregorio\TeX\ also supports several methods for fine tuning the choice of glyphs. Using the below functions, you can choose from alternative glyphs which are already built into Gregorio\TeX\ or import custom glyphs you have designed yourself.
\macroname{\textbackslash grechangeglyph}{\{\#1\}\{\#2\}\{\#3\}}{gregoriotex-main.tex}
Substitutes the given Gregorio\TeX\ score glyph with the specified glyph
from the specified font.
\begin{argtable}
\#1 & string & The name of the Gregorio\TeX\ glyph to replace.\\
\#2 & string & The name of the font to use.\\
\#3 & number & The code point of the glyph to use.\\
& \texttt{.}string & The name of the variant (appended to \#1) to use.\\
& string & (any other string) The name of the glyph to use.
\end{argtable}
\medskip If \texttt{\#1} has a wildcard (a \texttt{*}) in it, then \texttt{\#3}
must be empty or start with a dot, and all glyphs matching \texttt{\#1} will be
replaced with corresponding glyphs whose names have \texttt{\#3} appended.
\medskip If \texttt{\#2} is \texttt{*}, then the substitution is assumed
to be available in all score fonts.
\medskip For example, to use the old glyphs (from Caeciliae) for the
strophicus, use the following:\par\medskip
\begin{latexcode}
\grechangeglyph{Stropha}{greciliae}{.caeciliae}
\grechangeglyph{StrophaAucta}{greciliae}{.caeciliae}
\end{latexcode}
\medskip To replace all torculus resupinus glyphs with their alternate
versions, use the following:\par\medskip
\begin{latexcode}
\grechangeglyph{TorculusResupinus*}{*}{.alt}
\end{latexcode}
\textbf{Nota Bene:} Because the bar glyphs vary based on number of score lines,
substituting them is more complicated. To cover all numbers of score lines,
you will need to substitute all of the glyphs for the same (like
\texttt{VirgulaTwo} through \texttt{VirgulaSix} for all available virgula
glyphs). For example:
\medskip To replace all "dotted divisio maior" glyphs with their same-named
variants from the \texttt{gregorio} font, use the following:\par\medskip
\begin{latexcode}
\grechangeglyph{DivisioMaiorDotted*}{gregorio}{}
\end{latexcode}
\macroname{\textbackslash greresetglyph}{\{\#1\}}{gregoriotex-main.tex}
Removes a Gregorio\TeX\ score glyph substitution, restoring it back to
its original form.
\begin{argtable}
\#1 & string & The name of the Gregorio\TeX\ glyph to restore.\\
\end{argtable}
\medskip If \texttt{\#1} has a wildcard (a \texttt{*}) in it, then
all glyphs matching \texttt{\#1} will be restored.
\medskip For example, to restore the strophicus back to the new glyphs,
use the following:\par\medskip
\begin{latexcode}
\greresetglyph{Stropha}
\greresetglyph{StrophaAucta}
\end{latexcode}
\medskip To restore all torculus resupinus glyphs to their original
form, use the following:\par\medskip
\begin{latexcode}
\greresetglyph{TorculusResupinus*}
\end{latexcode}
\macroname{\textbackslash grechangecavumglyph}{\{\#1\}\{\#2\}\{\#3\}[\optional{\#4}][\optional{\#5}]}{gregoriotex-main.tex}
Substitutes the given Gregorio\TeX\ score cavum glyphs with the specified glyphs
from the specified font.
\begin{argtable}
\#1 & string & The name of the Gregorio\TeX\ glyph to replace.\\
\#2 & string & The name of the font to use for the cavum glyph.\\
\#3 & number & The code point of the cavum glyph to use.\\
& \texttt{.}string & The name of the variant (appended to \#1) to use for the cavum glyph.\\
& string & (any other string) The name of the cavum glyph to use.\\
\#4 & string & The name of the font to use for the glyph to fill in the cavum hole.\\
\#5 & number & The code point of the glyph to use to fill in the cavum hole.\\
& \texttt{.}string & The name of the variant (appended to \#1) to use to fill in the the cavum hole.\\
& string & (any other string) The name of the glyph to use to fill in the cavum hole.\\
\end{argtable}
\textbf{Nota Bene:} The usage of wildcards (\texttt{*}s) for \texttt{\#1},
\texttt{\#2}, and \texttt{\#4} is similar to \verb=\grechangeglyph=.
\macroname{\textbackslash greresetcavumglyph}{\{\#1\}}{gregoriotex-main.tex}
Removes a pair of Gregorio\TeX\ score cavum glyph substitution, restoring them
back to their original form.
\begin{argtable}
\#1 & string & The name of the Gregorio\TeX\ cavum glyph to restore.\\
\end{argtable}
\textbf{Nota Bene:} The usage of wildcards (\texttt{*}s) for \texttt{\#1} is
similar to \verb=\greresetcavumglyph=.
\macroname{\textbackslash gredefsymbol}{\{\#1\}\{\#2\}\{\#3\}}{gregoriotex-symbols.tex}
Defines (or redefines) a \TeX\ control sequence to be a non-score symbol.
If defined this way, the symbol will scale with the text font.
\begin{argtable}
\#1 & string & The name of the \TeX\ control sequence (without leading backslash).\\
\#2 & string & The name of the font to use.\\
\#3 & number & The code point of the glyph to use.\\
& string & The name of the glyph to use.
\end{argtable}
\macroname{\textbackslash gredefsizedsymbol}{\{\#1\}\{\#2\}\{\#3\}}{gregoriotex-symbols.tex}
Defines (or redefines) a \TeX\ control sequence to be a non-score symbol
which requires a single numeric argument (in points) to which the symbol
will be scaled.
\begin{argtable}
\#1 & string & The name of the \TeX\ control sequence (without leading backslash).\\
\#2 & string & The name of the font to use.\\
\#3 & number & The code point of the glyph to use.\\
& string & The name of the glyph to use.
\end{argtable}
\macroname{\textbackslash gresethepisema}{\{\#1\}}{gregoriotex-signs.tex}
Determines whether Gregorio\TeX\ should join (bridge) horizontal episemata on adjacent notes.
\begin{argtable}
\#1 & \texttt{bridge} & Adjacent horizontal episemata are joined together (default).\\
& \texttt{break} & Adjacent horizontal episemata are not joined.
\end{argtable}
\macroname{\textbackslash gresetpunctumcavum}{\{\#1\}}{gregoriotex-signs.tex}
A shortcut for switching to the alternative punctum cavum and back.
\begin{argtable}
\#1 & \texttt{alternate} & use the alternate punctum cavum\\
& \texttt{normal} & use the normal punctum cavum
\end{argtable}
Using the alternate punctum cavum is the equivalent of issuing the following commands:
\begin{latexcode}
\grechangeglyph{PunctumCavum}{greciliae}{.caeciliae}%
\grechangeglyph{LineaPunctumCavum}{greciliae}{.caeciliae}%
\grechangeglyph{PunctumCavumHole}{greciliae}{.caeciliae}%
\grechangeglyph{LineaPunctumCavumHole}{greciliae}{.caeciliae}%
\end{latexcode}
\macroname{\textbackslash gresetglyphstyle}{\{\#1\}}{gregoriotex-chars.tex}
Gregorio\TeX\ supports several glyph styles which can be changed with this macro. These style replace some non-note glyphs with alternatives.
\begin{argtable}
\#1 & \texttt{default} & Use the default style\\
& \texttt{medicaea} & Use a Medicaea style\\
& \texttt{hufnagel} & Use the hufnagel style\\
& \texttt{mensural} & Use the mensural style
\end{argtable}
%%% Should there be a table here or in the appendix which shows the affected glyphs in each of the styles?
\subsubsection[Barred letters (A/, etc.)]{Barred letters (\Abar, etc.)}
\macroname{\textbackslash gresimpledefbarredsymbol}{\{\#1\}\{\#2\}}{gregoriotex-symbols.tex}
Redefines a \TeX\ control sequence to be a a barred symbol.
\begin{argtable}
\#1 & character & must be \texttt{A}, \texttt{R}, or \texttt{V}.\\
\#2 & dimension & how much the bar will be shifted left.\\
\end{argtable}
Gregorio\TeX\ does not have precomposed barred letters, instead, it has bars that you
can use to composed barred letters in your text font. This command is the most
simple version.
For example:
\medskip \begin{latexcode}
\gresimpledefbarredsymbol{A}{0.3em}
\end{latexcode}
Will define \texttt{\textbackslash Abar} to be a A with a bar shifted right
of \texttt{0.3em} from the beginning of the glyph. This is the default definition
and fits well with the Linux Libertine font. If you use another font, you'll
certainly have to change this value by calling the \texttt{\textbackslash gresimpledefbarglyph} command.
\macroname{\textbackslash gredefbarredsymbol}{\{\#1\}\{\#2\}\{\#3\}\{\#4\}\{\#5\}\{\#6\}}{gregoriotex-symbols.tex}
Redefines a \TeX\ control sequence to be a barred symbol.
\begin{argtable}
\#1 & string & the name of the command you want to define.\\
\#2 & string & command to typeset the text.\\
\#3 & string & symbol of the bar (must be defined through \texttt{gredefsizedsymbol}).\\
\#4 & number & the size of greextra to use (in pt).\\
\#5 & dimension & horizontal right shift of the bar.\\
\#6 & dimension & vertical shift of the bar glyph.\\
\end{argtable}
This is a more complete version of the previous command, it allows you to define
barred letters with a different style. For example you can choose another bar
drawing, or take a bar more adapted to small font size.
For example:
\begin{footnotesize}
\begin{latexcode}
\gredefbarredsymbol{RBarBold}{\textbf{R}}{greRBarSmall}{13}{1.7mm}{0.1mm}
\end{latexcode}
\end{footnotesize}
\gredefbarredsymbol{RBarBold}{\textbf{R}}{greRBarSmall}{13}{1.7mm}{0.1mm}
Will define \texttt{\textbackslash RBarBold} to be a bold \textbf{R} with
the bar made for small text (a bit bolder, named \texttt{RBarSmall} in greextra)
, at 12pt, shifted right of \texttt{1.7mm} from the beginning of the glyph, and lowered down
by \texttt{0.1mm}. The result is that \texttt{\textbackslash RBarBold} will typeset \RBarBold .
See Appendix \ref{subsec:greextra} for a list of bars and other
symbols present in the greextra font.
\macroname{\textbackslash grelatexsimpledefbarredsymbol}{\{\#1\}\{\#2\}\{\#3\}\{\#4\}\{\#5\}}{gregoriotex-symbols.tex}
Redefines a \TeX\ control sequence to be a barred symbol.
\bigskip\textbf{Only available in \LaTeX.}
\begin{argtable}
\#1 & character & must be \texttt{A}, \texttt{R}, or \texttt{V}.\\
\#2 & dimension & how much the bar will be shifted left when upright and medium weight.\\
\#3 & dimension & how much the bar will be shifted left when italic/slanted and medium weight.\\
\#4 & dimension & how much the bar will be shifted left when upright and bold.\\
\#5 & dimension & how much the bar will be shifted left when italic/slanted and bold.\\
\end{argtable}
This is like \verb=\gresimpledefbarglyph=, but allows setting different shifts
for different font shapes and weights. If you need something more elaborate,
you will need to redefine the bar macro(s) manually. This macro is only
available in \LaTeX{} because it depends upon the \LaTeX{} font system.
\macroname{\textbackslash grebarredsymbol}{\{\#1\}\{\#2\}\{\#3\}\{\#4\}\{\#5\}}{gregoriotex-symbols.tex}
Generates a barred symbol. This macro does not change any barred symbol
definitions. Instead, it actually generates the code that would show the
barred symbol.
\begin{argtable}
\#1 & string & command to typeset the text.\\
\#2 & string & symbol of the bar (must be defined through \texttt{gredefsizedsymbol}).\\
\#3 & number & the size of greextra to use (in pt).\\
\#4 & dimension & horizontal right shift of the bar.\\
\#5 & dimension & vertical shift of the bar glyph.\\
\end{argtable}
\macroname{\textbackslash gothRbar}{}{gregoriotex-symbols.tex}
Prints \gothRbar. Defined with \verb=\gredefsymbol=.
\macroname{\textbackslash gothVbar}{}{gregoriotex-symbols.tex}
Prints \gothVbar. Defined with \verb=\gredefsymbol=.
\macroname{\textbackslash grealtcross}{}{gregoriotex-symbols.tex}
Prints \grealtcross. Defined with \verb=\gredefsymbol=.
\macroname{\textbackslash grecross}{}{gregoriotex-symbols.tex}
Prints \grecross. Defined with \verb=\gredefsymbol=.
\macroname{\textbackslash greheightstar}{}{gregoriotex-symbols.tex}
Prints \greheightstar. Defined with \verb=\gredefsymbol=.
\macroname{\textbackslash gresixstar}{}{gregoriotex-symbols.tex}
Prints \gresixstar. Defined with \verb=\gredefsymbol=.
\macroname{\textbackslash greseparator}{\{\#1\}\{\#2\}}{gregoriotex-symbols.tex}
A macro for invoking one of the five separators (fancy lines) which are contained in the greextra font.
\begin{argtable}
\#1 & \texttt{1}--\texttt{5} & Choose the number of the line desired\\
\#2 & integer & the point size at which to print the line\\
\end{argtable}
\macroname{\textbackslash greornamentation}{\{\#1\}\{\#2\}}{gregoriotex-symbols.tex}
A macro for invoking one of the ornamentation elements which are contained in the greextra font.
\begin{argtable}
\#1 & \texttt{1}--\texttt{2} & Choose the number of the ornamentation desired\\
\#2 & integer & the point size at which to print the line\\
\end{argtable}
\subsubsection{Special Characters}
% this is defined in gregoriotex-symbols.texx as having one argument, but the
% lua code generates a \gdef\<something> which then requires a second argument
\macroname{\textbackslash gresetspecial}{\{\#1\}\{\#2\}}{gregoriotex-symbols.tex}
Sets a special character. Special characters are used from gabc within
\texttt{<sp>} and \texttt{</sp>}.
\begin{argtable}
\#1 & string & The text between \texttt{<sp>} and \texttt{</sp>}.\\
\#2 & \TeX\ code & The \TeX\ code to substitute when \texttt{<sp>\#1</sp>}
is used in gabc.\\
\end{argtable}
\textbf{Nota Bene:} If you need to use a character in \#1 that is made special
by \TeX{} (\ie, \textbackslash, \%, \etc), you should instead use
\verb=\string\nnn=, where \texttt{nnn} is a three-digit, zero-padded number
representing the ASCII code of the character (\ie, \textbackslash{} would be
\verb=\string\092=).
\macroname{\textbackslash greunsetspecial}{\{\#1\}}{gregoriotex-symbols.tex}
Un-sets a special character. Using an unset special character will use its
text directly.
\begin{argtable}
\#1 & string & The text between \texttt{<sp>} and \texttt{</sp>}.\\
\end{argtable}
\textbf{Nota Bene:} The same rules apply for \#1 as in \verb=\gresetspecial=.
\macroname{\textbackslash gretilde}{}{gregoriotex-main.tex}
Macro to print $\sim$. This macro is set using the above for \texttt{<sp>$\sim$</sp>}.
\subsubsection{Styling}
Different elements of an include score have different styles applied. These elements and their defaults are listed below:
\begin{adjustbox}{center}
\let\stylename\texttt
\renewcommand{\thefootnote}{\fnsymbol{footnote}}
\bigskip\rowcolors{1}{lightgray}{lightgray}
\begin{tabular}{lp{7cm plus .5cm}r}
Element Name & Description & Default\\
\hline
\stylename{abovelinestext} & above line text (\texttt{<alt></alt>} in gabc, appears above the staff) & normal\\
\stylename{additionalstafflines} & short lines behind notes above or below the staff & special\footnotemark[1]\\
\stylename{annotation} & the annotation & none\\
\stylename{commentary} & the commentary & {\footnotesize\it footnote-size italics} (\LaTeX)\\
&& {\textit{italics}} (Plain \TeX)\\
\stylename{elision} & elisions (\texttt{<e></e>} in gabc) & {\textit{\small small-size italics}} (\LaTeX)\\
&& {\textit{italics}} (Plain \TeX)\\
\stylename{firstsyllable} & the first syllable of the score excluding the score initial & none\\
\stylename{firstsyllableinitial} & the first letter of the first syllable of a score which is not the score initial & none\\
\stylename{firstword} & the first word of the first score excluding the score initial & none\\
\stylename{highchoralsign} & high choral signs & none\\
\stylename{initial} & Score initial (the first letter of the score, when offset from the rest of the text) & 40 pt font\\
\stylename{lowchoralsign} & low choral signs & none\\
\stylename{modedifferentia} & the rendered annotation from the \texttt{mode-differentia: ;} header in the gabc file & \parbox[t]{2.2cm}{\raggedleft\textbf{bold}}\\
\stylename{modeline} & the rendered annotation from the \texttt{mode: ;} header in the gabc file & \parbox[t]{2.2cm}{\raggedleft\textsc{\textbf{bold small capitals}}} (\LaTeX)\\
& & \textbf{bold} (Plain\TeX)\\
\stylename{modemodifier} & the rendered annotation from the \texttt{mode-modifier: ;} header in the gabc file & \parbox[t]{2.2cm}{\raggedleft\textit{\textbf{bold italics}}}\\
\stylename{nabc} & ancient notation & {\color{gregoriocolor}gregoriocolor}\\
\stylename{normalstafflines} & Full length staff lines & none\\
\stylename{translation} & Translation text (appears below lyrics) & {\it italics}\\
\end{tabular}
\end{adjustbox}
\footnotemark[1]\textit{Special:} By default, \texttt{additionalstafflines} inherits its properties from \texttt{normalstafflines}. To decouple these environments, you must manually change \texttt{additionalstafflines} using \texttt{\textbackslash grechangestyle}.
\renewcommand{\thefootnote}{\arabic{footnote}}\breakabletrue
\macroname{\textbackslash grechangestyle}{\{\#1\}\{\#2\}[\optional{\#3}]}{gregoriotex.sty \textup{and} gregoriotex.tex}
Command to change styling of a score element.
\begin{argtable}
\#1 & string & element whose styling is to be changed (see list above for options)\\
\#2 & \TeX\ code & the code necessary to turn on the styling\\
\#3 & \TeX\ code & Optional. The code necessary to turn off the styling (\eg, if the code to turn on the styling contains a \verb=\begin{environment}= then the code to turn it off must have the matching \verb=\end{environment}=.
\end{argtable}
Examples:\par\medskip
\begin{latexcode}
% This one works for both PlainTeX and LaTeX this would make
% the translations bold and italic
\grechangestyle{translation}{\it\bf}
% This one is LaTeX only, and would make the above lines
% text small and italic
\grechangestyle{abovelinestext}{\begin{small}\begin{itshape}}%
[\end{itshape}\end{small}]
% This would make the initial print in 36pt font.
\grechangestyle{initial}{\fontsize{36}{36}\selectfont}
\end{latexcode}
\bigskip
Each element will be typeset within an isolated group to prevent styling commands from leaking from one element to the next. As a result, if a styling command has an ``on-switch'' but no ``off-switch'' (like \verb=\it= or \verb=\bf= in the first example above) it is not necessary to encapsulate them within \verb=\begingroup= and \verb=\endgroup=. As a result, the third argument is only necessary for styling commands which come in pairs (like the environments in the second example).
\subsubsection{Text Elements}
While the gabc headers provide support for some of the text elements commonly found on chant scores, Gregorio\TeX\ provides the following functions to allow you to enter and control those elements with a greater degree of precision than the gabc headers.
\macroname{\textbackslash greannotation}{[\optional{\#1}]\{\#2\}}{gregoriotex-main.tex}
Macro to add annotations (the text which appears above the initial) to a score. While a single call of the function does not support multiple lines, successive calls to the function will be added to the annotation as a new line below what is already there.
\begin{argtable}
\#1 & \texttt{c} & When adding a new line, align the center of the new line with the center of the existing lines\\
& \texttt{l} & When adding a new line, align the left side of the new line with the left side of the existing lines\\
& \texttt{r} & When adding a new line, align the right side of the new line with the right side of the existing lines\\
\#2 & string & the text of the annotation
\end{argtable}
\textbf{Nota Bene:} The first argument does not affect the alignment of lines already in the annotation, only the way the new line aligns with the existing lines as a whole.
\macroname{\textbackslash grecommentary}{[\optional{\#1}]\{\#2\}}{gregoriotex-main.tex}
Macro to add commentary (the text flush right at the top, usually a scripture reference) to a score. While a single call of this function does not support multiple lines, successive calls to the function will add a new line to the commentary directly below the previous.
\begin{argtable}
\#1 & distance & Optional. Additional distance to be placed between the commentary and the top staff line for the next score only.\\
\#2 & string & The text of the commentary.\\
\end{argtable}
\textbf{Nota Bene:} If your commentary is multi-lined, then the optional argument of the last line, and only the last line, will be taken into account. Further, pay attention to the fact that the optional argument is \emph{additional} distance, \ie, it will be added to \texttt{commentaryraise} to determine the distance from the baseline of the commentary to the top line of the staff.
\macroname{\textbackslash greillumination}{\{\#1\}}{gregoriotex-main.tex}
Macro to add an illuminated initial.
\begin{argtable}
\#1 & \TeX\ code & the code necessary to make the illuminated initial appear\\
\end{argtable}
\textbf{Nota Bene:} Usually the argument of this command should be an \verb=\includegraphics= command, but you may use what ever you want as the illuminated initial.
\macroname{\textbackslash gresetinitiallines}{\{\#1\}}{gregoriotex-syllable.tex}
Sets the number of lines the score initial requires.
\begin{argtable}
\#1 & number & The number of lines required by the initial. If \texttt{0}, the score will have no separated initial.\\
\end{argtable}
\textbf{Nota Bene:} As currently implemented, you cannot set an initial which is larger than 2 lines and in order to do so you must set manual line breaks in the gabc for the first two lines.
\macroname{\textbackslash gresetmodenumbersystem}{\{\#1\}}{gregoriotex-main.tex}
Sets the number system used for the mode number.
\begin{argtable}
\#1 & \texttt{roman-minuscule} & Use lower-case Roman numerals (the default in \LaTeX, good for small capitals).\\
& \texttt{roman-majuscule} & Use upper-case Roman numerals (the default in Plain\TeX).\\
& \texttt{arabic} & Use Arabic numerals.\\
\end{argtable}
\macroname{\textbackslash gresetlyrics}{\{\#1\}}{gregoriotex-syllable.tex}
Sets the visibility of the lyrics.
\begin{argtable}
\#1 & \texttt{visible} & Lyrics are visible (default).\\
& \texttt{invisible} & Lyrics are not visible.\\
\end{argtable}
\macroname{\textbackslash gresettranslation}{\{\#1\}}{gregoriotex-main.tex}
Sets the visibility of the translations.
\begin{argtable}
\#1 & \texttt{visible} & Translations are visible (default).\\
& \texttt{invisible} & Translations are not visible.\\
\end{argtable}
\macroname{\textbackslash gresetabovelinestext}{\{\#1\}}{gregoriotex-main.tex}
Sets the visibility of the above lines text.
\begin{argtable}
\#1 & \texttt{visible} & Above lines text are visible (default).\\
& \texttt{invisible} & Above lines text are not visible.\\
\end{argtable}
\subsubsection{Text Alignment}
Gregorio\TeX\ allows you to manipulate the global alignment behavior of some text elements using the following commands.
\macroname{\textbackslash gresetlyriccentering}{\{\#1\}}{gregoriotex-syllable.tex}
Macro to set how the text of the lyrics aligns with the alignment point of its respective neumes. The alignment point of the neumes is determined as follows:
\begin{itemize}
\item If the first glyph is only one note, or is a normal pes, or is composed of three or more notes, the alignment point is the middle of the first note.
\item If the first glyph is composed of two notes (other than a normal pes), the alignment point is the middle of the glyph.
\item In the case of a porrectus, the alignment point is the middle of an imaginary square punctum beginning at the same point as the porrectus.
\end{itemize}
\begin{argtable}
\#1 & \texttt{vowel} & The center of the vowel in the syllable will align with the alignment point of the neumes\\
& \texttt{syllable} & The center of the syllable will align with the alignment point of the neumes\\
& \texttt{firstletter} & The center of the first letter/character of the syllable will align with the alignment point of the neumes\\
\end{argtable}
\textbf{Nota Bene:} What constitutes the ``vowel'' of the syllable is determined by the language the lyric text is written in, as specified by the use of the \texttt{language} header in the gabc file. Out of the box, Gregorio\TeX\ explicitly supports Latin, English, Church Slavonic and Hungarian. Polish, Czech, and Slovak are supported as aliases for Church Slavonic. Furthermore the rules for Latin have a high degree of overlap with many Romance languages, allowing them to fall back on the Latin rules with acceptable results.
You can also define your own languages in \texttt{gregorio-vowels.dat} (see \nameref{customvowels} for details). If you do define a language, please consider sharing your work by submitting it to the project (see CONTRIBUTING.md for instructions).
Finally, in cases where you want some sort of exceptional alignment, you can force Gregorio to consider a particular part of the syllable to be the ``vowel'' by enclosing it in curly braces (``\{'' and ``\}'') in your gabc file. Curly braces only affect alignment when using vowel centering. Syllable centering will always use the entire syllable, and firstletter centering will always use the first character of the syllable --- regardless of curly braces in the gabc file.
\macroname{\textbackslash gresetgabcforcecenters}{\{\#1\}}{gregoriotex-syllable.tex}
Macro to determine whether a forced center (\ie, one specified by curly braces (``\{'' and ``\}'') in your gabc file) should influence the alignment of that syllable when \texttt{syllable} and \texttt{firstletter} alignments are in effect.
\begin{argtable}
\#1 & \texttt{allow} & Forced centers in gabc are allowed to influence the syllable alignment (default).\\
& \texttt{prohibit} & Forced centers in gabc do not influence the syllable alignment.\\
\end{argtable}
\macroname{\textbackslash gresettranslationcentering}{\{\#1\}}{gregoriotex-main.tex}
Macro to specify how the translation text should be aligned with it respective syllable text.
\begin{argtable}
\#1 & \texttt{left} & The translation text is left aligned with its respective syllable text.\\
& \texttt{center} & The translation text is centered under its respective syllable.
\end{argtable}
\macroname{\textbackslash gresetannotationby}{\{\#1\}}{gregoriotex-main.tex}
Macro to specify which line of the annotation should be used to determine its starting placement (i.e. before \texttt{annotationraise} is applied).
\begin{argtable}
\#1 & \texttt{topline} & Annotation placement is determined by the first line (default)\\
& \texttt{bottomline} & annotation placement is determined by the last line\\
\end{argtable}
\macroname{\textbackslash gresetannotationvalign}{\{\#1\}}{gregoriotex-main.tex}
Macro to specify which part of the control line in the annotation should be aligned with the top line of the staff before \texttt{annotationraise} is applied.
\begin{argtable}
\#1 & \texttt{top} & The top of the annotation control line will align with the top line of the staff\\
& \texttt{baseline} & The baseline of the control line is used (default)\\