summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/stackengine/stackengine.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/stackengine/stackengine.tex')
-rw-r--r--macros/latex/contrib/stackengine/stackengine.tex66
1 files changed, 34 insertions, 32 deletions
diff --git a/macros/latex/contrib/stackengine/stackengine.tex b/macros/latex/contrib/stackengine/stackengine.tex
index 9a870887ac..35384cdac6 100644
--- a/macros/latex/contrib/stackengine/stackengine.tex
+++ b/macros/latex/contrib/stackengine/stackengine.tex
@@ -32,7 +32,7 @@
\rule{0em}{.7em}\small Highly customized stacking of objects, insets,
baseline changes, \textit{etc.}\\
\rule{0em}{2.7em}\large Steven B. Segletes\\
-steven.b.segletes.civ@mail.mil\\
+SSegletes@verizon.net\\
\rule{0em}{1.7em}\today\\
\stackengineversionnumber%
\end{center}
@@ -55,13 +55,13 @@ you to familiarize yourself with a few terms as used in this package.
\Huge\setstackgap{S}{.4ex}
\setstackgap{L}{2.2ex}\normalsize
-In this package, ``Short'' refers to squeezing the extra space out of
-glyphs comprising the stack, so that the inter-item gap is solely what
+In this package, ``Short'' refers to squeezing or growing the empty space
+between glyphs comprising the stack, so that the inter-item gap is solely what
is set. Likewise, ``Long'' refers to a stack kept at constant
inter-item baseline spacing. Let's look at the following two
examples to see this clearly.
-Notice the consistent inter-item gap on a short stack:
+Notice the consistent inter-item gap between short stack items:
\Huge
\Shortstack{{\fbox{t}} {\fbox{y}} {\fbox{k}} {\fbox{e}}}%
{\quad\setstackgap{S}{\dimexpr.4ex+1.2pt}\Shortstack{t y k e}}
@@ -244,8 +244,10 @@ In addition to parameter definitions, there are several {\ste} mode
settings:
\itshape
-\vb|\stackMath|\\
-\vb|\stackText|\\
+\vb|\stackMath|\qquad \textup{and}\qquad \vb|\lstackMath|
+ \quad\textup{(global/local declaration)}\\
+\vb|\stackText|\qquad \textup{and}\qquad \vb|\lstackText|
+ \quad\textup{(global/local declaration)}\\
\vb|\strutlongstacks{T| or \vb|F}|\\
\vb|\strutshortanchors{T| or \vb|F}|\\
\vb|\setstackEOL{|end-of-line character\vb|}|
@@ -262,7 +264,9 @@ text mode. Both of these modes are global in their scope, so that invocation,
even within a macro, will continue to persist until later changed. If
you would like to have a single application stacked in math mode, without
changing the default mode setting, one could use the \vb|\ensurestackMath{}|
-macro (see \ref{s:esm}).
+macro (see \ref{s:esm}), or else the local versions that are scope
+limited, \vb|\lstackMath|\margcmd{lstackMath} and/or
+\vb|\lstackText|\margcmd{lstackText}.
By default, stacks made by {\ste} are set in unframed boxes that are
flush with the top and bottom of the stack. The \vb|\addstackgap|
@@ -301,12 +305,12 @@ space token, leading and trailing spaces are ignored in the row data for
the four cited stacking commands, as well as their derivatives
\vb|\Centerstack| and \vb|\Vectorstack|. (Note: other stacking commands
in the \vb|\stackon| / \vb|\stackunder| family will not ignore, but
-retain spaces in their arguments, since there is no issue associated
-with EOL seperators.)
+retain leading/trailing spaces in their arguments, since there are no
+EOL separators present.)
Note that these five mode-setting commands are not themselves parameters
to be part of a {\ste} argument, but are instead to be issued as separate
-commands prior to the invocation of a desired stacking macro.
+declarative commands prior to the invocation of a desired stacking macro.
\subsection{Stacking Macros}
@@ -381,8 +385,8 @@ forced to be a long stack with right-alignment and be typeset using
While the stacking macros in the following sections offer the convenience
of a condensed syntax, which can be useful within your document, it may be
preferable to use the \vb|\stackengine| macro to create your own
-stacking macros, since one can achieve the stacking result without
-having to modify the package defaults.
+stacking macros, since one can achieve the stacking result regardless of
+how the package defaults are set.
\subsubsection{\cmd{stackon} and \cmd{stackunder}\label{s:sou}}
@@ -394,11 +398,11 @@ an optional argument.
\itshape
\vb|\stackon[|stacklength%
\vb|]{|anchor%
- \vb|}{|item
+ \vb|}{|item%
\vb|}|\\
\vb|\stackunder[|stacklength%
\vb|]{|anchor%
- \vb|}{|item
+ \vb|}{|item%
\vb|}|
\upshape
@@ -464,8 +468,8 @@ As of V3.1 of \ste, the user may define the the argument to
\vb|\Longstack|, \vb|\Shortstack|, \vb|\Longunderstack|, and
\vb|\Shortunderstack| with a row separator different than a space.
The \vb|[usestackEOL]| package option will make the EOL character within
-these stacking commands a \vb|\\| character instead of a space. Here
-are an example of equivalent stack arguments for two different EOL
+these stacking commands a \vb|\\| macro instead of a space. Here
+is an example of equivalent stack arguments for two different EOL
characters:
Space EOL:~~~~\vb|{a {b c} {\P} $\beta^2$ ANCHOR}|\\
@@ -632,7 +636,7 @@ which are, respectively,\\
The macro \vb|\ensurestackMath{}| macro is used to force its argument
(a stacking command) to be processed in math mode, without setting
the global default stacking
-mode to math mode (otherwise accomplished via \vb|\stackMath|). Note
+mode to math mode (accomplished via \vb|\stackMath|). Note
that this macro does \textbf{not} ensure that
all elements of its argument are processed in math mode (\textit{i.e.},
it does not use, nor is it a replacement for \vb|\ensuremath|), but
@@ -708,8 +712,8 @@ horizontal size of the anchor, even if the inset spills outside of it).
While this command was designed with inlaid images in mind (see
\S\ref{s:ii}), there is nothing that prevents its use to inlay
character glyphs upon each other, as in
-\stackinset{c}{}{c}{-.25ex}{*}{O}, accomplished with
-\vb|\stackinset{c}{}{c}{-.25ex}{*}{O}|.
+\stackinset{c}{}{c}{-.3ex}{*}{O}, accomplished with
+\vb|\stackinset{c}{}{c}{-.3ex}{*}{O}|.
\subsubsection{\cmd{addstackgap}\label{s:asg}}
\def\stacktype{S}
@@ -1131,7 +1135,7 @@ Make sure you use the one that best applies to your situation.
\section{Image Insets\label{s:ii}}
\setstackgap{L}{18pt}%
-The command \vb|\stackinset| allows images to be
+The command \vb|\stackinset| allows images (or other data) to be
stacked atop one another, to produce the effect of an inset image. In
addition to specifying the two images, the effect can be tailored by
specifying the vertical and horizontal offset of the inset image.
@@ -1277,13 +1281,15 @@ stacking gaps and alignment, there are several hints to remember.
\begin{enumerate}
-\item Arguments to stacking commands are only taken in math mode, by
-default, following the invocation of the \vb|\stackMath| macro.
+\item Arguments to stacking commands are only taken in math mode,
+\textit{by default}, following the invocation of the
+\vb|\stackMath| macro.
-\item The \vb|\stackMath| and \vb|\stackText| macros are not to be
-used within stacking arguments, but are invoked prior to stacking, to
-set the default manner in which stacking arguments are subsequently
-processed.
+\item The \vb|\stackMath| and \vb|\stackText| macros, as well as
+their locally scoped counterparts, \vb|\lstackMath| and \vb|\lstackText|,
+are not to be used within stacking arguments, but are invoked prior
+to stacking, to set the manner in which stacking arguments
+are subsequently processed.
\item As described in \S\ref{s:sls}, if the math argument has spaces in
a command which uses space-separated lists, or if the argument ends in a
@@ -1350,12 +1356,6 @@ because of more preferable alternatives. They have been omitted from the
current documentation, except for mention here. They are:
\begin{itemize}
-\item \vb|\def\usestackstrut{T/F}|. This definition is fully replaced
-by the mode setting given by the \vb|\strutshortanchors{T/F}| macro.
-The new name is less ambiguous and the macro form is chosen vis-\`a-vis
-the \vb|\def| form, because the macro represents a \textbf{mode} of
-stack construction, rather than an argument parameter.
-
\item \vb|\bottominset| and \vb|\topinset|. These
macros are subsumed by the much more versatile \vb|\stackinset| macro.
The replacement offers insets relative to not only the top and bottom,
@@ -1465,6 +1465,8 @@ Definition, Mode, or Macro & \S\ Defined & \S\ Used\\
\ref{s:nsc}, \ref{s:mm}\\
\cmd{Lstackgap}&\ref{s:parms}&\ref{s:st}, \ref{s:stackeng}, \ref{s:bbl},
\ref{s:nsc}, \ref{s:bc}\\
+\cmd{lstackMath}&\ref{s:sm}&\\
+\cmd{lstackText}&\ref{s:sm}&\\
\cmd{parenVectorstack}&\ref{s:csvs}&\\
\cmd{quietstack}&\ref{s:parms}&\ref{s:stackeng}, \ref{s:qs}\\
\cmd{savestack}&\ref{s:ss}&\ref{s:sanc}, \ref{s:svs}, \ref{s:cae},