=========================================================================
The covington package

LaTeX macros for Linguistics

Copyright 1991--2025 Michael A. Covington
                     Robin Fairbairns
                     Juergen Spitzmueller

Current Maintainer: Juergen Spitzmueller
E-mail: juergen (at) spitzmueller (dot) org

Released under the LaTeX Project Public License v1.3 or later
See http://www.latex-project.org/lppl.txt
=========================================================================

== PURPOSE ==

This package, initially a collection of Michael Covington's private macros, provides
numerous minor LaTeX enhancements for linguistics, including multiple diacritics on
the same letter, interlinear glosses (word-by-word translations), Discourse
Representation Structures, and example numbering.

== CONTENTS ==

The package consists of the following files:

* covington.sty: the actual package
* covington.tex: the documentation
* README (this file)

== CHANGES ==

* Version 2.16 (2025 December 30):
	- Add subnumberrefsep option to subexamples environment.
	- Fix reference to subexample that is nested in an enumeration.

* Version 2.15 (2025 August 13):
	- Fix definition of covexercise if no chapters exist.
	- Enhance reflist documentation.

* Version 2.14 (2023 December 11)
	- Add \ownexcounterprep macro to add a prefix (e.g., the chapter)
	  to the (owncounter) example counter.
	- Document how to (not) number examples per chapter.

* Version 2.13 (2023-12-02)
	- Fix example numbering with chapters (#16).

* Version 2.12 (2023-06-25)
	- Fix issue with redefinitions of \glosslineone/\glosslinetwo/\glosslinethree,
	  which could get lost along the text (#13).

* Version 2.11 (2023-06-17)
	- Add support for judgment markers in examples and glosses.
	- Add support for customization of spacing between gloss lines.
	- Add support for gloss comment lines via optional arguments.
	- Add support for translation lines on the right side of glosses (via new tlr* option).

* Version 2.10 (2023-06-02)
	- Use LaTeX's own keyval mechanism rather than xkeyval.
	- Introduce a better interface to customize the appearance of examples. Now everything can
	  be easily adjusted globally and locally via key-val options. This entails the following changes:
	  * Allow to globally set example options via the new macro \setexampleoptions.
	  * Add way to customize example and subexample number format.
	  * Add new example options: fs, fsno, fspreamble, fspostamble, leftmargin, addnumbersep,
	    addsubnumbersep, numberformat, subnumberformat, and fnnumberformat.
	- Add new gloss options: fspreamble, fspostamble, fstl, and enquotetl.
	  This allows for full customization of glosses via options,  both locally and globally.
	- Package options now all have a key-value format as well.
	- Introduce new package choice-option fnexamplecounter that supersedes the two boolean,
	  mutually exclusive options ownfncounter and ownfncounter* (which are still supported
	  for backwards compatibility reasons).
	- Major documentation revisions.

* Version 2.9 (2023-05-26):
	- Add postamble and postamble* options to example and subexamples environment.
	- Add \expreamble, \subexpreamble, \expostamble and \subexpostamble macros.
	- Some documentation fixes.

* Version 2.8 (2022-08-30):
        - Add ownfncounter and ownfncounter* options to allow for separate counting
          of examples in footnotes. The starred option resets the counter at each footnote.
        - Add preamble option to example environment.

* Version 2.7 (2021-09-01):
        - Add postamble gloss macro option for arbitrary text that is appended to the free
          translation line (after closing quotation marks).
        - Add glosslinepostamble command to markup this text.

* Version 2.6 (2021-05-19):
        - New length \exampleind to adjust (increase/decrease) the indentation (left margin)
          of examples.

* Version 2.5 (2021-03-21):
	- Fix metrics of stacked diacritics with XeTeX/LuaTeX.

* Version 2.4 (2020-01-02):
	- Fix definition of covexercise if no subsection counter exists.

* Version 2.3 (2019-06-21):
	- Add preamble option to subexamples environment.
	- Allow to use covington together with the drs package.
	- Documentation fixes and restructuring.

* Version 2.2 (2019-06-04):
	- Add new option owncounter that makes covington use an own counter for examples
	  (rather than the equation counter).
	- Add starred \exampleno* command that outputs the current example number value
	  without stepping it.
	- Add macros \covexamplefs and \covexamplenofs for global setting of example text
	  markup.

* Version 2.1 (2019-05-12):
	- Add new option noglossbreaks that tries to prevent page breaks within glosses.
	- Add \glosspreamble command and preamble gloss macro option for arbitrary text
	  preceding glosses.

* Version 2.0 (2018-12-10):
	- Add new gloss macros (\digloss and \trigloss) for a more convenient,
	  flexible and robust gloss insertion.
	- Add \glot command for customizable gloss translation line,
	  together with customization possibilities.
	- Add possibility to customize \sentence font setting.
	- Add \lexp, \lcon and \lmean markup macros.

* Version 1.8 (2018-12-07):

	- Fix font markup of second gloss line (do not force rm).
	- Add possibility to customize gloss line font setting.
	- Add possibility to customize example number display.

* Version 1.7 (2018-09-08):

	- Fix alignment in subexamples.
	- Improve manual.

* Version 1.6 (2018-09-07):

	- Introduce new environment subexamples for sub-examples such as 1a.
	- Introduce new command \pxref that outputs references to examples including
          parentheses.

* Version 1.5 (2018-08-24):

	- Introduce new option "keeplayout" that allows to opt-out the
	  layout presettings covington does (\raggedbottom, \textfloatsep).

* Version 1.4 (2017-05-23):

	- Introduce a new macro \twodias that supersedes the rather odd \twoacc
	  (which is kept for backwards compatibility).

	- Introduce macro \SetDiaOffset for more convenient setting of vertical
	  distance in stacked diacritics.

	- LaTeX 2.09 is no longer officially supported (it might continue to work,
	  but is not tested).

	- Documentation file converted to un*x line endings.

* Version 1.3 (2017-04-05):

        - Gloss variants \xgll and \xglll that work inside macros (such as footnotes)
          but require explicit gloss line end markers (\xgle).

	- Provide way to globally alter indentation and vertical distance of reflists
          (new lengths \reflistindent, \reflistparsep and \reflistitemsep).

* Version 1.2 (2016-08-26):

	- New length \examplenumbersep to adjust (increase) the horizontal space
	  between example number and example text.
	
	- Add some more info about bibliography generation.

* Version 1.1a (2016-07-07):

	- Fix encoding problem in documentation and some typos. No change in functionality.

* Version 1.1 (2016-07-06):

	- The package now uses NFSS font commands if available (fallback for LaTeX 2.09
	  is still provided).

	- Work around clash with classes/packages that define their own example and
	  examples environments (most notably the beamer class) as well as execise
	  environments. The covington package no longer blindly attempts to define
	  these environments. By default, it does not define them if they are already
	  defined (covington's own environments, however, are still available via aliases).
	  By means of a new package option, a redefinition can also be forced.

	- New length \twoaccsep allows for the adjustment of the distance between stacked
	  accents.

	- Update manual.

	- New maintainer: J. Spitzmueller.

	- License has been changed to LPPL (in agreement with M. Covington).

	- Introduce version numbers. Arbitrarily, we start with 1.1.
