Skip to content

Commit

Permalink
Documentation update
Browse files Browse the repository at this point in the history
Found a few things documented which had been removed (and removed them from the documentation).
Added a few things which were not previously documented.
  • Loading branch information
rpspringuel committed Jan 22, 2016
1 parent e3562f3 commit aa5ba8b
Show file tree
Hide file tree
Showing 3 changed files with 77 additions and 16 deletions.
18 changes: 18 additions & 0 deletions doc/Command_Index_User.tex
Original file line number Diff line number Diff line change
Expand Up @@ -612,6 +612,24 @@ \subsubsection{Glyph Alteration}
\#5 & dimension & vertical shift of the bar glyph.\\
\end{argtable}

\macroname{\textbackslash gothRbar}{}{gregoriotex-symbols.tex}
Prints \gothRbar. Defined with \verb=\gredefsymbol=.

\macroname{\textbackslash gothVbar}{}{gregoriotex-symbols.tex}
Prints \gothVbar. Defined with \verb=\gredefsymbol=.

\macroname{\textbackslash grealtcross}{}{gregoriotex-symbols.tex}
Prints \grealtcross. Defined with \verb=\gredefsymbol=.

\macroname{\textbackslash grecross}{}{gregoriotex-symbols.tex}
Prints \grecross. Defined with \verb=\gredefsymbol=.

\macroname{\textbackslash greheightstar}{}{gregoriotex-symbols.tex}
Prints \greheightstar. Defined with \verb=\gredefsymbol=.

\macroname{\textbackslash gresixstar}{}{gregoriotex-symbols.tex}
Prints \gresixstar. Defined with \verb=\gredefsymbol=.

\macroname{\textbackslash greseparator}{\{\#1\}\{\#2\}}{gregoriotex-symbols.tex}
A macro for invoking one of the five separators (fancy lines) which are contained in the greextra font.

Expand Down
11 changes: 8 additions & 3 deletions doc/Command_Index_gregorio.tex
Original file line number Diff line number Diff line change
Expand Up @@ -751,9 +751,6 @@ \section{Gregorio Controls}
\#4 & \TeX\ code & Macros rendering the first syllable; should emit the initial and populate \verb=\gre@opening@syllabletext=.\\
\end{argtable}

\macroname{\textbackslash GreScoreReference}{\#1}{gregoriotex-main.tex}
Currently does nothing.

\macroname{\textbackslash GreSemicirculus}{\#1\#2}{gregoriotex-signs.tex}
Macro for typesetting a semicirculus.

Expand Down Expand Up @@ -1059,6 +1056,14 @@ \section{Gregorio Controls}
\#1 & integer & the number of \texttt{nabc} lines (currently only 1 is supported)\\
\end{argtable}


\macroname{\textbackslash GreModeNumber}{\#1}{gregoriotex-main.tex}
Macro which formats the mode in roman or arabic numerals according to the appropriate setting.

\begin{argtable}
\#1 & \texttt{1}--\texttt{8} & The mode to be formated\\
\end{argtable}

%%% Local Variables:
%%% mode: latex
%%% TeX-master: "GregorioRef"
Expand Down
64 changes: 51 additions & 13 deletions doc/Command_Index_internal.tex
Original file line number Diff line number Diff line change
Expand Up @@ -416,18 +416,10 @@ \section{Gregorio\TeX{} Controls}
\#7 & string & the line, byte offset, and column address for textedit links when point-and-click is enabled\\
\end{argtable}
\macroname{\textbackslash gre@calculate@clefnum}{\#1\#2}{gregoriotex-signs.tex}
Macro calculating the \verb=\gre@clefnum= from the letter and number.
\begin{argtable}
\#1 & charcter & type of clef (\texttt{c} or \texttt{f})\\
\#2 & integer & line number\\
\end{argtable}
\macroname{\textbackslash gre@clef}{}{gregoriotex-signs.tex}
Macro holding the current clef type.
\macroname{\textbackslash gre@clefline}{}{gregoriotex-signs.tex}
\macroname{\textbackslash gre@clefheight}{}{gregoriotex-signs.tex}
Macro holding the current clef line.
\macroname{\textbackslash gre@clefflatheight}{}{gregoriotex-signs.tex}
Expand All @@ -436,7 +428,7 @@ \section{Gregorio\TeX{} Controls}
\macroname{\textbackslash gre@cleftwo}{}{gregoriotex-signs.tex}
Macro holding the current secondary clef type.
\macroname{\textbackslash gre@cleftwoline}{}{gregoriotex-signs.tex}
\macroname{\textbackslash gre@cleftwoheight}{}{gregoriotex-signs.tex}
Macro holding the current secondary clef line (or 0 for no secondary clef).
\macroname{\textbackslash gre@cleftwoflatheight}{}{gregoriotex-signs.tex}
Expand Down Expand Up @@ -515,9 +507,6 @@ \section{Gregorio\TeX{} Controls}
\macroname{\textbackslash gre@opening@syllabletext}{}{gregoriotex-syllable.tex}
Macro that stores the computed \TeX\ code for rendering the text of the first syllable.
\macroname{\textbackslash gre@opening@initialstyle}{}{gregoriotex-syllable.tex}
Macro used by \verb=GreSetInitialStyle= to store the initial style
\macroname{\textbackslash gre@exhyphencharsave}{}{gregoriotex-main.tex}
Macro for saving the ex hyphen character so that it can be restored at the end of the score.
Expand Down Expand Up @@ -1089,6 +1078,47 @@ \section{Gregorio\TeX{} Controls}
\#1 & integer & The number to typeset\\
\end{argtable}
\macroname{\textbackslash gre@bar@text}{\#1}{gregoriotex-symbols.tex}
Macro used to switch between spacings where bar has text and those where it doesn't.
\begin{argtable}
\#1 & \texttt{0} & emits nothing\\
& \texttt{1} emits \texttt{text}\\
\end{argtable}
\macroname{\textbackslash gre@drawadditionalline}{\#1\#2\#3\#4\#5\#6}{gregoriotex-signs.tex}
Workhorse function behind \verb=\GreDrawAdditionalLine=.
\begin{argtable}
\#1 & \texttt{0} & Draw an over-the-staff ledger line. \\
& \texttt{1} & Draw an under-the-staff ledger line. \\
\#2 & distance & The length of the line, with TeX units, excluding any left or right distances coming from the rest of the arguments. \\
\#3 & \texttt{0} & Start the line at this point. \\
& \texttt{1} & Start the line to the left of this point by \verb=gre@dimen@additionallineswidth=. \\
& \texttt{2} & Start the line to the left of this point by \#4. \\
\#4 & distance & The distance to move left before starting the line if \#3 is \texttt{2}. \\
\#5 & \texttt{0} & End the line exactly \#2 to the right of this point. \\
& \texttt{1} & End the line \verb=gre@dimen@additionallineswidth= to the right of \#2 from this point. \\
& \texttt{2} & End the line \#6 to the right of \#2 from this point. \\
\#6 & distance & The distance to end the line after \#2 from this point if \#3 is \texttt{2}. \\
\end{argtable}
\macroname{\textbackslash gre@kern@bar@aftermora}{}{gregoriotex-signs.tex}
Macro which kerns between a punctum mora and a kern according to the setting in \verb=\gre@count@barshiftaftermora=.
\macroname{\textbackslash gre@setgregoriofontscaled}{[\#1]\#2\#3}{gregoriotex-main.tex}
Workhorse behind \verb=\gresetgregoriofontscaled=.
\begin{argtable}
\#1 & \textit{(omitted)} & Use the normal font and rule set.\\
& \texttt{op} & Use the alternate Dominican font/rule set.\\
\#2 & \texttt{greciliae} & Use the Greciliae font (default).\\
& \texttt{gregorio} & Use the Gregorio font.\\
& \texttt{parmesan} & Use the Parmesan font.\\
\#3 & integer & the scaling factor\\
\end{argtable}
\subsection{Auxiliary File}
Gregorio\TeX\ creates its own auxiliary file (extension \texttt{gaux}) which it uses to store information between successive typesetting runs. This allows for such features as the dynamic interline spacing. The following functions are used to interact with that auxiliary file.
Expand Down Expand Up @@ -1124,6 +1154,9 @@ \subsection{Fonts}
\macroname{\textbackslash gre@font@initial}{}{gregoriotex.tex}
The font for the default initial format in Plain \TeX.
\macroname{\textbackslash gre@fontfactor@...}{}{gregoriotex-main.tex}
Macro holding the factor at which the font is loaded. There is one of these macros for each chant font which has been loaded with the ending of the macro name being the name of the chant font (gregorio, parmesan, \etc).
\subsection{Character Reference Aliases}
To make referencing and changing them easier, Gregorio\TeX\ stores reference information for certain characters using the following macros.
Expand Down Expand Up @@ -1424,6 +1457,11 @@ \subsection{Flags}
\macroname{\textbackslash ifgre@haslinefive}{}{gregoriotex-spaces.tex}
Boolean indicating whether the staff has a fifth line.
\macroname{\textbackslash gre@count@barshiftaftermora}{}{gregoriotex-signs.tex}
Count indicating when the presence of a punctum mora immediately before a bar line should affect the spacing.
\macroname{\textbackslash ifgre@allowdeprecated}{}{gregoriotex.sty \textup{and} gregoriotex.tex}
Boolean which controls whether deprecated functions raise a warning (true) or an error (false).
\subsection{Boxes}
Expand Down

0 comments on commit aa5ba8b

Please sign in to comment.