summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/covington/covington.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/covington/covington.tex')
-rw-r--r--macros/latex/contrib/covington/covington.tex63
1 files changed, 54 insertions, 9 deletions
diff --git a/macros/latex/contrib/covington/covington.tex b/macros/latex/contrib/covington/covington.tex
index 5b99e5a73c..585d38ff47 100644
--- a/macros/latex/contrib/covington/covington.tex
+++ b/macros/latex/contrib/covington/covington.tex
@@ -94,10 +94,10 @@
%
% Titling
%
-\def\pversion{Version 2.7}
-\def\pdate{September 1, 2021}
+\def\pversion{Version 2.8}
+\def\pdate{August 30, 2022}
-\title{\textbf{The \cvt\ Package\\Macros for Linguistics}}
+\title{\textbf{The \cvt\ Package\\\Large Macros for Linguistics}}
\author{Michael A. Covington \and J\"urgen Spitzm\"uller\thanks{Current maintainer.
Please report issues via \protect\url{https://github.com/jspitz/covington}}}
@@ -160,6 +160,16 @@ The package has the following options:
in the same paper, you get a single continuous series of numbers. While some people (including the original author of this package)
consider this a feature, others might prefer to number equations and linguistic examples separately. If you count to the latter sort,
use this option.
+
+\item{\joption{ownfncounter}:} Use a separate counter for numbered examples in footnotes.
+
+ By default, \cvt\ numbers examples in footnotes in sequence with the numbering used in the main text. With this option,
+ examples in footnotes get a different numbering. This uses by default roman numbering (see sec.~\ref{sec:custno} on how
+ to change this) and is incremented throughout the whole footnote apparatus.
+
+\item{\joption{ownfncounter*}:} Same as \joption{ownfncounter}, except that this variant resets the counter at each footnote
+ (similar to \textsf{linguex} and \textsf{gb4e}).
+
\end{description}
%
Please note the following package-related caveats:
@@ -270,6 +280,16 @@ This is a sentence.\label{expl}
\end{example}
The example can be of any length; it can consist of many lines (separated by \verb"\\"), or even whole paragraphs.
+The \jenv{example} environment provides the following option:
+
+\begin{description}
+ \item[\joption{preamble=\{\jparam{arbitrary text}\}}] Arbitrary text that is inserted on an own line
+ after the example number (preceding the actual example text). This might be useful, for instance,
+ to give context information, to specify the language or the source in case of cited examples.
+ The advantage over just adding a line manually in the example is that you can globally set the markup
+ (see sec.~\ref{sec:custno}).
+\end{description}
+%
If you need more space between the example number and the text, you can increase it by means of
the length \jcsmacro{examplenumbersep} (which is preset to \texttt{0pt}). Doing \lstinline|\setlength\examplenumbersep{1em}|,
for instance, will increase the space by 1\,em (negative values will decrease the space accordingly).
@@ -308,9 +328,9 @@ convenient for this task.
\subsection[The \texttt{examples} environment]{The \jenv{examples} environment}\label{sec:exs}
To display a series of examples together, each with its own example
-number, use \jenv{examples} (or \jenv{covexamples}) instead of \jenv{example} or \jenv{covexample}. The only
-difference is that there can be more than one example, and each of them
-has to be introduced by \jfcsmacro{item}, like this:
+number, use \jenv{examples} (or \jenv{covexamples}) instead of \jenv{example} or \jenv{covexample}.
+The only drawback is that there is no \joption{preamble} option. On the other hand, there can be more
+than one example with this environment, and each of them has to be introduced by \jfcsmacro{item}, like this:
\begin{lstlisting}
\begin{examples}
\item This is the first sentence.
@@ -329,6 +349,7 @@ This prints as:
\item This is the first sentence.
\item This is the second sentence.
\end{examples}
+%
As for \jenv{example}, \cvt\ checks if there is already an \jenv{examples} environment defined,
and if this is the case, \cvt\ does not define its own one. The alias environment \jenv{covexamples}
is always available as a fallback. If you use the package option \joption{force}, \cvt\ will override
@@ -431,7 +452,12 @@ You can change the display of the example number by redefining (via \jfcsmacro{r
\end{lstlisting}
%
with the variable \texttt{\#1} representing the number.
-
+If you use \joption{ownfncounter}, example numbers in footnote use this macro as well. If you want
+a different display, you can redefine
+\begin{lstlisting}[moretexcs={covexfnnumber}]
+\newcommand*\covexfnnumber[1]{\covennumber{#1}}
+\end{lstlisting}
+%
In the same vein, you can customize the display of the subexample letter by redefining
the macro \jcsmacro{covsubexnumber}, which has the following default definition:
\begin{lstlisting}[moretexcs={covsubexnumber}]
@@ -453,11 +479,22 @@ Note that this does, deliberately, not include the numbers, since those are cont
\jcsmacro{covexamplenofs}, which defaults to \jfcsmacro{normalfont}. Of course you are free to redefine this as well,
if you wish do to so.
-Finally, you can customize the markup of the sub-example preamble text by redefining the macro
-\jcsmacro{subexpreamblefs}, which also defaults to \jfcsmacro{normalfont}. To have it italicized, analogously do:
+Finally, you can customize the markup of the example and sub-example preamble text by redefining the macro
+\jcsmacro{expreamblefs} or \jcsmacro{subexpreamblefs}, which also both default to \jfcsmacro{normalfont}.
+To have them italicized, analogously do:
\begin{lstlisting}[moretexcs={\subexpreamblefs}]
\renewcommand*{\subexpreamblefs}{\itshape}
\end{lstlisting}
+or
+\begin{lstlisting}[moretexcs={\expreamblefs}]
+\renewcommand*{\expreamblefs}{\itshape}
+\end{lstlisting}
+%
+The separate footnote example number with \joption{ownfncounter} uses roman numbering by default.
+This can be changed by redefining
+\begin{lstlisting}[moretexcs={\thecovfnex}]
+\renewcommand{\thecovfnex}{\roman{covfnex}}
+\end{lstlisting}
\subsection{Referring to examples}\label{sec:ref}
@@ -1128,6 +1165,14 @@ it.
\section{Release history}
+\subsection*{2.8 (2022 August 30)}
+
+\begin{itemize}
+ \item Add \joption{ownfncounter} and \joption{ownfncounter*} options to allow for separate counting of examples
+ in footnotes. The starred option resets the counter at each footnote. See sec.~\ref{sec:intro}.
+ \item Add \joption{preamble} option to \jenv{example} environment. See sec.~\ref{expl}.
+\end{itemize}
+
\subsection*{2.7 (2021 September 1)}
\begin{itemize}