lingtex.sty

\RequirePackage{expl3}
\ExplSyntaxOn

\ProvidesExplPackage
{lingtex}  % package name
{2023-09-22}  % release date
{0.1}  % release version
{Linguistics~meta-package}  % description

\keys_define:nn { lingtex }
{
	% Should TIPA be loaded?
	tipa .bool_set:N = \l__lingtex_tipa_bool,
	tipa .initial:n = true,

	% Which font should be used?
	font .tl_set:N = \l__lingtex_font_tl,
	font .initial:n = times,

	% Which package should be used for OT tableaux?
	tableaux .tl_set:N = \l__lingtex_tableaux_tl,
	tableaux .initial:n = ,

	% Which package should be used for trees?
	trees .tl_set:N = \l__lingtex_trees_tl,
	trees .initial:n = ,

	% Which package should be used for examples?
	examples .tl_set:N = \l__lingtex_examples_tl,
	examples .initial:n = ,

	% Should Biblatex be loaded?
	biblatex .bool_set:N = \l__lingtex_biblatex_bool,
	biblatex .initial:n = false,
}
\ProcessKeyOptions [ lingtex ]

% Packages
\RequirePackage[fleqn]{amsmath}
\RequirePackage{amssymb}
\RequirePackage{booktabs}
\RequirePackage{enumitem}
\RequirePackage[pass]{geometry}
\RequirePackage{hyperref}
\RequirePackage{cleveref}  % LoadAfter: hyperref
\RequirePackage{iftex}
\RequirePackage{leipzig}
\RequirePackage{microtype}
\RequirePackage{setspace}
\RequirePackage{stmaryrd}
\RequirePackage{tabularx}
\RequirePackage[table, dvipsnames]{xcolor}

\ifPDFTeX
	\RequirePackage[T1]{fontenc}
	\RequirePackage[utf8]{inputenc}
\fi

% Itemize
\setitemize{itemsep=0pt}
\setlist[enumerate]{itemsep=0pt}

% Page Layout
\newgeometry{margin=1.2in}
\onehalfspacing

% gb4e redefines some commands which forest uses; 
% we have to load forest before gb4e
\str_case:VnF \l__lingtex_trees_tl {
{ forest } {
\RequirePackage{forest}
\useforestlibrary{linguistics}
\forestapplylibrarydefaults{linguistics}
% \ExplSyntaxOff
% TikZ synax uses spaces, while ExplSyntax will elide.
% Temporarily turn off ExplSyntax to set TikZ options.
\forestset{
nice~trees/.style={
for~tree={
parent~anchor=south,
child~anchor=north,
align=center,
base=top,
inner~sep=1pt,
l-=4ex,
before~typesetting~nodes={% based on nice empty nodes - page 52 of the manual, used in Jason Zentz's answer: http://tex.stackexchange.com/a/216103/
if~content={}{
for~parent={
for~children={anchor=north},
calign=fixed~edge~angles,
calign~angle=60,
},
shape=coordinate,
calign=fixed~edge~angles,
calign~angle=60,
}{},
},
},
},
somewhat~nice~trees/.style={% needed to avoide divide by 0 errors: http://tex.stackexchange.com/q/204094/42880
for~tree={
parent~anchor=south,
child~anchor=north,
align=center,
base=top,
inner~sep=1pt,
l-=4ex,
before~typesetting~nodes={% based on nice empty nodes - page 52 of the manual, used in Jason Zentz's answer: http://tex.stackexchange.com/a/216103/
if~content={}{
for~parent={
for~children={anchor=north},
calign=fixed~edge~angles,
calign~angle=60,
},
inner~sep=0pt,
edge~path={\noexpand\path~[\forestoption{edge}]~(!u.parent anchor)~--~(.south)\forestoption{edge~label};}, %from http://tex.stackexchange.com/a/281546
calign=fixed~edge~angles,
calign~angle=60,
}{},
},
},
}
}
\ExplSyntaxOff
% ExplSyntax will elide spaces, but TikZ syntax uses spaces for
% settings. Temporarily turn off ExplSyntax to set TikZ options.
\usetikzlibrary{
	bbox,
	calc,
	bending,
	arrows,
	arrows.meta,
	positioning,
}
\ExplSyntaxOn
\DeclareDocumentCommand \tikzexsetup {} {%
\tikzstyle{every~picture}+=[remember~picture, inner~sep=0pt,
baseline, anchor=base]}
% % arg 1: optional strut; arg 2: node name; arg 3: node content
\DeclareDocumentCommand \ND {s m m} {%
	\tikzifinpicture{}{\tikz}\node(#2){\IfBooleanTF{#1}{\strut}{}#3};}
\tikzset{exarrows/.style={semithick,  % fatter arrow for poster
arrows={-{Stealth[width=0.2em,length=0.2em]}}}}
\tikzset{
every~tree~node/.style={align=center,anchor=north},
level~distance=20pt,
sibling~distance=1.5\baselineskip,
>=stealth'}
}
{ qtree } { \RequirePackage{qtree} }
{ tikz-qtree } { \RequirePackage{tikz-qtree} }
{ pstrees } { \RequirePackage{pstrees} }
{} {}
}{
\PackageError{lingtex}{Unknown~trees~package~‘\l__lingtex_trees_tl’}{}
}

\str_case:VnF \l__lingtex_examples_tl {
	{ expex } {
			\RequirePackage{expex}
			\RequirePackage{epltxfn}
			% ExPex Formatting
			\lingset{%
				aboveexskip=1.25ex,
				belowexskip=1.5ex,
				glstyle=wrap,
				everyglpreamble={\itshape},
				belowglpreambleskip=-0.2ex,
				everygla={\itshape},
				aboveglftskip=-0.2ex,
				textoffset=\tabcolsep,
				interpartskip=0.5ex,
				glspace=!2pt plus .2em,
				glrightskip=0pt plus .5\hsize
			}
			\gathertags % Allow forward references with expex
		}
		{ gb4e } { \RequirePackage{gb4e} }
		{ linguex } { \RequirePackage{linguex} }
		{ covington } {
			\RequirePackage{covington}
			\def\cl@chapter{\@elt {section}}
		}
		{} {}
}{
	\PackageError{lingtex}{Unknown~examples~package~‘\l__lingtex_examples_tl’}{}
}

\bool_if:NT \l__lingtex_biblatex_bool {
	\RequirePackage[
		style=unified,  % S&P unified style
		maxcitenames=3,
		maxbibnames=99,
		backend=biber,
		natbib=true,
	]{biblatex}

	% Clean up bibliographies a bit.
	\AtBeginBibliography{\normalsize}
	\DeclareSourcemap{
		\maps[datatype=bibtex]{
			\map{
				\step[fieldsource=url, notmatch=\regexp{wiki}, final=1]
				\step[fieldset=urldate, null]  % Never show 'date accsessed'
			}
			\map{
				\step[fieldset=note, null]  % Never show 'note'
			}
		}
	}

	% Display eprints
	\renewbibmacro*{doi+eprint+url}{
		\printfield{doi}
		\newunit\newblock
		\iftoggle{bbx:eprint}{
			\usebibmacro{eprint}
		}{}%
		\newunit\newblock
		\iffieldundef{doi}{
			\usebibmacro{url+urldate}}
		{}
	}
}

% Load tableaux package
\str_case:VnF \l__lingtex_tableaux_tl {
	{ OTtablx } {
			\ifPDFTeX
				\msg_new:nnn { lingtex } { lingtex warning } { OTtablx~is~not~compatible~with~PDFLaTeX;~use~a~unicode-compatible~engine~instead,~or~switch~to~the~ot-tableau~option!}
				\msg_warning:nn { lingtex } { lingtex warning }
			\fi

			% OTTablx redefines \ipafont and \textipa, so we need to save
			% them and restore them after loading the package.
			\let\oldipafont\ipafont
			\let\ipafont\relax
			\let\oldtextipa\textipa
			\let\textipa\relax
			\RequirePackage[noipa]{OTtablx}
			\let\ipafont\oldipafont
			\bool_if:NT \l__lingtex_tipa_bool
			% It's a bad idea to use OTtablx with PDFTeX, but
			% if you insist, I'll fix the tipa-compatibility for you.
			{
				\ifPDFTeX\else
					\let\textipa\oldtextipa
				\fi
			}
		}
		{ ot-tableau } {
			\RequirePackage[notipa]{ot-tableau}
			\let\ipa\relax
		}
		{} {}
}{
	\PackageError{lingtex}{Unknown~tableaux~package~‘\l__lingtex_tableaux_tl’}{}
}

% Load fonts
% We need to load fonts after most of the packages since they
% may define IPA fonts that we want to override.
\ifPDFTeX
	\str_case:VnF \l__lingtex_font_tl {
		{ cochineal } {
            \RequirePackage{cochineal}
            \RequirePackage[varqu,varl,var0]{inconsolata}
            \RequirePackage[scale=.95,type1]{cabin}
            \RequirePackage[cochineal,vvarbb]{newtxmath}
            \RequirePackage[cal=boondoxo]{mathalfa}
        }
        { libertinus } { \RequirePackage{libertinus} }
        { lmodern } { \RequirePackage{lmodern} }
        { times } { \RequirePackage{mathptmx} }
        {} {}
	}{
		\PackageError{lingtex}{Unknown~font~‘\l__lingtex_font_tl’}{}
	}
	\bool_if:NTF \l__lingtex_tipa_bool
	{
		\RequirePackage{tipa}
		\let\ipafont\tipaencoding
	}
	{
		\msg_new:nnn { lingtex } { lingtex warning } { You~are~using~a~non~unicode~compatible~TeX~engine~but~you~haven't~loaded~tipa;~if~you~intend~on~using~IPA~symbols~you~should~load~tipa~or~switch~to~a~unicode~compatible~engine!}
		\msg_warning:nn { lingtex } { lingtex warning }
		\let\ipafont\rmfamily
	}
\else
	\bool_if:NT \l__lingtex_tipa_bool
	{
		\RequirePackage[
			preservefont,
		]{tipauni}
	}
	\str_case:Vn \l__lingtex_examples_tl {
		% expex / unicode-math fix
		% unicode-math redefines \gla at document start, we redefine it back
		{ expex } { \let\oldgla\gla }}
	\str_case:VnF \l__lingtex_font_tl {
        { cochineal } {
            % We need to load the non-otf cochineal fonts
            % via newtx in order to get \mathrm to use them.
            \usepackage[cochineal,vvarbb]{newtx}
            \usepackage[cal=boondoxo]{mathalfa}
            \usepackage{cochineal}
        }
		{ libertinus } {
            \RequirePackage[libertinus]{fontsetup}
            \let\ipafont\rmfamily
        }
        { lmodern } {
            % I have no idea why this is necessary, but for some reason
            % *only* the `default` option (loading New Computer Modern)
            % causes a conflict with `tipauni`.
            \let\oldtextipa\textipa
            \let\textipa\relax
            \RequirePackage[default]{fontsetup}
            \let\textipa\oldtextipa
            \let\ipafont\rmfamily
        }
        { times } {
            % \RequirePackage[times]{fontsetup}
            % \RequirePackage[nomath]{fontspec}
            \setmainfont{TeX Gyre Termes}
            \RequirePackage{unicode-math}
            \setmathfont{XITS Math}
            \newfontfamily\doulos{Doulos SIL}[Scale=MatchLowercase]
            \let\ipafont\doulos
        }
        {} {\let\ipafont\rmfamily}
	}{
		\PackageError{lingtex}{Unknown~font~‘\l__lingtex_font_tl’}{}
	}
	% \def\ipafontfont{\textipa\ipafont}
	\str_case:Vn \l__lingtex_examples_tl {
		{ expex } { \let\gla\oldgla }}
\fi

% Custom linguistics macros
\NewDocumentCommand \lex {om}
% For formatting lexical entires. If only a single argument is given,
% it is typeset in italics. If an optional argument is given,
% it is treated as the translated form and set in quotes after
% the lexical entry.
{
	\IfValueTF{#1}
	{\emph{#2}~`#1'}
	{\emph{#2}}
}
\NewDocumentCommand \ipa {m}
% For formatting IPA strings
{\text{\ipafont\textipa{#1}}}
\NewDocumentCommand \orth {m}
% For orthgraphic forms in <angle brackets>
{\ensuremath{\left\langle\text{#1}\right\rangle}}
\NewDocumentCommand \phon {m}
% For phonological forms in /slashes/
{\ensuremath{/\text{\ipa{#1}}/}}
\NewDocumentCommand \allo {m}
% For phonetic forms in [brackets]
{\ensuremath{[\text{\ipa{#1}}]}}
\NewDocumentCommand \den {m}
% For denotations in [[double brackets]]
{\ensuremath{\left\llbracket\text{#1}\right\rrbracket}}

% Use this macro to vertically align trees when using expex
\def\upp{\leavevmode\vadjust{\vspace{-\baselineskip}}\newline}


\ExplSyntaxOff