chiark / gitweb /
slowbox.dtx: Mention that `\newslowboxenv' handles optional args correctly.
[mdwtools] / slowbox.dtx
index bf031bacccf1efd02a535cea5129b14ca176a649..c910cd9ca8ea15229014359b31cab85feff8333e 100644 (file)
 % \syntax{"\\newslowboxenv{"<env-name>"}"\* "["<n-args>"]"\*
 % "{"<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>"}"\*