Merge pull request #992 from rpspringuel/documentation

Documentation

.gregorio-version

@@ -1,4 +1,4 @@
-4.1.0-rc2
+4.1.0
 
 *** Do not modify this file. ***
 Use VersionManager.py to change the version.

UPGRADE.md

@@ -62,6 +62,8 @@ The spaces around bars are now:
 - `bar@minima` (both replacing `spacearoundsmallbars`)
 - `bar@minor` (replacing `spacearoundminor`)
 - `bar@maior` (replacing `spacearoundmaior`)
+- `bar@finalis` (replacing `spacearoundfinalis`)
+- `bar@finalifinalis` (replaceing `spacebeforefinalfinalis`)
 - `bar@dominican` (new)
 
 They have variants for the new bar spacing algorithm only:
@@ -187,7 +189,7 @@ This would have made the text which was wrapped with `<alt></alt>` in your gabc
 
 ### Centering scheme
 
-The gabc `centering-scheme` header is now deprecated and will disappear soon.  Use the `\grelyriccentering` command from TeX instead.  If you were using `centering-scheme: latine;` in gabc, now use `\grelyriccentering{vowel}` in the TeX file that includes the gabc.  If you were using `centering-scheme: english;` in gabc, now use `\grelyriccentering{syllable}` in the TeX file that includes the gabc.
+The gabc `centering-scheme` header is now deprecated and will disappear soon.  Use the `\gresetlyriccentering` command from TeX instead.  If you were using `centering-scheme: latine;` in gabc, now use `\gresetlyriccentering{vowel}` in the TeX file that includes the gabc.  If you were using `centering-scheme: english;` in gabc, now use `\gresetlyriccentering{syllable}` in the TeX file that includes the gabc.
 
 Using the gabc header will, in this release, do that for you, but it will produce a deprecation warning.  This header will no longer be available in the next release.
 

configure.ac

@@ -16,8 +16,8 @@ dnl
 dnl You should have received a copy of the GNU General Public License
 dnl along with Gregorio.  If not, see <http://www.gnu.org/licenses/>.
 
-AC_INIT([gregorio],[4.1.0-rc2],[https://github.com/gregorio-project/gregorio/issues],[gregorio],[http://gregorio-project.github.io/])
-FILENAME_VERSION="4_1_0-rc2"
+AC_INIT([gregorio],[4.1.0],[https://github.com/gregorio-project/gregorio/issues],[gregorio],[http://gregorio-project.github.io/])
+FILENAME_VERSION="4_1_0"
 AC_SUBST(FILENAME_VERSION)
 AC_DEFINE_UNQUOTED(FILENAME_VERSION, "$FILENAME_VERSION", [version suitable for file names])
 MK=""

def_check.sh

@@ -30,23 +30,38 @@ sed -i.temp 's:.*OBSOLETE.*::' $TEXFILE
 sed -i.temp 's:.*DEPRECATED.*::' $TEXFILE
 
 #Isolate function names
-sed -i.temp 's:.*\(Gre[a-zA-Z]*\).*:\1:' $TEXFILE
+sed -i.temp 's:Gre:\
+Gre:g' $TEXFILE
+sed -i.temp '/Gre/!d' $TEXFILE
+sed -i.temp 's:\(Gre[a-zA-Z]*\).*:\1:' $TEXFILE
+
+#label file
+echo "00 GreMacros Defined in TeX" >> $TEXFILE
 
 #alphabetize and remove duplicates
 sort -u -o$TEXFILE $TEXFILE
 
 
 #Extraction from c code
 cd ../src/gregoriotex
-
 grep -hE '\\\\Gre.*' gregoriotex-write.c > $CFILE
 
+cd ../gabc
+grep -hE '\\\\Gre.*' gabc-notes-determination.l >> $CFILE
+grep -hE '\\\\Gre.*' gabc-score-determination.y >> $CFILE
+
 #remove deprecated code
 sed -i.temp 's:.*OBSOLETE.*::' $CFILE
 sed -i.temp 's:.*DEPRECATED.*::' $CFILE
 
 #Isolate function names
-sed -i.temp 's:.*\(Gre[a-zA-Z]*\).*:\1:' $CFILE
+sed -i.temp 's:Gre:\
+Gre:g' $CFILE
+sed -i.temp '/Gre/!d' $CFILE
+sed -i.temp 's:\(Gre[a-zA-Z]*\).*:\1:' $CFILE
+
+#label file
+echo "00 Macros Written by C" >> $CFILE
 
 #alphabetize and remove duplicates
 sort -u -o$CFILE $CFILE

doc/Command_Index_User.tex

@@ -671,6 +671,10 @@ \subsubsection{Special Characters}
 
 \textbf{Nota Bene:} The same rules apply for \#1 as in \verb=\gresetspecial=.
 
+\macroname{\textbackslash gretilde}{}{gregoriotex-main.tex}
+Macro to print $\sim$.  This macro is set using the above for \texttt{<sp>~</sp>}.
+
+
 
 \subsubsection{Styling}
 Different elements of an include score have different styles applied.  These elements and their defaults are listed below:
@@ -1600,6 +1604,14 @@ \subsubsection*{Bar distances}
 Same as \texttt{interwordspacetext@bars} for \texttt{euouae} blocks (so quite rare).
 \end{gdimension}
 
+\begin{gdimension}{interwordspacetext@bars@notext}
+Minimum space between texts of adjacent words when they are separated by a bar syllable which has no text associated with it (new bar spacing algorithm only).
+\end{gdimension}
+
+\begin{gdimension}{interwordspacetext@bars@notext@euouae}
+Same as \texttt{interwordspacetext@bars@notext} for \texttt{euouae} blocks (so quite rare).
+\end{gdimension}
+
 \begin{gdimension}{textbartextspace}
 Space between the text of previous syllable and the text associated with the bar (old bar spacing algorithm only).
 \end{gdimension}

doc/Command_Index_gregorio.tex

@@ -951,9 +951,6 @@ \section{Gregorio Controls}
   \#9 & Gregorio\TeX\ glyphs & all the notes
 \end{argtable}
 
-\macroname{\textbackslash GreTilde}{}{gregoriotex-main.tex}
-Macro to print $\sim$.
-
 \macroname{\textbackslash GreTranslationCenterEnd}{}{gregoriotex-main.tex}
 Macro to end the centering of the translation text.
 
@@ -1050,11 +1047,6 @@ \section{Gregorio Controls}
   \#1 & string & Text to typeset in the translation (at the beginning of a line).\\
 \end{argtable}
 
-\macroname{\textbackslash GreZeroHyph}{}{gregoriotex-main.tex}
-Macro to typeset a zero-width hyphen (the hyphen is visible, it is only
-treated as if it had 0 width when calculating spaces).  Used for fine tuning spacing
-(especially at line endings).
-
 \macroname{\textbackslash GreForceBreak}{}{gregoriotex-spaces.tex}
 Macro used to force a line break to occur at a given position.
 

doc/Command_Index_internal.tex

@@ -1349,6 +1349,11 @@ \subsection{Character Reference Aliases}
 \macroname{\textbackslash gre@char@normalhyphen}{}{gregoriotex-main.tex}
 A normal hyphen in the text font.
 
+\macroname{\textbackslash gre@char@zerohyph}{}{gregoriotex-main.tex}
+Macro to typeset a zero-width hyphen (the hyphen is visible, it is only
+treated as if it had 0 width when calculating spaces).  Used for fine tuning spacing
+(especially at line endings).
+
 \macroname{\textbackslash gre@char@fuse@debilis}{}{gregoriotex-chars.tex}
 A fused character consisting of a leading punctum initio debilis (of ambitus one) and a regular punctum.
 
@@ -1593,7 +1598,7 @@ \subsection{Flags}
 \macroname{\textbackslash ifgre@disablemora}{}{gregoriotex-signs.tex}
 Boolean to disable the printing of punctum morae.
 
-\macroname{\textbackslash ifgre@disablevepsiema}{}{gregoriotex-signs.tex}
+\macroname{\textbackslash ifgre@disablevepisema}{}{gregoriotex-signs.tex}
 Boolean to disable the printing of vertical episemata.
 
 \macroname{\textbackslash ifgre@lastendswithmorasave}{}{gregoriotex-syllable.tex}

doc/GregorioRef.tex

@@ -152,7 +152,7 @@
 
     \vspace{1cm}
 
-    \large Version \textbf{4.1.0-rc2}, 25 February 2016 %% PARSE_VERSION_DATE
+    \large Version \textbf{4.1.0}, 1 March 2016 %% PARSE_VERSION_DATE
 
     \vspace{1.5cm}
   \end{center}

fonts/squarize.py

@@ -78,7 +78,7 @@
     5: 'Five',
 }
 
-GREGORIO_VERSION = '4.1.0-rc2'
+GREGORIO_VERSION = '4.1.0'
 
 # The unicode character at which we start our numbering:
 # U+E000 is the start of the BMP Private Use Area

macosx/Gregorio.pkgproj

@@ -564,7 +564,7 @@
 				<key>OVERWRITE_PERMISSIONS</key>
 				<false/>
 				<key>VERSION</key>
-				<string>4.1.0-rc2</string><!--GREGORIO_VERSION-->
+				<string>4.1.0</string><!--GREGORIO_VERSION-->
 			</dict>
 			<key>UUID</key>
 			<string>74692645-8112-42EB-8FFC-2CBE2CEDE9FB</string>

tex/gregoriosyms.sty

@@ -19,7 +19,7 @@
 
 \NeedsTeXFormat{LaTeX2e}
 \ProvidesPackage{gregoriosyms}
-    [2016/02/25 v4.1.0-rc2 GregorioTeX symbols only.]% PARSE_VERSION_DATE_LTX
+    [2016/03/01 v4.1.0 GregorioTeX symbols only.]% PARSE_VERSION_DATE_LTX
 
 % If gregoriotex has been loaded, then we need to abort the loading process of this package here in order to avoid some conflicts.
 \ifcsname gregoriotex@symbols@loaded\endcsname\endinput\fi%
@@ -38,7 +38,7 @@
 
 % The version of gregorio. All gregoriotex*.tex files must have the same.
 % All gtex files must also have the same version.
-\xdef\gre@gregorioversion{4.1.0-rc2}% GREGORIO_VERSION - VersionManager.py
+\xdef\gre@gregorioversion{4.1.0}% GREGORIO_VERSION - VersionManager.py
 
 \providecommand{\gre@declarefileversion}[2]{\relax}
 

tex/gregoriotex-chars.tex

@@ -18,7 +18,7 @@
 % along with Gregorio.  If not, see <http://www.gnu.org/licenses/>.
 
 \gre@debugmsg{general}{Loading gregoriotex-chars.tex}%
-\gre@declarefileversion{gregoriotex-chars.tex}{4.1.0-rc2}% GREGORIO_VERSION
+\gre@declarefileversion{gregoriotex-chars.tex}{4.1.0}% GREGORIO_VERSION
 
 \def\gre@char@fuse@punctum@one{\GreFuseTwo{\GreCPLeadingPunctumOne}{\GreCPPunctum}}%
 \def\gre@char@fuse@quilisma@one{\GreFuseTwo{\GreCPLeadingQuilismaOne}{\GreCPPunctum}}%

tex/gregoriotex-main.tex

@@ -108,7 +108,7 @@
 
 % The version of gregorio. All gregoriotex*.tex files must have the same.
 % All gtex files must also have the same version.
-\xdef\gre@gregorioversion{4.1.0-rc2}% GREGORIO_VERSION - VersionManager.py
+\xdef\gre@gregorioversion{4.1.0}% GREGORIO_VERSION - VersionManager.py
 
 % first some macros to allow checks for version:
 % Tests that all gregoriotex files are of the same version.
@@ -1673,7 +1673,7 @@
 %% fonts
 %%%%%%%%%
 
-\def\GreTilde{%
+\def\gretilde{%
   \ensuremath{\sim}%
   \relax %
 }%
@@ -1936,7 +1936,7 @@
 %%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 % a zero-width hyphen, useful for fine tuning line endings. To input in gabc verb for example.
-\def\GreZeroHyph{%
+\def\gre@char@zerohyph{%
   \hbox to 0pt{%
   \char\the\hyphenchar\font %
   \hss %
@@ -1957,7 +1957,7 @@
   \IfStrEq{#1}{normal}%
     {\global\let\GreHyph\gre@char@normalhyphen}%
     {\IfStrEq{#1}{zero}%
-      {\global\let\GreHyph\GreZeroHyph}%
+      {\global\let\GreHyph\gre@char@zerohyph}%
       {\gre@error{Unrecognized option for \protect\greseteolhyphen}}%
     }%
 }%

tex/gregoriotex-nabc.lua

@@ -20,7 +20,7 @@
 -- this file contains lua functions used by GregorioTeX St. Gall ancient
 -- neume support when called with LuaTeX.
 
--- GREGORIO_VERSION 4.1.0-rc2
+-- GREGORIO_VERSION 4.1.0
 
 local gregallaliases = {
   ["ci~"] = "cl>",

tex/gregoriotex-nabc.tex

@@ -20,7 +20,7 @@
 % this file contains macros for St. Gall ancient neume support
 
 \gre@debugmsg{general}{Loading gregoriotex-nabc.tex}%
-\gre@declarefileversion{gregoriotex-nabc.tex}{4.1.0-rc2}% GREGORIO_VERSION
+\gre@declarefileversion{gregoriotex-nabc.tex}{4.1.0}% GREGORIO_VERSION
 
 
 \xdef\gre@nabcfontname{gregall}

tex/gregoriotex-signs.lua

@@ -19,7 +19,7 @@
 
 -- this file contains lua functions to support signs used by GregorioTeX.
 
--- GREGORIO_VERSION 4.1.0-rc2
+-- GREGORIO_VERSION 4.1.0
 
 local err = gregoriotex.module.err
 local warn = gregoriotex.module.warn

tex/gregoriotex-signs.tex

@@ -23,7 +23,7 @@
 \def\grebarbracewidth{.58879}%
 
 \gre@debugmsg{general}{Loading gregoriotex-signs.tex}%
-\gre@declarefileversion{gregoriotex-signs.tex}{4.1.0-rc2}% GREGORIO_VERSION
+\gre@declarefileversion{gregoriotex-signs.tex}{4.1.0}% GREGORIO_VERSION
 
 \def\gre@usestylecommon{%
   \ifgre@usestylefont\else %

tex/gregoriotex-spaces.tex

@@ -20,7 +20,7 @@
 % this file contains definitions of spaces
 
 \gre@debugmsg{general}{Loading gregoriotex-spaces.tex}%
-\gre@declarefileversion{gregoriotex-spaces.tex}{4.1.0-rc2}% GREGORIO_VERSION
+\gre@declarefileversion{gregoriotex-spaces.tex}{4.1.0}% GREGORIO_VERSION
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %% macros for tuning penalties
@@ -1187,6 +1187,34 @@
     \gre@debugmsg{spacing}{Changing a dimen.}%
     \def\gre@prefix{dimen}%
   \fi%
+  \IfStrEqCase{#1}{% DEPRECATED
+    {spacearoundsmallbars}% DEPRECATED
+      {% DEPRECATED
+        \gre@deprecated{spacearoundsmallbars}{bar@virgula or bar@minima}% DEPRECATED
+        \grechangedim{bar@virgula}{#2}{#3}% DEPRECATED
+        \grechangedim{bar@minima}{#2}{#3}% DEPRECATED
+      }% DEPRECATED
+    {spacearoundminor}% DEPRECATED
+      {% DEPRECATED
+        \gre@deprecated{spacearoundminor}{bar@minor}% DEPRECATED
+        \grechangedim{bar@minor}{#2}{#3}% DEPRECATED
+      }% DEPRECATED
+    {spacearoundmaior}% DEPRECATED
+      {% DEPRECATED
+        \gre@deprecated{spacearoundmaior}{bar@maior}% DEPRECATED
+        \grechangedim{bar@maior}{#2}{#3}% DEPRECATED
+      }% DEPRECATED
+    {spacearoundfinalis}% DEPRECATED
+      {% DEPRECATED
+        \gre@deprecated{spacearoundfinalis}{bar@finalis}% DEPRECATED
+        \grechangedim{bar@finalis}{#2}{#3}% DEPRECATED
+      }% DEPRECATED
+    {spacebeforefinalfinalis}% DEPRECATED
+      {% DEPRECATED
+        \gre@deprecated{spacebeforfinalfinalis}{bar@finalfinalis}% DEPRECATED
+        \grechangedime{bar@finalfinalis}{#2}{#3}% DEPRECATED
+      }% DEPRECATED
+    }% DEPRECATED
   \ifcsname gre@space@\gre@prefix @#1\endcsname%
     \gre@debugmsg{spacing}{It does exist.}%
     \gre@dimension{#1}{#2}%

tex/gregoriotex-syllable.tex

@@ -20,7 +20,7 @@
 % this file contains definitions of the glyphs and the syllables
 
 \gre@debugmsg{general}{Loading gregoriotex-syllable.tex}%
-\gre@declarefileversion{gregoriotex-syllable.tex}{4.1.0-rc2}% GREGORIO_VERSION
+\gre@declarefileversion{gregoriotex-syllable.tex}{4.1.0}% GREGORIO_VERSION
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %% macros for the typesetting of the different glyphs

tex/gregoriotex-symbols.lua

@@ -19,7 +19,7 @@
 
 -- this file contains lua functions to support signs used by GregorioTeX.
 
--- GREGORIO_VERSION 4.1.0-rc2
+-- GREGORIO_VERSION 4.1.0
 
 local err = gregoriotex.module.err
 local warn = gregoriotex.module.warn

tex/gregoriotex-symbols.tex

@@ -23,7 +23,7 @@
 \def\gregoriotex@symbols@loaded{}%
 
 \gre@debugmsg{general}{Loading gregoriotex-symbols.tex}%
-\gre@declarefileversion{gregoriotex-symbols.tex}{4.1.0-rc2}% GREGORIO_VERSION
+\gre@declarefileversion{gregoriotex-symbols.tex}{4.1.0}% GREGORIO_VERSION
 
 \RequireLuaModule{gregoriotex}%
 
@@ -229,9 +229,9 @@
 \gresetspecial{oe}{\oe{}}%
 \gresetspecial{*}{\GreStar{}}%
 \gresetspecial{+}{\GreDagger{}}%
-\gresetspecial{-}{\GreZeroHyph{}}%
+\gresetspecial{-}{\gre@char@zerohyph{}}%
 \gresetspecial{\string\092}{\textbackslash{}}%
 \gresetspecial{\string\038}{\&{}}%
 \gresetspecial{\string\035}{\#{}}%
 \gresetspecial{\string\095}{\_{}}%
-\gresetspecial{\string\126}{\GreTilde{}}%
+\gresetspecial{\string\126}{\gretilde{}}%

tex/gregoriotex.lua

@@ -24,13 +24,13 @@ local hpack, traverse, traverse_id, has_attribute, count, remove, insert_after,
 gregoriotex = gregoriotex or {}
 local gregoriotex = gregoriotex
 
-local internalversion = '4.1.0-rc2' -- GREGORIO_VERSION (comment used by VersionManager.py)
+local internalversion = '4.1.0' -- GREGORIO_VERSION (comment used by VersionManager.py)
 
 local err, warn, info, log = luatexbase.provides_module({
     name               = "gregoriotex",
-    version            = '4.1.0-rc2', -- GREGORIO_VERSION
+    version            = '4.1.0', -- GREGORIO_VERSION
     greinternalversion = internalversion,
-    date               = "2016/02/25", -- GREGORIO_DATE_LTX
+    date               = "2016/03/01", -- GREGORIO_DATE_LTX
     description        = "GregorioTeX module.",
     author             = "The Gregorio Project (see CONTRIBUTORS.md)",
     copyright          = "2008-2015 - The Gregorio Project",

tex/gregoriotex.sty

@@ -19,7 +19,7 @@
 
 \NeedsTeXFormat{LaTeX2e}%
 \ProvidesPackage{gregoriotex}%
-    [2016/02/25 v4.1.0-rc2 GregorioTeX system.]% PARSE_VERSION_DATE_LTX
+    [2016/03/01 v4.1.0 GregorioTeX system.]% PARSE_VERSION_DATE_LTX
 
 % If gregoriosyms has been loaded then there are going to be some conflicts in the definitions made in that package and this one.  In order to provide for a more informative error message, we check for that conflict right away
 \ifcsname gregoriotex@symbols@loaded\endcsname\gre@error{Loading gregoriotex after\MessageBreak gregoriosyms is not supported.  Please remove the\MessageBreak loading of gregoriosyms (its contents are loaded\MessageBreak by gregoriotex)}\fi%

tex/gregoriotex.tex

@@ -21,7 +21,7 @@
 
 
 % This file needs to be marked with the version number.  For now I've done this with the following comment, but we should check to see if PlainTeX has something similar to the version declaration of LaTeX and use that if it does.
-% 		[2016/02/25 v4.1.0-rc2 GregorioTeX system.]% PARSE_VERSION_DATE_LTX
+% 		[2016/03/01 v4.1.0 GregorioTeX system.]% PARSE_VERSION_DATE_LTX
 
 
 \edef\greoldcatcode{\the\catcode`@}