texlive[58761] Master/texmf-dist: abraces (6apr21)
commits+preining at tug.org
commits+preining at tug.org
Tue Apr 6 00:44:16 CEST 2021
Revision: 58761
http://tug.org/svn/texlive?view=revision&revision=58761
Author: preining
Date: 2021-04-06 00:44:16 +0200 (Tue, 06 Apr 2021)
Log Message:
-----------
abraces (6apr21)
Modified Paths:
--------------
trunk/Master/texmf-dist/doc/latex/abraces/abraces-doc.pdf
trunk/Master/texmf-dist/doc/latex/abraces/abraces-doc.tex
trunk/Master/texmf-dist/tex/latex/abraces/abraces.sty
Added Paths:
-----------
trunk/Master/texmf-dist/doc/latex/abraces/README.md
Added: trunk/Master/texmf-dist/doc/latex/abraces/README.md
===================================================================
--- trunk/Master/texmf-dist/doc/latex/abraces/README.md (rev 0)
+++ trunk/Master/texmf-dist/doc/latex/abraces/README.md 2021-04-05 22:44:16 UTC (rev 58761)
@@ -0,0 +1,16 @@
+`abraces` 2021/03/31 v2.0
+----------------------------------------
+
+A package that provides a character key-driven interface to
+supplement new constructions of the traditional `\overbrace`
+and `\underbrace` pairs in an asymmetric or arbitrary way.
+
+Copyright (c) 2021 Werner Grundlingh
+
+This work may be distributed and/or modified under the
+conditions of the LaTeX Project Public License, either version 1.3
+of this license or (at your option) any later version.
+The latest version of this license is in
+ http://www.latex-project.org/lppl.txt
+and version 1.3 or later is part of all distributions of LaTeX
+version 2005/12/01 or later.
\ No newline at end of file
Property changes on: trunk/Master/texmf-dist/doc/latex/abraces/README.md
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Modified: trunk/Master/texmf-dist/doc/latex/abraces/abraces-doc.pdf
===================================================================
(Binary files differ)
Modified: trunk/Master/texmf-dist/doc/latex/abraces/abraces-doc.tex
===================================================================
--- trunk/Master/texmf-dist/doc/latex/abraces/abraces-doc.tex 2021-04-05 22:43:00 UTC (rev 58760)
+++ trunk/Master/texmf-dist/doc/latex/abraces/abraces-doc.tex 2021-04-05 22:44:16 UTC (rev 58761)
@@ -1,17 +1,23 @@
-% $Id: abraces-doc.tex,v 1.0 2012/08/31 00:00:00 wgrundlingh stable $
+% $Id: abraces-doc.tex,v 2.0 2021/03/31 00:00:00 wgrundlingh stable $
\RequirePackage{xcolor}% http://ctan.org/pkg/xcolor (required to "overload" color package)
-\documentclass{ltxdockit}[2011/03/25]
-%\usepackage{xspace}% http://ctan.org/pkg/xspace (already loaded by ltxdockit)
-\usepackage[overload]{abraces}% http://ctan.org/pkg/abraces
-\usepackage{booktabs}% http://ctan.org/pkg/booktabs
-\usepackage{shortvrb}% http://ctan.org/pkg/shortvrb
-\usepackage{amsmath}% http://ctan.org/pkg/amsmath
+\documentclass[10pt]{ltxdockit}[2011/03/25]
+
+%\usepackage{xspace}% Already loaded by ltxdockit
+\usepackage[overload]{abraces}
+\usepackage{booktabs,shortvrb,amsmath,xfp}
\MakeShortVerb{\|}
-\rcsid{$Id: abraces.tex,v 1.0 2012/08/31 00:00:00 wgrundlingh stable $}
+\rcsid{$Id: abraces.tex,v 2.0 2021/03/31 00:00:00 wgrundlingh stable $}
%\setcounter{secnumdepth}{2}
%\setcounter{tocdepth}{4}
+% https://tex.stackexchange.com/a/472150/5764
+% Use cases for breaking a paragraph that is not visible to the end user, forcing the paragraph to be set with a full-width/-length
+% last line. Then one could insert a \pagebreak if needed, depending on the layout requirements
+\newcommand{\parnopar}[1][]{\parfillskip=0pt\par%
+ #1%
+ \parskip=0pt\noindent\parfillskip=0pt plus1fil}
+
\newsavebox{\codebox}% For storing code segments in footer.
\newcommand*{\abracesctan}{http://ctan.org/pkg/abraces}
@@ -23,9 +29,14 @@
color,
bracetext,
bracescript,
- foxanddog,
+ FnD,
newcolumntype,
- newbracespec}
+ newbracespec,
+ bracecolor,
+ color,
+ textcolor,
+ aftergroup,
+ text}
}
\titlepage{%
@@ -38,138 +49,222 @@
date={\rcstoday}}
\hypersetup{%
- pdftitle={The abraces Package},
+ pdftitle={The abraces package},
pdfsubject={Asymmetric or arbitrary braces},
- pdfauthor={Werner Grundlingh},
+ pdfauthor={Werner Grundlingh (latex.abraces at gmail.com)},
pdfkeywords={tex, latex, braces, overbrace, underbrace, math-mode}}
+\usepackage{parskip}
+
+\newlength{\bracecusplen}
+\settowidth{\bracecusplen}{$\braceru\bracelu$}
+
\begin{document}
\printtitlepage
%\tableofcontents
-\section{Introduction} \label{intro}
+\section{Introduction} \label{sec:introduction}
-The \sty{abraces}\footnote{The \sty{abraces} package: \url{http://ctan.org/pkg/abraces}} package provides a character key-driven interface to supplement new constructions of the traditional \lstinline!\overbrace! and \lstinline!\underbrace! pairs in an asymmetric or arbitrary way.
+The \href{http://ctan.org/pkg/abraces}{\sty{abraces} package} provides a character key-driven interface to supplement new constructions of the traditional \lstinline!\overbrace! and \lstinline!\underbrace! pairs in an asymmetric or arbitrary way.
-\section{User interface} \label{user-interface}
+\section{Basic user interface} \label{sec:user-interface}
-\sty{abraces} defines two counterparts to the existing braces:
+This package defines two counterparts to the existing braces:
\begin{ltxsyntax}
-\cmditem{aoverbrace}[spec]{stuff}
+\cmditem{aoverbrace}[brace spec]{stuff}[script spec]\lstinline!^{!\prm{upper script}\lstinline!}_{!\prm{lower script}\lstinline!}!
-\cmditem{aunderbrace}[spec]{stuff}
+\cmditem{aunderbrace}[brace spec]{stuff}[script spec]\lstinline!^{!\prm{upper script}\lstinline!}_{!\prm{lower script}\lstinline!}!
-These create an overbrace and underbrace where \prm{spec} defines a construction pattern based on the elements in Table~\ref{tab:abrace-spec}.
+\end{ltxsyntax}
-The provided interface is based on a ratio-principle, allowing one to put a larger share of ``filler'' (the horizontal rule) at any location within the brace construction. The traditional \lstinline!\overbrace! and \lstinline!\underbrace! pairs have a \mbox{1:1} share between the left and right side (either side of the tip/cust of the brace). Using a \mbox{1:2} ratio would place the brace cusp one third (from the left) into the brace. Similary a \mbox{3:2} ratio would place the cusp 40\% (or two fifths) from the right edge of the brace.
+Note that both the \prm{brace spec} and \prm{script spec} arguments are optional, as well as the use of an \prm{upper script} and \prm{lower script}. As such, in its most basic form, \lstinline!\aoverbrace{!\prm{stuff}\lstinline!}! (and \lstinline!\aunderbrace{!\prm{stuff}\lstinline!}!) would be similar to the traditional \lstinline!\overbrace{!\prm{stuff}\lstinline!}! (and \lstinline!\underbrace{!\prm{stuff}\lstinline!}!). However, if you specify a \prm{brace spec} -- a construction pattern based on the elements in \hyperref[tab:abrace-spec]{Table~\ref*{tab:abrace-spec}} -- you could adjust the shape of the brace in an arbitrary way. These definitions are robust.
-Other, more complex construction -- by means of the optional \prm{spec} argument -- can also be made by mixing the elements presented in Table~\ref{tab:abrace-spec}.
+The \prm{brace spec} interface is based on a ratio-principle, allowing one to put a larger share of ``filler'' (the horizontal rule) at any location within the brace construction. The traditional \lstinline!\overbrace! and \lstinline!\underbrace! pairs have a \mbox{1:1} share between the left and right side (either side of the tip/cusp of the brace), thereby forcing the tip/cust to be placed directly in the center horizontally. With \lstinline!abraces!, using a \mbox{1:2} ratio would place the brace cusp one third (from the left) into the brace. Similary a \mbox{3:2} ratio would place the cusp 40\% (or two fifths) from the right edge of the brace. The same holds for elements specified within \prm{script spec}, except these are used to alter the location of the scrips. For more detail, see section \hyperref[sec:advanced-interface]{\ref*{sec:advanced-interface}~\nameref*{sec:advanced-interface}}.
-\cmditem{newbracespec}{char}{spec}
+Other, more complex constructions are possible by mixing the elements presented in \hyperref[tab:abrace-spec]{Table~\ref*{tab:abrace-spec}}. See section \hyperref[sec:examples]{\ref*{sec:examples} \nameref*{sec:examples}} for a showcase of uses.
-This allows the user to define a new brace specification \prm{char} the results in the (possibly complex) construction \prm{spec}. The usage is similar to that of a \lstinline!\newcolumntype! construction provided by the \sty{array}\footnote{The \sty{array} package: \url{http://ctan.org/pkg/array}} package.
+\begin{ltxsyntax}
-\cmditem{bracescript}{spec}
+\cmditem{newbracespec}{char}{brace spec}
-Since the brace cusps may not fall directly at the horizontal centre of the construction, \lstinline|\bracescript| is provided that takes a similar construction-style interface to that of \prm{spec} in \lstinline|\aoverbrace| and \lstinline|\aunderbrace|. This allows the user to position the scripted text at the location(s) best-suited for presentation.
-
\end{ltxsyntax}
+This allows the user to define a new brace specification \prm{char} that results in the (possibly complex) construction \prm{brace spec}. Note that \prm{char} should be different from any already used (see \hyperref[tab:abrace-spec]{Table~\ref*{tab:abrace-spec}}). The usage is similar to that of a \lstinline!\newcolumntype! construction provided by the \href{http://ctan.org/pkg/array}{\sty{array} package}.
\begin{table}[t]
\centering
+ \makeatletter
\begin{tabular}{cl}
\toprule
- \prm{spec} character & Output \\
+ \prm{spec} character & Output \\
\midrule
- |l| & $\bracelu$ \\
- |L| & $\braceld$ \\
- |r| & $\braceru$ \\
- |R| & $\bracerd$ \\
- |U| & $\braceru\bracelu$ \\
- |D| & $\bracerd\braceld$ \\
- |0| & (single) Empty fill \\
- |1|, \ldots,\verb|9| & Copies of regular fill \rule[.4ex]{2em}{1.5pt} \\
- |@{|\prm{stuff}|}| & Places \prm{stuff} into brace \\
- |!{|\prm{len}|}| & Regular fill of length \prm{len} \\
+ |l| & $\bracelu$ (left upward brace) \\
+ |L| & $\braceld$ (left downward brace) \\
+ |r| & $\braceru$ (right upward brace) \\
+ |R| & $\bracerd$ (right downward brace)\\
+ |U| & $\braceru\bracelu$ (upward cusp) \\
+ |D| & $\bracerd\braceld$ (downward cusp) \\
+ |,[|\prm{len}|]| & % Similar to \downbracketend in abraces.sty
+ \sbox\z@{$\braceld$}\dimen@\ht\z@ \advance\dimen at .7\fontdimen5\textfont2\relax
+ \vrule \@width\ht\z@ \@height\ht\z@ \@depth\dimexpr\dimen at -\ht\z@\ (downward end with optional \prm{len}gth control) \\
+ |'[|\prm{len}|]| & % Similar to \upbracketend in abraces.sty
+ \sbox\z@{$\bracelu$}\dimen@\ht\z@ \advance\dimen at .7\fontdimen5\textfont2\relax
+ \vrule \@width\ht\z@ \@height\dimen@ \@depth\z@\ (upward end with optional \prm{len}gth control) \\
+ |0| & (single) Empty fill \\
+ |1|, \ldots, |9| & Copies of regular fill \rule[.4ex]{2em}{1.5pt} \\
+ |@{|\prm{stuff}|}| & Places \prm{stuff} into brace \\
+ |!{|\prm{len}|}| & Regular fill of length \prm{len} \\
|*{|\prm{num}|}{|\prm{stuff}|}| & Repeat \prm{stuff} a total of \prm{num} times \\
\bottomrule
\end{tabular}
- \caption{Character specifications \prm{spec} used to construct braces.}
+ \makeatother
+ \caption{Character specifications within \prm{brace spec} used to construct braces.}
\label{tab:abrace-spec}
\end{table}
+By default, any scripts will be placed at the cusp (|D| when providing a \prm{lower script} via \lstinline|_| or |U| when providing an \prm{upper script} via \lstinline|^|) of the brace. If you use more than one cusp within your \prm{brace spec}, you can separate scripts using \lstinline!&! which will place them above/below subsequent brace cusps, similar to separating columns within a \lstinline!tabular!.
+
+\begin{ltxsyntax}
+
+\cmditem{bracecolor}{spec}
+
+\end{ltxsyntax}
+
+If you're interested in using any form of colour, \lstinline|\bracecolor| will allow you to change the brace colour via an \lstinline!@!-insertion (for example, \lstinline!@{\bracecolor{red}}! would yield a \textcolor{red}{red} brace from that point onward). Regular script colouring can still be achieved using \lstinline!\color! or \lstinline!\textcolor!. The motivation here is that elements within the \lstinline!@!-insertions are grouped; \lstinline!\bracecolor! uses \lstinline!\aftergroup! to re-insert the use of \lstinline!\color!.
+
If the package is loaded with the \lstinline!overload! option
-
\begin{lstlisting}
\usepackage[overload]{abraces}
\end{lstlisting}
-
-\noindent the traditional \lstinline!\overbrace! and \lstinline!\underbrace! pairs are redefined to be equivalent to \lstinline!\aoverbrace! and \lstinline!\aunderbrace!, respectively, via a straight-forward \lstinline!\let!:
-
+the traditional \lstinline!\overbrace!/\lstinline!\underbrace! pairs are redefined to be equivalent to \lstinline!\aoverbrace! and \lstinline!\aunderbrace!, respectively, via a straight-forward \lstinline!\let!:
\begin{lstlisting}
\let\overbrace\aoverbrace
\let\underbrace\aunderbrace
\end{lstlisting}
-\section{Examples}
+\section{Advanced uses} \label{sec:advanced-interface}
-Some examples of the types of braces that can be constructed using \sty{abraces}:
+There are some cases where you don't want to place elements exactly at the tip(s) of the brace(s). Maybe it's because you don't have any tips on your braces, or need to write other information around the tips. To that end, the second optional \prm{script spec} argument is provided where you can specify a new sequence that may differ from the original brace specification. Without any tips, for example, one could write \lstinline!$\aoverbrace[L1R]{a + b + \cdots +!\parnopar\lstinline!z}[U]^{\text{26 terms}}$! to denote a grouping of elements:
+\[
+ \aoverbrace[L1R]{a + b + \cdots + z}[U]^{\text{26 terms}}
+\]
+More detailed examples are covered in section \hyperref[sec:examples]{\ref*{sec:examples}~\nameref*{sec:examples}}.
+\section{Examples} \label{sec:examples}
+
+Some basic examples of the types of braces that can be constructed using \sty{abraces}:
\begin{lstlisting}
-\newcommand{\foxanddog}{%
+\newcommand{\FnD}{%
\textrm{The quick brown fox jumped over the lazy dog}}
\end{lstlisting}
-\newcommand{\foxanddog}{%
+\newcommand{\FnD}{%
\textrm{The quick brown fox jumped over the lazy dog}}
\begin{itemize}
- \item \lstinline!\aoverbrace{\foxanddog}! (traditional \lstinline!\overbrace!): \\ $\aoverbrace{\foxanddog}$
- \item \lstinline!\aunderbrace{\foxanddog}! (traditional \lstinline!\underbrace!): \\ $\aunderbrace{\foxanddog}$
- \item \lstinline!\aoverbrace[L3U1R]{\foxanddog}!: \\ $\aoverbrace[L3U1R]{\foxanddog}$
- \item \lstinline!\aoverbrace[l1D1r]{\foxanddog}!: \\ $\aoverbrace[l1D1r]{\foxanddog}$
- \item \lstinline!\aunderbrace[l2D7r]{\foxanddog}!: \\ $\aunderbrace[l2D7r]{\foxanddog}$
- \item \lstinline!\aunderbrace[l1D2U2D1r]{\foxanddog}!: \\ $\aunderbrace[l1D2U2D1r]{\foxanddog}$
- \item \lstinline!\aoverbrace[L1R]{\foxanddog}!: \\ $\aoverbrace[L1R]{\foxanddog}$
- \item \lstinline!\aunderbrace[L1U3R]{\foxanddog}!: \\ $\aunderbrace[L1U3R]{\foxanddog}$
- \item \lstinline!\aunderbrace[l6R0l3D3r0L6r]{\foxanddog}!: \\ $\aunderbrace[l6R0l3D3r0L6r]{\foxanddog}$
- \item \lstinline!\aoverbrace[L5*{3}{01}05U50*{3}{10}5R]{\foxanddog}!: \\ $\aoverbrace[L5*{3}{01}05U50*{3}{10}5R]{\foxanddog}$
- \item \lstinline!\aunderbrace[l1@{\hspace{5em}}2D2@{\hspace{3em}}1r]{\foxanddog}!: \\ $\aunderbrace[l1@{\hspace{5em}}2D2@{\hspace{3em}}1r]{\foxanddog}$
- \item \lstinline~\aunderbrace[l1R@{\color{red!80!white}}L1r]{\foxanddog}~: \\ $\aunderbrace[l1R@{\color{red!80!white}}L1r]{\foxanddog}$
- \item \lstinline~\aoverbrace[L1D!{5em}R]{\foxanddog}~: \\ $\aoverbrace[L1D!{5em}R]{\foxanddog}$
+ \item \lstinline!\aoverbrace{\FnD}! (traditional \lstinline!\overbrace!): \\
+ $\aoverbrace{\FnD}$
+
+ \item \lstinline!\aunderbrace{\FnD}! (traditional \lstinline!\underbrace!): \\
+ $\aunderbrace{\FnD}$
+
+ \item \lstinline!\aoverbrace[L3U1R]{\FnD}!: \\
+ $\aoverbrace[L3U1R]{\FnD}$
+
+ \item \lstinline!\aoverbrace[*{6}{0}l1D1r*{5}{0}]{\FnD}!: \\
+ $\aoverbrace[*{6}{0}l1D1r*{5}{0}]{\FnD}$
+
+ \item \lstinline~\aunderbrace[l2D1r000@{\bracecolor{blue!70!black}}l1D2r]{\FnD}~: \\
+ $\aunderbrace[l2D1r000@{\bracecolor{blue!70!black}}l1D2r]{\FnD}$
+
+ \item \lstinline!\aunderbrace[l1D2U2D1r]{\FnD}!: \\
+ $\aunderbrace[l1D2U2D1r]{\FnD}$
+
+ \item \lstinline!\aoverbrace[L1R]{\FnD}!: \\
+ $\aoverbrace[L1R]{\FnD}$
+
+ \item \lstinline!\aunderbrace[L1U3R]{\FnD}!: \\
+ $\aunderbrace[L1U3R]{\FnD}$
+
+ \item \lstinline!\aunderbrace['6,0l3D3r0,6']{\FnD}!: \\
+ $\aunderbrace['6,0l3D3r0,6']{\FnD}$
+
+ \item \lstinline!\aoverbrace[L5*{3}{01}05U50*{3}{10}5R]{\FnD}!: \\
+ $\aoverbrace[L5*{3}{01}05U50*{3}{10}5R]{\FnD}$
+
+ \item \lstinline!\aunderbrace[l1@{\hspace{5em}}2D2@{~\ldots~}1r]{\FnD}!: \\
+ $\aunderbrace[l1@{\hspace{5em}}2D2@{~\ldots~}1r]{\FnD}$
+
+ \item \lstinline~\aunderbrace[l1R@{\bracecolor{red!80!white}}L1r]{\FnD}~: \\
+ $\aunderbrace[l1R@{\bracecolor{red!80!white}}L1r]{\FnD}$
+
+ \item \lstinline~\aoverbrace[,1D!{5em},]{\FnD}~: \\
+ $\aoverbrace[,1D!{5em},]{\FnD}$
\end{itemize}
-The next question might be how to add content to the brace cusps. Here's a possible way to insert text at the appropriate ratio, using the above construction techniques:
+Some more advanced techniques of adding content to the brace cusps:
+\begin{itemize}
+ \item \lstinline!\aoverbrace[L1U2R]{\FnD}^{\text{one-third of the way}}!: \\
+ $\aoverbrace[L1U2R]{\FnD}^{\text{one-third of the way}}$
+
+ \item \lstinline!\aoverbrace[L1U1D1U1R]{\FnD}^{\text{left} & \text{right}}!: \\
+ $\aoverbrace[L1U1D1U1R]{\FnD}^{\text{left} & \text{right}}$
-\newcommand{\bracetext}[1]{%
- \makebox[0pt][c]{\scriptsize#1}}%
-\[
- \overbrace[L2U2D1U1R]{\foxanddog}^{%
- \bracescript{L2r@{\bracetext{left}}l2D1r@{\bracetext{right}}l1R}%
- }%
-\]
+ \item \lstinline!\aoverbrace[L1U1D1U1R]{\FnD}! \\
+ \quad\lstinline![L1U1U1U1R]^{\text{left} & \text{middle} & \text{right}}!: \\
+ $\aoverbrace[L1U1D1U1R]{\FnD}[L*{3}{1U}1R]^{\text{left} & \text{middle} & \text{right}}$
-\begin{lstlisting}
-\newcommand{\bracetext}[1]{%
- \makebox[0pt][c]{\scriptsize#1}}%
-\[
- \overbrace[L2U2D1U1R]{\foxanddog}^{%
- \bracescript{L2r@{\bracetext{left}}l2D1r@{\bracetext{right}}l1R}%
- }%
-\]
-\end{lstlisting}
+ \item
+ \newcommand{\ind}[1][1]{\hspace*{\fpeval{#1*1.5}em}}%
+ \lstinline!\newbracespec{u}! \\
+ \ind\lstinline!{@{\hspace{-.5\bracecusplen}}U@{\hspace{-.5\bracecusplen}}}! \\
+ \lstinline!\newbracespec{d}! \\
+ \ind\lstinline!{@{\hspace{-.5\bracecusplen}}D@{\hspace{-.5\bracecusplen}}}! \\
+ \lstinline!$\aunderbrace! \\
+ \ind[1]\lstinline![00l2@{\hspace{-\bracecusplen}}1r]{% \aunderbrace brace script! \\
+ \ind[2]\lstinline!\aoverbrace! \\
+ \ind[3]\lstinline![L1@{\hspace{-\bracecusplen}}1R000]% \aoverbrace brace script! \\
+ \ind[3]\lstinline!{\FnD}% stuff! \\
+ \ind[3]\lstinline![1u13]% \aoverbrace script spec! \\
+ \ind[3]\lstinline!^{2/5}% \aoverbrace upper script! \\
+ \ind\lstinline!}! \\
+ \lstinline![43d3]% \aunderbrace script spec! \\
+ \lstinline!_{3/5}$% \aunderbrace lower script!: \\
+ \newbracespec{u}{@{\hspace{-.5\bracecusplen}}U@{\hspace{-.5\bracecusplen}}}%
+ \newbracespec{d}{@{\hspace{-.5\bracecusplen}}D@{\hspace{-.5\bracecusplen}}}%
+ $\aunderbrace
+ [00l2@{\hspace{-\bracecusplen}}1r]{% \aunderbrace brace script
+ \aoverbrace
+ [L1@{\hspace{-\bracecusplen}}1R000]% \aoverbrace brace script
+ {\FnD}% stuff
+ [1u13]% \aoverbrace script spec
+ ^{2/5}% \aoverbrace upper script
+ }
+ [43d3]% \aunderbrace script spec
+ _{3/5}$% \aunderbrace lower script
+
+ \item
+ \lstinline!\newbracespec{a}{@{\hspace{-.5\bracecusplen}}D}! \\
+ \quad\lstinline!\newbracespec{z}{D@{\hspace{-.5\bracecusplen}}}! \\
+ \quad\lstinline!\aunderbrace[l1r]{\FnD}! \\
+ \quad\quad\lstinline![a1z]_{\text{\rlap{far left}} & \text{\llap{far right}}}!: \\
+ \newbracespec{a}{@{\hspace{-.5\bracecusplen}}D}%
+ \newbracespec{z}{D@{\hspace{-.5\bracecusplen}}}%
+ $\aunderbrace[l1r]{\FnD}[a1z]_{\text{\rlap{far left}} & \text{\llap{far right}}}$
+\end{itemize}
\begin{lrbox}{\codebox}\footnotesize\lstinline!\overbrace!\end{lrbox}% Capture code in \codebox
-Another usage might include ``breaking'' a brace across lines to indicate a continuous grouping of objects. The following example\footnote{Taken from the question \href{http://tex.stackexchange.com/q/25510/5764}{\usebox{\codebox} split across multiple lines} on the TeX StackExchange network.} constructs two open-ended \lstinline!\aoverbrace!s which ``spans'' multiple lines:
+Here is a real-world example where ``breaking'' a brace across lines is required to indicate a continuous grouping of objects. This example\footnote{Taken from the question \href{http://tex.stackexchange.com/q/25510/5764}{\usebox{\codebox} split across multiple lines} on the TeX StackExchange network.} constructs two open-ended \lstinline!\aoverbrace!s that ``span'' multiple lines:
\begin{multline*}
- f(x)=a_0+a_1x+a_2x^2+
- \aoverbrace[L1U1]{a_3x^3+a_4x^4+\cdots+a_{i-1}x^{i-1}+\hspace{1em}}^
- {\bracescript{L1r@{\bracetext{some text}}l1}} \\[\jot]
- \aoverbrace[1R]{\hspace{1em}a_ix^i+a_{i+1}x^{i+1}}+\cdots+a_{n-1}x^{n-1}
+ f(x) = a_0 + a_1 x + a_2 x^2 +
+ \aoverbrace[L1U1@{~\ldots}]{a_3 x^3 + a_4 x^4 + \dots +
+ a_{i - 1} x^{i - 1} + \quad}^
+ {\text{some text}} \\[\jot]
+ \aoverbrace[@{\ldots~}1R]{\quad a_i x^i + a_{i + 1} x^{i + 1}} +
+ \dots + a_{n - 1} x^{n - 1}
\end{multline*}
\begin{lstlisting}
@@ -176,39 +271,59 @@
\usepackage{amsmath}% http://ctan.org/pkg/amsmath
%...
\begin{multline*}
- f(x)=a_0+a_1x+a_2x^2+
- \aoverbrace[L1U1]{a_3x^3+a_4x^4+\cdots+a_{i-1}x^{i-1}+\hspace{1em}}^
- {\bracescript{L1r@{\bracetext{some text}}l1}} \\[\jot]
- \aoverbrace[1R]{\hspace{1em}a_ix^i+a_{i+1}x^{i+1}}+
- \cdots+a_{n-1}x^{n-1}
+ f(x) = a_0 + a_1 x + a_2 x^2 +
+ \aoverbrace[L1U1@{~\ldots}]{a_3 x^3 + a_4 x^4 + \dots +
+ a_{i - 1} x^{i - 1} + \quad}^
+ {\text{some text}} \\[\jot]
+ \aoverbrace[@{\ldots~}1R]{\quad a_i x^i + a_{i + 1} x^{i + 1}} +
+ \dots + a_{n - 1} x^{n - 1}
\end{multline*}
\end{lstlisting}
As a final example, consider a brace that should include a dashed component. Using \lstinline|\newbracespec| one can define your own dashed component:
-
\begin{lstlisting}
\newbracespec{d}{%
5@{\hspace{4pt}}1@{\hspace{4pt}}!{2em}@{\hspace{4pt}}1@{\hspace{4pt}}5%
}
\end{lstlisting}
-
\noindent and then use
-
\begin{lstlisting}
\[
- \aunderbrace[l*{3}{d}D*{3}{d}r]{\foxanddog}_
- {\bracetext{What happened to the cat?}}
+ \aunderbrace[l*{3}{d}D*{3}{d}r]{\FnD}_{\text{What happened to the cat?}}
\]
\end{lstlisting}
+\[
+ \newbracespec{d}{1@{\hspace{4pt}}1@{\hspace{4pt}}!{1em}@{\hspace{4pt}}1@{\hspace{4pt}}1}
+ \aunderbrace[l*{3}{d}D*{3}{d}r]{\FnD}_{\text{What happened to the cat?}}
+\]
-\newbracespec{d}{1@{\hspace{4pt}}1@{\hspace{4pt}}!{1em}@{\hspace{4pt}}1@{\hspace{4pt}}1}
+\section{Terms of reference}
-\[ \aunderbrace[l*{3}{d}D*{3}{d}r]{\foxanddog}_{\bracetext{What happened to the cat?}} \]
+This package originated from a question on the TeX StackEchange network called \href{http://tex.stackexchange.com/q/68526/5764}{Asymmetric overbrace}. Some code was taken from the \href{http://ctan.org/pkg/mathtools}{\sty{mathtools} package}.
-\section{Terms of reference}
+This material is released under and subject to the \href{https://latex-project.org/lppl/}{LaTeX Project Public Licence}.
-This package originated from a question on the TeX StackEchange network called \href{http://tex.stackexchange.com/q/68526/5764}{Asymmetric overbrace}. Some code was taken from the \sty{mathtools}\footnote{The \sty{mathtools} package: \url{http://ctan.org/pkg/mathtools}} package.
+\section{Acknowledgements}
-This material is released under and subject to the \href{http://www.ctan.org/tex-archive/help/Catalogue/licenses.lppl.html}{LaTeX Project Public Licence}.
+Thanks to Frank Mittlebach who stepped in and suggested an improvement in the original way \sty{abraces} functioned. Expansions included the use of \LaTeX3 command interface (via the \href{http://ctan.org/pkg/xparse}{\sty{xparse} package}).
+\section{Change log}
+
+\begin{itemize}
+ \item v2.0 (2021-03-31) Major update
+
+ \begin{itemize}
+ \item
+ The package now uses \href{http://ctan.org/pkg/xparse}{\sty{xparse}} for macro definitions.
+
+ \item
+ Included an automated way for handling elementary/default scripts. The placement of scripts can still be modified using the \lstinline|\bracescript| interface.
+
+ \item
+ The documentation was also updated to reflect the changes.
+ \end{itemize}
+
+ \item v1.0 (2012-08-31) Initial release
+\end{itemize}
+
\end{document}
\ No newline at end of file
Modified: trunk/Master/texmf-dist/tex/latex/abraces/abraces.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/abraces/abraces.sty 2021-04-05 22:43:00 UTC (rev 58760)
+++ trunk/Master/texmf-dist/tex/latex/abraces/abraces.sty 2021-04-05 22:44:16 UTC (rev 58761)
@@ -1,5 +1,25 @@
+%% abraces.sty
+%% Copyright 2021 Werner Grundlingh
+%
+% This work may be distributed and/or modified under the
+% conditions of the LaTeX Project Public License, either version 1.3
+% of this license or (at your option) any later version.
+% The latest version of this license is in
+% http://www.latex-project.org/lppl.txt
+% and version 1.3 or later is part of all distributions of LaTeX
+% version 2005/12/01 or later.
+%
+% This work has the LPPL maintenance status `maintained'.
+%
+% The Current Maintainer of this work is Werner Grundlingh.
+%
+% This work consists of the file abraces.sty.
+
\ProvidesPackage{abraces}% http://ctan.org/pkg/abraces
- [2012/08/24 v1.0 Arbitrary and asymmetric braces]
+ [2021/03/31 v2.0 Arbitrary and asymmetric braces]
+
+\RequirePackage{xparse}
+
\newif\if at overload
\DeclareOption{overload}{\@overloadtrue}
\ProcessOptions
@@ -25,42 +45,231 @@
\def\aupbracefill#1{$\m at th\setbox\z@\hbox{$\braceld$}\genbrace{#1}$}
\def\adownbracefill#1{$\m at th\setbox\z@\hbox{$\braceld$}\genbrace{#1}$}
+\DeclareDocumentCommand{\downbracketend}{ O{.7\fontdimen5\textfont2} }{%
+ \@use at rl@se
+ {\sbox\z@{$\braceld$}%
+ \dimen@\ht\z@ \advance\dimen@#1\relax
+ \vrule \@width\ht\z@ \@height\ht\z@ \@depth\dimexpr\dimen at -\ht\z@}%
+ \@genbrace}
+
+\DeclareDocumentCommand{\upbracketend}{ O{.7\fontdimen5\textfont2} }{%
+ \@use at rl@se
+ {\sbox\z@{$\bracelu$}%
+ \dimen@\ht\z@ \advance\dimen@#1\relax
+ \vrule \@width\ht\z@ \@height\dimen@ \@depth\z@}%
+ \@genbrace}
+
% Repetition structure. Reference:
% Repeat command n times?
% http://tex.stackexchange.com/q/16189/5764
-% Alternatively
-% \RequirePackage{expl3}% http://ctan.org/pkg/expl3
-% \ExplSyntaxOn
-% \cs_new_eq:NN \Repeat \prg_replicate:nn
-% \ExplSyntaxOff
+\ExplSyntaxOn
+\cs_new_eq:NN \Repeat \prg_replicate:nn
+%FMi
+\cs_new_eq:NN \TrimArgSpaces \tl_trim_spaces:n % only needed when ^{...} should be text
+%FMi
+\ExplSyntaxOff
-\newcommand{\Repeat}[1]{%
- \expandafter\@Repeat\expandafter{\the\numexpr #1\relax}%
-}
-\def\@Repeat#1{%
- \ifnum#1>0
- \expandafter\@@Repeat\expandafter{\the\numexpr #1-1\expandafter\relax\expandafter}%
- \else
- \expandafter\@gobble
- \fi
-}
-\def\@@Repeat#1#2{%
- \@Repeat{#1}{#2}#2%
-}
% Taken from mathtools package (http://ctan.org/pkg/mathtools)
-\newcommand{\aunderbrace}[2][l1D1r]{%
+\DeclareDocumentCommand{\aunderbrace}{ O{l1D1r} m o e{^_}}{%
\begin{lrbox}{\bracebox}$\displaystyle{#2}$\end{lrbox}%
\mathop{\vtop{\m at th\ialign{##\crcr
$\hfil\displaystyle{#2}\hfil$\crcr
\noalign{\kern.7\fontdimen5\textfont2\nointerlineskip}%
- \aupbracefill{#1}\crcr\noalign{\kern.5\fontdimen5\textfont2}}}}\limits}
-\newcommand{\aoverbrace}[2][L1U1R]{%
+ \aupbracefill{#1}\crcr\noalign{\kern.5\fontdimen5\textfont2}}}}\limits
+ % ...there was a ^:
+ \IfValueT{#4}{%
+ ^{%
+%FMi
+ \gdef\@abrace at text@arg{#4}% % save argument then split of portions later
+%FMi
+ \@defbracecharcode{A}{%
+ \@use at rl@se\braceru
+ \makebox[0pt][c]{\scriptsize
+%FMi % split off next part
+ \expandafter\@abrace at next@text\@abrace at text@arg&\@abrace at next@text}%
+%FMi
+ \@use at rl@se\bracelu\@genbrace
+ }%
+ % We interpret U as A
+ \let\brace at char@U\brace at char@A
+%FMi
+ \let\@abrace at stuff\phantom % render @{...} harmless
+%FMi
+ % Use the normal spec by default
+ \IfValueTF{#3}
+ {\bracescript{#3}}% Use newly-specified spec
+ {\bracescript{#1}}% Use default spec
+%FMi
+ \@abrace at is@arg at fully@used{^}{U}%
+%FMi
+ }%
+ }%
+ % ...there was a _:
+ \IfValueT{#5}{%
+ _{%
+%FMi
+ \gdef\@abrace at text@arg{#5}%
+%FMi
+ \@defbracecharcode{A}{%
+ \@use at rl@se\bracerd
+ \makebox[0pt][c]{%
+ \scriptsize % not needed if processed in math
+%FMi
+ \expandafter\@abrace at next@text\@abrace at text@arg&\@abrace at next@text}%
+%FMi
+ \@use at rl@se\braceld\@genbrace
+ }%
+ % We interpret D as A
+ \let\brace at char@D\brace at char@A
+%FMi
+ \let\@abrace at stuff\phantom % render @{...} harmless
+%FMi
+ % Use the normal spec by default
+ \IfValueTF{#3}
+ {\bracescript{#3}}% Use the newly-specified spec
+ {\bracescript{#1}}% Use the default spec
+%FMi
+ \@abrace at is@arg at fully@used{_}{D}%
+%FMi
+ }%
+ }%
+%FMi
+% If there is a second optional argument (#3) but there is neither
+% a ^{..} nor a _{..} then interpret the bracket group was not an optional argument
+% but actually belongs to the current formula, so return it.
+% Order of the test is #3 #5 #4 because an overbrace is more likely to have ^{..}.
+% For underbrace it is #3 #4 #5.
+ \IfValueT{#3}{\IfValueF{#5}{\IfValueF{#4}{[#3]}}}%
+%FMi
+}
+
+%\RequirePackage{unravel}
+
+%FMi
+\def\@abrace at next@text#1\@abrace at next@text{%
+ \gdef\@abrace at text@arg{#2}%
+ % \TrimArgSpaces{#1}% % text solution
+ $\scriptstyle #1$% % use math mode instead? I think so
+}
+%FMi
+
+
+
+%FMi
+% check if current value of \@abrace at text@arg contains parts that haven't been used.
+%
+% Possible cases: (a) empty (b) one or more & symbols (c) some & symbol(s) and other stuff
+%
+% (c) is the case we need to generate an error for.
+
+
+\def\@abrace at is@arg at fully@used#1#2{%
+ \edef\abrace at tempa{\detokenize{#1}}% _ or ^
+ \def\abrace at tempb{#2}% % D or U
+ \let\abrace at next\@abrace at is@arg at fully@used@
+ \expandafter\@abrace at is@arg at fully@used@ \@abrace at text@arg \@nil &%
+}
+
+% As we know that here is at least \verb=\@nil &= in the stream ahead
+% we can grep one argument delimited by \verb=&= and then check if it
+% is empty (case (a) or (b)), if it is \verb=\@nil= (we are done) or
+% if it is anything else (case (c)).
+
+
+\def\@abrace at is@arg at fully@used@ #1&{%
+ \def\@abrace at text@arg{#1}%
+ \ifx\@abrace at text@arg\@empty % ok case
+ \else
+ \ifx\@abrace at text@arg\@nnil % we are done
+ \let\abrace at next\relax
+ \else
+ \PackageError{abraces}{Unused part in \abrace at tempa{...}:\MessageBreak
+ '\detokenize{#1}' dropped}%
+ {There have been more \string& symbols than
+ \abrace at tempb\space or A elements in the pattern.
+ Check your source!}%
+ \fi
+ \fi
+ \abrace at next
+}
+%FMi
+
+
+
+\DeclareDocumentCommand{\aoverbrace}{ O{L1U1R} m o e{^_}}{%
+%
+% \typeout{Arguments: \detokenize{1=#1|2=#2|3=#3|4=#4|5=#5|}}%
+%
\begin{lrbox}{\bracebox}$\displaystyle{#2}$\end{lrbox}%
\mathop{\vbox{\m at th\ialign{##\crcr
\noalign{\kern.5\fontdimen5\textfont2}%
\adownbracefill{#1}\crcr
\noalign{\kern.7\fontdimen5\textfont2\nointerlineskip}%
- $\hfil\displaystyle{#2}\hfil$\crcr}}}\limits}
+ $\hfil\displaystyle{#2}\hfil$\crcr}}}\limits
+ % ...there was a ^:
+ \IfValueT{#4}{%
+ ^{%
+ % Define a text point instead of a tip
+%FMi
+ \gdef\@abrace at text@arg{#4}% % save argument then split of portions later
+%FMi
+ \@defbracecharcode{A}{%
+ \@use at rl@se\braceru
+ \makebox[0pt][c]{\scriptsize
+%FMi % split off next part
+ \expandafter\@abrace at next@text\@abrace at text@arg&\@abrace at next@text}%
+%FMi
+ \@use at rl@se\bracelu\@genbrace
+ }%
+ % We interpret U as A
+ \let\brace at char@U\brace at char@A
+ % Use the normal spec by default
+%FMi
+ \let\@abrace at stuff\phantom % render @{...} harmless
+%FMi
+ \IfValueTF{#3}
+ {\bracescript{#3}}% Use newly-specified spec
+ {\bracescript{#1}}% Use default spec
+%FMi
+ \@abrace at is@arg at fully@used{^}{U}%
+%FMi
+ }%
+ }%
+ % ...there was a _:
+ \IfValueT{#5}{%
+ _{%
+ % Define a text point instead of a tip
+%FMi
+ \gdef\@abrace at text@arg{#5}%
+%FMi
+ \@defbracecharcode{A}{%
+ \@use at rl@se\bracerd
+ \makebox[0pt][c]{%
+ \scriptsize % not needed if processed in math
+ %FMi
+ \expandafter\@abrace at next@text\@abrace at text@arg&\@abrace at next@text
+ }%
+%FMi
+ \@use at rl@se\braceld\@genbrace
+ }%
+ % We interpret D as A
+ \let\brace at char@D\brace at char@A
+%FMi
+ \let\@abrace at stuff\phantom % render @{...} harmless
+%FMi
+ % Use the normal spec by default
+ \IfValueTF{#3}
+ {\bracescript{#3}}% Use the newly-specified spec
+ {\bracescript{#1}}% Use the default spec
+%FMi
+ \@abrace at is@arg at fully@used{_}{D}%
+%FMi
+ }%
+ }%
+%FMi
+ \IfValueT{#3}{\IfValueF{#4}{\IfValueF{#5}{[#3]}}}%
+%FMi
+}
% Parsing structure. Reference:
% Parsing a macro argument character-by-character for conditional execution
@@ -89,15 +298,46 @@
\@defbracecharcode{@}{\@firstofone at go}% Insert arbitrary stuff
\@defbracecharcode{!}{\@firstofone at len}% Insert a leader of specific length
\@defbracecharcode{*}{\@repeat at num@times}% Repeat stuff a number of times
+\@defbracecharcode{,}{\downbracketend}% Downward bracket end
+\@defbracecharcode{'}{\upbracketend}% Upward bracket end
-\newcommand{\@firstofone at go}[1]{#1\@genbrace}%
+
+%FMi
+%like U or D (same width) but a straight line marking a possible anchor point for annotation material
+% can be used in patterns, e.g., $\aunderbrace[3A1]{a+b+c+d}_{x}$ makes a an underline rule with
+% the "x" being placed off center
+
+\@defbracecharcode{A}{%
+ \setbox\z@\hbox{$\m at th\braceru\bracelu$}%
+ \hb at xt@\wd\z@{\@@bfil}%
+ \@genbrace}%
+
+%FMi
+
+
+\newcommand{\bracecolor}[1]{\xdef\bracecolor@{\noexpand\color{#1}}\aftergroup\bracecolor@}
+%FMi
+\let\bracecolor\color % no longer needed
+%\newcommand{\@firstofone at go}[1]{\mathord{#1}\@genbrace}%
+\let\@abrace at stuff\@firstofone
+\newcommand{\@firstofone at go}[1]{\mathord{}\@abrace at stuff{#1}\mathord{}\@genbrace}%
+%FMi
+%\newcommand{\@firstofone at go}[1]{#1\@genbrace}%
\newcommand{\@firstofone at len}[1]{\hb at xt@#1{\@@bfil}\@genbrace}%
\newcommand{\@repeat at num@times}[2]{\Repeat{#1}{\@genbrace#2\@nnil}\@genbrace}%
\newcommand{\@genbrace}[1]{%
\ifx\@nnil#1\relax\else
- \@nameuse{brace at char@#1\expandafter}%
- \fi%
+%FMi
+ \expandafter\ifx\csname brace at char@#1\endcsname\relax
+ \PackageError{abraces}{Brace pattern '#1' unknown}%
+ {I'll use '0' instead.}%
+ \csname brace at char@0\expandafter\expandafter\expandafter\endcsname
+ \else
+ \csname brace at char@#1\expandafter\expandafter\expandafter\endcsname
+ \fi
+%FMi
+ \fi
}
\newcommand{\genbrace}[1]{%
\@genbrace#1\@nnil%
More information about the tex-live-commits
mailing list.