summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/langsci-avm
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2023-02-22 03:01:37 +0000
committerNorbert Preining <norbert@preining.info>2023-02-22 03:01:37 +0000
commit470678475288a244fd8a9af69f9abc9b46b2860f (patch)
treeb39e9f327aaf2a4b10bada3897e374878369fccc /macros/latex/contrib/langsci-avm
parentb05164a5b679570a7040f2b28bbf156a0479c429 (diff)
CTAN sync 202302220301
Diffstat (limited to 'macros/latex/contrib/langsci-avm')
-rw-r--r--macros/latex/contrib/langsci-avm/README23
-rw-r--r--macros/latex/contrib/langsci-avm/langsci-avm.dtx894
-rw-r--r--macros/latex/contrib/langsci-avm/langsci-avm.ins23
-rw-r--r--macros/latex/contrib/langsci-avm/langsci-avm.pdfbin114198 -> 160240 bytes
4 files changed, 621 insertions, 319 deletions
diff --git a/macros/latex/contrib/langsci-avm/README b/macros/latex/contrib/langsci-avm/README
index 80c60efd2c..e884844e03 100644
--- a/macros/latex/contrib/langsci-avm/README
+++ b/macros/latex/contrib/langsci-avm/README
@@ -1,20 +1,15 @@
-langsci-avm is aimed at typesetting beautiful feature structures,
-also known as attribute-value matrices (AVMs), for use in linguistics.
+A package for typesetting feature structures, also known as attribute-value
+matrices (AVMs), for use in linguistics.
-The package provides a minimal and easy to read syntax.
-It depends only on the array package and can be placed almost everywhere,
-in particular in footnotes or graphs and tree structures. The package is meant
-as an update to, and serves the same purpose as, Christopher Manning’s
-avm package, but shares no code base with that package.
+The package provides a minimal and easy to read syntax. It depends only on the
+array package and can be placed almost everywhere, in particular in footnotes or
+graphs and tree structures. The package serves the same purpose as, Christopher
+Manning’s avm package, but shares no code base with that package.
-langsci-avm was developed at Language Science Press to help in the
-production of scientific texts in linguistics.
+Copyright (C) 2023 by Felix Kopecky, Language Science Press
-Copyright (C) 2020 by Felix Kopecky, Language Science Press
-
-This work consists of the file langsci-avm.dtx
- and the derived files langsci-avm.ins,
- langsci-avm.pdf.
+This work consists of the file langsci-avm.dtx
+ and the derived file langsci-avm.pdf.
It may be distributed and/or modified under the conditions of the
LaTeX Project Public License (LPPL), either version 1.3c of this
diff --git a/macros/latex/contrib/langsci-avm/langsci-avm.dtx b/macros/latex/contrib/langsci-avm/langsci-avm.dtx
index 72346d4f51..06ca884a80 100644
--- a/macros/latex/contrib/langsci-avm/langsci-avm.dtx
+++ b/macros/latex/contrib/langsci-avm/langsci-avm.dtx
@@ -11,23 +11,18 @@
\preamble
------------------------------------------------------------------------------
-langsci-avm is aimed at typesetting beautiful feature structures,
-also known as attribute-value matrices (AVMs), for use in linguistics.
+A package for typesetting feature structures, also known as attribute-value
+matrices (AVMs), for use in linguistics.
-The package provides a minimal and easy to read syntax.
-It depends only on the array package and can be placed almost everywhere,
-in particular in footnotes or graphs and tree structures. The package is meant
-as an update to, and serves the same purpose as, Christopher Manning’s
-avm package, but shares no code base with that package.
+The package provides a minimal and easy to read syntax. It depends only on the
+array package and can be placed almost everywhere, in particular in footnotes or
+graphs and tree structures. The package serves the same purpose as, Christopher
+Manning’s avm package, but shares no code base with that package.
-langsci-avm was developed at Language Science Press to help in the
-production of scientific texts in linguistics.
+Copyright (C) 2023 by Felix Kopecky, Language Science Press
-Copyright (C) 2020 by Felix Kopecky, Language Science Press
-
-This work consists of the file langsci-avm.dtx
- and the derived files langsci-avm.ins,
- langsci-avm.pdf.
+This work consists of the file langsci-avm.dtx
+ and the derived file langsci-avm.pdf.
It may be distributed and/or modified under the conditions of the
LaTeX Project Public License (LPPL), either version 1.3c of this
@@ -71,7 +66,9 @@ Please report any bugs or feature requests to
%<*driver>
\documentclass{l3doc}
\usepackage[linguistics]{forest}
-\usepackage{langsci-avm,enumitem,url,gb4e}
+\usepackage[lfg,tikz]{langsci-avm}
+\usetikzlibrary{arrows, arrows.meta}
+\usepackage{enumitem,url,gb4e,xltxtra}
\setlist[description]{font=\normalfont}
\begin{document}
\DocInput{\jobname.dtx}
@@ -83,15 +80,15 @@ Please report any bugs or feature requests to
% Please submit bug reports and feature requests to
% \protect\url{https://github.com/langsci/langsci-avm/issues}.
% }}
-% \date{Version 0.2.1 -- 15th July 2020}
+% \date{Version 0.3.0 -- \today}
% \maketitle
% \frenchspacing
% \begin{documentation}
% \section{Introduction}
-% \pkg{langsci-avm} is a \LaTeX3 package aimed at typesetting beautiful feature structures, also known as \emph{attribute-value matrices}, for use in linguistics. The package provides a minimal and easy to read syntax. It depends only on the \pkg{array} package and can be placed almost everywhere, in particular in footnotes or graphs and tree structures. The package is meant as an update to, and serves the same purpose as, Christopher Manning's \pkg{avm} package, but shares no code base with that package. When you come from \pkg{avm}, please see Section~\ref{sec:switching} for a quick conversion guide.
+% \pkg{langsci-avm} allows typesetting of feature structures, or \emph{attribute-value matrices} (AVM), for use in linguistics. The package provides a minimal and easy to read syntax. The package serves the same purpose as Christopher Manning's \pkg{avm} package, but shares no code base with that package. There is a conversion guide in Section~\ref{sec:switching}.
%
% To start using \pkg{langsci-avm}, place |\usepackage{langsci-avm}| in your preamble.\\\\
-% \emph{This document is structured as follows:} Section~\ref{sec:basiccommands} describes the input syntax for AVMs and their parts. Ways to customise your AVM's layout follow in Section~\ref{sec:options}, and selected usage cases are presented in Section~\ref{sec:applications}. There's also an administrative and \TeX nical appendix at the end of this document, in case you are interested.
+% \emph{This documentation is structured as follows:} Section~\ref{sec:basiccommands} describes the input syntax for AVMs and their parts. Ways to customise your AVM's layout follow in Section~\ref{sec:options}, and selected usage cases are presented in Section~\ref{sec:applications}. There's also an administrative and \TeX nical appendix at the end of this document, in case you are interested.
%
% \subsection{Example}
% \begin{verbatim}
@@ -119,7 +116,7 @@ Please report any bugs or feature requests to
% \begin{syntax}
% \cs{avm} \oarg{options} \marg{structure}
% \end{syntax}
-% The heart of this package and its root document comand is |\avm|. In the scope of the command, delimiter characters are processed to open and close (sub-)structures, as described in Section~\ref{sec:commands}. Special elements are described in Section~\ref{sec:specialcommands}. For a description of the layout \meta{options}, see Section~\ref{sec:options}.
+% This root command of the package type sets AVMs in the documen. In the \marg{structure}, delimiter characters are processed to open and close (sub-)structures, as described in Section~\ref{sec:commands}. Special elements (e.g. tags, operators, type descriptors) are described in Section~\ref{sec:specialcommands}. For a description of the layout \meta{options}, see Section~\ref{sec:options}.
%
% A \meta{structure} is basically the content of a stylised \cmd{tabular}: The columns are separated by \cmd{&} and a new line is entered with \cmd{\\}.
% \end{function}
@@ -127,42 +124,74 @@ Please report any bugs or feature requests to
% \subsection{Entering (sub-)structures within \texttt{\textbackslash avm}}
% \label{sec:commands}
%
-% \begin{function}{[...],<...>,(...),\{...\}}
+% \begin{function}[updated=2020-10-02]{[...],<...>,(...),\{...\},\[...\]}
% \begin{syntax}
% \cmd{[} \meta{structure} \cmd{]}
% \cmd{<} \meta{structure} \cmd{>}
% \cmd{(} \meta{structure} \cmd{)}
% \cmd{\{} \meta{structure} \cmd{\}}
+% \cmd{\[} \meta{structure} \cmd{\]}
% \end{syntax}
% Within the scope of \cs{avm}, these delimiters create (sub-)structures that are enclosed by the respective delimiter. Due to the special meaning that curly braces have in \LaTeX, these are the only ones that need to be run with an escape token (|\|). It is currently possible to mix delimiters, e.g. with |<|\meta{structure}|)|, but this may change in future versions.
%
-% \pkg{langsci-avm} expects your (sub-)structures to have \emph{at most two columns}, so that for every line in each (sub-)structure, there should be no more than one \cmd{&}. It is recommended to have at least some lines with a \cmd{&} in your \meta{structure}. Currently, display issues may appear in some structures if none are given.\bigskip\\
+% \pkg{langsci-avm} expects your (sub-)structures to have \emph{at most two columns}, so that for every line in each (sub-)structure, there should be no more than one \cmd{&}. It is recommended to have at least some lines with a \cmd{&} in your \meta{structure}. Currently, display issues may appear in some structures if none are given -- see the |align=false| option to remedy this effect.\bigskip\\
% \noindent\begin{minipage}[c]{.5\linewidth}
% \begin{verbatim}
% \avm{
-% [ < ( \{ ... \} ) > ]
+% [ < ( \{ ... \} ) > ]
% }
% \end{verbatim}
% \end{minipage}\begin{minipage}[c]{.5\linewidth}
% \avm{
-% [ < ( \{ ... \} ) > ]
+% [ < ( \{ ... \} ) > ]
% }
% \end{minipage}\bigskip\\
% \noindent\begin{minipage}[c]{.5\linewidth}
% \begin{verbatim}
% \avm{
-% [ \{ ... \} \\
-% < ( ... ), ( ... ) > ]
+% [ \{ ... \} \\
+% < ( ... ), ( ... ) > ]
% }
% \end{verbatim}
% \end{minipage}\begin{minipage}[c]{.5\linewidth}
% \avm{
-% [ \{ ... \} \\
-% < ( ... ), ( ... ) > ]
+% [ \{ ... \} \\
+% < ( ... ), ( ... ) > ]
% }
% \end{minipage}
% \end{function}
%
+% \begin{function}[added=2020-10-02]{\[ ... \]}
+% \begin{syntax} \cmd{\[} \meta{structure} \cmd{\]} \end{syntax}
+% Add a semantic bracket \avm[attributes=\normalfont]{\[ \meta{structure} \]}.\smallskip\\
+% \emph{Warning:} Semantic brackets are only available when the package option |[lfg]| is loaded (|\usepackage[lfg]{langsci-avm}|). Documents with this option can only be compiled with \XeLaTeX{}. If the |[lfg]| option is not present, \cmd{\[} \marg{structure} \cmd{\]} will result in none delimiter output, but the \marg{structure} will be printed nonetheless. (The semantic delimiters are not available in every font, and are currently not provided in standard \LaTeX\ documents. If you load the |[lfg]| option but do not provide the symbol (e.g. by using a font such as \pkg{libertinus}), the package \pkg{unicode-math} will automatically be loaded to provide the symbol.)
+% \end{function}
+%
+% \begin{function}[added=2021-03-03]{\lframe ... \rframe}
+% \begin{syntax}
+% \cmd{\lframe} \meta{structure} \cmd{\rframe}
+% \end{syntax}
+% Delimit a \meta{structure} placed in a rectangular box, which is used in Fillmore \& Kay's notation. It can be used like the other delimiters.\bigskip\\
+% \noindent\begin{minipage}[c]{.5\linewidth}
+% \begin{verbatim}
+% \avm{
+% \lframe ... \rframe
+% }
+% \end{verbatim}
+% \end{minipage}\begin{minipage}[c]{.5\linewidth}
+% \avm{
+% \lframe ... \rframe
+% }
+% \end{minipage}
+%
+% The parameters of the frame can be adjusted with these options:
+% \begin{description}[style=nextline]
+% \item[|framewidth =| \meta{length} \hfill (initially |1pt|)] Width of the frame.
+% \item[|framesep =| \meta{length} \hfill (initially |3pt|)] Separation of the frame and its contents.
+% \end{description}
+%
+% \end{function}
+%
% \begin{function}{!...!}
% \begin{syntax}
% \cmd{!} \meta{text} \cmd{!}
@@ -196,7 +225,7 @@ Please report any bugs or feature requests to
% \begin{syntax}
% \cs{type}\meta{*} \marg{type}
% \end{syntax}
-% Will output the \meta{type} in the |types| font (roman italics by default). The starred variant \cs{type*} will span the complete (sub-)structure and \emph{can only be placed in the first column} of this structure. After the starred \cs{type*}, a |\\| is recommended, but can usually be omitted.\bigskip\\
+% Will output the \meta{type} in the |types| font (serif italics by default). The starred variant \cs{type*} will span the complete (sub-)structure and \emph{can only be placed in the first column} of this structure. After the starred \cs{type*}, a |\\| is recommended, but can usually be omitted.\bigskip\\
% \noindent\begin{minipage}{.6\linewidth}
% \begin{verbatim}
% \avm{[ \type*{A type spanning a line}
@@ -210,20 +239,41 @@ Please report any bugs or feature requests to
% \end{minipage}
% \end{function}
%
-% \begin{function}{\punk}
+% \begin{function}[added=2020-10-02,updated=2021-12-14]{\id}
+% \begin{syntax}
+% \cs{id} \marg{id} \marg{structure}
+% \end{syntax}
+% A variant of \cs{substack} from \pkg{amsmath}, this command adds an identifier to the \marg{structure}. The contents of \marg{id} will be set in math mode by default, which is convenient given that they often contain variables with subscript indices. Multiple IDs should be separated by a new line, |\\|.\\
+% \noindent\begin{minipage}{.75\linewidth}
+% \begin{verbatim}
+% \avm{\id{n_1\\n_2}{[subj\\pred&swim]}}
+% \end{verbatim}
+% \end{minipage}\begin{minipage}{.25\linewidth}
+% \avm{\id{n_1\\n_2}{[subj\\pred&swim]}}
+% \end{minipage}\smallskip\\
+%
+% The position of the \marg{id} column relative to the \marg{structure} and the alignment within the \marg{id} column can be changed:
+%
+% \begin{description}[style=nextline]
+% \item[|id align =| \meta{token} \hfill (initially |l|)] Change the alignment of the column inserted by \cs{id}. Has to be a column specification. The most probable choices are \cmd{l} and \cmd{r}.
+% \item[|id position =| \meta{option} \hfill (initially |south-west|)] Change the position of \cs{id}. In the standard setting |south-west|, the \cs{id} is placed in the lower left corner of the enclosed structure. When set to |south-east|, the contents are set to the lower right corner. Currently, only |south-west| and |south-east| are recognised inputs, and an error is raised when an unknown option is input.
+% \end{description}
+% \end{function}
+%
+% \begin{function}[updated=2021-06-08]{\punk}
% \begin{syntax}
% \cs{punk} \marg{attribute}\marg{type}
% \end{syntax}
% Some \meta{attributes} think that the layout of the other attributes in their community leaves no space for them to express their individuality. They desire a life outside the confines of the alignment defined by the others, while still remaining a member of the matrix.
%
-% Technically, this is a line with no snapping to the column layout, but with spacing between the \meta{attribute} and \meta{type}. After \cs{punk}, a |\\| is recommended, but can be omitted in ``normal'' cases.\bigskip\\
+% Technically, this is a line with no snapping to the column layout, but with spacing between the \meta{attribute} and \meta{type}. After \cs{punk}, a |\\| is obligatory if not in the last line.\bigskip\\
% \noindent\begin{minipage}{.6\linewidth}
% \begin{verbatim}
% \avm{[ attr1 & val1\\
-% \punk{a quite long attr2}{val2} ]}
+% \punk{a quite long attr2}{val2}
% attr3 & val3\\
% attr4 & val4
-% ]}
+% ]}
% \end{verbatim}
% \end{minipage}\begin{minipage}{.4\linewidth}
% \avm{[
@@ -232,7 +282,8 @@ Please report any bugs or feature requests to
% attr3 & val3\\
% attr4 & val4
% ]}
-% \end{minipage}
+% \end{minipage}\bigskip\\
+% \emph{Hint:} Also have a look at the option |align=false|.
% \end{function}
%
% \begin{function}[updated=2020-03-16]{\+}
@@ -240,7 +291,7 @@ Please report any bugs or feature requests to
% \end{function}
%
% \begin{function}[added=2020-03-17]{\-}
-% In the scope of \cs{avm}, \cs{-} comes out as ``$\ominus$''. To use the ``optional hyphenation'' meaning of \cs{-}, please write |!\-!|.
+% In the scope of \cs{avm}, \cs{-} comes out as ``$\ominus$''. To use the ``optional hyphenation'' meaning of \cs{-}, please write |!\-!|, where |!| is your current |switch| token.
% \end{function}
%
% \begin{function}[added=2020-03-17]{\shuffle}
@@ -251,13 +302,13 @@ Please report any bugs or feature requests to
%
% \subsection{Defining styles}
%
-% You can customise many aspects of how an AVM is printed, including the fonts or spacing between delimiters and content. You can apply them locally via the \oarg{options} of \cs{avm} or by using \cs{avmsetup}. And you can also define your own styles and use them via the \oarg{style = } option in \cs{avm}.
+% You can customise many aspects of how an AVM is printed, including the fonts or spacing between delimiters and content. You can apply them locally via the \oarg{options} of \cs{avm} or globally by using \cs{avmsetup}. And you can also define your own styles and use them via the \oarg{style = } option in \cs{avm}.
%
% \begin{function}{\avmsetup}
% \begin{syntax}
% \cs{avmsetup} \marg{options}
% \end{syntax}
-% \marg{options} is a comma-separated list of |key = value| settings. See the list below for all user-configurable options. The \marg{options} are the same as in \cs{avm}\oarg{options}. When inserted in \cs{avm}\oarg{options}, they apply locally, and globally if given to \cs{avmsetup}. Local settings always override global ones, and you can have any feasible number of \cs{avmsetup}s in your document.
+% \marg{options} is a comma-separated list of |key=value| settings. See the list below for all user-configurable options. The \marg{options} are the same as in \cs{avm}\oarg{options}. When inserted in \cs{avm}\oarg{options}, they apply locally, and globally if given to \cs{avmsetup}. Local settings always override global ones, and you can have any feasible number of \cs{avmsetup}s in your document. The scope of \cs{avmsetup} can be restricted through grouping.
%
% \end{function}
%
@@ -265,7 +316,7 @@ Please report any bugs or feature requests to
% \begin{syntax}
% \cs{avmdefinestyle} \marg{name} \marg{settings}
% \end{syntax}
-% Instead of applying settings globally or per AVM, you can also define styles and assign them to AVMs, as in |\avm[style=|\meta{name}|]{...}|. The \meta{settings} are a comma-separated list of |key = value| settings, and should be a subset of the settings from \cs{avmsetup}. For example, the following |plain| style highlights neither attributes, values, nor types:
+% Instead of applying settings globally or per AVM, you can also define styles and assign them to AVMs, as in |\avm[style=|\meta{name}|]{...}|. The \meta{settings} are a comma-separated list of |key=value| settings, and should be a subset of the settings from \cs{avmsetup}. For example, the following |plain| style highlights neither attributes, values, nor types:
%
% \begin{verbatim}
% \avmdefinestyle{plain}{attributes=\normalfont,
@@ -277,14 +328,18 @@ Please report any bugs or feature requests to
%
% \bigskip
%
-% \noindent Now to the list of settings you can actually apply:
+% \noindent Now to the list of settings:
%
% \begin{description}[style=nextline]
% \item[|style =| \meta{name} \hfill (initially empty)] In addition to any style that you possibly define yourself, a style |narrow| is pre-defined in the package (see Section~\ref{sec:spacing}).
%
+% \item[|align =| \meta{choice} \hfill (initially |true|)] Controls whether the columns in the AVM and its substructures should be aligned (snapping to the grid) or not. Aligned AVMs are separated by |columnsep|, non-aligned are separated by |vectorsep|.
+%
% \item[|stretch =| \meta{factor} \hfill (initially |0.9|)] Define \cs{arraystretch}, i.e. a factor in the determination of line height.
%
% \item[|columnsep =| \meta{length} \hfill (initially |0.5ex|)] Define the \cs{tabcolsep}, i.e. horizontal space between columns. The first and second column will have |0\columnsep| to the left and right, respectively. Between the two the distance is |2\columnsep|. Using relative units (like |ex| or |em|) may be a good idea so that |columnsep| scales well with changes in font size.
+%
+% \item[|vectorsep =| \meta{length} \hfill (initially |1em|)] Define the horizontal separation between columns in non-aligned matrices (see option |align|).
%
% \item[|delimfactor =| \meta{factor} \hfill (initially |1000|)] Sets \cs{delimiterfactor}. The calculation for the minimum height of a delimiter is $y \cdot f /1000$, where $y$ is the height of the content and $f$ the value of \cmd{delimfactor}. The default |1000| ensure that the delimiters' height is at least that of the structure.
%
@@ -295,8 +350,6 @@ Please report any bugs or feature requests to
% \item[|attributes =| \meta{font settings} \hfill (initially |\textbackslash scshape|)] The font for attributes, i.e. the first column of each structure.
%
% \item[|values =| \meta{font settings} \hfill (initially |\textbackslash itshape|)] The font for values, i.e. the second column of each structure.
-%
-% \item[|apptovalues=| \meta{code} \hfill (initially \cs{/})] The \meta{code} is applied after the second column (``append to''). This is useful if |values| is set to |\itshape|, since \cs{itshape} does not automatically insert italic correction.
%
% \item[|types =| \meta{font settings} \hfill (initially |\textbackslash itshape|)] The font used in \cs{type} and \cs{type*}.
% \item[|tags =| \meta{format settings} \hfill (initially |\textbackslash footnotesize|)] The font (size) used in \cs{tag} and the shortcuts \cs{1}...\cs{9}.
@@ -304,13 +357,70 @@ Please report any bugs or feature requests to
% \item[|customise = | \meta{settings} \hfill (initially empty)] An interface to input custom commands to be run at the beginning of every \cs{avm}.
% \end{description}
%
+% \subsection{Drawing edges between AVM contents}
+% It is possible to make AVM contents available to \pkg{tikz}, so that they can be referenced in a \cmd{tikzpicture}. To enable this feature, \pkg{langsci-avm} has to be loaded with the option |[tikz]|:
+%
+% \begin{verbatim}
+% \usepackage[tikz]{langsci-avm}
+% \end{verbatim}
+% Additionaly, \cmd{avm} environments on which \pkg{tikz} is to be used need to have the |[pic]| option present:
+%
+% \begin{verbatim}
+% \avm[pic] {...}
+% \end{verbatim}
+%
+% Only the parts of an AVM that are specifically marked will be known to \pkg{tikz}. To mark a part of an AVM to be used by Ti\emph{k}Z, use \cs{node}:
+%
+% \begin{function}[added=2020-09-23]{\node}
+% \begin{syntax}
+% \cs{node} \marg{id} \marg{contents}
+% \end{syntax}
+% \marg{id} serves as part of the node's identifier in a \cmd{tikzpicture}. It will be prefixed, and it's complete name will be |avm-n-|\meta{id}, where |n| is the counter of \cs{avm} in your document that have the |[pic]| option enabled and that don't have a |picname| (see below). |n| starts at 1. For example, a \cs{node} named ``pretty-node'' in the fourth |[pic]|-enabled \cmd{avm} in your document will be |avm-4-pretty-node|. Note that \cs{node} will register the complete name globally in your document, and so can't be declared by other \pkg{tikz} nodes.
+%
+% This behaviour can be adjusted by passing a |[picname = |\meta{avm's name}|]| to \cs{avm}. E.g., \cs{node}s within |\avm[pic, picname=example1]| will have a full name pattern of |example1-|\meta{id}. Named \cs{avm}s do \emph{not} raise the |n| mentioned in the last paragraph.
+%
+% Any (sub-)structure can be placed into \marg{contents}. It could be just a value, an attribute's name, or parts thereof, but whole (sub-)structures can be part of \marg{contents} as well.
+% \end{function}
+%
+% A \cmd{tikzpicture} with options |[remember picture, overlay]| enabled can reference \pkg{langsci-avm}'s \cs{node}s. This way, Ti\emph{k}Z' extensive drawing abilities are available for the decoration of AVMs. Here's a very simple example document:
+%
+% \begin{center}
+% \avm[pic, picname=example1]{[ subj & \1\\
+% comps & <\node{gap}{gap-ss}> \bigskip\\
+% \node{phon}{phon} & <\1 \+ \2>
+% ]}
+%
+% \begin{tikzpicture}[remember picture,overlay]
+% \path[{Stealth[]}-{Stealth[]},gray,dashed,in=90,out=270]
+% (example1-gap.south) edge (example1-phon.north);
+% \end{tikzpicture}
+% \end{center}
+%
+% \begin{verbatim}
+% \documentclass{article}
+% \usepackage[tikz]{langsci-avm}
+% \usepackage{tikz} % optional, since langsci-avm will load tikz if option
+% % tikz is present
+% \usetikzlibrary{arrows,arrows.meta}
+%
+% \avm[pic]{[ subj & \1\\
+% comps & <\node{gap}{gap-ss}> \bigskip\\
+% \node{phon}{phon} & <\1 \+ \2>
+% ]}
+%
+% \begin{tikzpicture}[remember picture,overlay]
+% \path[{Stealth[]}-{Stealth[]},gray,dashed,in=90,out=270]
+% (avm-1-gap.south) edge (avm-1-phon.north);
+% \end{tikzpicture}
+% \end{verbatim}
+%
% \subsection{Defining input patterns}
%
% \begin{function}[added=2020-06-29]{\avmdefinecommand}
% \begin{syntax}
% \cs{avmdefinecommand} \marg{name} \oarg{label} \marg{settings}
% \end{syntax}
-% Sub-structures often come in patterns. For example, AVMs often have a \textsc{phon} attribute, which is mapped to a list, the entries of which are in italics. \cs{avmdefinecommand} can account for this and other input patterns. For example,
+% Structures often follow specific patterns. For example, AVMs often have a \textsc{phon} attribute, which is mapped to a list, the entries of which are in italics. \cs{avmdefinecommand} can account for this and other input patterns. For example,
%
% \begin{verbatim}
% \avmdefinecommand{custom}{...}
@@ -332,7 +442,7 @@ Please report any bugs or feature requests to
%
% This creates a command \cs{phon} (and the variant \cs{phon*}) within the scope of any \cs{avm}. It will print the label \texttt{phon} in the current font and then apply three settings locally: italics for the attribute (first) column, and two settings for very narrow delimiter fitting.
%
-% This results in: (The font of this documentation has little support for IPA.)\avmdefinecommand{phon}[phon] {attributes = \itshape,delimfactor = 900, delimfall = 10pt}\\\\
+% This results in: \avmdefinecommand{phon}[phon] {attributes = \itshape,delimfactor = 900, delimfall = 10pt}\bigskip\\
% \noindent\begin{minipage}[c]{.5\linewidth}
% \begin{verbatim}
% \avm{
@@ -349,12 +459,12 @@ Please report any bugs or feature requests to
% synsem & [ ... ]
% ]
% }
-% \end{minipage}
+% \end{minipage}\bigskip
%
% Note that any other structure type would have worked instead of \avm{<>}. But \avm{<>} and any other markers for sub-structures are left unchanged by \cs{phon} and other custom commands. This is why the \emph{attribute} font is changed by \cs{phon}, although \emph{lin'gwistiks} is technically a value. Remember that \cmd{<} creates a new list sub-substructure, and the first content is printed in its attribute font.
% \end{function}
%
-% \section{Applications}\label{sec:applications}
+% \newpage\section{Applications}\label{sec:applications}
%
% \subsection{Spacing and size of delimiters}\label{sec:spacing}
% \pkg{langsci-avm} automatically detects if the end of a sub-structure is followed by a line break. This is useful to find cases in which two sub-structures are printed immediately below each other, and to add extra spacing (the |extraskip| from the options). This automatic detection can be suppressed with \cs{relax}. See below for the effect of that detection:\bigskip\\
@@ -386,7 +496,7 @@ Please report any bugs or feature requests to
% [attr1 & val1 \\
% attr2 & val2 ]
% ]}
-% \end{minipage}\\\\
+% \end{minipage}\medskip
%
% If many delimiters are nested, this occasionally results in larger delimiter sizes. There is a pre-defined |narrow| style that resets |delimfall| (to |5pt|) and |delimfactor| (to |997|), which are the values recommended in the \textit{\TeX book}. This results in a more compact appearance:\bigskip\\
% \noindent\begin{minipage}[t]{.5\textwidth}\centering
@@ -407,33 +517,33 @@ Please report any bugs or feature requests to
% Sometimes AMVs are placed beside other content to express disjunctions or other relations. In \pkg{langsci-avm} this is done naturally:\bigskip\\
% \noindent\begin{minipage}[c]{.5\textwidth}
% \begin{verbatim}
-% \avm{ [attr1 & val1\\
+% \avm{[attr1 & val1\\
% attr2 & val2\\
-% attr3 & val3] } $\lor$
-% \avm{ [attr1' & val1'\\
+% attr3 & val3]} $\lor$
+% \avm{[attr1' & val1'\\
% attr2' & val2'\\
-% attr3' & val3'\\] }
+% attr3' & val3'\\]}
% \end{verbatim}
% \end{minipage}\begin{minipage}[c]{.5\textwidth}
-% \avm{ [attr1 & val1\\
-% attr2 & val2\\
-% attr3 & val3] } $\lor$
-% \avm{ [attr1' & val1'\\
-% attr2' & val2'\\
-% attr3' & val3'\\] }
+% \avm{[attr1 & val1\\
+% attr2 & val2\\
+% attr3 & val3]} $\lor$
+% \avm{[attr1' & val1'\\
+% attr2' & val2'\\
+% attr3' & val3'\\]}
% \end{minipage}\bigskip\\
% \noindent\begin{minipage}[c]{.5\textwidth}
% \begin{verbatim}
% \textit{sign} $\to$
-% \avm{ [ attribute1 & value1\\
-% attribute2 & value2\\
-% attribute3 & value3 ] }
+% \avm{[attribute1 & value1\\
+% attribute2 & value2\\
+% attribute3 & value3]}
% \end{verbatim}
% \end{minipage}\begin{minipage}[c]{.5\textwidth}
% \textit{sign} $\to$
-% \avm{ [ attribute1 & value1\\
+% \avm{[ attribute1 & value1\\
% attribute2 & value2\\
-% attribute3 & value3 ] }
+% attribute3 & value3 ]}
% \end{minipage}
%
% \pagebreak\subsection{Use as a vector}
@@ -505,7 +615,7 @@ Please report any bugs or feature requests to
% attr2 & val2\\
% attr3 & val3]}} ] ]
% \end{forest}
-% \end{minipage}
+% \end{minipage}\newpage
%
% It may happen that extensive AVMs protrude into the space reserved for other \pkg{forest} nodes or edges. In this case, the \pkg{forest} setting \cmd{for children = \{anchor=north\}} may be useful: (If you like, try this tree without that setting.)\bigskip\\
% \noindent\begin{minipage}[c]{.6\textwidth}
@@ -535,29 +645,14 @@ Please report any bugs or feature requests to
%
% Paths can be printed with a normal \cmd{|}, and $\oplus$ and other relation symbols can be input more easily (see Section~\ref{sec:commands}), though the package will also work with \verb+$|$+ and \verb+$\oplus$+.
%
-% \pkg{langsci-avm} is not yet able to draw lines in elements of AVMs. This feature is planned for Version 0.3.
-%
-%
-% \subsection{Spanning both columns}
-% You can use the \pkg{multicol} package to span both columns in a (sub-)structure. Please remember that every structure has two columns, so the only sensible usage is
-%
-% \begin{verbatim}
-% \multicolumn{2}{l}{...}
-% \end{verbatim}
-%
-% \noindent but only in the first column of a (sub-)structure. For a special usage case, see \cs{type} and \cs{type*} (which do not depend on \pkg{multicol}).
-%
% \section{Caveats and planned features}\label{sec:caveats}
% \begin{enumerate}
% \item There are currently no error messages. If you do not receive the intended output, please make sure that your code fits the syntax described in this documentation. If your code is fine but the output is not, please submit a bug report or feature request at \url{https://github.com/langsci/langsci-avm/issues}.
% \item[] These features are planned for the future:
% \item A check whether the delimiters are balanced, i.e. whether all (sub-)structures are closed by a \verb+]+, \verb+}+, etc.
-% \item Introduce the ability to draw (curved) lines between structures and elements.
% \item Improve the appearance of (very) large angle brackets so that they vertically span the complete structure they enclose, maybe using \pkg{scalerel}.
% \end{enumerate}
%
-% \section{Feedback and bug reports}
-% Comments, usage reports, and feature requests are welcome! Please open an issue for any of these at \url{https://github.com/langsci/langsci-avm/issues}, or write to me at \url{mailto:felix.kopecky@langsci-press.org} if you feel the need for a feature not listed here, big or small.
% \end{documentation}
%
% \begin{implementation}
@@ -570,34 +665,89 @@ Please report any bugs or feature requests to
%<@@=avm>
% \end{macrocode}
% \begin{macrocode}
-\RequirePackage{xparse,array}
+\RequirePackage{xparse}[2022/03/26]
+\RequirePackage{array}
% \end{macrocode}
%
% \begin{macrocode}
\ProvidesExplPackage {langsci-avm}
- {2020-07-15} {0.2.1}
- {AVMs and feature structures in LaTeX3}
+ {2023-02-20} {0.3.0}
+ {AVMs and feature structures}
+
+\msg_new:nnnn {avm} {lfgoptionmissing}
+ { Missing~package~option~lfg~at~line~\msg_line_number: }
+ {
+ You~issued~a~command~in~line~\msg_line_number:~that~is~only~available~when~
+ the~lfg~package~option~is~enabled.
+ }
+
+\msg_new:nnnn {avm} {idpositionunknown}
+ { Unkown~value~for~option~`id~position`~near~line~\msg_line_number:. }
+ { You~specified~an~unknown~value~for~option~`id~position`.~The~content~of~
+ the~id~could~not~be~output.~Please~see~the~manual~for~a~list~of~valid~
+ settings.
+ }
+% \end{macrocode}
+% Let's first check for package options.
+% \begin{macrocode}
+\bool_new:N \l__avm_lfg_bool
+\bool_new:N \l__avm_tikz_bool
+\DeclareOption{tikz}{ \bool_set_true:N \l__avm_tikz_bool }
+\DeclareOption{lfg}{ \bool_set_true:N \l__avm_lfg_bool }
+\ProcessOptions\relax
+% \end{macrocode}
+% Handling for the Ti\emph{k}Z package option.
+% \begin{macrocode}
+\bool_if:NT \l__avm_tikz_bool
+ {
+ \RequirePackage{tikz}
+ \newcounter{l__avm_picture_counter}
+ \tl_new:N \l__avm_picture_name_prefix_tl
+ }
+% \end{macrocode}
+% Handling for the LFG package option: If the semantic bracket is not available at the end of the preamble (i.e.) it was not loaded by another package, load \pkg{unicode-math} to provide the symbol.
+% \begin{macrocode}
+\bool_if:NT \l__avm_lfg_bool
+ {
+ \cs_if_exist:NF \lBrack
+ {
+ \RequirePackage{etoolbox}
+ \AtEndPreamble { \RequirePackage{unicode-math} }
+ }
+ }
% \end{macrocode}
% \begin{macro}{\avm}
% This document command initialises an AVM. The first, optional argumet is a key-value list of settings (see \cs{keys_define:nn} below) and the second is the AVM itself, given in the syntax described in this documentation.
%
-% \cs{avm} enters a group so that keys- and macro-assignemts remain local. It then initialises the commands and shortcuts and any user customisation, sets its mode to |true| and assigns the keys as given in the optional argument (if any). After the wrapper \cs{avm_wrap:n} is called, the group is closed.
+% \cs{avm} enters a group so that keys- and macro-assignemts remain local. It then initialises the commands and shortcuts and any user customisation, sets its mode to |true| and assigns the keys as given in the optional argument (if any). After the parser \cs{__avm_parse:n} is called, the group is closed.
%
% \begin{macrocode}
\NewDocumentCommand{\avm}{ O{} +m }
{
\c_group_begin_token
+ \keys_set:nn { avm } { #1 }
\__avm_initialise_document_commands:
\__avm_initialise_custom_commands:
\tl_use:N \l__avm_defined_commands_tl
- \bool_set_true:N \l__avm_mode_bool
- \keys_set:nn { avm } { #1 }
- \__avm_wrap:n { #2 }
+ \__avm_mode_switch:
+ \__avm_parse:n { #2 }
\c_group_end_token
}
% \end{macrocode}
% \end{macro}
%
+% \begin{variable}{\l__avm_mode_bool, \l__avm_parens_tracker, \l__avm_defined_commands_tl, \l__avm_fillmore_kay_box}
+% We need an auxiliary variable to store the current mode. \cs{l__avm_parens_tracker} is a stack for a future check whether the delimiters given to \cs{avm} are balanced. \cs{l__avm_defined_commands_tl} is a token list that stores any commands provided by the user via \cs{avmdefinecommand}. The box \cs{l__avm_fillmore_kay_box} is used as a temporary storage to realise Fillmore \& Kay's notation.
+% \begin{macrocode}
+\bool_new:N \l__avm_mode_bool
+\seq_new:N \l__avm_parens_tracker
+\tl_new:N \l__avm_defined_commands_tl
+\box_new:N \l__avm_fillmore_kay_box
+\tl_new:N \l__avm_parsed_tl
+\int_new:N \l__avm_mode_switch_character_int
+% \end{macrocode}
+% \end{variable}
+%
% \begin{macro}{\avmsetup}
% Forward the key-value settings given as the optional argument to \cs{avm} to the keys defined in |\keys_define:nn { avm }|. For the meaning of these keys and initial values, see Section~\ref{sec:basiccommands}.
%
@@ -607,14 +757,22 @@ Please report any bugs or feature requests to
\keys_define:nn { avm }
{
+ align .bool_set:N = \l__avm_align_bool,
+ align .initial:n = {true},
stretch .tl_set:N = \l__avm_arraystretch_tl,
stretch .initial:n = {0.9},
columnsep .dim_set:N = \l__avm_tabcolsep_dim,
columnsep .initial:n = {.5ex},
+ vectorsep .dim_set:N = \l__avm_singlesep_dim,
+ vectorsep .initial:n = {1em},
delimfactor .int_set:N = \l__avm_delimfactor_int,
delimfactor .initial:n = {1000},
delimfall .dim_set:N = \l__avm_delimshortfall_dim,
delimfall .initial:n = {0pt},
+ framewidth .dim_set:N = \l__avm_fillmore_kay_boxrule_dim,
+ framewidth .initial:n = {1pt},
+ framesep .dim_set:N = \l__avm_fillmore_kay_boxsep_dim,
+ framesep .initial:n = {3pt},
attributes .code:n = {\cs_set:Nn \__avm_font_attribute: {#1}},
attributes .initial:n = {\scshape},
types .code:n = {\cs_set:Nn \__avm_font_type: {#1}},
@@ -623,18 +781,32 @@ Please report any bugs or feature requests to
values .initial:n = {\itshape},
tags .code:n = {\cs_set:Nn \__avm_font_tag: {#1}},
tags .initial:n = {\footnotesize},
- apptovalues .code:n = {\cs_set:Nn \__avm_deinit_second_column: {#1}},
- apptovalues .initial:n = {\/},
singleton .code:n = {\cs_set:Nn \__avm_font_singleton: {#1}},
singleton .initial:n = {\normalfont},
- switch .code:n = {\tl_set:Nn \__avm_mode_switch_character {#1}},
+ switch .code:n =
+ {
+ \tl_set:Nn \l__avm_mode_switch_character {#1}
+ \exp_args:NNx \int_set:Nn \l__avm_mode_switch_character_int
+ {`\tl_use:N \l__avm_mode_switch_character}
+ },
switch .initial:n = { ! },
extraskip .dim_set:N = \l__avm_extra_skip_dim,
extraskip .initial:n = {\smallskipamount},
- customise .code:n = {\cs_set:Nn \__avm_initialise_custom_commands: {#1}},
+ extraskip~in~every~row .bool_set:N = \l__avm_extraskip_bool,
+ customise .code:n = {\cs_set:Nn \__avm_initialise_custom_commands:
+ {#1}},
customise .initial:n = { },
+ pic .bool_set:N = \l__avm_picture_bool,
+ pic .default:n = { true },
+ picname .tl_set:N = \l__avm_picture_name_tl,
+ picname .initial:n = {automatic},
+ id~align .code:n = { \newcolumntype{i}{#1} },
+ id~align .initial:n = {l},
+ id~position .tl_set:N = \l__avm_id_position_tl,
+ id~position .initial:n = {south-west},
style .choice:,
- style / narrow .code:n = {\delimiterfactor=997\delimitershortfall5pt},
+ style / narrow .code:n = {\int_set:Nn \l__avm_delimfactor_int {997}
+ \dim_set:Nn \l__avm_delimshortfall_dim {5pt}},
}
% \end{macrocode}
% \end{macro}
@@ -667,20 +839,11 @@ Please report any bugs or feature requests to
}
% \end{macrocode}
% \end{macro}
-
-% \begin{variable}{\l__avm_mode_bool, \l__avm_parens_tracker, \l__avm_defined_commands_tl}
-% We need an auxiliary variable to store the current mode. \cs{l__avm_parens_tracker} is a stack for a future check whether the delimiters given to \cs{avm} are balanced. \cs{l__avm_defined_commands_tl} is a token list that stores any commands provided by the user via \cs{avmdefinecommand}
-% \begin{macrocode}
-\bool_new:N \l__avm_mode_bool
-\seq_new:N \l__avm_parens_tracker
-\tl_new:N \l__avm_defined_commands_tl
-% \end{macrocode}
-% \end{variable}
-% \begin{macro}[int]{\seq_set_split:NVn}
-% In preparation for \cs{avm_wrap:n}, we need to split the user input at each occurrence of the escape character. Since the character is given in a variable, we need a variant of the sequence splitter that takes the \emph{evaluation} of the variable, rather than the variable itself, as its second argument.
+% \begin{macro}[int]{\tl_if_eq:VnTF}
+% A useful variant for comparing the values of token list variables with token lists.
% \begin{macrocode}
-\cs_generate_variant:Nn \seq_set_split:Nnn { NVn }
+\cs_generate_variant:Nn \tl_if_eq:nnTF {VnTF}
% \end{macrocode}
% \end{macro}
@@ -691,8 +854,8 @@ Please report any bugs or feature requests to
% \end{macrocode}
% \end{variable}
-% \begin{macro}[int]{\__avm_init_first_column:, \__avm_init_second_column:}
-% These macros apply the settings for the columns in a (sub-)structure. They take care of font selection and report the currently active column back to the system. Knowing which column is active is important when closing the (sub-)structure. If the structure is closed without a second column present, we need to skip back |2\tabcolsep|.
+% \begin{macro}[int]{\__avm_init_first_column:, \__avm_init_second_column:, \__avm_init_single_column:}
+% These macros apply the settings for the columns in a (sub-)structure. They take care of font selection and report the currently active column back to the system. Knowing which column is active is important when closing the (sub-)structure. If the structure is closed without a second column present, we need to skip back |2\tabcolsep|. (This does not apply to the case of vector structures, which are handled without this check.)
% \begin{macrocode}
\cs_new:Nn \__avm_init_first_column:
{
@@ -705,6 +868,35 @@ Please report any bugs or feature requests to
\bool_set_false:N \l__avm_in_first_column
\normalfont\__avm_font_value:
}
+
+\cs_new:Nn \__avm_init_single_column:
+ {
+ \normalfont\__avm_font_attribute:
+ }
+
+% \end{macrocode}
+% \end{macro}
+
+% \begin{macro}[int,added=2020-09-21]{\__avm_deinit_first_column:, \__avm_deinit_second_column:}
+% These commands control settings that are applied after each column is exited. The single check here is whether italics is currently in use. If it is, the the italic correction is automatically applied. This replaces the user-configurable setting |apptovalues| from previous versions.
+% \begin{macrocode}
+
+\tl_const:Nn \l__avm_italics_tl {it}
+
+\cs_new:Nn \__avm_deinit_first_column:
+ {
+ \tl_if_eq:NNT \f@shape \l__avm_italics_tl {\/}
+ }
+
+\cs_new:Nn \__avm_deinit_second_column:
+ {
+ \tl_if_eq:NNT \f@shape \l__avm_italics_tl {\/}
+ }
+
+\cs_new:Nn \__avm_deinit_single_column:
+ {
+ \tl_if_eq:NNT \f@shape \l__avm_italics_tl {\/}
+ }
% \end{macrocode}
% \end{macro}
@@ -731,87 +923,216 @@ Please report any bugs or feature requests to
% \end{macro}
% \begin{macro}[int]{\__avm_module_begin:,\__avm_module_end:,etc.}
-% The replacement instructions for \cs{__avm_parse:n}
+% The replacement instructions for \cs{__avm_parse:n}. When option \meta{align = true} (default), the structure has two columns. Vector structures are inserted if \meta{align = false}.
% \begin{macrocode}
\cs_new:Nn \__avm_module_begin:
- {
- \begin{tabular}{@{}
- >{\__avm_init_first_column:}l
- >{\__avm_init_second_column:}l
- <{\__avm_deinit_second_column:}
- @{}}
+ {
+ \bool_if:NTF \l__avm_align_bool
+ {
+ \begin{tabular}{@{}
+ >{\__avm_init_first_column:}l
+ <{\__avm_deinit_first_column:}
+ >{\__avm_init_second_column:}l
+ <{\__avm_deinit_second_column:}
+ @{}}
+ }
+ {
+ \begin{tabular}{@{}
+ >{\__avm_init_single_column:}l
+ <{\__avm_deinit_single_column:}
+ @{}}
+ }
}
\cs_new:Nn \__avm_module_end:
{
\__avm_kern_unused_columns:
\end{tabular}
}
-\cs_new:Nn \__avm_replace_lbrace:
- {
- \__avm_parse_output:nw
- { \c_math_toggle_token\left\lbrace\__avm_module_begin: }
+
+\cs_new:Nn \__avm_replace_ampersand:
+ {
+ \bool_if:NTF \l__avm_align_bool
+ { \tl_build_put_right:Nn \l__avm_parsed_tl { & } }
+ { \tl_build_put_right:Nn \l__avm_parsed_tl
+ {
+ \exp_not:n
+ {
+ \__avm_deinit_first_column:\skip_horizontal:N
+ \dim_use:N \l__avm_singlesep_dim \__avm_init_second_column:
+ }
+ }
+ }
}
-\cs_new:Nn \__avm_replace_rbrace:
- {
- \__avm_parse_output:nw
- { \__avm_module_end:\right\rbrace\c_math_toggle_token\__avm_extra_skip: }
+\cs_new:Nn \__avm_replace_lbrace:
+ {
+ \c_math_toggle_token\left\lbrace\__avm_module_begin:
}
-\cs_new:Nn \__avm_replace_lbrack:
- {
- \__avm_parse_output:nw
- { \c_math_toggle_token\left\lbrack\__avm_module_begin: }
- }
-\cs_new:Nn \__avm_replace_rbrack:
- {
- \__avm_parse_output:nw
- { \__avm_module_end:\right\rbrack\c_math_toggle_token\__avm_extra_skip: }
+\cs_new:Nn \__avm_replace_rbrace:
+ {
+ \__avm_module_end:\right\rbrace\c_math_toggle_token\__avm_extra_skip:
+ }
+\cs_new:Nn \__avm_replace_lbrack:
+ {
+ \tl_build_put_right:Nn \l__avm_parsed_tl
+ {
+ \exp_not:n
+ {
+ \bool_if:NTF \l__avm_mode_bool
+ {
+ \c_math_toggle_token\left\lbrack\__avm_module_begin:
+ }
+ { [ }
+ }
+ }
+ }
+\cs_new:Nn \__avm_replace_rbrack:
+ {
+ \tl_build_put_right:Nn \l__avm_parsed_tl
+ {
+ \exp_not:n
+ {
+ \bool_if:NTF \l__avm_mode_bool
+ {
+ \__avm_module_end:\right\rbrack\c_math_toggle_token%
+ \__avm_extra_skip:
+ }
+ { ] }
+ }
+ }
+ }
+\bool_if:NTF \l__avm_lfg_bool
+ {
+ \cs_new:Nn \__avm_replace_llbrack:
+ {
+ \c_math_toggle_token\left\lBrack\__avm_module_begin:
+ }
+ \cs_new:Nn \__avm_replace_rrbrack:
+ {
+ \__avm_module_end:\right\rBrack\c_math_toggle_token\__avm_extra_skip:
+ }
+ }
+ {
+ \cs_new:Nn \__avm_replace_llbrack:
+ {
+ \tl_build_put_right:Nn \l__avm_parsed_tl
+ {
+ \exp_not:n
+ {
+ \msg_warning:nn {avm}{lfgoptionmissing}
+ \c_math_toggle_token\left.\__avm_module_begin:
+ }
+ }
+ }
+ \cs_new:Nn \__avm_replace_rrbrack:
+ {
+ \tl_build_put_right:Nn \l__avm_parsed_tl
+ {
+ \exp_not:n
+ {
+ \msg_warning:nn {avm}{lfgoptionmissing}
+ \__avm_module_end:\right.\c_math_toggle_token\__avm_extra_skip:
+ }
+ }
+ }
}
\cs_new:Nn \__avm_replace_lparen:
- {
- \__avm_parse_output:nw
- { \c_math_toggle_token\left(\__avm_module_begin: }
- }
-\cs_new:Nn \__avm_replace_rparen:
- {
- \__avm_parse_output:nw
- { \__avm_module_end:\right)\c_math_toggle_token\__avm_extra_skip: }
- }
-\cs_new:Nn \__avm_replace_langle:
- {
- \__avm_parse_output:nw
- { \c_math_toggle_token\left<\__avm_module_begin: }
- }
-\cs_new:Nn \__avm_replace_rangle:
- {
- \__avm_parse_output:nw
- { \__avm_module_end:\right>\c_math_toggle_token\__avm_extra_skip: }
+ {
+ \tl_build_put_right:Nn \l__avm_parsed_tl
+ {
+ \exp_not:n
+ {
+ \bool_if:NTF \l__avm_mode_bool
+ {
+ \c_math_toggle_token\left(\__avm_module_begin:
+ }
+ { ( }
+ }
+ }
+ }
+\cs_new:Nn \__avm_replace_rparen:
+ {
+ \tl_build_put_right:Nn \l__avm_parsed_tl
+ {
+ \exp_not:n
+ {
+ \bool_if:NTF \l__avm_mode_bool
+ {
+ \__avm_module_end:\right)\c_math_toggle_token\__avm_extra_skip:
+ }
+ { ) }
+ }
+ }
}
-\cs_new:Nn \__avm_replace_plus:
+\cs_new:Nn \__avm_replace_langle:
+ {
+ \tl_build_put_right:Nn \l__avm_parsed_tl
+ {
+ \exp_not:n
+ {
+ \bool_if:NTF \l__avm_mode_bool
+ {
+ \c_math_toggle_token\left<\__avm_module_begin:
+ }
+ { < }
+ }
+ }
+ }
+\cs_new:Nn \__avm_replace_rangle:
+ {
+ \tl_build_put_right:Nn \l__avm_parsed_tl
+ {
+ \exp_not:n
+ {
+ \bool_if:NTF \l__avm_mode_bool
+ {
+ \__avm_module_end:\right>\c_math_toggle_token\__avm_extra_skip:
+ }
+ { > }
+ }
+ }
+ }
+\cs_new:Nn \__avm_replace_lframe:
+ {
+ \hbox_set:Nw \l__avm_fillmore_kay_box \group_begin:
+ \c_math_toggle_token\__avm_module_begin:
+ }
+\cs_new:Nn \__avm_replace_rframe:
+ {
+ \__avm_module_end:\c_math_toggle_token\group_end:\hbox_set_end:
+ \group_begin:
+ \dim_set_eq:NN \fboxrule \l__avm_fillmore_kay_boxrule_dim
+ \dim_set_eq:NN \fboxsep \l__avm_fillmore_kay_boxsep_dim
+ \fbox{\box_use:N \l__avm_fillmore_kay_box}
+ \group_end: \__avm_extra_skip:
+ }
+\cs_new:Nn \__avm_replace_plus:
{
- \__avm_parse_output:nw { \ensuremath { \oplus \! } }
+ \leavevmode\unskip\hbox{${}\oplus{}$}\ignorespaces
}
-\cs_new:Nn \__avm_replace_minus:
+\cs_new:Nn \__avm_replace_minus:
{
- \__avm_parse_output:nw { \ensuremath { \ominus \! } }
+ \leavevmode\unskip\hbox{${}\ominus{}$}\ignorespaces
}
-\cs_new:Nn \__avm_replace_circle:
+\cs_new:Nn \__avm_replace_circle:
{
- \__avm_parse_output:nw { \ensuremath { \bigcirc \, } }
+ \leavevmode\unskip\hbox{${}\bigcirc{}$}\ignorespaces
}
% \end{macrocode}
% \end{macro}
-% \begin{macro}[updated=2020-03-30]{\tag,\type,\punk}
+% \begin{macro}[updated=2020-09-21]{\tag,\type,\punk,\node,\id}
% \begin{macrocode}
\cs_new:Npn \__avm_controls_tag:n #1
- { \fboxsep.25ex\fbox{\normalfont\__avm_font_tag: #1} }
+ { \fboxsep.25ex\fboxrule.4pt\fbox{\normalfont\__avm_font_tag: #1} }
\cs_new:Npn \__avm_controls_type:n #1
{ \c_group_begin_token\normalfont\__avm_font_type: #1\c_group_end_token }
\cs_new_protected:Npn \__avm_controls_type_starred:n #1
{
\bool_set_false:N \l__avm_in_first_column
- \normalfont\__avm_font_type: #1
- \__avm_deinit_second_column:\span\hspace*{-2\tabcolsep}
+ \normalfont\__avm_font_type: #1
+ \bool_if:NTF \l__avm_align_bool
+ { \__avm_deinit_second_column:\span\hspace*{-2\tabcolsep} }
+ { \__avm_deinit_single_column:}
\peek_meaning_ignore_spaces:NTF \\ {} {\\}
}
\cs_new_protected:Npn \__avm_controls_punk:nn #1 #2
@@ -819,165 +1140,156 @@ Please report any bugs or feature requests to
\bool_set_false:N \l__avm_in_first_column
\normalfont\c_group_begin_token\__avm_font_attribute:#1%
\c_group_end_token\hspace{2\tabcolsep}%
- \c_group_begin_token\__avm_font_type: #2\c_group_end_token%
+ \c_group_begin_token\__avm_font_value: #2\c_group_end_token%
\__avm_deinit_second_column:\span\hspace*{-2\tabcolsep}
- \peek_meaning_ignore_spaces:NTF \\ {} {\\}
+ \peek_charcode_ignore_spaces:NTF \\ {} {\\}
}
+\cs_new:Nn \__avm_mode_switch:
+ {
+ \bool_set_inverse:N \l__avm_mode_bool
+ \bool_if:NTF \l__avm_mode_bool
+ {
+ \DeclareDocumentCommand{\{}{}{ \__avm_replace_lbrace: }
+ \DeclareDocumentCommand{\}}{}{ \__avm_replace_rbrace: }
+ \DeclareDocumentCommand{\[}{}{ \__avm_replace_llbrack: }
+ \DeclareDocumentCommand{\]}{}{ \__avm_replace_rrbrack: }
+ \DeclareDocumentCommand{\+}{}{ \__avm_replace_plus: }
+ \DeclareDocumentCommand{\-}{}{ \__avm_replace_minus: }
+ }
+ {
+ \DeclareCommandCopy{\{}{\__avm_old_lbrace_store:}
+ \DeclareCommandCopy{\}}{\__avm_old_rbrace_store:}
+ \DeclareCommandCopy{\[}{\__avm_old_llbrack_store:}
+ \DeclareCommandCopy{\]}{\__avm_old_rrbrack_store:}
+ \DeclareCommandCopy{\+}{\__avm_old_plus_store:}
+ \DeclareCommandCopy{\-}{\__avm_old_minus_store:}
+ }
+ }
+
\cs_new:Nn \__avm_initialise_document_commands:
{
+ \DeclareCommandCopy{\__avm_old_lbrace_store:}{\{}
+ \DeclareCommandCopy{\__avm_old_rbrace_store:}{\}}
+ \DeclareCommandCopy{\__avm_old_llbrack_store:}{\[}
+ \DeclareCommandCopy{\__avm_old_rrbrack_store:}{\]}
+ \DeclareCommandCopy{\__avm_old_plus_store:}{\+}
+ \DeclareCommandCopy{\__avm_old_minus_store:}{\-}
\def\arraystretch{\tl_use:N \l__avm_arraystretch_tl}
- \tabcolsep=\l__avm_tabcolsep_dim
- \delimiterfactor=\l__avm_delimfactor_int
- \delimitershortfall=\l__avm_delimshortfall_dim
- \cs_if_exist:NTF \tag
- { \RenewDocumentCommand{\tag}{m}{ \__avm_controls_tag:n {##1} } }
- { \NewDocumentCommand{\tag}{m}{ \__avm_controls_tag:n {##1} } }
- \cs_if_exist:NTF \0
- { \RenewDocumentCommand{\0}{}{ \__avm_controls_tag:n {0} } }
- { \NewDocumentCommand{\0}{}{ \__avm_controls_tag:n {0} } }
- \cs_if_exist:NTF \1
- { \RenewDocumentCommand{\1}{}{ \__avm_controls_tag:n {1} } }
- { \NewDocumentCommand{\1}{}{ \__avm_controls_tag:n {1} } }
- \cs_if_exist:NTF \2
- { \RenewDocumentCommand{\2}{}{ \__avm_controls_tag:n {2} } }
- { \NewDocumentCommand{\2}{}{ \__avm_controls_tag:n {2} } }
- \cs_if_exist:NTF \3
- { \RenewDocumentCommand{\3}{}{ \__avm_controls_tag:n {3} } }
- { \NewDocumentCommand{\3}{}{ \__avm_controls_tag:n {3} } }
- \cs_if_exist:NTF \4
- { \RenewDocumentCommand{\4}{}{ \__avm_controls_tag:n {4} } }
- { \NewDocumentCommand{\4}{}{ \__avm_controls_tag:n {4} } }
- \cs_if_exist:NTF \5
- { \RenewDocumentCommand{\5}{}{ \__avm_controls_tag:n {5} } }
- { \NewDocumentCommand{\5}{}{ \__avm_controls_tag:n {5} } }
- \cs_if_exist:NTF \6
- { \RenewDocumentCommand{\6}{}{ \__avm_controls_tag:n {6} } }
- { \NewDocumentCommand{\6}{}{ \__avm_controls_tag:n {6} } }
- \cs_if_exist:NTF \7
- { \RenewDocumentCommand{\7}{}{ \__avm_controls_tag:n {7} } }
- { \NewDocumentCommand{\7}{}{ \__avm_controls_tag:n {7} } }
- \cs_if_exist:NTF \8
- { \RenewDocumentCommand{\8}{}{ \__avm_controls_tag:n {8} } }
- { \NewDocumentCommand{\8}{}{ \__avm_controls_tag:n {8} } }
- \cs_if_exist:NTF \9
- { \RenewDocumentCommand{\9}{}{ \__avm_controls_tag:n {9} } }
- { \NewDocumentCommand{\9}{}{ \__avm_controls_tag:n {9} } }
- \cs_if_exist:NTF \type
- { \RenewDocumentCommand{\type}{s m}
- {
- \IfBooleanTF { ##1 }
- { \__avm_controls_type_starred:n {##2} }
- { \__avm_controls_type:n {##2} }
- }
+ \dim_set_eq:NN \tabcolsep \l__avm_tabcolsep_dim
+ \int_set_eq:NN \delimiterfactor \l__avm_delimfactor_int
+ \dim_set_eq:NN \delimitershortfall \l__avm_delimshortfall_dim
+ \DeclareDocumentCommand{\shuffle}{}{ \__avm_replace_shuffle: }
+ \DeclareDocumentCommand{\lframe}{}{ \__avm_replace_lframe: }
+ \DeclareDocumentCommand{\rframe}{}{ \__avm_replace_rframe: }
+ \DeclareDocumentCommand{\tag}{m}{ \__avm_controls_tag:n {##1} }
+ \DeclareDocumentCommand{\0}{}{ \__avm_controls_tag:n {0} }
+ \DeclareDocumentCommand{\1}{}{ \__avm_controls_tag:n {1} }
+ \DeclareDocumentCommand{\2}{}{ \__avm_controls_tag:n {2} }
+ \DeclareDocumentCommand{\3}{}{ \__avm_controls_tag:n {3} }
+ \DeclareDocumentCommand{\4}{}{ \__avm_controls_tag:n {4} }
+ \DeclareDocumentCommand{\5}{}{ \__avm_controls_tag:n {5} }
+ \DeclareDocumentCommand{\6}{}{ \__avm_controls_tag:n {6} }
+ \DeclareDocumentCommand{\7}{}{ \__avm_controls_tag:n {7} }
+ \DeclareDocumentCommand{\8}{}{ \__avm_controls_tag:n {8} }
+ \DeclareDocumentCommand{\9}{}{ \__avm_controls_tag:n {9} }
+ \DeclareDocumentCommand{\type}{s m}
+ {
+ \IfBooleanTF { ##1 }
+ { \__avm_controls_type_starred:n {##2} }
+ { \__avm_controls_type:n {##2} }
}
- { \NewDocumentCommand{\type}{s m}
- {
- \IfBooleanTF { ##1 }
- { \__avm_controls_type_starred:n {##2} }
- { \__avm_controls_type:n {##2} }
- }
- }
- \cs_if_exist:NTF \punk
- { \RenewDocumentCommand{\punk}{m m}
- { \__avm_controls_punk:nn {##1}{##2} } }
- { \NewDocumentCommand{\punk}{m m}
- { \__avm_controls_punk:nn {##1}{##2} } }
- }
+ \DeclareDocumentCommand{\punk}{m m}{ \__avm_controls_punk:nn {##1}{##2} }
+ \DeclareDocumentCommand{\id}{m m}
+ {%
+ \hcoffin_set:Nw \l_tmpa_coffin
+ \bgroup
+ \def\arraystretch{.5}
+ \begin{tabular}[b]{@{}>{$\scriptstyle}i<{$}@{}}
+ ##1
+ \end{tabular}
+ \egroup
+ \hcoffin_set_end:
+ \hcoffin_set:Nw \l_tmpb_coffin ##2 \hcoffin_set_end:
+ \tl_if_eq:VnTF \l__avm_id_position_tl {south-west}
+ {%
+ \coffin_join:NnnNnnnn \l_tmpb_coffin {l}{H}
+ \l_tmpa_coffin {r}{H}{ 0pt }{ -\coffin_dp:N \l_tmpb_coffin }
+ }
+ {%
+ \tl_if_eq:VnTF \l__avm_id_position_tl {south-east}
+ {%
+ \coffin_join:NnnNnnnn \l_tmpb_coffin {l}{H}
+ \l_tmpa_coffin {l}{H}{ \coffin_wd:N \l_tmpb_coffin }
+ { -\coffin_dp:N \l_tmpb_coffin }
+ }
+ {
+ \msg_error:nn {avm}{idpositionunknown}
+ }
+ }
+ \coffin_typeset:Nnnnn \l_tmpb_coffin {l}{vc}{0pt}{0pt}
+ }
% \end{macrocode}
-% \end{macro}
-
-% \begin{macro}{\__avm_wrap:n}
-% The wrapper that first splits the input to \cs{avm} at each occurrence of \cs{__avm_mode_switch_character} and then inverses \cs{l__avm_mode_bool}. It then calls the parser (\cs{__avm_parse:n}) for each splitted sequence. This wrapping is necessary because there is no known expandable way to switch a boolean.
+% The last of the bunch is only loaded if Ti\emph{k}Z is loaded as well:
% \begin{macrocode}
-\cs_new_protected:Npn \__avm_wrap:n #1
- {
- \seq_set_split:NVn \l__avm_wrapper_seq
- \__avm_mode_switch_character { #1 }
- \seq_map_inline:Nn \l__avm_wrapper_seq
- {
- \exp_args:No \exp_not:o
- { \__avm_parse:n {##1} }
- \bool_set_inverse:N \l__avm_mode_bool
+ \bool_if:NT \l__avm_tikz_bool
+ {
+ \tl_if_eq:VnTF \l__avm_picture_name_tl {automatic}
+ {
+ \stepcounter{l__avm_picture_counter}
+ \tl_set:Nn \l__avm_picture_name_prefix_tl
+ {avm-\tl_use:N \thel__avm_picture_counter}
+ }
+ {
+ \tl_set_eq:NN \l__avm_picture_name_prefix_tl \l__avm_picture_name_tl
+ }
+ \DeclareDocumentCommand{\node}{m m}
+ {
+ \tikz [remember~picture,
+ baseline=(\l__avm_picture_name_prefix_tl-##1.base)]
+ \node [inner~sep=0pt] (\l__avm_picture_name_prefix_tl-##1)
+ {\strut ##2};
+ }
}
}
% \end{macrocode}
% \end{macro}
% \begin{macro}{\__avm_parse:n}
-% Finnaly, the parser. It is build on \cs{@@@@_act:NNNnn} from \cmd{l3tl} (see the sub-section \emph{Token by token changes}). Many thanks to Phelype Oleinik for help on this, and in particular on help with expansion.
+% Finally, the parser. It is build on \cs{@@@@_act:NNNnn} from \cmd{l3tl} (see the sub-section \emph{Token by token changes}). Many thanks to Phelype Oleinik for help on this, and in particular on help with expansion.
% \begin{macrocode}
\cs_new:Npn \__avm_parse:n #1
{
- \exp:w
- \group_align_safe_begin:
- \__avm_parse_loop:w #1
- \q_recursion_tail \q_recursion_stop
- \__avm_result:n { }
- }
-
-\cs_new:Npn \__avm_end:w \__avm_result:n #1
- {
- \group_align_safe_end:
- \exp_end:
- #1
- }
-
-\cs_new:Npn \__avm_parse_loop:w #1 \q_recursion_stop
- {
- \tl_if_head_is_N_type:nTF {#1}
- {
- \__avm_N_type:N #1 \q_recursion_stop
- }
- {
- \tl_if_head_is_group:nTF {#1}
- { \__avm_replace_group:nw #1 \q_recursion_stop }
- { \__avm_replace_space:w #1 \q_recursion_stop }
- }
- }
-
-\cs_new:Npn \__avm_N_type:N #1
- {
- \quark_if_recursion_tail_stop_do:Nn #1 { \__avm_end:w }
- \bool_if:NTF \l__avm_mode_bool
- { \__avm_replace:N #1 }
- { \__avm_replace_none:N #1 }
- }
-
-\cs_new:Npn \__avm_replace_none:N #1
- {
- \__avm_parse_output:nw {#1}
- }
-
-\cs_new:Npn \__avm_replace:N #1
- {
- \str_case:nnF {#1}
+ \group_align_safe_begin:
+ \tl_build_begin:N \l__avm_parsed_tl
+ \tl_build_put_right:Nn \l__avm_parsed_tl { \exp_not:n {\ignorespaces} }
+ \tl_analysis_map_inline:nn { #1 }
{
- { \+ }{ \__avm_replace_plus: }
- { \- }{ \__avm_replace_minus: }
- { \shuffle }{ \__avm_replace_circle: }
- { [ }{ \__avm_replace_lbrack: }
- { ] }{ \__avm_replace_rbrack: }
- { ( }{ \__avm_replace_lparen: }
- { ) }{ \__avm_replace_rparen: }
- { \{ }{ \__avm_replace_lbrace: }
- { \} }{ \__avm_replace_rbrace: }
- { < }{ \__avm_replace_langle: }
- { > }{ \__avm_replace_rangle: }
+ \int_case:nnF { ##2 }
+ {
+ { `& }{ \__avm_replace_ampersand: }
+ { `[ }{ \__avm_replace_lbrack: }
+ { `] }{ \__avm_replace_rbrack: }
+ { `( }{ \__avm_replace_lparen: }
+ { `) }{ \__avm_replace_rparen: }
+ { `< }{ \__avm_replace_langle: }
+ { `> }{ \__avm_replace_rangle: }
+ { \l__avm_mode_switch_character_int }
+ {
+ \tl_build_put_right:Nn \l__avm_parsed_tl
+ { \exp_not:n { \__avm_mode_switch: } }
+ }
+ }
+ {
+ \tl_build_put_right:Nn \l__avm_parsed_tl { ##1 }
+ }
}
- { \__avm_replace_none:N #1 }
+ \tl_build_end:N \l__avm_parsed_tl
+ \tl_set:Nx \l__avm_parsed_tl {\l__avm_parsed_tl}
+ \tl_use:N \l__avm_parsed_tl
+ \group_align_safe_end:
}
-\cs_new:Npn \__avm_replace_group:nw #1
- { \exp_args:NNo \exp_args:No \__avm_replace_group:n { \__avm_parse:n {#1} } }
-
-\cs_new:Npn \__avm_replace_group:n #1 { \__avm_parse_output:nw { {#1} } }
-
-\exp_last_unbraced:NNo
-\cs_new:Npn \__avm_replace_space:w \c_space_tl { \__avm_parse_output:nw { ~ } }
-
-\cs_new:Npn \__avm_parse_output:nw #1 #2 \q_recursion_stop \__avm_result:n #3
- { \__avm_parse_loop:w #2 \q_recursion_stop \__avm_result:n {#3 #1 } }
% \end{macrocode}
% \end{macro}
% \begin{macrocode}
diff --git a/macros/latex/contrib/langsci-avm/langsci-avm.ins b/macros/latex/contrib/langsci-avm/langsci-avm.ins
index a60e9b54e2..fe04e59c12 100644
--- a/macros/latex/contrib/langsci-avm/langsci-avm.ins
+++ b/macros/latex/contrib/langsci-avm/langsci-avm.ins
@@ -12,23 +12,18 @@
\preamble
------------------------------------------------------------------------------
-langsci-avm is aimed at typesetting beautiful feature structures,
-also known as attribute-value matrices (AVMs), for use in linguistics.
+A package for typesetting feature structures, also known as attribute-value
+matrices (AVMs), for use in linguistics.
-The package provides a minimal and easy to read syntax.
-It depends only on the array package and can be placed almost everywhere,
-in particular in footnotes or graphs and tree structures. The package is meant
-as an update to, and serves the same purpose as, Christopher Manning’s
-avm package, but shares no code base with that package.
+The package provides a minimal and easy to read syntax. It depends only on the
+array package and can be placed almost everywhere, in particular in footnotes or
+graphs and tree structures. The package serves the same purpose as, Christopher
+Manning’s avm package, but shares no code base with that package.
-langsci-avm was developed at Language Science Press to help in the
-production of scientific texts in linguistics.
+Copyright (C) 2023 by Felix Kopecky, Language Science Press
-Copyright (C) 2020 by Felix Kopecky, Language Science Press
-
-This work consists of the file langsci-avm.dtx
- and the derived files langsci-avm.ins,
- langsci-avm.pdf.
+This work consists of the file langsci-avm.dtx
+ and the derived file langsci-avm.pdf.
It may be distributed and/or modified under the conditions of the
LaTeX Project Public License (LPPL), either version 1.3c of this
diff --git a/macros/latex/contrib/langsci-avm/langsci-avm.pdf b/macros/latex/contrib/langsci-avm/langsci-avm.pdf
index 73f036d8af..ff605e08d7 100644
--- a/macros/latex/contrib/langsci-avm/langsci-avm.pdf
+++ b/macros/latex/contrib/langsci-avm/langsci-avm.pdf
Binary files differ