Merge pull request #1476 from henryso/develop

Added parenthesized virgula, divisio minima, flat, natural, and sharp.

CHANGELOG.md

@@ -6,6 +6,7 @@ As of v3.0.0 this project adheres to [Semantic Versioning](http://semver.org/).
 ### Fixed
 - Fixed some problem in 900_gregorio.xml (Scribus render frame tool).  First, the use of `filecontents` rather than `filecontents*` was leading to a comment header that made it impossible for Gregorio to find the gabc headers in the temporary score file.  Further, some of the indenting (which makes the file more human readable) was leading to errors in the formatting of the created files because they are processed in a way which handles whitespace differently from XML.  See [#1457](https://github.com/gregorio-project/gregorio/issues/1457).
 - `spacelinestext` is now based on the lyric font size instead of being a fixed distance.  As a result, large lyrics should no longer overlap with low notes.  See [#1261](https://github.com/gregorio-project/gregorio/issues/1261).
+- Added parenthesized figures for virgula (gabc: `` `?``), divisio minima (gabc: ` ,?`), flat (gabc: `x?`), natural (gabc: `y?`), and sharp (gabc: `#?`).  See [#1475](https://github.com/gregorio-project/gregorio/issues/1475).
 
 ### Added
 - Default spacings are now designated internal and thus always loaded.  `gsp-sample.tex` is added to the `doc` folder to show users how to create their own custom spacing configuration.  As part of this change, spacing configuration files no longer need to be complete.  Since the default configuration is always loaded at package startup, all needed penalties and spacings will be defined and the user's configuration file need only specify those whose value they wish to customize.  Addresses issues raised in [#1460](https://github.com/gregorio-project/gregorio/issues/1460).  **This is a change to the user interface and warrants a major release.**

contrib/gabc.vim

@@ -12,7 +12,8 @@ syn match gabcAttributeEnd ";"
 syn match gabcNoteError "." contained
 syn match gabcBasicNote "[a-np]" contained
 syn match gabcBasicNote "[A-NP][012]\?" contained
-syn match gabcNoteShape "[\<\>~xy#vVwWqQR\-Ss\.+]" contained
+syn match gabcNoteShape "[\<\>~vVwWqQR\-Ss\.+]" contained
+syn match gabcNoteShape "[xy#]?\?" contained
 syn match gabcNoteShape "_[0-5]*" contained
 syn match gabcNoteShape "[oO'\.][01]\?" contained
 syn match gabcNoteShape "r[0-8]\?" contained
@@ -32,7 +33,9 @@ syn match gabcFuseEnd "\]" contained
 syn match gabcBar ":?\?" contained
 syn match gabcBar ";[1-8]\?" contained
 syn match gabcBar ",[0-8]\?" contained
-syn match gabcBar "[`^]0\?" contained
+syn match gabcBar "[,`]?\?0\?" contained
+syn match gabcBar "[,`]0?" contained
+syn match gabcBar "\^0\?" contained
 syn match gabcSpace "[! ]" contained
 syn match gabcSpace "/0\?" contained
 syn match gabcSpace "z[-+0]\?" contained

doc/Command_Index_User.tex

@@ -1859,6 +1859,12 @@ \subsubsection{Bar distances}
 \begin{gdimension}{bar@virgula@short}
 \end{gdimension}
 
+\begin{gdimension}{bar@virgulaparen}
+\end{gdimension}
+
+\begin{gdimension}{bar@virgulaparen@short}
+\end{gdimension}
+
 \begin{gdimension}{bar@minimis}
 \end{gdimension}
 
@@ -1871,6 +1877,12 @@ \subsubsection{Bar distances}
 \begin{gdimension}{bar@minima@short}
 \end{gdimension}
 
+\begin{gdimension}{bar@minimaparen}
+\end{gdimension}
+
+\begin{gdimension}{bar@minimaparen@short}
+\end{gdimension}
+
 \begin{gdimension}{bar@minor}
 \end{gdimension}
 
@@ -1891,6 +1903,12 @@ \subsubsection{Bar distances}
 \begin{gdimension}{bar@virgula@standalone@text@short}
 \end{gdimension}
 
+\begin{gdimension}{bar@virgulaparen@standalone@text}
+\end{gdimension}
+
+\begin{gdimension}{bar@virgulaparen@standalone@text@short}
+\end{gdimension}
+
 \begin{gdimension}{bar@minimis@standalone@text}
 \end{gdimension}
 
@@ -1903,6 +1921,12 @@ \subsubsection{Bar distances}
 \begin{gdimension}{bar@minima@standalone@text@short}
 \end{gdimension}
 
+\begin{gdimension}{bar@minimaparen@standalone@text}
+\end{gdimension}
+
+\begin{gdimension}{bar@minimaparen@standalone@text@short}
+\end{gdimension}
+
 \begin{gdimension}{bar@minor@standalone@text}
 \end{gdimension}
 
@@ -1926,6 +1950,12 @@ \subsubsection{Bar distances}
 \begin{gdimension}{bar@virgula@standalone@notext@short}
 \end{gdimension}
 
+\begin{gdimension}{bar@virgulaparen@standalone@notext}
+\end{gdimension}
+
+\begin{gdimension}{bar@virgulaparen@standalone@notext@short}
+\end{gdimension}
+
 \begin{gdimension}{bar@minimis@standalone@notext}
 \end{gdimension}
 
@@ -1938,6 +1968,12 @@ \subsubsection{Bar distances}
 \begin{gdimension}{bar@minima@standalone@notext@short}
 \end{gdimension}
 
+\begin{gdimension}{bar@minimaparen@standalone@notext}
+\end{gdimension}
+
+\begin{gdimension}{bar@minimaparen@standalone@notext@short}
+\end{gdimension}
+
 \begin{gdimension}{bar@minor@standalone@notext}
 \end{gdimension}
 

doc/Command_Index_gregorio.tex

@@ -118,7 +118,7 @@ \section{Gregorio Controls}
   & \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 @@ \section{Gregorio Controls}
   & \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).
 
@@ -496,6 +518,18 @@ \section{Gregorio Controls}
   \#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 +676,12 @@ \section{Gregorio Controls}
 \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 GreInDivisioMinor}{\#1\#2}{gregoriotex-signs.tex}
 Same as \verb=\GreDivisioMinor= except inside a syllable.
 
@@ -663,6 +703,12 @@ \section{Gregorio Controls}
 \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 +792,18 @@ \section{Gregorio Controls}
   \#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 +1062,18 @@ \section{Gregorio Controls}
   \#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 +1126,7 @@ \section{Gregorio Controls}
   & \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 +1232,28 @@ \section{Gregorio Controls}
   & \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.