Lyric fontsize

CHANGELOG.md

@@ -5,6 +5,10 @@ As of v3.0.0 this project adheres to [Semantic Versioning](http://semver.org/).
 ## [Unreleased][develop]
 ### 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
+- 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.**
 
 ## [Unreleased][CTAN]
 ### Fixed

VersionManager.py

@@ -65,6 +65,7 @@
                   "tex/gregoriotex-nabc.lua",
                   "tex/gregoriosyms.sty",
                   "tex/gregoriotex-common.tex",
+                  "tex/gsp-default.tex",
                   "fonts/squarize.py",
                  ]
 COPYRIGHT_FILES = ["install-gtex.sh",
@@ -109,6 +110,7 @@
                    "doc/Gabc.tex",
                    "doc/GregorioRef.lua",
                    "doc/Appendix_Font_Tables.tex",
+                   "doc/gsp-sample.tex',
                    "VersionManager.py",
                    "coverage.sh",
                    "COPYING.md",

doc/Command_Index_User.tex

@@ -251,17 +251,6 @@ \subsubsection{Overall Size}
 \subsubsection{Fine Tuning Dimensions}
 In addition to providing control over the overall size of your scores, Gregorio\TeX\ allows you to fine tune the spacings around and between the various elements using the following functions.
 
-\macroname{\textbackslash grecreatedim}{\{\#1\}\{\#2\}\{\#3\}}{gregoriotex-spaces.tex}
-Macro to create one of Gregorio\TeX’s distances.  Used to initialize distances in a space configuration file.  For an example of such a file, please see \textit{gsp-default.tex}, which contains the default spacing configuration for Gregorio\TeX.
-
-\begin{argtable}
-  \#1 & string & The name of the distance to be changed.  See \nameref{distances} below.\\
-  \#2 & string & The distance in string format.  \textbf{Note:} You cannot use a length register for this argument.  You \emph{must} use a string because of the way that Gregorio\TeX\ handles spaces.\\
-  \#3 & \texttt{fixed} & Distance will not scale when staff size is changed.\\
-  & \texttt{scalable} & Distance will scale when staff size is changed.\\
-  & \texttt{inherited} & Distance will inherit its value from another distance.  When this argument is used, then \#2 should be the name of another Gregorio\TeX\ distance.
-\end{argtable}
-
 \macroname{\textbackslash grechangedim}{\{\#1\}\{\#2\}\{\#3\}}{gregoriotex-spaces.tex}
 Macro to change one of Gregorio\TeX’s distances.  This function will check to make sure the distance you are trying to change exists first.
 
@@ -322,7 +311,7 @@ \subsubsection{Fine Tuning Dimensions}
 \end{argtable}
 
 \macroname{\textbackslash greloadspaceconf}{\{\#1\}}{gregoriotex-spaces.tex}
-Macro to load a space configuration file.  Space configuration file names have the format \verb=gsp-identifier.tex= and must be in the same directory as your project or in your texmf directory.
+Macro to load a space configuration file.  Space configuration file names have the format \verb=gsp-identifier.tex= and must be in the same directory as your project or in your texmf directory.  See \verb=gsp-sample.tex= for an example file.
 
 \begin{argtable}
   \#1 & string & The identifier of the space configuration file.

doc/Command_Index_internal.tex

@@ -2011,6 +2011,20 @@ \subsection{Protrusion factors}
 
 
 \subsection{Distances}
+
+\macroname{\textbackslash gre@createdim}{\{\#1\}\{\#2\}\{\#3\}}{gregoriotex-spaces.tex}
+Macro to create one of Gregorio\TeX’s distances.  Used to initialize distances in \textit{gsp-default.tex}.
+
+\begin{argtable}
+  \#1 & string & The name of the distance to be changed.  See \nameref{distances} below.\\
+  \#2 & string & The distance in string format.  \textbf{Note:} You cannot use a length register for this argument.  You \emph{must} use a string because of the way that Gregorio\TeX\ handles spaces.\\
+  \#3 & \texttt{fixed} & Distance will not scale when staff size is changed.\\
+  & \texttt{scalable} & Distance will scale when staff size is changed.\\
+  & \texttt{inherited} & Distance will inherit its value from another distance.  When this argument is used, then \#2 should be the name of another Gregorio\TeX\ distance.
+\end{argtable}
+
+
+
 All of the distances listed in \nameref{distances} have an internal associated
 with them, of the form of \verb=\gre@space@*@*=, which stores the value of the
 distance (in string representation).  The first wildcard is either

doc/Makefile.am

@@ -19,7 +19,7 @@
 SRCFILES = GregorioRef.tex Command_Index_gregorio.tex \
 		   Command_Index_internal.tex Command_Index_User.tex \
 		   Gabc.tex Appendix_Font_Tables.tex GregorioRef.lua factus.gabc \
-		   pitches2.gabc pitches3.gabc pitches4.gabc pitches5.gabc
+		   pitches2.gabc pitches3.gabc pitches4.gabc pitches5.gabc gsp-sample.tex
 NABCSRCFILES = GregorioNabcRef.tex veni.gabc omnes.gabc
 
 GREGORIO=gregorio-$(FILENAME_VERSION)