summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2013-10-23 00:14:07 +0000
committerKarl Berry <karl@freefriends.org>2013-10-23 00:14:07 +0000
commit0c0b57a76b4561bfcff9ec1e1eef04913d4f11a6 (patch)
treeccc0c0fa0b34ff8c1575d0aa992043c5a2243238
parentfc758c5bbb7666b9ac752029277d61adeeaff056 (diff)
stackengine (21oct13)
git-svn-id: svn://tug.org/texlive/trunk@31967 c570f23f-e606-0410-a88d-b1316a301751
-rw-r--r--Master/texmf-dist/doc/latex/stackengine/stackengine.pdfbin347693 -> 376590 bytes
-rw-r--r--Master/texmf-dist/doc/latex/stackengine/stackengine.tex40
2 files changed, 23 insertions, 17 deletions
diff --git a/Master/texmf-dist/doc/latex/stackengine/stackengine.pdf b/Master/texmf-dist/doc/latex/stackengine/stackengine.pdf
index 5cec2173a35..6ede5bb37a7 100644
--- a/Master/texmf-dist/doc/latex/stackengine/stackengine.pdf
+++ b/Master/texmf-dist/doc/latex/stackengine/stackengine.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/stackengine/stackengine.tex b/Master/texmf-dist/doc/latex/stackengine/stackengine.tex
index 89944774684..b46c362923f 100644
--- a/Master/texmf-dist/doc/latex/stackengine/stackengine.tex
+++ b/Master/texmf-dist/doc/latex/stackengine/stackengine.tex
@@ -34,16 +34,18 @@ baseline changes, \textit{etc.}\\
\rule{0em}{2.7em}\large Steven B. Segletes\\
steven.b.segletes.civ@mail.mil\\
\rule{0em}{1.7em}\today\\
-\stackengineversionnumber
+\stackengineversionnumber a%
+\footnote{V3.21a alters only the documentation. V3.21 of
+\textsf{stackengine.sty} is still current.}% THE "a" IS FOR V3.21 ONLY
+% TO DENOTE DOCUMENTATION CHANGES ONLY
\end{center}
%\tableofcontents
\sffamily%
-A sectional index for this package is found in \S\ref{s:index}.
+New! A sectional index for this package is found in \S\ref{s:index}.
-Note: A syntax change in version 2.0 may require minor changes in your
-existing V1.0 stackengine code. See \S\ref{s:bc} for details.
+Note: See \S\ref{s:bc} for details on a small syntax change in V2.0.
\rmfamily%
\section{Definitions and Terms}
@@ -191,7 +193,7 @@ of \vb|\stacktype| and will output either \vb|\Sstackgap| or
``S'' (short) or ``L'' (long).
In addition to these lengths, there are several parameter definitions
-that define default behaviors for those stacking macros when explict
+that define default behaviors for those stacking macros when explicit
values of these settings are not requested. The parameters, each set
with a \vb|\def| (or a \vb|\renewcommand|), are
@@ -209,7 +211,7 @@ more discussion of this parameter.
The parameter \vb|\quietstack| \margcmd{quietstack}defaults to ``F''
(false) and determines whether the result of a stacking operation is
-supressed from the output. If the output is suppressed by setting this
+suppressed from the output. If the output is suppressed by setting this
parameter to ``T'', the most recent stacking operation may be recovered
with a \vb|\usebox{\stackedbox}|. See \S\ref{s:qs} for more discussion
of this parameter.
@@ -264,8 +266,8 @@ flush with the top and bottom of the stack. The \vb|\addstackgap|
macro (\S\ref{s:asg}) is one way to add a buffer space above and below a stack.
Such an approach makes more sense for short stacks, where a constant
buffer size determines the gap between objects. But for long stacks, a
-method invoving \vb|\strut|'s makes more sense. The mode
-\vb|\strutlongstacks|
+method involving \vb|\strut|'s makes more sense. The mode
+\vb|\strutlongstacks|%
\margcmd{strutlongstacks}, when set true (\vb|T|), will automatically
cause {\ste} to condition each row of a long stack with a \vb|\strut|
during its construction (see \S\ref{s:ag} for more details).
@@ -277,18 +279,18 @@ By default true (\vb|T|), a split short-stack anchor is set so that the
middle of the stack gap falls halfway up the height of the \vb|\strut|.
This will give the short-stack anchor the appearance of being split
relative to text that sits atop the baseline. When set false, however,
-any short-stack anchor that is constucted has its gap split across the
+any short-stack anchor that is constructed has its gap split across the
baseline itself.
Until V3.1 of \ste, the \vb|\Longstack|, \vb|\Shortstack|,
\vb|\Longunderstack|, and \vb|\Shortunderstack| macros used,
-exclusively, space tokens as the end-of-line seperators between
+exclusively, space tokens as the end-of-line separators between
rows of these stacks. Not only is such a syntax atypical of \LaTeX{},
but it can be inconvenient when the items within a stack row
also contain spaces. The \vb|\setstackEOL|
\margcmd{setstackEOL}macro allows the end-of-line (EOL)
character to be defined to a more convenient setting, such as \vb|\\|,
-though any charcter will work. There is a package option
+though any character will work. There is a package option
\vb|[usestackEOL]| \margtt{[usestackEOL]\rmfamily\\\raggedleft package
option} which sets the end-of-line symbol to be used when parsing stack
arguments to \vb|\\|. When the stacking EOL is something other than a
@@ -759,7 +761,7 @@ these items below:
The macro \vb|\savestack| provides a means to save an intermediate
result (in a box that can be recalled with the specified macro) without
-printing it. It's syntax is
+printing it. Its syntax is
\itshape
\vb|\savestack{|macro token\vb|}{|stacking operation\vb|}|
@@ -782,9 +784,9 @@ later be recalled with an invocation of \vb|\mymacro|, to yield
There are times where one needs to make a stack in several consecutive
steps. In order to do so, there are several ways, detailed below.
-\subsection{Supressing Output\label{s:qs}}
+\subsection{Suppressing Output\label{s:qs}}
-One can define \vb|\quietstack| as \vb|T| to supress output. Then, the
+One can define \vb|\quietstack| as \vb|T| to suppress output. Then, the
intermediate stack can be passed as an argument to the next stacking
operation with a \vb|\usebox{\stackedbox}|. That same \vb|\usebox|
may be used to output the final stack, as long as \vb|\quietstack|
@@ -797,7 +799,7 @@ Perhaps a quicker and better way is to use the package's
\vb|\savestack| macro, of the form
\itshape\vb|\savestack{|macro token\vb|}{|stacking operation\vb|}|
\upshape. This will perform the stacking operation and place it into
-the supplied token (without printing it), so that ths intermediate stack
+the supplied token (without printing it), so that the intermediate stack
can be passed to the subsequent stacking operation by executing the
token macro.
@@ -1004,7 +1006,7 @@ Short stacktype\rl\rl\belowbaseline[0pt]{\fbox{0pt below baseline}}%
\rl\belowbaseline{\fbox{6pt}}\rl\belowbaseline[-6pt]{\fbox{-6pt}}\rl\rl
\normalsize
-When used in with a \vb|\stacktpe| ``L'', the optional length denotes
+When used with \vb|\stacktype| ``L'', the optional length denotes
the distance to the baseline of the understacked object (default
\vb|\Lstackgap|).
@@ -1202,7 +1204,7 @@ understack macros are set up to conveniently stack multiple objects
using a space separated argument list. Because of parsing constraints
on the space-separated list, however (see \S\ref{s:mm}), there may be
times that you would prefer building stacks by way of nesting the more
-primative stacking macros.
+primitive stacking macros.
Nesting can be accomplished, but some care must be taken, in the case of
long stacks. But first, let us see the ways in which nesting may be
@@ -1423,6 +1425,10 @@ expansion in certain situations:\\
\vb|http://tex.stackexchange.com/questions/131581/|\\
\vb|parsing-rows-and-tab-characters/131594#131594|
+Finally, I extend my thanks to Per Starb\"ack, for
+his unsolicited but gratefully accepted edit of the V3.21
+package documentation, which corrected numerous typographical errors.
+
\section{Sectional index of \textsf{stackengine} definitions, modes,
\& macros\label{s:index}}