summaryrefslogtreecommitdiff
path: root/support/gregoriotex/doc/Command_Index_gregorio.tex
diff options
context:
space:
mode:
Diffstat (limited to 'support/gregoriotex/doc/Command_Index_gregorio.tex')
-rw-r--r--support/gregoriotex/doc/Command_Index_gregorio.tex112
1 files changed, 104 insertions, 8 deletions
diff --git a/support/gregoriotex/doc/Command_Index_gregorio.tex b/support/gregoriotex/doc/Command_Index_gregorio.tex
index eaf0121293..d6eac996fc 100644
--- a/support/gregoriotex/doc/Command_Index_gregorio.tex
+++ b/support/gregoriotex/doc/Command_Index_gregorio.tex
@@ -1,7 +1,7 @@
% !TEX root = GregorioRef.tex
% !TEX program = LuaLaTeX+se
%
-% Copyright (C) 2006-2019 The Gregorio Project (see CONTRIBUTORS.md)
+% Copyright (C) 2006-2021 The Gregorio Project (see CONTRIBUTORS.md)
%
% This file is part of Gregorio.
%
@@ -118,7 +118,7 @@ Macro for typesetting a bar syllable.
& \texttt{1} & this syllable is the end of a word\\
\#5 & \TeX\ code & macros setting syllable letters for the next syllable\\
\#6 & string & the line, byte offset, and column address for textedit links when point-and-click is enabled\\
- \#7 & & alignment type of the first next glyph\\
+ \#7 & pair of integers & a pair containing alignment type and alteration type of the next glyph\\
\#8 &\TeX\ code & other macros (translation, double text, etc.) that don't fit in the limitation of the number of arguments\\
\#9 & \TeX\ code & The bar line (usually a \textit{writebar} call).
\end{argtable}
@@ -291,6 +291,28 @@ Macro to typeset a divisio minima on the ledger line above the staff.
& \texttt{1} & The notes around the bar are far, \verb=@short= versions of spaces will be used.\\
\end{argtable}
+\macroname{\textbackslash GreDivisioMinimaParen}{\#1\#2\#3}{gregoriotex-signs.tex}
+Macro to typeset a parenthesized divisio minima.
+
+\begin{argtable}
+ \#1 & \texttt{0} & There is no text under the bar.\\
+ & \texttt{1} & There is text under the bar.\\
+ \#2 & \TeX\ code & Macros which may happen before the skip but after the divisio minima (typically \verb=\grevepisema=).\\
+ \#3 & \texttt{0} & The notes around the bar are vertically close to the bar.\\
+ & \texttt{1} & The notes around the bar are far, \verb=@short= versions of spaces will be used.\\
+\end{argtable}
+
+\macroname{\textbackslash GreDivisioMinimaParenHigh}{\#1\#2\#3}{gregoriotex-signs.tex}
+Macro to typeset a parenthesized divisio minima on the ledger line above the staff.
+
+\begin{argtable}
+ \#1 & \texttt{0} & There is no text under the bar.\\
+ & \texttt{1} & There is text under the bar.\\
+ \#2 & \TeX\ code & Macros which may happen before the skip but after the divisio minima (typically \verb=\grevepisema=).\\
+ \#3 & \texttt{0} & The notes around the bar are vertically close to the bar.\\
+ & \texttt{1} & The notes around the bar are far, \verb=@short= versions of spaces will be used.\\
+\end{argtable}
+
\macroname{\textbackslash GreDivisioMinimis}{\#1\#2\#3}{gregoriotex-signs.tex}
Macro to typeset a divisio ``minimis'' (eighth bar).
@@ -302,7 +324,7 @@ Macro to typeset a divisio ``minimis'' (eighth bar).
& \texttt{1} & The notes around the bar are far, \verb=@short= versions of spaces will be used.\\
\end{argtable}
-\macroname{\textbackslash GreDivisioMinimaHigh}{\#1\#2\#3}{gregoriotex-signs.tex}
+\macroname{\textbackslash GreDivisioMinimisHigh}{\#1\#2\#3}{gregoriotex-signs.tex}
Macro to typeset a divisio ``minimis'' (eighth bar) on the ledger line above the staff.
\begin{argtable}
@@ -464,10 +486,8 @@ after the centered letters.
\macroname{\textbackslash GreFirstSyllableInitial}{\#1}{gregoriotex-syllable.tex}
A macro which is called with the first letter of the first syllable which is
-not the initial of the score. If the \texttt{initial-style} is \texttt{0}, the
-first letter of the syllable will be passed. If the \texttt{initial-style} is
-\texttt{1} or \texttt{2}, the \emph{second} letter will be passed. This macro
-may be redefined to style the first letter appropriately.
+not the initial of the score. If there is no initial (\verb=\gresetinitiallines{0}= has been called), the
+first letter of the syllable will be passed. Otherwise, the \emph{second} letter will be passed.
\begin{argtable}
\#1 & string & The first letter of the first syllable which is not the
@@ -496,6 +516,18 @@ Macro to typeset a flat.
\#5 & string & the line, byte offset, and column address for textedit links when point-and-click is enabled\\
\end{argtable}
+\macroname{\textbackslash GreFlatParen}{\#1\#2\#3\#4\#5}{gregoriotex-signs.tex}
+Macro to typeset a parenthesized flat.
+
+\begin{argtable}
+ \#1 & integer & Height number of the flat.\\
+ \#2 & \texttt{0} & The flat is not part of the clef.\\
+ & \texttt{1} & The flat is part of the clef.\\
+ \#3 & \TeX\ code & signs to typeset before the glyph (typically additional bars, as they must be "behind" the glyph)\\
+ \#4 & \TeX\ code & signs to typeset after the glyph (almost all signs)\\
+ \#5 & string & the line, byte offset, and column address for textedit links when point-and-click is enabled\\
+\end{argtable}
+
\macroname{\textbackslash GreForceHyphen}{}{gregoriotex-syllable.tex}
Macro that indicates that a hyphen should be forced (if enabled) after the given syllable.
@@ -642,6 +674,18 @@ Same as \verb=\GreDivisioMinima= except inside a syllable.
\macroname{\textbackslash GreInDivisioMinimaHigh}{\#1\#2\#3}{gregoriotex-signs.tex}
Same as \verb=\GreDivisioMinimaHigh= except inside a syllable.
+\macroname{\textbackslash GreInDivisioMinimaParen}{\#1\#2\#3}{gregoriotex-signs.tex}
+Same as \verb=\GreDivisioMinimaParen= except inside a syllable.
+
+\macroname{\textbackslash GreInDivisioMinimaParenHigh}{\#1\#2\#3}{gregoriotex-signs.tex}
+Same as \verb=\GreDivisioMinimaParenHigh= except inside a syllable.
+
+\macroname{\textbackslash GreInDivisioMinimis}{\#1\#2\#3}{gregoriotex-signs.tex}
+Same as \verb=\GreDivisioMinimis= except inside a syllable.
+
+\macroname{\textbackslash GreInDivisioMinimisHigh}{\#1\#2\#3}{gregoriotex-signs.tex}
+Same as \verb=\GreDivisioMinimisHigh= except inside a syllable.
+
\macroname{\textbackslash GreInDivisioMinor}{\#1\#2}{gregoriotex-signs.tex}
Same as \verb=\GreDivisioMinor= except inside a syllable.
@@ -663,6 +707,12 @@ Same as \verb=\GreVirgula= except inside a syllable.
\macroname{\textbackslash GreInVirgulaHigh}{\#1\#2\#3}{gregoriotex-signs.tex}
Same as \verb=\GreVirgulaHigh= except inside a syllable.
+\macroname{\textbackslash GreInVirgulaParen}{\#1\#2\#3}{gregoriotex-signs.tex}
+Same as \verb=\GreVirgulaParen= except inside a syllable.
+
+\macroname{\textbackslash GreInVirgulaParenHigh}{\#1\#2\#3}{gregoriotex-signs.tex}
+Same as \verb=\GreVirgulaParenHigh= except inside a syllable.
+
\macroname{\textbackslash GreItalic}{\#1}{gregoriotex.sty or gregoriotex.tex}
Makes argument (a string) italic. Accesses \LaTeX\ \verb=\textit= or
Plain \TeX\ \verb=\it= as appropriate. Corresponds to ``<i></i>'' tags
@@ -746,6 +796,18 @@ Macro to typeset a natural.
\#5 & string & the line, byte offset, and column address for textedit links when point-and-click is enabled\\
\end{argtable}
+\macroname{\textbackslash GreNaturalParen}{\#1\#2\#3\#4\#5}{gregoriotex-signs.tex}
+Macro to typeset a parenthesized natural.
+
+\begin{argtable}
+ \#1 & integer & Height number of the natural.\\
+ \#2 & \texttt{0} & The natural is not part of the clef.\\
+ & \texttt{1} & The natural is part of the clef (doesn't happen).\\
+ \#3 & \TeX\ code & signs to typeset before the glyph (typically additional bars, as they must be "behind" the glyph)\\
+ \#4 & \TeX\ code & signs to typeset after the glyph (almost all signs)\\
+ \#5 & string & the line, byte offset, and column address for textedit links when point-and-click is enabled\\
+\end{argtable}
+
\macroname{\textbackslash GreNewLine}{}{gregoriotex-main.tex}
Macro to call if you want to go to the next line.
@@ -1004,6 +1066,18 @@ Macro to typeset a sharp.
\#5 & string & the line, byte offset, and column address for textedit links when point-and-click is enabled\\
\end{argtable}
+\macroname{\textbackslash GreSharpParen}{\#1\#2\#3\#4\#5}{gregoriotex-signs.tex}
+Macro to typeset a parenthesized sharp.
+
+\begin{argtable}
+ \#1 & integer & Height number of the sharp.\\
+ \#2 & \texttt{0} & The sharp is not part of the clef.\\
+ & \texttt{1} & The sharp is part of the clef (doesn't happen).\\
+ \#3 & \TeX\ code & signs to typeset before the glyph (typically additional bars, as they must be "behind" the glyph)\\
+ \#4 & \TeX\ code & signs to typeset after the glyph (almost all signs)\\
+ \#5 & string & the line, byte offset, and column address for textedit links when point-and-click is enabled\\
+\end{argtable}
+
\macroname{\textbackslash GreSmallCaps}{\#1}{gregoriotex.sty and gregoriotex.tex}
Makes argument small capitals. Accesses \LaTeX\ \verb=\textsc= or
Plain \TeX\ \verb=\sc= as appropriate Corresponds to ``<sc></sc>'' tags
@@ -1056,7 +1130,7 @@ Macro to typeset the syllable.
& \texttt{1} & this syllable is the end of a word\\
\#5 & \TeX\ code & macros setting syllable letters for the next syllable\\
\#6 & string & the line, byte offset, and column address for textedit links when point-and-click is enabled\\
- \#7 & & alignment type of the first next glyph\\
+ \#7 & pair of integers & a pair containing alignment type and alteration type of the next glyph\\
\#8 &\TeX\ code & other macros (translation, double text, etc.) that don't fit in the limitation of the number of arguments\\
\#9 & Gregorio\TeX\ glyphs & all the notes
\end{argtable}
@@ -1162,6 +1236,28 @@ Macro to typeset a virgula on the ledger line above the staff.
& \texttt{1} & The notes around the bar are far, \verb=@short= versions of spaces will be used.\\
\end{argtable}
+\macroname{\textbackslash GreVirgulaParen}{\#1\#2\#3}{gregoriotex-signs.tex}
+Macro to typeset a parenthesized virgula.
+
+\begin{argtable}
+ \#1 & \texttt{0} & There is no text under the bar.\\
+ & \texttt{1} & There is text under the bar.\\
+ \#2 & code & Macros which may happen before the skip but after the virgula (typically \verb=\grevepisema=).\\
+ \#3 & \texttt{0} & The notes around the bar are vertically close to the bar.\\
+ & \texttt{1} & The notes around the bar are far, \verb=@short= versions of spaces will be used.\\
+\end{argtable}
+
+\macroname{\textbackslash GreVirgulaParenHigh}{\#1\#2\#3}{gregoriotex-signs.tex}
+Macro to typeset a parenthesized virgula on the ledger line above the staff.
+
+\begin{argtable}
+ \#1 & \texttt{0} & There is no text under the bar.\\
+ & \texttt{1} & There is text under the bar.\\
+ \#2 & code & Macros which may happen before the skip but after the virgula (typically \verb=\grevepisema=).\\
+ \#3 & \texttt{0} & The notes around the bar are vertically close to the bar.\\
+ & \texttt{1} & The notes around the bar are far, \verb=@short= versions of spaces will be used.\\
+\end{argtable}
+
\macroname{\textbackslash GreWriteTranslation}{\#1}{gregoriotex-main.tex}
Macro to typeset argument in the translation position.