slowbox.dtx: Reword `\newslowboxenv' description for better line breaks.

[mdwtools] / slowbox.dtx

diff --git a/slowbox.dtx b/slowbox.dtx
index ae32bbf..f4b71a7 100644 (file)
--- a/slowbox.dtx
+++ b/slowbox.dtx
@@ -17,12 +17,12 @@
 %% it under the terms of the GNU General Public License as published by
 %% the Free Software Foundation; either version 2 of the License, or
 %% (at your option) any later version.
-%% 
+%%
 %% This program is distributed in the hope that it will be useful,
 %% but WITHOUT ANY WARRANTY; without even the implied warranty of
 %% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 %% GNU General Public License for more details.
-%% 
+%%
 %% You should have received a copy of the GNU General Public License
 %% along with this program; if not, write to the Free Software Foundation,
 %% Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
@@ -58,7 +58,6 @@
 \input{mdwtools}
 \describespackage{slowbox}
 \newcommand\opt[1]{\textsf{#1}}
-\expandafter\def\csname sb@box:tag\endcsname{{2cm}{1cm}{0.5cm}}
 \def\*{\hspace{0pt plus 0.1pt}\ignorespaces}
 \mdwdoc
 %</driver>
@@ -83,7 +82,7 @@
 % mode, everything happens normally; in \opt{hide} mode, slow  boxes are
 % replaced by frames.  In order for the package to know the sizes of all of
 % your boxes, you must first run through once in \opt{show} mode.
-% Thereafter, all should be well. 
+% Thereafter, all should be well.
 %
 % \DescribeEnv{slowbox}
 % In \opt{show} mode, the \env{slowbox} environment typesets its contents in
@@ -118,28 +117,31 @@
 % boxes.  Often, though, what happens is that you want to put some stuff
 % \emph{inside} the slow box, but that doesn't work properly.  What you must
 % do instead is say something like
-% \begin{verbatim}
+%\begin{verbatim}
 %   \newenvironment{splunt}[1]
 %     {...\slowboxbegin{#1}{...\startsplunt...}}
 %     {\slowboxend{...\finishsplunt...}...}
-% \end{verbatim}
-% That is, \syntax{"\\slowboxbegin{"<tag>"}{{"<stuff>"}"} starts a slow box,
-% beginning with \<stuff> if we're in \opt{show} mode.
+%\end{verbatim}
+% That is, \syntax{"\\slowboxbegin{"<tag>"}{"<stuff>"}"} starts a slow box,
+% beginning with \<stuff> if we're in \opt{show} mode; and
+% \syntax{"\\slowboxend{"<stuff>"}"} finishes it, ending with \<stuff>.
 %
 % The |\slowboxbegin| command has a |*|-variant, which causes the box to be
 % typeset regardless of the current mode setting.
 %
 % \DescribeMacro\newslowboxenv
-% There's an environment for building slow box environments.  Say
-% \syntax{"\\newslowboxenv{"<env-name>"}"\* "["<n-args>"]"\*
+% Plumbing all of this together is rather tedious, so there's also a
+% command for building slow box environments.  Say
+% \syntax{"\\newslowboxenv{"<env-name>"}"\* "["<n-args>"]"\*"["<default>"]"\*
 % "{"<before-text>"}"\* "{"<start-text>"}"\* "{"<end-text>"}"\*
 % "{"<after-text>"}"}. This creates a new environment (just like with
-% |\newenvironment|).  The contents are put in a slow box with \<start-text>
-% on the front and \<end-text> on the end.  Before the box is begun,
-% \<before-text> is performed, and \<after-text> is done afterwards.  The
-% environments so created have \env{$*$}-variants which ignore the current
-% mode, just like \env{slowbox$*$}.  They also gather an additional \<tag>
-% argument, which you don't have to bother with. 
+% |\newenvironment|, taking \<n-args> arguments, maybe with the first one
+% optional and defaulting to \<default>).  The contents are put in a slow box
+% with \<start-text> on the front and \<end-text> on the end.  Before the box
+% is begun, \<before-text> is performed, and \<after-text> is done
+% afterwards.  The environments so created have \env{$*$}-variants which
+% ignore the current mode, just like \env{slowbox$*$}.  They also gather an
+% additional \<tag> argument, which you don't have to bother with.
 %
 % \DescribeMacro\doslowbox
 % Finally, for commands, there's \syntax{"\\doslowbox{"<tag>"}"\*
@@ -282,7 +284,7 @@
 }
 \def\sb@hidden@i#1#2#3#4{%
   \frameonly{#1}{#2}{#3}{Omitted \texttt{#4}}%
-  \immediate\write\@auxout{\string\sb@def{#4}{#1}{#2}{#3}}%  
+  \immediate\write\@auxout{\string\sb@def{#4}{#1}{#2}{#3}}%
 }
 %    \end{macrocode}
 % \end{macro}
@@ -315,7 +317,7 @@
   }%
   \dimen@#3\advance\dimen@-\dp\z@%
   \setbox\z@\hbox{\lower\dimen@\box\z@}%
-  \leavevmode\box\z@%  
+  \leavevmode\box\z@%
 }
 %    \end{macrocode}
 % \end{macro}
@@ -372,4 +374,4 @@
 %    \end{macrocode}
 %
 % \Finale
-\endinput
\ No newline at end of file
+\endinput