| 1 |
% !TEX root = GregorioRef.tex |
| 2 |
% !TEX program = LuaLaTeX+se |
| 3 |
% |
| 4 |
% Copyright (C) 2006-2025 The Gregorio Project (see CONTRIBUTORS.md) |
| 5 |
% |
| 6 |
% This file is part of Gregorio. |
| 7 |
% |
| 8 |
% Gregorio is free software: you can redistribute it and/or modify |
| 9 |
% it under the terms of the GNU General Public License as published by |
| 10 |
% the Free Software Foundation, either version 3 of the License, or |
| 11 |
% (at your option) any later version. |
| 12 |
% |
| 13 |
% Gregorio is distributed in the hope that it will be useful, |
| 14 |
% but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 15 |
% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 16 |
% GNU General Public License for more details. |
| 17 |
% |
| 18 |
% You should have received a copy of the GNU General Public License |
| 19 |
% along with Gregorio. If not, see <http://www.gnu.org/licenses/>. |
| 20 |
% |
| 21 |
\section{Gregorio Controls} |
| 22 |
|
| 23 |
These functions are the ones written by gregorio to the gtex file. |
| 24 |
While one could, in theory, use/change them to alter the appearance of |
| 25 |
elements of the score, it is far better to make your changes in the |
| 26 |
gabc file and let gregorio make the changes to the gtex file. |
| 27 |
|
| 28 |
\macroname{\textbackslash GreAnnotationLines}{\#1\#2}{gregoriotex-main.tex} |
| 29 |
A wrapper macro for placing annotations above the initial. The |
| 30 |
arguments are provided by the \texttt{gabc} file in the |
| 31 |
\texttt{annotation} header field. This macro tests for the presence |
| 32 |
of the annotation box which means that the annotation is explicitly |
| 33 |
defined in the \texttt{main.tex} file. If so, this macro does nothing, |
| 34 |
respecting the annotation value in the \texttt{main.tex} file. |
| 35 |
|
| 36 |
\begin{argtable} |
| 37 |
\#1 & string & First line text to place above the initial.\\ |
| 38 |
\#2 & string & Second line text to place above the initial.\\ |
| 39 |
\end{argtable} |
| 40 |
|
| 41 |
\macroname{\textbackslash GreBeginScore}{\#1\#2\#3\#4\#5\#6\#7\#8}{gregoriotex-main.tex} |
| 42 |
Macro to start a score. |
| 43 |
|
| 44 |
\begin{argtable} |
| 45 |
\#1 & string & a unique identifier for the score (currently an SHA-1-based digest of the gabc file)\\ |
| 46 |
\#2 & integer & the height number of the top pitch of the entire score, including signs\\ |
| 47 |
\#3 & integer & the height number of the bottom pitch of the entire score, including signs\\ |
| 48 |
\#4 & 0 & there is no translation line in the score\\ |
| 49 |
& 1 & there is a translation line somewhere in the score\\ |
| 50 |
\#5 & 0 & there is no above lines text in the score\\ |
| 51 |
& 1 & there is above lines text somewhere in the score\\ |
| 52 |
\#6 & string & the absolute filename of the gabc file if point-and-click is enabled\\ |
| 53 |
\#7 & integer & the number of staff lines\\ |
| 54 |
\#8 & \TeX\ code & macros to run before the score (\eg, setting clef |
| 55 |
extrema)\\ |
| 56 |
\end{argtable} |
| 57 |
|
| 58 |
\macroname{\textbackslash GreEndScore}{}{gregoriotex-main.tex} |
| 59 |
Macro to end a score. |
| 60 |
|
| 61 |
\macroname{\textbackslash GreBeginHeaders}{}{gregoriotex-main.tex} |
| 62 |
Macro called at the beginning of a set of gabc headers. |
| 63 |
|
| 64 |
\macroname{\textbackslash GreEndHeaders}{}{gregoriotex-main.tex} |
| 65 |
Macro called at the end of a set of gabc headers. |
| 66 |
|
| 67 |
\macroname{\textbackslash GreAccentus}{\#1\#2}{gregoriotex-signs.tex} |
| 68 |
Macro for typesetting an accentus. |
| 69 |
|
| 70 |
\begin{argtable} |
| 71 |
\#1 & integer & height number of episema\\ |
| 72 |
\#2 & string & Type of glyph the episema is attached to. See \Nameref{NoteOffset} for a description of options.\\ |
| 73 |
\end{argtable} |
| 74 |
|
| 75 |
\macroname{\textbackslash GreAdditionalLine}{\#1\#2\#3}{gregoriotex-signs.tex} |
| 76 |
Macro to typeset the additional line above or below the staff. |
| 77 |
|
| 78 |
\begin{argtable} |
| 79 |
\#1 & string & See \Nameref{NoteOffset}.\\ |
| 80 |
\#2 & integer & The ambitus of the porrectus or porrectus flexus if the first references these glyph types; ignored otherwise.\\ |
| 81 |
\#3 & integer & Set horizontal episema (0), horizontal episema under a note (1), line at top of staff (2), line at bottom of staff (3), choral sign (4).\\ |
| 82 |
\end{argtable} |
| 83 |
|
| 84 |
\macroname{\textbackslash GreAdHocSpaceEndOfElement}{\#1\#2\#3}{gregoriotex-main.tex} |
| 85 |
Macro to end an element with an ad-hoc space. |
| 86 |
|
| 87 |
\begin{argtable} |
| 88 |
\#1 & float & The factor to scale the default space for use as an ad-hoc space.\\ |
| 89 |
\#2 & \texttt{0} & Space is breakable.\\ |
| 90 |
& \texttt{1} & Space is unbreakable.\\ |
| 91 |
\#3 & integer & The number of notes in the syllable prior to this macro.\\ |
| 92 |
\end{argtable} |
| 93 |
|
| 94 |
\macroname{\textbackslash GreAugmentumDuplex}{\#1\#2\#3}{gregoriotex-signs.tex} |
| 95 |
Macro for typesetting an augmentum duplex (a pair of punctum mora) |
| 96 |
|
| 97 |
\begin{argtable} |
| 98 |
\#1 & integer & Height number for first punctum mora.\\ |
| 99 |
\#2 & integer & Height number for second punctum mora.\\ |
| 100 |
\#3 & integer & First punctum mora occurs before last note of a podatus, prorectus, or toculus resupinus (1), or not (0).\\ |
| 101 |
\end{argtable} |
| 102 |
|
| 103 |
\macroname{\textbackslash GreBarBrace}{\#1}{gregoriotex-signs.tex} |
| 104 |
Macro for typesetting a bar brace. |
| 105 |
|
| 106 |
\begin{argtable} |
| 107 |
\#1 & string & Type of glyph the episema is attached to. See \Nameref{NoteOffset} for a description of options.\\ |
| 108 |
\end{argtable} |
| 109 |
|
| 110 |
\macroname{\textbackslash GreBarSyllable}{\#1\#2\#3\#4\#5\#6\#7\#8\#9}{gregoriotex-syllable.tex} |
| 111 |
Macro for typesetting a bar syllable. |
| 112 |
|
| 113 |
\begin{argtable} |
| 114 |
\#1 & \TeX\ code & macro setting syllable letters for the current syllable\\ |
| 115 |
\#2 & empty & reserved for future use\\ |
| 116 |
\#3 & \TeX\ control sequence & the control sequence to use for styling the hyphen\\ |
| 117 |
\#4 & \texttt{0} & this syllable is not the end of a word\\ |
| 118 |
& \texttt{1} & this syllable is the end of a word\\ |
| 119 |
\#5 & \TeX\ code & macros setting syllable letters for the next syllable\\ |
| 120 |
\#6 & string & the line, byte offset, and column address for textedit links when point-and-click is enabled\\ |
| 121 |
\#7 & pair of integers & a pair containing alignment type and alteration type of the next glyph\\ |
| 122 |
\#8 &\TeX\ code & other macros (translation, double text, etc.) that don't fit in the limitation of the number of arguments\\ |
| 123 |
\#9 & \TeX\ code & The bar line (usually a \textit{writebar} call). |
| 124 |
\end{argtable} |
| 125 |
|
| 126 |
\macroname{\textbackslash GreBarVEpisema}{\#1}{gregoriotex-signs.tex} |
| 127 |
Macro to typeset a vertical episema on a bar. |
| 128 |
|
| 129 |
\begin{argtable} |
| 130 |
\#1 & string & Type of glyph the episema is attached to. See \Nameref{NoteOffset} for a description of options.\\ |
| 131 |
\end{argtable} |
| 132 |
|
| 133 |
\macroname{\textbackslash GreBeginEUOUAE}{\#1}{gregoriotex-main.tex} |
| 134 |
Macro to mark the beginning of a EUOUAE block. Alters spacings and prohibits a line break until the end of the block. |
| 135 |
|
| 136 |
\begin{argtable} |
| 137 |
\#1 & integer & The identifier of the EUOUAE block.\\ |
| 138 |
\end{argtable} |
| 139 |
|
| 140 |
\macroname{\textbackslash GreBeginNLBArea}{\#1\#2}{gregoriotex-main.tex} |
| 141 |
Macro called at beginning of a no line break area. |
| 142 |
|
| 143 |
\begin{argtable} |
| 144 |
\#1 & \texttt{0} & Not in the neumes.\\ |
| 145 |
& \texttt{1} & In the neumes.\\ |
| 146 |
\#2 & \texttt{0} & Call didn't come from translation centering.\\ |
| 147 |
& \texttt{1} & Call came from translation centering. |
| 148 |
\end{argtable} |
| 149 |
|
| 150 |
\macroname{\textbackslash GreBold}{\#1}{gregoriotex.sty and gregoriotex.tex} |
| 151 |
Makes argument bold. Accesses \LaTeX\ \verb=\textbf= (\textit{gregoriotex.sty}) or Plain \TeX\ \verb=\bf= (\textit{gregoriotex.tex}) as appropriate. Corresponds to ``<b></b>'' tags in gabc. |
| 152 |
|
| 153 |
\begin{argtable} |
| 154 |
\#1 & string & Text to be typeset in bold.\\ |
| 155 |
\end{argtable} |
| 156 |
|
| 157 |
\macroname{\textbackslash GreBracket}{\#1\#2\#3\#4}{gregoriotex-signs.tex} |
| 158 |
Typesets a bracket. |
| 159 |
|
| 160 |
\begin{argtable} |
| 161 |
\#1 & \texttt{0} & Typeset a left bracket.\\ |
| 162 |
& \texttt{1} & Typeset a right bracket.\\ |
| 163 |
\#2 & integer & The height of the lowest note within the brackets.\\ |
| 164 |
\#3 & integer & The height of the highest note within the brackets.\\ |
| 165 |
\#4 & string & the line, byte offset, and column address for textedit |
| 166 |
links when point-and-click is enabled.\\ |
| 167 |
\end{argtable} |
| 168 |
|
| 169 |
\macroname{\textbackslash GreChangeClef}{\#1\#2\#3\#4\#5\#6\#7}{gregoriotex-signs.tex} |
| 170 |
Macro called when key changes |
| 171 |
|
| 172 |
\begin{argtable} |
| 173 |
\#1 & character & Type of new clef (c or f).\\ |
| 174 |
\#2 & \texttt{1}--\texttt{5} & Line of new clef.\\ |
| 175 |
\#3 & \texttt{0} & Print space before clef.\\ |
| 176 |
& \texttt{1} & Do not print space before clef.\\ |
| 177 |
\#4 & integer & Height number of flat in clef (\texttt{3} for no flat).\\ |
| 178 |
\#5 & \texttt{c} or \texttt{f} & Type of secondary clef.\\ |
| 179 |
\#6 & \texttt{0}--\texttt{5} & Line of secondary clef (\texttt{0} for no secondary clef).\\ |
| 180 |
\#7 & integer & Height of flat in secondary clef (\texttt{3} for no flat).\\ |
| 181 |
\end{argtable} |
| 182 |
|
| 183 |
\macroname{\textbackslash GreCirculus}{\#1\#2}{gregoriotex-signs.tex} |
| 184 |
Macro for typesetting a circulus. |
| 185 |
|
| 186 |
\begin{argtable} |
| 187 |
\#1 & integer & Height number of circulus.\\ |
| 188 |
\#2 & string & Type of glyph the circulus is attached to. See \Nameref{NoteOffset} for a description of options.\\ |
| 189 |
\end{argtable} |
| 190 |
|
| 191 |
\macroname{\textbackslash GreClearSyllableText}{\#1\#2}{gregoriotex-syllable.tex} |
| 192 |
Macro indicating that the text in this syllable should not overlap any previous syllable. |
| 193 |
|
| 194 |
\macroname{\textbackslash GreColored}{\#1}{gregoriotex.sty \textup{and} gregoriotex.tex} |
| 195 |
Colors argument (a string) in \verb=gregoriocolor.= Corresponds to ``<c></c>'' tags in gabc. Does nothing in Plain \TeX\ because color is not supported there. |
| 196 |
|
| 197 |
\macroname{\textbackslash GreCPVirgaReversaAscendensOnDLine}{\#1}{gregoriotex-main.tex} |
| 198 |
Allows the Dominican rule set to force long stems to be used for virga |
| 199 |
reversa ascendens neumes on the ``d'' (lowest) line. This macro is |
| 200 |
defined and re-defined by the \verb=\gresetgregoriofont= macro. |
| 201 |
|
| 202 |
\begin{argtable} |
| 203 |
\#1 & \TeX{} code & The \TeX{} code to use when long stems are not forced.\\ |
| 204 |
\end{argtable} |
| 205 |
|
| 206 |
\macroname{\textbackslash GreCP...}{}{gregoriotex-main.tex} |
| 207 |
A class of macros which point to the individual characters in a Gregoiro\TeX\ compatible font. This class of macros is dynamically mapped from the glyph names embedded in the \texttt{ttf} file via a Lua script to ensure that the code points match up with the installed font. |
| 208 |
|
| 209 |
\macroname{\textbackslash GreHollowCP...}{}{gregoriotex-main.tex} |
| 210 |
A class of macros which point to the individual characters in a Gregoiro\TeX\ compatible cavum neume font. This class of macros is dynamically mapped from the glyph names embedded in the \texttt{ttf} file via a Lua script to ensure that the code points match up with the installed font. |
| 211 |
|
| 212 |
\macroname{\textbackslash GreHoleCP...}{}{gregoriotex-main.tex} |
| 213 |
A class of macros which point to the individual characters in a Gregoiro\TeX\ compatible cavum neume hole font. This class of macros is dynamically mapped from the glyph names embedded in the \texttt{ttf} file via a Lua script to ensure that the code points match up with the installed font. |
| 214 |
|
| 215 |
\macroname{\textbackslash GreCavum}{\#1}{gregoriotex-signs.tex} |
| 216 |
Typesets a cavum glyph. |
| 217 |
|
| 218 |
\begin{argtable} |
| 219 |
\#1 & string & The name of the cavum glyph.\\ |
| 220 |
\end{argtable} |
| 221 |
|
| 222 |
\macroname{\textbackslash GreCustos}{\#1\#2}{gregoriotex-signs.tex} |
| 223 |
Typesets a custos. |
| 224 |
|
| 225 |
\begin{argtable} |
| 226 |
\#1 & integer & Height number of custos.\\ |
| 227 |
\#2 & \texttt{Flat} & The custos should have a flat.\\ |
| 228 |
& \texttt{Natural} & The custos should have a natural.\\ |
| 229 |
& \texttt{Sharp} & The custos should have a sharp.\\ |
| 230 |
& \textit{empty} & The custos should not have an alteration.\\ |
| 231 |
\end{argtable} |
| 232 |
|
| 233 |
\macroname{\textbackslash GreDagger}{}{gregoriotex-symbols.tex} |
| 234 |
Macro to typeset a dagger (\GreDagger). |
| 235 |
|
| 236 |
\macroname{\textbackslash GreDiscretionary}{\#1\#2\#3}{gregoriotex-signs.tex} |
| 237 |
A Gregorio\TeX-specific discretionary. Currently only used to avoid clef change at beginning or end of line, or even with more complex data (z0::c3 for instance). We require a special function because in the normal discretionary function you cannot use \verb=\hskip= (but you can use \verb=\kern=) and you cannot use \verb=\penalty= (which is useless indeed). This macro corrects for these two limitations. The first argument allows to select the penalty assigned to the discretionary by recent version of Lua\TeX. |
| 238 |
|
| 239 |
\begin{argtable} |
| 240 |
\#1 & integer & Type of discretionary (for penalty assignment). Currently possible value is 0 for clef change discretionaries.\\ |
| 241 |
\#2 & \TeX\ code & First argument of resulting \verb=\discretionary=.\\ |
| 242 |
\#3 & \TeX\ code & Third argument of resulting \verb=\discretionary=.\\ |
| 243 |
\end{argtable} |
| 244 |
|
| 245 |
\macroname{\textbackslash GreDivisioFinalis}{\#1\#2}{gregoriotex-signs.tex} |
| 246 |
Macro to typeset a divisio finalis. |
| 247 |
|
| 248 |
\begin{argtable} |
| 249 |
\#1 & \texttt{0} & There is no text under the bar.\\ |
| 250 |
& \texttt{1} & There is text under the bar.\\ |
| 251 |
\#2 & \TeX\ code & Macros which may happen before the skip but after the divisio finalis (typically \verb=\grevepisema=).\\ |
| 252 |
\end{argtable} |
| 253 |
|
| 254 |
\macroname{\textbackslash GreDivisioMaior}{\#1\#2}{gregoriotex-signs.tex} |
| 255 |
Macro to typeset a divisio maior. |
| 256 |
|
| 257 |
\begin{argtable} |
| 258 |
\#1 & \texttt{0} & There is no text under the bar.\\ |
| 259 |
& \texttt{1} & There is text under the bar.\\ |
| 260 |
\#2 & \TeX\ code & Macros which may happen before the skip but after the divisio maior (typically \verb=\grevepisema=).\\ |
| 261 |
\end{argtable} |
| 262 |
|
| 263 |
\macroname{\textbackslash GreDivisioMaiorDotted}{\#1\#2}{gregoriotex-signs.tex} |
| 264 |
Macro to typeset a dotted divisio maior. |
| 265 |
|
| 266 |
\begin{argtable} |
| 267 |
\#1 & \texttt{0} & There is no text under the bar.\\ |
| 268 |
& \texttt{1} & There is text under the bar.\\ |
| 269 |
\#2 & \TeX\ code & Macros which may happen before the skip but after the divisio maior (typically \verb=\grevepisema=).\\ |
| 270 |
\end{argtable} |
| 271 |
|
| 272 |
\macroname{\textbackslash GreDivisioMinima}{\#1\#2\#3}{gregoriotex-signs.tex} |
| 273 |
Macro to typeset a divisio minima. |
| 274 |
|
| 275 |
\begin{argtable} |
| 276 |
\#1 & \texttt{0} & There is no text under the bar.\\ |
| 277 |
& \texttt{1} & There is text under the bar.\\ |
| 278 |
\#2 & \TeX\ code & Macros which may happen before the skip but after the divisio minima (typically \verb=\grevepisema=).\\ |
| 279 |
\#3 & \texttt{0} & The notes around the bar are vertically close to the bar.\\ |
| 280 |
& \texttt{1} & The notes around the bar are far, \verb=@short= versions of spaces will be used.\\ |
| 281 |
\end{argtable} |
| 282 |
|
| 283 |
\macroname{\textbackslash GreDivisioMinimaHigh}{\#1\#2\#3}{gregoriotex-signs.tex} |
| 284 |
Macro to typeset a divisio minima on the ledger line above the staff. |
| 285 |
|
| 286 |
\begin{argtable} |
| 287 |
\#1 & \texttt{0} & There is no text under the bar.\\ |
| 288 |
& \texttt{1} & There is text under the bar.\\ |
| 289 |
\#2 & \TeX\ code & Macros which may happen before the skip but after the divisio minima (typically \verb=\grevepisema=).\\ |
| 290 |
\#3 & \texttt{0} & The notes around the bar are vertically close to the bar.\\ |
| 291 |
& \texttt{1} & The notes around the bar are far, \verb=@short= versions of spaces will be used.\\ |
| 292 |
\end{argtable} |
| 293 |
|
| 294 |
\macroname{\textbackslash GreDivisioMinimaParen}{\#1\#2\#3}{gregoriotex-signs.tex} |
| 295 |
Macro to typeset a parenthesized divisio minima. |
| 296 |
|
| 297 |
\begin{argtable} |
| 298 |
\#1 & \texttt{0} & There is no text under the bar.\\ |
| 299 |
& \texttt{1} & There is text under the bar.\\ |
| 300 |
\#2 & \TeX\ code & Macros which may happen before the skip but after the divisio minima (typically \verb=\grevepisema=).\\ |
| 301 |
\#3 & \texttt{0} & The notes around the bar are vertically close to the bar.\\ |
| 302 |
& \texttt{1} & The notes around the bar are far, \verb=@short= versions of spaces will be used.\\ |
| 303 |
\end{argtable} |
| 304 |
|
| 305 |
\macroname{\textbackslash GreDivisioMinimaParenHigh}{\#1\#2\#3}{gregoriotex-signs.tex} |
| 306 |
Macro to typeset a parenthesized divisio minima on the ledger line above the staff. |
| 307 |
|
| 308 |
\begin{argtable} |
| 309 |
\#1 & \texttt{0} & There is no text under the bar.\\ |
| 310 |
& \texttt{1} & There is text under the bar.\\ |
| 311 |
\#2 & \TeX\ code & Macros which may happen before the skip but after the divisio minima (typically \verb=\grevepisema=).\\ |
| 312 |
\#3 & \texttt{0} & The notes around the bar are vertically close to the bar.\\ |
| 313 |
& \texttt{1} & The notes around the bar are far, \verb=@short= versions of spaces will be used.\\ |
| 314 |
\end{argtable} |
| 315 |
|
| 316 |
\macroname{\textbackslash GreDivisioMinimis}{\#1\#2\#3}{gregoriotex-signs.tex} |
| 317 |
Macro to typeset a divisio ``minimis'' (eighth bar). |
| 318 |
|
| 319 |
\begin{argtable} |
| 320 |
\#1 & \texttt{0} & There is no text under the bar.\\ |
| 321 |
& \texttt{1} & There is text under the bar.\\ |
| 322 |
\#2 & \TeX\ code & Macros which may happen before the skip but after the divisio ``minimis'' (typically \verb=\grevepisema=).\\ |
| 323 |
\#3 & \texttt{0} & The notes around the bar are vertically close to the bar.\\ |
| 324 |
& \texttt{1} & The notes around the bar are far, \verb=@short= versions of spaces will be used.\\ |
| 325 |
\end{argtable} |
| 326 |
|
| 327 |
\macroname{\textbackslash GreDivisioMinimisHigh}{\#1\#2\#3}{gregoriotex-signs.tex} |
| 328 |
Macro to typeset a divisio ``minimis'' (eighth bar) on the ledger line above the staff. |
| 329 |
|
| 330 |
\begin{argtable} |
| 331 |
\#1 & \texttt{0} & There is no text under the bar.\\ |
| 332 |
& \texttt{1} & There is text under the bar.\\ |
| 333 |
\#2 & \TeX\ code & Macros which may happen before the skip but after the divisio ``minimis'' (typically \verb=\grevepisema=).\\ |
| 334 |
\#3 & \texttt{0} & The notes around the bar are vertically close to the bar.\\ |
| 335 |
& \texttt{1} & The notes around the bar are far, \verb=@short= versions of spaces will be used.\\ |
| 336 |
\end{argtable} |
| 337 |
|
| 338 |
\macroname{\textbackslash GreDivisioMinor}{\#1\#2}{gregoriotex-signs.tex} |
| 339 |
Macro to typeset a divisio minor. |
| 340 |
|
| 341 |
\begin{argtable} |
| 342 |
\#1 & \texttt{0} & There is no text under the bar.\\ |
| 343 |
& \texttt{1} & There is text under the bar.\\ |
| 344 |
\#2 & \TeX\ code & Macros which may happen before the skip but after the divisio minor (typically \verb=\grevepisema=).\\ |
| 345 |
\end{argtable} |
| 346 |
|
| 347 |
\macroname{\textbackslash GreDominica}{\#1\#2\#3}{gregoriotex-signs.tex} |
| 348 |
Macro to typeset a dominican bar. |
| 349 |
|
| 350 |
\begin{argtable} |
| 351 |
\#1 & \texttt{1}--\texttt{6} & Type of dominican bar. Corresponds to bar types 6--13 in \verb=\grewritebar=.\\ |
| 352 |
\#2 & \texttt{0} & There is no text under the bar.\\ |
| 353 |
& \texttt{1} & There is text under the bar.\\ |
| 354 |
\#3 & \TeX\ code & Macros which may happen before the skip but after the divisio dominica (typically \verb=\grevepisema=).\\ |
| 355 |
\end{argtable} |
| 356 |
|
| 357 |
\macroname{\textbackslash GreDrawAdditionalLine}{\#1\#2\#3\#4\#5\#6}{gregoriotex-signs.tex} |
| 358 |
Macro to draw ledger lines. |
| 359 |
|
| 360 |
\begin{argtable} |
| 361 |
\#1 & \texttt{0} & Draw an over-the-staff ledger line. \\ |
| 362 |
& \texttt{1} & Draw an under-the-staff ledger line. \\ |
| 363 |
\#2 & distance & The length of the line, with TeX units, excluding any left or right distances coming from the rest of the arguments. \\ |
| 364 |
\#3 & \texttt{0} & Start the line at this point. \\ |
| 365 |
& \texttt{1} & Start the line to the left of this point by \verb=gre@dimen@additionallineswidth=. \\ |
| 366 |
& \texttt{2} & Start the line to the left of this point by \#4. \\ |
| 367 |
\#4 & distance & The distance to move left before starting the line if \#3 is \texttt{2}. \\ |
| 368 |
\#5 & \texttt{0} & End the line exactly \#2 to the right of this point. \\ |
| 369 |
& \texttt{1} & End the line \verb=gre@dimen@additionallineswidth= to the right of \#2 from this point. \\ |
| 370 |
& \texttt{2} & End the line \#6 to the right of \#2 from this point. \\ |
| 371 |
\#6 & distance & The distance to end the line after \#2 from this point if \#3 is \texttt{2}. \\ |
| 372 |
\end{argtable} |
| 373 |
|
| 374 |
\macroname{\textbackslash GreElision}{\#1}{gregoriotex-syllable.tex} |
| 375 |
Typesets \#1 using the \texttt{elision} style. |
| 376 |
|
| 377 |
\begin{argtable} |
| 378 |
\#1 & string & Text to be typeset in the \texttt{elision} style.\\ |
| 379 |
\end{argtable} |
| 380 |
|
| 381 |
\macroname{\textbackslash GreEmptyFirstSyllableHyphen}{}{gregoriotex-syllable.tex} |
| 382 |
Macro that indicates the position of an empty-first-syllable hyphen, should one be desired. |
| 383 |
|
| 384 |
\macroname{\textbackslash GreEndEUOUAE}{\#1}{gregoriotex-main.tex} |
| 385 |
Macro to mark the end of a EUOUAE block. |
| 386 |
|
| 387 |
\begin{argtable} |
| 388 |
\#1 & \texttt{0} & ending element\\ |
| 389 |
& \texttt{1} & ending syllable\\ |
| 390 |
& \texttt{2} & ending score\\ |
| 391 |
& \texttt{3} & before bar |
| 392 |
\end{argtable} |
| 393 |
|
| 394 |
\macroname{\textbackslash GreEndOfElement}{\#1\#2\#3}{gregoriotex-main.tex} |
| 395 |
Macro to end elements. |
| 396 |
|
| 397 |
\begin{argtable} |
| 398 |
\#1 & \texttt{0} & Default space.\\ |
| 399 |
& \texttt{1} & Larger space.\\ |
| 400 |
& \texttt{2} & Glyph space.\\ |
| 401 |
& \texttt{3} & Zero-width space.\\ |
| 402 |
& \texttt{4} & Ad-hoc space.\\ |
| 403 |
\#2 & \texttt{0} & Space is breakable.\\ |
| 404 |
& \texttt{1} & Space is unbreakable.\\ |
| 405 |
& \texttt{2} & Space is breakable according to the \verb=\setunisonbreakbehavior= setting.\\ |
| 406 |
\#3 & integer & The number of notes in the syllable prior to this macro.\\ |
| 407 |
\end{argtable} |
| 408 |
|
| 409 |
\macroname{\textbackslash GreEndNLBArea}{\#1\#2}{gregoriotex-main.tex} |
| 410 |
Macro to end a no line break area. |
| 411 |
|
| 412 |
\begin{argtable} |
| 413 |
\#1 & 0 & ending element\\ |
| 414 |
& \texttt{1} & ending syllable\\ |
| 415 |
& \texttt{2} & ending score\\ |
| 416 |
& \texttt{3} & before bar\\ |
| 417 |
\#2 & \texttt{0} & ??\\ %I can’t tell what this flag is for |
| 418 |
& else & ?? |
| 419 |
\end{argtable} |
| 420 |
|
| 421 |
\macroname{\textbackslash GreEndOfGlyph}{\#1}{gregoriotex-main.tex} |
| 422 |
Macro to end a glyph without ending the element. |
| 423 |
|
| 424 |
\begin{argtable} |
| 425 |
\#1 & \texttt{0} & Default space.\\ |
| 426 |
& \texttt{1} & Zero-width space.\\ |
| 427 |
& \texttt{2} & Space between flat or natural and a note.\\ |
| 428 |
& \texttt{3} & Space between two puncta inclinata, descending.\\ |
| 429 |
& \texttt{4} & Space between bivirga or trivirga.\\ |
| 430 |
& \texttt{5} & space between bistropha or tristropha.\\ |
| 431 |
& \texttt{6} & Space after a punctum mora XXX: not used yet, not so sure it is a good idea\ldots\\ |
| 432 |
& \texttt{7} & Space between a punctum inclinatum and a punctum inclinatum debilis, descending.\\ |
| 433 |
& \texttt{8} & Space between two puncta inclinata debilis.\\ |
| 434 |
& \texttt{9} & Space before a punctum (or something else) and a punctum inclinatum.\\ |
| 435 |
& \texttt{10} & Space between puncta inclinata (also debilis for now), larger ambitus (range=3rd), descending.\\ |
| 436 |
& \texttt{11} & Space between puncta inclinata (also debilis for now), larger ambitus (range=4th or 5th), descending.\\ |
| 437 |
& \texttt{12} & Space between two puncta inclinata, ascending. \\ |
| 438 |
& \texttt{13} & Space between a punctum inclinatum and a punctum inclinatum debilis, ascending. \\ |
| 439 |
& \texttt{14} & Space between puncta inclinata (also debilis for now), larger ambitus (range=3rd), ascending. \\ |
| 440 |
& \texttt{15} & Space between puncta inclinata (also debilis for now), larger ambitus (range=4th or 5th), ascending. \\ |
| 441 |
& \texttt{16} & Space between a punctum inclinatum and a ``no-bar'' glyph one pitch below. \\ |
| 442 |
& \texttt{17} & Space between a punctum inclinatum and a ``no-bar'' glyph two pitches below. \\ |
| 443 |
& \texttt{18} & Space between a punctum inclinatum and a ``no-bar'' glyph three or four pitches below \\ |
| 444 |
& \texttt{19} & Space between a punctum inclinatum and a ``no-bar'' glyph one pitch above. \\ |
| 445 |
& \texttt{20} & Space between a punctum inclinatum and a ``no-bar'' glyph two pitches above. \\ |
| 446 |
& \texttt{21} & Space between a punctum inclinatum and a ``no-bar'' glyph three or four pitches above \\ |
| 447 |
& \texttt{22} & Half-space. \\ |
| 448 |
& \texttt{23} & Space between unison puncta inclinata. \\ |
| 449 |
\end{argtable} |
| 450 |
|
| 451 |
\macroname{\textbackslash GreFinalCustos}{\#1\#2}{gregoriotex-signs.tex} |
| 452 |
Typesets a custos after the final bar in a score. |
| 453 |
|
| 454 |
\begin{argtable} |
| 455 |
\#1 & integer & Height number of custos.\\ |
| 456 |
\#2 & \texttt{Flat} & The custos should have a flat.\\ |
| 457 |
& \texttt{Natural} & The custos should have a natural.\\ |
| 458 |
& \texttt{Sharp} & The custos should have a sharp.\\ |
| 459 |
& \textit{empty} & The custos should not have an alteration.\\ |
| 460 |
\end{argtable} |
| 461 |
|
| 462 |
\macroname{\textbackslash GreFinalDivisioFinalis}{\#1}{gregoriotex-signs.tex} |
| 463 |
Macro to end a score with a divisio finalis. |
| 464 |
|
| 465 |
\begin{argtable} |
| 466 |
\#1 & \texttt{0} & Something does not need to be placed after the divisio finalis.\\ |
| 467 |
& \texttt{1} & Something needs to be placed after the divisio finalis.\\ |
| 468 |
\end{argtable} |
| 469 |
|
| 470 |
\macroname{\textbackslash GreFinalDivisioMaior}{\#1}{gregoriotex-signs.tex} |
| 471 |
Macro to end a score with a divisio maior. |
| 472 |
|
| 473 |
\begin{argtable} |
| 474 |
\#1 & \texttt{0} & Something does not need to be placed after the divisio maior.\\ |
| 475 |
& \texttt{1} & Something needs to be placed after the divisio maior.\\ |
| 476 |
\end{argtable} |
| 477 |
|
| 478 |
\macroname{\textbackslash GreFirstSyllable}{\#1}{gregoriotex-syllable.tex} |
| 479 |
A macro which is called with the text of the first syllable, excluding the |
| 480 |
initial of the score. This macro may be redefined to style the first syllable |
| 481 |
appropriately. This macro may be called up to three times: for the letters |
| 482 |
before the centered letters, for the centered letters, and for the letters |
| 483 |
after the centered letters. |
| 484 |
|
| 485 |
\begin{argtable} |
| 486 |
\#1 & string & Text from the first syllable. |
| 487 |
\end{argtable} |
| 488 |
|
| 489 |
\macroname{\textbackslash GreFirstSyllableInitial}{\#1}{gregoriotex-syllable.tex} |
| 490 |
A macro which is called with the first letter of the first syllable which is |
| 491 |
not the initial of the score. If there is no initial (\verb=\gresetinitiallines{0}= has been called), the |
| 492 |
first letter of the syllable will be passed. Otherwise, the \emph{second} letter will be passed. |
| 493 |
|
| 494 |
\begin{argtable} |
| 495 |
\#1 & string & The first letter of the first syllable which is not the |
| 496 |
initial of the score. |
| 497 |
\end{argtable} |
| 498 |
|
| 499 |
\macroname{\textbackslash GreFirstWord}{\#1}{gregoriotex-syllable.tex} |
| 500 |
A macro which is called with the text of the first word, excluding the |
| 501 |
initial of the score. This macro may be redefined to style the first word |
| 502 |
appropriately. This macro may be called multiple times, depending on how |
| 503 |
many syllables are in the word. |
| 504 |
|
| 505 |
\begin{argtable} |
| 506 |
\#1 & string & Text from the first word. |
| 507 |
\end{argtable} |
| 508 |
|
| 509 |
\macroname{\textbackslash GreFlat}{\#1\#2\#3\#4\#5}{gregoriotex-signs.tex} |
| 510 |
Macro to typeset a flat. |
| 511 |
|
| 512 |
\begin{argtable} |
| 513 |
\#1 & integer & Height number of the flat.\\ |
| 514 |
\#2 & \texttt{0} & The flat is not part of the clef.\\ |
| 515 |
& \texttt{1} & The flat is part of the clef.\\ |
| 516 |
\#3 & \TeX\ code & signs to typeset before the glyph (typically additional bars, as they must be ``behind'' the glyph)\\ |
| 517 |
\#4 & \TeX\ code & signs to typeset after the glyph (almost all signs)\\ |
| 518 |
\#5 & string & the line, byte offset, and column address for textedit links when point-and-click is enabled\\ |
| 519 |
\end{argtable} |
| 520 |
|
| 521 |
\macroname{\textbackslash GreFlatParen}{\#1\#2\#3\#4\#5}{gregoriotex-signs.tex} |
| 522 |
Macro to typeset a parenthesized flat. |
| 523 |
|
| 524 |
\begin{argtable} |
| 525 |
\#1 & integer & Height number of the flat.\\ |
| 526 |
\#2 & \texttt{0} & The flat is not part of the clef.\\ |
| 527 |
& \texttt{1} & The flat is part of the clef.\\ |
| 528 |
\#3 & \TeX\ code & signs to typeset before the glyph (typically additional bars, as they must be ``behind'' the glyph)\\ |
| 529 |
\#4 & \TeX\ code & signs to typeset after the glyph (almost all signs)\\ |
| 530 |
\#5 & string & the line, byte offset, and column address for textedit links when point-and-click is enabled\\ |
| 531 |
\end{argtable} |
| 532 |
|
| 533 |
\macroname{\textbackslash GreFlatSoft}{\#1\#2\#3\#4\#5}{gregoriotex-signs.tex} |
| 534 |
Macro to typeset a soft flat. |
| 535 |
|
| 536 |
\begin{argtable} |
| 537 |
\#1 & integer & Height number of the flat.\\ |
| 538 |
\#2 & \texttt{0} & The flat is not part of the clef.\\ |
| 539 |
& \texttt{1} & The flat is part of the clef.\\ |
| 540 |
\#3 & \TeX\ code & signs to typeset before the glyph (typically additional bars, as they must be ``behind'' the glyph)\\ |
| 541 |
\#4 & \TeX\ code & signs to typeset after the glyph (almost all signs)\\ |
| 542 |
\#5 & string & the line, byte offset, and column address for textedit links when point-and-click is enabled\\ |
| 543 |
\end{argtable} |
| 544 |
|
| 545 |
\macroname{\textbackslash GreForceHyphen}{}{gregoriotex-syllable.tex} |
| 546 |
Macro that indicates that a hyphen should be forced (if enabled) after the given syllable. |
| 547 |
|
| 548 |
\macroname{\textbackslash GreFuse}{}{gregoriotex-main.tex} |
| 549 |
Macro used between two fused glyphs. |
| 550 |
|
| 551 |
\macroname{\textbackslash GreFuseTwo}{\#1\#2}{gregoriotex-main.tex} |
| 552 |
Macro for fusing two glyphs to create a larger neume. |
| 553 |
|
| 554 |
\begin{argtable} |
| 555 |
\#1 & Gregorio\TeX\ glyph & The first glyph in the sequence.\\ |
| 556 |
\#2 & Gregorio\TeX\ glyph & The second. |
| 557 |
\end{argtable} |
| 558 |
|
| 559 |
\macroname{\textbackslash GreGlyph}{\#1\#2\#3\#4\#5\#6\#7}{gregoriotex-syllable.tex} |
| 560 |
Macro to typeset a glyph. |
| 561 |
|
| 562 |
\begin{argtable} |
| 563 |
\#1 & character & the character that it must call\\ |
| 564 |
\#2 & integer & The number for where the glyph is located. \texttt{a} in gabc is 1, \texttt{b} is 2, \etc\\ |
| 565 |
\#3 & \TeX\ code & code to set the next custos (using \verb=\GreNextCustos=)\\ |
| 566 |
\#4 & \texttt{0} & One-note glyph or more than two notes glyph except porrectus: \ie, we must put the aligncenter in the middle of the first note\\ |
| 567 |
& \texttt{1} & Two notes glyph (podatus is considered as a one-note glyph): \ie, we put the aligncenter in the middle of the glyph\\ |
| 568 |
& \texttt{2} & Porrectus: has a special align center.\\ |
| 569 |
& \texttt{3} & initio-debilis : same as 1 but the first note is much smaller\\ |
| 570 |
& \texttt{4} & case of a glyph starting with a quilisma\\ |
| 571 |
& \texttt{5} & case of a glyph starting with an oriscus\\ |
| 572 |
& \texttt{6} & case of a punctum inclinatum\\ |
| 573 |
& \texttt{7} & case of a stropha\\ |
| 574 |
& \texttt{8} & flexus with an ambitus of one\\ |
| 575 |
& \texttt{9} & flexus deminutus\\ |
| 576 |
\#5 & \TeX\ code & signs to typeset before the glyph (typically additional bars, as they must be ``behind'' the glyph)\\ |
| 577 |
\#6 & \TeX\ code & signs to typeset after the glyph (almost all signs)\\ |
| 578 |
\#7 & string & the line, byte offset, and column address for textedit links when point-and-click is enabled |
| 579 |
\end{argtable} |
| 580 |
|
| 581 |
\macroname{\textbackslash GreGlyphHeights}{\#1\#2}{gregoriotex-syllable.tex} |
| 582 |
Passes the glyph height limits. |
| 583 |
|
| 584 |
\begin{argtable} |
| 585 |
\#1 & integer & the high height\\ |
| 586 |
\#2 & integer & the low height |
| 587 |
\end{argtable} |
| 588 |
|
| 589 |
\macroname{\textbackslash GregorioTeXAPIVersion}{\#1}{gregoriotex-main.tex} |
| 590 |
Checks to see if Gregorio\TeX\ API is version specified by argument (and |
| 591 |
therefore compatible with the score. |
| 592 |
|
| 593 |
\begin{argtable} |
| 594 |
\#1 & string & Version number for Gregorio\TeX.\\ |
| 595 |
\end{argtable} |
| 596 |
|
| 597 |
\macroname{\textbackslash GreHeader}{\#1\#2}{gregoriotex-main.tex} |
| 598 |
Macro used to pass headers to TeX. |
| 599 |
|
| 600 |
\begin{argtable} |
| 601 |
\#1 & string & The header name.\\ |
| 602 |
\#2 & string & The header value.\\ |
| 603 |
\end{argtable} |
| 604 |
|
| 605 |
\macroname{\textbackslash GreHEpisema}{\#1\#2\#3\#4\#5\#6\#7\#8\#9}{gregoriotex-signs.tex} |
| 606 |
Macro to typeset an horizontal episema. |
| 607 |
|
| 608 |
\begin{argtable} |
| 609 |
\#1 & integer & Height number of the episema.\\ |
| 610 |
\#2 & string & See \Nameref{NoteOffset}.\\ |
| 611 |
\#3 & integer & The ambitus for a two note episema at the diagonal stroke of a |
| 612 |
porrectus, porrectus flexus, orculus resupinus, or torculus resupinus |
| 613 |
flexus.\\ |
| 614 |
\#4 & \texttt{0} & an horizontal episema\\ |
| 615 |
& \texttt{1} & an horizontal episema under a note\\ |
| 616 |
& \texttt{2} & a line at the top\\ |
| 617 |
& \texttt{3} & a line at the bottom\\ |
| 618 |
\#5 & \texttt{f} & a normal episema\\ |
| 619 |
& \texttt{l} & a small episema aligned left\\ |
| 620 |
& \texttt{c} & a small episema aligned center\\ |
| 621 |
& \texttt{r} & a small episema aligned right\\ |
| 622 |
\#6 & integer & Replacement for \#1 if a bridge causes a height substitution.\\ |
| 623 |
\#7 & \TeX\ code & code that sets heuristics\\ |
| 624 |
\#8 & string & a positive or negative ``nudge'' (dimension) for the vertical position of the horizontal episema\\ |
| 625 |
\#9 & \texttt{0} & for horizontal episema cases, use automatic positioning within the space\\ |
| 626 |
& \texttt{1} & for horizontal episema cases, position in the middle of the space\\ |
| 627 |
& \texttt{2} & for horizontal episema cases, position low within the space as if the episema is over the note\\ |
| 628 |
& \texttt{3} & for horizontal episema cases, position high within the space as if the episema is under the note\\ |
| 629 |
& \texttt{4} & for horizontal episema cases, position low within the space as if the episema is over the note\\ |
| 630 |
& \texttt{5} & for horizontal episema cases, position high within the space as if the episema is under the note\\ |
| 631 |
\end{argtable} |
| 632 |
|
| 633 |
\macroname{\textbackslash GreHEpisemaBridge}{\#1\#2\#3\#4\#5\#6}{gregoriotex-signs.tex} |
| 634 |
Macro to typeset a bridge episema for the last note of a glyph |
| 635 |
(element, syllable) if the next episema is at the same height. |
| 636 |
|
| 637 |
\begin{argtable} |
| 638 |
\#1 & integer & Height number of the episema.\\ |
| 639 |
\#2 & \texttt{0} & Episema above the note.\\ |
| 640 |
& \texttt{1} & Episema below the note.\\ |
| 641 |
\#3 & \texttt{0} & Default space.\\ |
| 642 |
& \texttt{1} & Zero-width space.\\ |
| 643 |
& \texttt{2} & Space between flat or natural and a note.\\ |
| 644 |
& \texttt{3} & Space between two puncta inclinata.\\ |
| 645 |
& \texttt{4} & Space between bivirga or trivirga.\\ |
| 646 |
& \texttt{5} & space between bistropha or tristropha.\\ |
| 647 |
& \texttt{6} & Space after a punctum mora XXX: not used yet, not so sure it is a good idea\ldots\\ |
| 648 |
& \texttt{7} & Space between a punctum inclinatum and a punctum inclinatum debilis.\\ |
| 649 |
& \texttt{8} & Space between two puncta inclinata debilis.\\ |
| 650 |
& \texttt{9} & Space before a punctum (or something else) and a punctum inclinatum.\\ |
| 651 |
& \texttt{10} & Space between puncta inclinata (also debilis for now), larger ambitus (range=3rd).\\ |
| 652 |
& \texttt{11} & Space between puncta inclinata (also debilis for now), larger ambitus (range=4th or more).\\ |
| 653 |
\#4 & \TeX\ code & code that sets heuristics\\ |
| 654 |
\#5 & string & a positive or negative ``nudge'' (dimension) for the vertical position of the horizontal episema\\ |
| 655 |
\#6 & \texttt{0} & for horizontal episema cases, use automatic positioning within the space\\ |
| 656 |
& \texttt{1} & for horizontal episema cases, position in the middle of the space\\ |
| 657 |
& \texttt{2} & for horizontal episema cases, position low within the space as if the episema is over the note\\ |
| 658 |
& \texttt{3} & for horizontal episema cases, position high within the space as if the episema is under the note\\ |
| 659 |
& \texttt{4} & for horizontal episema cases, position low within the space as if the episema is over the note\\ |
| 660 |
& \texttt{5} & for horizontal episema cases, position high within the space as if the episema is under the note\\ |
| 661 |
\end{argtable} |
| 662 |
|
| 663 |
\macroname{\textbackslash GreHighChoralSign}{\#1\#2\#3}{gregoriotex-signs.tex} |
| 664 |
Macro for typesetting high choral signs. |
| 665 |
|
| 666 |
\begin{argtable} |
| 667 |
\#1 & integer & Height number of the sign.\\ |
| 668 |
\#2 & string & The choral sign.\\ |
| 669 |
\#3 & \texttt{0} & Choral sign does not occur before last note of podatus, porrectus, or torculus resupinus.\\ |
| 670 |
& \texttt{1} & Choral sign occurs before last note of podatus, porrectus, or torculus resupinus.\\ |
| 671 |
\end{argtable} |
| 672 |
|
| 673 |
\macroname{\textbackslash GreHyph}{}{gregoriotex-main.tex} |
| 674 |
Macro used for end of line hyphens. Defaults to \verb=\gre@char@normalhyph=. |
| 675 |
|
| 676 |
\macroname{\textbackslash GreInDivisioFinalis}{\#1\#2}{gregoriotex-signs.tex} |
| 677 |
Same as \verb=\GreDivisioFinalis= except inside a syllable. |
| 678 |
|
| 679 |
\macroname{\textbackslash GreInDivisioMaior}{\#1\#2}{gregoriotex-signs.tex} |
| 680 |
Same as \verb=\GreDivisioMaior= except inside a syllable. |
| 681 |
|
| 682 |
\macroname{\textbackslash GreInDivisioMaiorDotted}{\#1\#2}{gregoriotex-signs.tex} |
| 683 |
Same as \verb=\GreDivisioMaiorDotted= except inside a syllable. |
| 684 |
|
| 685 |
\macroname{\textbackslash GreInDivisioMinima}{\#1\#2\#3}{gregoriotex-signs.tex} |
| 686 |
Same as \verb=\GreDivisioMinima= except inside a syllable. |
| 687 |
|
| 688 |
\macroname{\textbackslash GreInDivisioMinimaHigh}{\#1\#2\#3}{gregoriotex-signs.tex} |
| 689 |
Same as \verb=\GreDivisioMinimaHigh= except inside a syllable. |
| 690 |
|
| 691 |
\macroname{\textbackslash GreInDivisioMinimaParen}{\#1\#2\#3}{gregoriotex-signs.tex} |
| 692 |
Same as \verb=\GreDivisioMinimaParen= except inside a syllable. |
| 693 |
|
| 694 |
\macroname{\textbackslash GreInDivisioMinimaParenHigh}{\#1\#2\#3}{gregoriotex-signs.tex} |
| 695 |
Same as \verb=\GreDivisioMinimaParenHigh= except inside a syllable. |
| 696 |
|
| 697 |
\macroname{\textbackslash GreInDivisioMinimis}{\#1\#2\#3}{gregoriotex-signs.tex} |
| 698 |
Same as \verb=\GreDivisioMinimis= except inside a syllable. |
| 699 |
|
| 700 |
\macroname{\textbackslash GreInDivisioMinimisHigh}{\#1\#2\#3}{gregoriotex-signs.tex} |
| 701 |
Same as \verb=\GreDivisioMinimisHigh= except inside a syllable. |
| 702 |
|
| 703 |
\macroname{\textbackslash GreInDivisioMinor}{\#1\#2}{gregoriotex-signs.tex} |
| 704 |
Same as \verb=\GreDivisioMinor= except inside a syllable. |
| 705 |
|
| 706 |
\macroname{\textbackslash GreInDominica}{\#1\#2\#3}{gregoriotex-signs.tex} |
| 707 |
Same as \verb=\GreDominica= except inside a syllable. |
| 708 |
|
| 709 |
\macroname{\textbackslash GreInitialClefPosition}{\#1\#2}{gregoriotex-signs.tex} |
| 710 |
Saves the extrema of the initial clef. |
| 711 |
|
| 712 |
\begin{argtable} |
| 713 |
\#1 & integer & the line of the primary clef (1 is the bottom line)\\ |
| 714 |
\#2 & integer & the line of the secondary clef (1 is the bottom line, 0 means |
| 715 |
no secondary clef)\\ |
| 716 |
\end{argtable} |
| 717 |
|
| 718 |
\macroname{\textbackslash GreInVirgula}{\#1\#2\#3}{gregoriotex-signs.tex} |
| 719 |
Same as \verb=\GreVirgula= except inside a syllable. |
| 720 |
|
| 721 |
\macroname{\textbackslash GreInVirgulaHigh}{\#1\#2\#3}{gregoriotex-signs.tex} |
| 722 |
Same as \verb=\GreVirgulaHigh= except inside a syllable. |
| 723 |
|
| 724 |
\macroname{\textbackslash GreInVirgulaParen}{\#1\#2\#3}{gregoriotex-signs.tex} |
| 725 |
Same as \verb=\GreVirgulaParen= except inside a syllable. |
| 726 |
|
| 727 |
\macroname{\textbackslash GreInVirgulaParenHigh}{\#1\#2\#3}{gregoriotex-signs.tex} |
| 728 |
Same as \verb=\GreVirgulaParenHigh= except inside a syllable. |
| 729 |
|
| 730 |
\macroname{\textbackslash GreItalic}{\#1}{gregoriotex.sty or gregoriotex.tex} |
| 731 |
Makes argument (a string) italic. Accesses \LaTeX\ \verb=\textit= or |
| 732 |
Plain \TeX\ \verb=\it= as appropriate. Corresponds to ``<i></i>'' tags |
| 733 |
in gabc. |
| 734 |
|
| 735 |
\begin{argtable} |
| 736 |
\#1 & string & Text to be typeset in italic font.\\ |
| 737 |
\end{argtable} |
| 738 |
|
| 739 |
\macroname{\textbackslash GreLastOfLine}{}{gregoriotex-main.tex} |
| 740 |
Macro to set \verb=\gre@lastoflinecount= to 1 (\ie, mark that this syllable is the last of the line). |
| 741 |
|
| 742 |
\macroname{\textbackslash GreLastOfScore}{}{gregoriotex-main.tex} |
| 743 |
Macro to mark the syllable as the last of the score. |
| 744 |
|
| 745 |
\macroname{\textbackslash GreLastSyllableBeforeEUOUAE}{\#1\#2}{gregoriotex-syllable.tex} |
| 746 |
Indicates that this syllable is the last syllable before a EUOUAE block. |
| 747 |
|
| 748 |
\begin{argtable} |
| 749 |
\#1 & integer & The identifier of the EUOUAE block.\\ |
| 750 |
\#2 & \texttt{0} & There is no line break between this syllable and the EUOUAE block.\\ |
| 751 |
& \texttt{1} & There is a line break between this syllable and the beginning of the EUOUAE block.\\ |
| 752 |
\end{argtable} |
| 753 |
|
| 754 |
\macroname{\textbackslash GreLowChoralSign}{\#1\#2\#3}{gregoriotex-signs.tex} |
| 755 |
Macro for typesetting low choral signs. |
| 756 |
|
| 757 |
\begin{argtable} |
| 758 |
\#1 & integer & Height number of the sign.\\ |
| 759 |
\#2 & string & The choral sign.\\ |
| 760 |
\#3 & \texttt{0} & Choral sign does not occur before last note of podatus, porrectus, or torculus resupinus.\\ |
| 761 |
& \texttt{1} & Choral sign occurs before last note of podatus, porrectus, or torculus resupinus.\\ |
| 762 |
\end{argtable} |
| 763 |
|
| 764 |
\macroname{\textbackslash GreMode}{\#1\#2\#3}{gregoriotex-main.tex} |
| 765 |
If the gabc file contains a mode in the header, then this function |
| 766 |
places said mode as the first (top) annotation. If the user has |
| 767 |
manually added a first annotation in the \TeX\ file, then this |
| 768 |
function does nothing. Also, if the \texttt{annotation} header field |
| 769 |
is used, then this function does nothing. |
| 770 |
|
| 771 |
\begin{argtable} |
| 772 |
\#1 & \TeX\ code & Mode text to place above the initial of a score in the \texttt{modeline} style.\\ |
| 773 |
\#2 & \TeX\ code & Arbitrary code to typeset, in the \texttt{modemodifier} style, after the mode text.\\ |
| 774 |
\#3 & \TeX\ code & Arbitrary code to typeset, in the \texttt{modedifferentia} style, after \#2.\\ |
| 775 |
\end{argtable} |
| 776 |
|
| 777 |
\macroname{\textbackslash GreMusicaFictaFlat}{\#1\#2}{gregoriotex-signs.tex} |
| 778 |
Macro for typesetting a musica ficta flat. |
| 779 |
|
| 780 |
\begin{argtable} |
| 781 |
\#1 & integer & Height number of the musica ficta flat.\\ |
| 782 |
\#2 & string & Type of glyph the musica ficta flat is attached to. See \Nameref{NoteOffset} for a description of options.\\ |
| 783 |
\end{argtable} |
| 784 |
|
| 785 |
\macroname{\textbackslash GreMusicaFictaNatural}{\#1\#2}{gregoriotex-signs.tex} |
| 786 |
Macro for typesetting a musica ficta natural. |
| 787 |
|
| 788 |
\begin{argtable} |
| 789 |
\#1 & integer & Height number of the musica ficta natural.\\ |
| 790 |
\#2 & string & Type of glyph the musica ficta natural is attached to. See \Nameref{NoteOffset} for a description of options.\\ |
| 791 |
\end{argtable} |
| 792 |
|
| 793 |
\macroname{\textbackslash GreMusicaFictaSharp}{\#1\#2}{gregoriotex-signs.tex} |
| 794 |
Macro for typesetting a musica ficta sharp. |
| 795 |
|
| 796 |
\begin{argtable} |
| 797 |
\#1 & integer & Height number of the musica ficta sharp.\\ |
| 798 |
\#2 & string & Type of glyph the musica ficta sharp is attached to. See \Nameref{NoteOffset} for a description of options.\\ |
| 799 |
\end{argtable} |
| 800 |
|
| 801 |
\macroname{\textbackslash GreNatural}{\#1\#2\#3\#4\#5}{gregoriotex-signs.tex} |
| 802 |
Macro to typeset a natural. |
| 803 |
|
| 804 |
\begin{argtable} |
| 805 |
\#1 & integer & Height number of the natural.\\ |
| 806 |
\#2 & \texttt{0} & The natural is not part of the clef.\\ |
| 807 |
& \texttt{1} & The natural is part of the clef (doesn't happen).\\ |
| 808 |
\#3 & \TeX\ code & signs to typeset before the glyph (typically additional bars, as they must be ``behind'' the glyph)\\ |
| 809 |
\#4 & \TeX\ code & signs to typeset after the glyph (almost all signs)\\ |
| 810 |
\#5 & string & the line, byte offset, and column address for textedit links when point-and-click is enabled\\ |
| 811 |
\end{argtable} |
| 812 |
|
| 813 |
\macroname{\textbackslash GreNaturalParen}{\#1\#2\#3\#4\#5}{gregoriotex-signs.tex} |
| 814 |
Macro to typeset a parenthesized natural. |
| 815 |
|
| 816 |
\begin{argtable} |
| 817 |
\#1 & integer & Height number of the natural.\\ |
| 818 |
\#2 & \texttt{0} & The natural is not part of the clef.\\ |
| 819 |
& \texttt{1} & The natural is part of the clef (doesn't happen).\\ |
| 820 |
\#3 & \TeX\ code & signs to typeset before the glyph (typically additional bars, as they must be ``behind'' the glyph)\\ |
| 821 |
\#4 & \TeX\ code & signs to typeset after the glyph (almost all signs)\\ |
| 822 |
\#5 & string & the line, byte offset, and column address for textedit links when point-and-click is enabled\\ |
| 823 |
\end{argtable} |
| 824 |
|
| 825 |
\macroname{\textbackslash GreNaturalSoft}{\#1\#2\#3\#4\#5}{gregoriotex-signs.tex} |
| 826 |
Macro to typeset a soft natural. |
| 827 |
|
| 828 |
\begin{argtable} |
| 829 |
\#1 & integer & Height number of the natural.\\ |
| 830 |
\#2 & \texttt{0} & The natural is not part of the clef.\\ |
| 831 |
& \texttt{1} & The natural is part of the clef (doesn't happen).\\ |
| 832 |
\#3 & \TeX\ code & signs to typeset before the glyph (typically additional bars, as they must be ``behind'' the glyph)\\ |
| 833 |
\#4 & \TeX\ code & signs to typeset after the glyph (almost all signs)\\ |
| 834 |
\#5 & string & the line, byte offset, and column address for textedit links when point-and-click is enabled\\ |
| 835 |
\end{argtable} |
| 836 |
|
| 837 |
\macroname{\textbackslash GreNewLine}{}{gregoriotex-main.tex} |
| 838 |
Macro to call if you want to go to the next line. |
| 839 |
|
| 840 |
\macroname{\textbackslash GreNewParLine}{}{gregoriotex-main.tex} |
| 841 |
Same as \verb=\GreNewLine= except line is not justified. |
| 842 |
|
| 843 |
\macroname{\textbackslash GreFinalNewLine}{}{gregoriotex-main.tex} |
| 844 |
Handles a new line after the final bar. This currently just advances \verb=\gre@knownline= in order to prevent a potential error message with a two-line initial on a two-line score. |
| 845 |
|
| 846 |
\macroname{\textbackslash GreNextCustos}{\#1\#2}{gregoriotex-signs.tex} |
| 847 |
Sets the pitch to use for the next custos if it were to happen at the point |
| 848 |
where this macro is called. |
| 849 |
|
| 850 |
\begin{argtable} |
| 851 |
\#1 & integer & Height number of the custos.\\ |
| 852 |
\#2 & \texttt{Flat} & The custos should have a flat.\\ |
| 853 |
& \texttt{Natural} & The custos should have a natural.\\ |
| 854 |
& \texttt{Sharp} & The custos should have a sharp.\\ |
| 855 |
& \textit{empty} & The custos should not have an alteration.\\ |
| 856 |
\end{argtable} |
| 857 |
|
| 858 |
\macroname{\textbackslash GreSuppressEolCustos}{}{gregoriotex-main.tex} |
| 859 |
Macro which disables automatic custos at the end of lines. |
| 860 |
|
| 861 |
\macroname{\textbackslash GreResetEolCustos}{}{gregoriotex-main.tex} |
| 862 |
Alias that resets the use of automatic custos to the value set by |
| 863 |
\verb=\greseteolcustos=. This macro is aliased to \verb=\gre@useautoeolcustos= |
| 864 |
or \verb=\GreSuppressEolCustos= by \verb=\greseteolcustos=. |
| 865 |
|
| 866 |
\macroname{\textbackslash GreNextSyllableBeginsEUOUAE}{\#1\#2}{gregoriotex-syllable.tex} |
| 867 |
Indicates that the syllable which follows begins a EUOUAE block. |
| 868 |
|
| 869 |
\begin{argtable} |
| 870 |
\#1 & integer & The identifier of the EUOUAE block.\\ |
| 871 |
\#2 & \texttt{0} & There is no line break between this syllable and the EUOUAE block.\\ |
| 872 |
& \texttt{1} & There is a line break between this syllable and the beginning of the EUOUAE block.\\ |
| 873 |
\end{argtable} |
| 874 |
|
| 875 |
\macroname{\textbackslash GreOverBrace}{\#1\#2\#3\#4}{gregoriotex-signs.tex} |
| 876 |
Macro to typeset a round brace above the lines. |
| 877 |
|
| 878 |
\begin{argtable} |
| 879 |
\#1 & length & The width of the brace.\\ |
| 880 |
\#2 & length & A vertical shift.\\ |
| 881 |
\#3 & length & A horizontal shift.\\ |
| 882 |
\#4 & \texttt{0} & Don't shift before starting the brace.\\ |
| 883 |
& \texttt{1} & Shift back a punctum's width before starting the brace. |
| 884 |
\end{argtable} |
| 885 |
|
| 886 |
\macroname{\textbackslash GreOverCurlyBrace}{\#1\#2\#3\#4\#5}{gregoriotex-signs.tex} |
| 887 |
Macro to typeset a curly brace above the lines. |
| 888 |
|
| 889 |
\begin{argtable} |
| 890 |
\#1 & length & The width of the brace.\\ |
| 891 |
\#2 & length & A vertical shift.\\ |
| 892 |
\#3 & length & A horizontal shift.\\ |
| 893 |
\#4 & \texttt{0} & Don't shift before starting the brace.\\ |
| 894 |
& \texttt{1} & Shift back a punctum's width before starting the brace.\\ |
| 895 |
\#5 & \texttt{0} & No accentus above the brace.\\ |
| 896 |
& \texttt{1} & Typeset an accentus above the brace. |
| 897 |
\end{argtable} |
| 898 |
|
| 899 |
\macroname{\textbackslash GreProtrusion}{\#1\#2}{gregoriotex-spaces.tex} |
| 900 |
Typesets a protrusion. |
| 901 |
|
| 902 |
\begin{argtable} |
| 903 |
\#1 & float & The protrusion factor. May be a call to \verb=\GreProtrusionFactor=\\ |
| 904 |
\#2 & \TeX\ code & The content of the protrusion.\\ |
| 905 |
\end{argtable} |
| 906 |
|
| 907 |
\macroname{\textbackslash GreProtrusionFactor}{\#1}{gregoriotex-spaces.tex} |
| 908 |
Returns a automatic protrusion factor. The argument is character whose |
| 909 |
automatic protrusion factor is desired. |
| 910 |
|
| 911 |
\begin{argtable} |
| 912 |
\#1 & \texttt{,} & The comma protrusion factor.\\ |
| 913 |
& \texttt{;} & The semicolon protrusion factor.\\ |
| 914 |
& \texttt{:} & The colon protrusion factor.\\ |
| 915 |
& \texttt{.} & The period protrusion factor.\\ |
| 916 |
\end{argtable} |
| 917 |
|
| 918 |
\macroname{\textbackslash GrePunctumMora}{\#1\#2\#3\#4}{gregoriotex-signs.tex} |
| 919 |
Macro for typesetting punctum mora. |
| 920 |
|
| 921 |
\begin{argtable} |
| 922 |
\#1 & integer & Height number of punctum mora.\\ |
| 923 |
\#2 & \texttt{0} & General case.\\ |
| 924 |
& \texttt{1} & Make the punctum mora zero width.\\ |
| 925 |
& \texttt{2} & Shift left width of 1 punctum.\\ |
| 926 |
& \texttt{3} & Shift left width of 1 punctum if last ambitus is 1.\\ |
| 927 |
\#3 & \texttt{0} & Punctum mora does not occur before last note of podatus, porrectus, or torculus resupinus.\\ |
| 928 |
& \texttt{1} & Punctum mora occurs before last note of podatus, porrectus, or torculus resupinus.\\ |
| 929 |
\#4 & \texttt{0} & No punctum inclinatum.\\ |
| 930 |
& \texttt{1} & Punctum inclinatum.\\ |
| 931 |
\end{argtable} |
| 932 |
|
| 933 |
\macroname{\textbackslash GreReversedAccentus}{\#1\#2}{gregoriotex-signs.tex} |
| 934 |
Macro for typesetting a reversed accentus. |
| 935 |
|
| 936 |
\begin{argtable} |
| 937 |
\#1 & integer & Height number of accentus.\\ |
| 938 |
\#2 & string & Type of glyph the accentus is attached to. See \Nameref{NoteOffset} for a description of options.\\ |
| 939 |
\end{argtable} |
| 940 |
|
| 941 |
\macroname{\textbackslash GreReversedSemicirculus}{\#1\#2}{gregoriotex-signs.tex} |
| 942 |
Macro for typesetting a reversed semicirculus. |
| 943 |
|
| 944 |
\begin{argtable} |
| 945 |
\#1 & integer & Height number of semicirculus.\\ |
| 946 |
\#2 & string & Type of glyph the semicirculus is attached to. See \Nameref{NoteOffset} for a description of options.\\ |
| 947 |
\end{argtable} |
| 948 |
|
| 949 |
\macroname{\textbackslash GreScoreOpening}{\#1\#2\#3\#4\#5}{gregoriotex-syllable.tex} |
| 950 |
Opens the score. |
| 951 |
|
| 952 |
\begin{argtable} |
| 953 |
\#1 & \TeX\ code & Macros rendering the things after the initial but before the notes.\\ |
| 954 |
\#2 & \TeX\ code & Macros rendering the things after starting notes but before the syllable.\\ |
| 955 |
\#3 & \TeX\ code & Macros rendering the things before the initial.\\ |
| 956 |
\#4 & \TeX\ control sequence & Control sequence for the syllable.\\ |
| 957 |
\#5 & \TeX\ code & Macros rendering the first syllable; should emit the initial and populate \verb=\gre@opening@syllabletext=.\\ |
| 958 |
\end{argtable} |
| 959 |
|
| 960 |
\macroname{\textbackslash GreSemicirculus}{\#1\#2}{gregoriotex-signs.tex} |
| 961 |
Macro for typesetting a semicirculus. |
| 962 |
|
| 963 |
\begin{argtable} |
| 964 |
\#1 & integer & Height number of semicirculus.\\ |
| 965 |
\#2 & string & Type of glyph the semicirculus is attached to. See \Nameref{NoteOffset} for a description of options.\\ |
| 966 |
\end{argtable} |
| 967 |
|
| 968 |
\macroname{\textbackslash GreSetFirstSyllableText}{\#1\#2\#3\#4\#5\#6}{gregoriotex-syllable.tex} |
| 969 |
Sets the first syllable text. |
| 970 |
|
| 971 |
\begin{argtable} |
| 972 |
\#1 & \TeX\ code & Initial.\\ |
| 973 |
\#2 & \TeX\ code & First letter after the initial.\\ |
| 974 |
\#3 & \TeX\ code & Everything else in the syllable.\\ |
| 975 |
\#4 & \TeX\ code & Three syllable parts when there is a separated initial.\\ |
| 976 |
\#5 & \TeX\ code & Three syllable parts where there is no separated initial.\\ |
| 977 |
\#6 & \TeX\ code & Extra macros to run if there is an initial.\\ |
| 978 |
\end{argtable} |
| 979 |
|
| 980 |
\macroname{\textbackslash GreSetFixedNextTextFormat}{\#1}{gregoriotex-syllable.tex} |
| 981 |
Same as \verb=\GreSetFixedTextFormat= except for next syllable. |
| 982 |
|
| 983 |
\macroname{\textbackslash GreSetFixedTextFormat}{\#1}{gregoriotex-syllable.tex} |
| 984 |
Macro to specify a text which is different from \verb=#1#2#3= (of \verb=\GreSyllable=). It is useful for styles, for instance with: |
| 985 |
\par\medskip |
| 986 |
\begin{gabccode} |
| 987 |
<i>ffj</i>(gh) |
| 988 |
\end{gabccode} |
| 989 |
|
| 990 |
we will have |
| 991 |
|
| 992 |
\begin{latexcode} |
| 993 |
#1 = \textit{f} |
| 994 |
#2 = \textit{f} |
| 995 |
#3 = \textit{j} |
| 996 |
\end{latexcode} |
| 997 |
|
| 998 |
and thus \verb=#1#2#3= will be \verb=\textit{f}\textit{f}\textit{j}=, which won't typeset |
| 999 |
ligatures. In this example we should call \verb=\grefixedtext{\textit{ffj}}=. |
| 1000 |
|
| 1001 |
\begin{argtable} |
| 1002 |
\#1 & \texttt{0} & nothing (normal text)\\ |
| 1003 |
& \texttt{1}& italic\\ |
| 1004 |
& \texttt{2} & bold\\ |
| 1005 |
& \texttt{3} & small caps\\ |
| 1006 |
& \texttt{4} & typewriter\\ |
| 1007 |
& \texttt{5} & underline |
| 1008 |
\end{argtable} |
| 1009 |
|
| 1010 |
\begin{argtable} |
| 1011 |
\#1 & character & The initial letter of the score.\\ |
| 1012 |
\end{argtable} |
| 1013 |
|
| 1014 |
\macroname{\textbackslash GreSetInitialClef}{\#1\#2\#3\#4\#5\#6\#7}{gregoriotex-signs.tex} |
| 1015 |
Macro for writing initial clef. |
| 1016 |
|
| 1017 |
\begin{argtable} |
| 1018 |
\#1 & \texttt{c} or \texttt{f} & Type of clef.\\ |
| 1019 |
\#2 & \texttt{1}--\texttt{5} & Line of clef.\\ |
| 1020 |
\#3 & integer & Height number of flat in clef (\texttt{3} for no flat).\\ |
| 1021 |
\#4 & \texttt{c} or \texttt{f} & Type of secondary clef.\\ |
| 1022 |
\#5 & \texttt{0}--\texttt{5} & Line of secondary clef (\texttt{0} for no secondary clef).\\ |
| 1023 |
\#6 & integer & Height of flat in secondary clef (\texttt{3} for no flat).\\ |
| 1024 |
\#7 & integer & \texttt{0} if clef and first note are far enough to use a shorter space, 1 otherwise.\\ |
| 1025 |
\end{argtable} |
| 1026 |
|
| 1027 |
\macroname{\textbackslash GreSetLinesClef}{\#1\#2\#3\#4\#5\#6\#7}{gregoriotex-signs.tex} |
| 1028 |
Macro to define the clef that will appear at the beginning of the lines. |
| 1029 |
|
| 1030 |
\begin{argtable} |
| 1031 |
\#1 & \texttt{c} or \texttt{f} & Type of clef.\\ |
| 1032 |
\#2 & \texttt{1}--\texttt{5} & Line of clef.\\ |
| 1033 |
\#3 & \texttt{0} & No space after clef.\\ |
| 1034 |
& \texttt{1} & Space after clef.\\ |
| 1035 |
\#4 & integer & Height of flat in clef (\texttt{3} for no flat).\\ |
| 1036 |
\#5 & \texttt{c} or \texttt{f} & Type of secondary clef.\\ |
| 1037 |
\#6 & \texttt{0}--\texttt{5} & Line of secondary clef (\texttt{0} for no secondary clef).\\ |
| 1038 |
\#7 & integer & Height of flat in secondary clef (\texttt{3} for no flat).\\ |
| 1039 |
\end{argtable} |
| 1040 |
|
| 1041 |
\macroname{\textbackslash GreSetLargestClef}{\#1\#2\#3\#4\#5\#6}{gregoriotex-signs.tex} |
| 1042 |
Macro defining the largest clef of the score (for notes left alignment). |
| 1043 |
The arguments are the same as \verb=\GreSetInitialClef= without the \#7th one, which is always considered |
| 1044 |
to be \texttt{1}. |
| 1045 |
|
| 1046 |
\macroname{\textbackslash GreSetNabcAboveLines}{\#1}{gregoriotex-main.tex} |
| 1047 |
Macro to place argument containing Nabc neumes above the lines and empty |
| 1048 |
\verb=\gre@currenttextabovelines= when done. |
| 1049 |
|
| 1050 |
\begin{argtable} |
| 1051 |
\#1 & string & Nabc neumes to be placed above the lines.\\ |
| 1052 |
\end{argtable} |
| 1053 |
|
| 1054 |
\macroname{\textbackslash GreSetNextSyllable}{\#1\#2\#3}{gregoriotex-syllable.tex} |
| 1055 |
Macro to set the text of the next syllable for spacing purposes. |
| 1056 |
|
| 1057 |
\begin{argtable} |
| 1058 |
\#1 & string & the first letters of the syllable, that don't count for the alignment\\ |
| 1059 |
\#2 & string & the middle letters of the syllable, we must align in the middle of them\\ |
| 1060 |
\#3 & string & the end letters, they don't count for alignment\\ |
| 1061 |
\end{argtable} |
| 1062 |
|
| 1063 |
\macroname{\textbackslash GreSetNoFirstSyllableText}{}{gregoriotex-syllable.tex} |
| 1064 |
Macro that indicates there is no next in the first syllable. |
| 1065 |
|
| 1066 |
\macroname{\textbackslash GreSetTextAboveLines}{\#1}{gregoriotex-main.tex} |
| 1067 |
Macro to place argument above the lines and empty |
| 1068 |
\verb=\gre@currenttextabovelines= when done. |
| 1069 |
|
| 1070 |
\begin{argtable} |
| 1071 |
\#1 & string & Text to be placed above the lines.\\ |
| 1072 |
\end{argtable} |
| 1073 |
|
| 1074 |
\macroname{\textbackslash GreSetThisSyllable}{\#1\#2\#3}{gregoriotex-syllable.tex} |
| 1075 |
Macro to set the text of the current syllable. |
| 1076 |
|
| 1077 |
\begin{argtable} |
| 1078 |
\#1 & string & the first letters of the syllable, that don't count for the alignment\\ |
| 1079 |
\#2 & string & the middle letters of the syllable, we must align in the middle of them\\ |
| 1080 |
\#3 & string & the end letters, they don't count for alignment\\ |
| 1081 |
\end{argtable} |
| 1082 |
|
| 1083 |
\macroname{\textbackslash GreSharp}{\#1\#2\#3\#4\#5}{gregoriotex-signs.tex} |
| 1084 |
Macro to typeset a sharp. |
| 1085 |
|
| 1086 |
\begin{argtable} |
| 1087 |
\#1 & integer & Height number of the sharp.\\ |
| 1088 |
\#2 & \texttt{0} & The sharp is not part of the clef.\\ |
| 1089 |
& \texttt{1} & The sharp is part of the clef (doesn't happen).\\ |
| 1090 |
\#3 & \TeX\ code & signs to typeset before the glyph (typically additional bars, as they must be ``behind'' the glyph)\\ |
| 1091 |
\#4 & \TeX\ code & signs to typeset after the glyph (almost all signs)\\ |
| 1092 |
\#5 & string & the line, byte offset, and column address for textedit links when point-and-click is enabled\\ |
| 1093 |
\end{argtable} |
| 1094 |
|
| 1095 |
\macroname{\textbackslash GreSharpParen}{\#1\#2\#3\#4\#5}{gregoriotex-signs.tex} |
| 1096 |
Macro to typeset a parenthesized sharp. |
| 1097 |
|
| 1098 |
\begin{argtable} |
| 1099 |
\#1 & integer & Height number of the sharp.\\ |
| 1100 |
\#2 & \texttt{0} & The sharp is not part of the clef.\\ |
| 1101 |
& \texttt{1} & The sharp is part of the clef (doesn't happen).\\ |
| 1102 |
\#3 & \TeX\ code & signs to typeset before the glyph (typically additional bars, as they must be ``behind'' the glyph)\\ |
| 1103 |
\#4 & \TeX\ code & signs to typeset after the glyph (almost all signs)\\ |
| 1104 |
\#5 & string & the line, byte offset, and column address for textedit links when point-and-click is enabled\\ |
| 1105 |
\end{argtable} |
| 1106 |
|
| 1107 |
\macroname{\textbackslash GreSharpSoft}{\#1\#2\#3\#4\#5}{gregoriotex-signs.tex} |
| 1108 |
Macro to typeset a soft sharp. |
| 1109 |
|
| 1110 |
\begin{argtable} |
| 1111 |
\#1 & integer & Height number of the sharp.\\ |
| 1112 |
\#2 & \texttt{0} & The sharp is not part of the clef.\\ |
| 1113 |
& \texttt{1} & The sharp is part of the clef (doesn't happen).\\ |
| 1114 |
\#3 & \TeX\ code & signs to typeset before the glyph (typically additional bars, as they must be ``behind'' the glyph)\\ |
| 1115 |
\#4 & \TeX\ code & signs to typeset after the glyph (almost all signs)\\ |
| 1116 |
\#5 & string & the line, byte offset, and column address for textedit links when point-and-click is enabled\\ |
| 1117 |
\end{argtable} |
| 1118 |
|
| 1119 |
\macroname{\textbackslash GreSmallCaps}{\#1}{gregoriotex.sty and gregoriotex.tex} |
| 1120 |
Makes argument small capitals. Accesses \LaTeX\ \verb=\textsc= or |
| 1121 |
Plain \TeX\ \verb=\sc= as appropriate Corresponds to ``<sc></sc>'' tags |
| 1122 |
in gabc. |
| 1123 |
|
| 1124 |
\begin{argtable} |
| 1125 |
\#1 & string & Text to be typeset in small caps font.\\ |
| 1126 |
\end{argtable} |
| 1127 |
|
| 1128 |
\macroname{\textbackslash GreSlur}{\#1\#2\#3\#4\#5\#6}{gregoriotex-signs.tex} |
| 1129 |
Typesets a slur. |
| 1130 |
|
| 1131 |
\begin{argtable} |
| 1132 |
\#1 & integer & Height number of the pitch.\\ |
| 1133 |
\#2 & \texttt{-1} & The slur should appear under the note.\\ |
| 1134 |
& \texttt{1} & The slur should appear over the note.\\ |
| 1135 |
\#3 & \texttt{0} & The slur should start at the right end of the note.\\ |
| 1136 |
& \texttt{1} & The slur should start at one punctum's width to the left of the right end of the note.\\ |
| 1137 |
& \texttt{2} & The slur should start at one-half punctum's width to the left of the right end of the note.\\ |
| 1138 |
\#4 & string & The horizontal dimension of the slur.\\ |
| 1139 |
\#5 & string & The vertical dimension of the slur.\\ |
| 1140 |
\#6 & integer & Height number of the pitch.\\ |
| 1141 |
\end{argtable} |
| 1142 |
|
| 1143 |
\macroname{\textbackslash GreSpecial}{\#1}{gregoriotex-symbols.tex} |
| 1144 |
Typesets a special character. If the \#1 special character wasn't defined by |
| 1145 |
\verb=\gresetspecial=, the text of \#1 will be output directly. |
| 1146 |
|
| 1147 |
\begin{argtable} |
| 1148 |
\#1 & string & The text between \texttt{<sp>} and \texttt{</sp>}.\\ |
| 1149 |
\end{argtable} |
| 1150 |
|
| 1151 |
\macroname{\textbackslash GreStar}{}{gregoriotex-symbol.tex} |
| 1152 |
Macro to typeset an asterisk (\GreStar). |
| 1153 |
|
| 1154 |
\macroname{\textbackslash GreSupposeHighLedgerLine}{}{gregoriotex-spaces.tex} |
| 1155 |
Indicates that the system should act as if a ledger line exists above the staff. |
| 1156 |
|
| 1157 |
\macroname{\textbackslash GreSupposeLowLedgerLine}{}{gregoriotex-spaces.tex} |
| 1158 |
Indicates that the system should act as if a ledger line exists below the staff. |
| 1159 |
|
| 1160 |
\macroname{\textbackslash GreSyllable}{\#1\#2\#3\#4\#5\#6\#7\#8\#9}{gregoriotex-syllable.tex} |
| 1161 |
Macro to typeset the syllable. |
| 1162 |
|
| 1163 |
\begin{argtable} |
| 1164 |
\#1 & \TeX\ code & macro setting syllable letters for the current syllable\\ |
| 1165 |
\#2 & empty & reserved for future use\\ |
| 1166 |
\#3 & \TeX\ control sequence & the control sequence to use for styling the hyphen\\ |
| 1167 |
\#4 & \texttt{0} & this syllable is not the end of a word\\ |
| 1168 |
& \texttt{1} & this syllable is the end of a word\\ |
| 1169 |
\#5 & \TeX\ code & macros setting syllable letters for the next syllable\\ |
| 1170 |
\#6 & string & the line, byte offset, and column address for textedit links when point-and-click is enabled\\ |
| 1171 |
\#7 & pair of integers & a pair containing alignment type and alteration type of the next glyph\\ |
| 1172 |
\#8 &\TeX\ code & other macros (translation, double text, etc.) that don't fit in the limitation of the number of arguments\\ |
| 1173 |
\#9 & Gregorio\TeX\ glyphs & all the notes |
| 1174 |
\end{argtable} |
| 1175 |
|
| 1176 |
\macroname{\textbackslash GreSyllableNoteCount}{\#1}{gregoriotex-syllable.tex} |
| 1177 |
Indicates the number of notes in the current syllable. |
| 1178 |
|
| 1179 |
\begin{argtable} |
| 1180 |
\#1 & integer & The number of notes in the current syllable.\\ |
| 1181 |
\end{argtable} |
| 1182 |
|
| 1183 |
\macroname{\textbackslash GreTranslationCenterEnd}{}{gregoriotex-main.tex} |
| 1184 |
Macro to end the centering of the translation text. |
| 1185 |
|
| 1186 |
\macroname{\textbackslash GreTypewriter}{\#1}{gregoriotex.sty and gregoriotex.tex} |
| 1187 |
Makes argument typewriter font. Accesses \LaTeX\ \verb=\texttt= or |
| 1188 |
Plain \TeX\ \verb=\tt= as appropriate. |
| 1189 |
|
| 1190 |
\begin{argtable} |
| 1191 |
\#1 & string & Text to typeset in typewriter font.\\ |
| 1192 |
\end{argtable} |
| 1193 |
|
| 1194 |
\macroname{\textbackslash GreUnderBrace}{\#1\#2\#3\#4}{gregoriotex-signs.tex} |
| 1195 |
Macro to typeset a round brace below the lines. |
| 1196 |
|
| 1197 |
\begin{argtable} |
| 1198 |
\#1 & length & The width of the brace.\\ |
| 1199 |
\#2 & length & A vertical shift.\\ |
| 1200 |
\#3 & length & A horizontal shift.\\ |
| 1201 |
\#4 & \texttt{0} & Don't shift before starting the brace.\\ |
| 1202 |
& \texttt{1} & Shift back a punctum's width before starting the brace. |
| 1203 |
\end{argtable} |
| 1204 |
|
| 1205 |
\macroname{\textbackslash GreUnderline}{\#1}{gregoriotex.sty and gregoriotex.tex} |
| 1206 |
Makes argument underlined under \LaTeX\ using \verb=\underline=. Does |
| 1207 |
nothing in Plain \TeX. |
| 1208 |
|
| 1209 |
\begin{argtable} |
| 1210 |
\#1 & string & Text to typeset underlined.\\ |
| 1211 |
\end{argtable} |
| 1212 |
|
| 1213 |
\macroname{\textbackslash GreUnstyled}{\#1}{gregoriotex-syllable.tex} |
| 1214 |
Returns its argument as-is. |
| 1215 |
|
| 1216 |
\begin{argtable} |
| 1217 |
\#1 & string & Text to typeset without any extra styling.\\ |
| 1218 |
\end{argtable} |
| 1219 |
|
| 1220 |
\macroname{\textbackslash GreUpcomingNewLineForcesCustos}{\#1}{gregoriotex-syllable.tex} |
| 1221 |
Indicates that the new line in the next syllable forces a custos. |
| 1222 |
|
| 1223 |
\begin{argtable} |
| 1224 |
\#1 & \texttt{0} & The custos is forced off.\\ |
| 1225 |
& \texttt{1} & The custos is forced on.\\ |
| 1226 |
\end{argtable} |
| 1227 |
|
| 1228 |
\macroname{\textbackslash GreVarBraceLength}{\#1}{gregoriotex-signs.tex} |
| 1229 |
Returns the computed length of the given brace or ledger line. |
| 1230 |
|
| 1231 |
\begin{argtable} |
| 1232 |
\#1 & string & unique identifier for the brace within the score. |
| 1233 |
\end{argtable} |
| 1234 |
|
| 1235 |
\macroname{\textbackslash GreVarBraceSavePos}{\#1\#2\#3}{gregoriotex-signs.tex} |
| 1236 |
Records positions to compute the lengths of variable-sized braces and ledger lines. |
| 1237 |
|
| 1238 |
\begin{argtable} |
| 1239 |
\#1 & string & unique identifier for the brace within the score.\\ |
| 1240 |
\#2 & \texttt{0} & Don't shift before recording the position.\\ |
| 1241 |
& \texttt{1} & Shift back a punctum's width before recording the position.\\ |
| 1242 |
& \texttt{2} & Shift back one-half a punctum's width before recording the position.\\ |
| 1243 |
\#3 & \texttt{1} & Position to save is the start of brace.\\ |
| 1244 |
& \texttt{2} & Position to save is the end of brace. |
| 1245 |
\end{argtable} |
| 1246 |
|
| 1247 |
\macroname{\textbackslash GreVEpisema}{\#1\#2}{gregoriotex-signs.tex} |
| 1248 |
Macro for typesetting the vertical episema. |
| 1249 |
|
| 1250 |
\begin{argtable} |
| 1251 |
\#1 & integer & Height number of episema.\\ |
| 1252 |
\#2 & string & Type of glyph the episema is attached to. See \Nameref{NoteOffset} for a description of options.\\ |
| 1253 |
\end{argtable} |
| 1254 |
|
| 1255 |
\macroname{\textbackslash GreVirgula}{\#1\#2\#3}{gregoriotex-signs.tex} |
| 1256 |
Macro to typeset a virgula. |
| 1257 |
|
| 1258 |
\begin{argtable} |
| 1259 |
\#1 & \texttt{0} & There is no text under the bar.\\ |
| 1260 |
& \texttt{1} & There is text under the bar.\\ |
| 1261 |
\#2 & code & Macros which may happen before the skip but after the virgula (typically \verb=\grevepisema=).\\ |
| 1262 |
\#3 & \texttt{0} & The notes around the bar are vertically close to the bar.\\ |
| 1263 |
& \texttt{1} & The notes around the bar are far, \verb=@short= versions of spaces will be used.\\ |
| 1264 |
\end{argtable} |
| 1265 |
|
| 1266 |
\macroname{\textbackslash GreVirgulaHigh}{\#1\#2\#3}{gregoriotex-signs.tex} |
| 1267 |
Macro to typeset a virgula on the ledger line above the staff. |
| 1268 |
|
| 1269 |
\begin{argtable} |
| 1270 |
\#1 & \texttt{0} & There is no text under the bar.\\ |
| 1271 |
& \texttt{1} & There is text under the bar.\\ |
| 1272 |
\#2 & code & Macros which may happen before the skip but after the virgula (typically \verb=\grevepisema=).\\ |
| 1273 |
\#3 & \texttt{0} & The notes around the bar are vertically close to the bar.\\ |
| 1274 |
& \texttt{1} & The notes around the bar are far, \verb=@short= versions of spaces will be used.\\ |
| 1275 |
\end{argtable} |
| 1276 |
|
| 1277 |
\macroname{\textbackslash GreVirgulaParen}{\#1\#2\#3}{gregoriotex-signs.tex} |
| 1278 |
Macro to typeset a parenthesized virgula. |
| 1279 |
|
| 1280 |
\begin{argtable} |
| 1281 |
\#1 & \texttt{0} & There is no text under the bar.\\ |
| 1282 |
& \texttt{1} & There is text under the bar.\\ |
| 1283 |
\#2 & code & Macros which may happen before the skip but after the virgula (typically \verb=\grevepisema=).\\ |
| 1284 |
\#3 & \texttt{0} & The notes around the bar are vertically close to the bar.\\ |
| 1285 |
& \texttt{1} & The notes around the bar are far, \verb=@short= versions of spaces will be used.\\ |
| 1286 |
\end{argtable} |
| 1287 |
|
| 1288 |
\macroname{\textbackslash GreVirgulaParenHigh}{\#1\#2\#3}{gregoriotex-signs.tex} |
| 1289 |
Macro to typeset a parenthesized virgula on the ledger line above the staff. |
| 1290 |
|
| 1291 |
\begin{argtable} |
| 1292 |
\#1 & \texttt{0} & There is no text under the bar.\\ |
| 1293 |
& \texttt{1} & There is text under the bar.\\ |
| 1294 |
\#2 & code & Macros which may happen before the skip but after the virgula (typically \verb=\grevepisema=).\\ |
| 1295 |
\#3 & \texttt{0} & The notes around the bar are vertically close to the bar.\\ |
| 1296 |
& \texttt{1} & The notes around the bar are far, \verb=@short= versions of spaces will be used.\\ |
| 1297 |
\end{argtable} |
| 1298 |
|
| 1299 |
\macroname{\textbackslash GreWriteTranslation}{\#1}{gregoriotex-main.tex} |
| 1300 |
Macro to typeset argument in the translation position. |
| 1301 |
|
| 1302 |
\begin{argtable} |
| 1303 |
\#1 & string & Text to typeset in the translation.\\ |
| 1304 |
\end{argtable} |
| 1305 |
|
| 1306 |
\macroname{\textbackslash GreWriteTranslationWithCenterBeginning}{\#1}{gregoriotex-main.tex} |
| 1307 |
Macro to typeset argument (a string) in the translation position (at |
| 1308 |
the beginning of a line?). |
| 1309 |
|
| 1310 |
\begin{argtable} |
| 1311 |
\#1 & string & Text to typeset in the translation (at the beginning of a line).\\ |
| 1312 |
\end{argtable} |
| 1313 |
|
| 1314 |
\macroname{\textbackslash GreForceBreak}{}{gregoriotex-spaces.tex} |
| 1315 |
Macro used to force a line break to occur at a given position. |
| 1316 |
|
| 1317 |
\macroname{\textbackslash GreNoBreak}{}{gregoriotex-spaces.tex} |
| 1318 |
Macro used to prevent a line break from occurring at a given position. |
| 1319 |
|
| 1320 |
\macroname{\textbackslash GreScoreId}{}{gregoriotex-main.tex} |
| 1321 |
A Lua\TeX\ attribute which designates a unique identifier for each score. |
| 1322 |
|
| 1323 |
\macroname{\textbackslash GreNABCNeumes}{\#1\#2\#3\#4}{gregoriotex-nabc.tex} |
| 1324 |
Macro to print a nabc character above the lines. |
| 1325 |
|
| 1326 |
\begin{argtable} |
| 1327 |
\#1 & integer & the line on which the character should appear (currently unused)\\ |
| 1328 |
\#2 & string & The \texttt{nabc} syntax which indicates what neumes are to be printed\\ |
| 1329 |
\#3 & integer & The high pitch of the notes covered by the nabc character(s).\\ |
| 1330 |
\#4 & integer & The low pitch of the notes covered by the nabc character(s).\\ |
| 1331 |
\end{argtable} |
| 1332 |
|
| 1333 |
\macroname{\textbackslash GreNABCChar}{\#1}{gregoriotex-nabc.tex} |
| 1334 |
Macro to print a nabc character. |
| 1335 |
|
| 1336 |
\begin{argtable} |
| 1337 |
\#1 & string & The \texttt{nabc} syntax which indicates what neumes are to be printed\\ |
| 1338 |
\end{argtable} |
| 1339 |
|
| 1340 |
\macroname{\textbackslash GreScoreNABCLines}{\#1}{gregoriotex-nabc.tex} |
| 1341 |
Macro which sets the number of \texttt{nabc} lines in the score. |
| 1342 |
|
| 1343 |
\begin{argtable} |
| 1344 |
\#1 & integer & the number of \texttt{nabc} lines (currently only 1 is supported)\\ |
| 1345 |
\end{argtable} |
| 1346 |
|
| 1347 |
|
| 1348 |
\macroname{\textbackslash GreModeNumber}{\#1}{gregoriotex-main.tex} |
| 1349 |
Macro which formats the mode in roman or arabic numerals according to the appropriate setting. |
| 1350 |
|
| 1351 |
\begin{argtable} |
| 1352 |
\#1 & \texttt{1}--\texttt{8} & The mode to be formated\\ |
| 1353 |
\end{argtable} |
| 1354 |
|
| 1355 |
\macroname{\textbackslash GreNoNoteSyllable}{}{gregoriotex-syllable.tex} |
| 1356 |
Alias for \verb=\GreSyllable= or \verb=\GreBarSyllable= depending on whether the old or new bar spacing algorithm (respectively) is active. This is used only for syllables which have no notes. |
| 1357 |
|
| 1358 |
\macroname{\textbackslash GreGABCForceCenters}{}{gregoriotex-syllable.tex} |
| 1359 |
Macro inserted into \verb=\GreSyllable= and \verb=\GreBarSyllable= to indicate that the center of the of the current syllable was forced in the gabc with curly braces (``\{'' and ``\}''). |
| 1360 |
|
| 1361 |
\macroname{\textbackslash GreGABCNextForceCenters}{}{gregoriotex-syllable.tex} |
| 1362 |
Macro inserted into \verb=\GreSyllable= and \verb=\GreBarSyllable= to indicate that the center of the of the next syllable was forced in the gabc with curly braces (``\{'' and ``\}''). |
| 1363 |
|
| 1364 |
|
| 1365 |
%%% Local Variables: |
| 1366 |
%%% mode: latex |
| 1367 |
%%% TeX-master: "GregorioRef" |
| 1368 |
%%% End: |