summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/asmejour/asmewide_example/asmewide.sty
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/asmejour/asmewide_example/asmewide.sty')
-rw-r--r--macros/latex/contrib/asmejour/asmewide_example/asmewide.sty23
1 files changed, 16 insertions, 7 deletions
diff --git a/macros/latex/contrib/asmejour/asmewide_example/asmewide.sty b/macros/latex/contrib/asmejour/asmewide_example/asmewide.sty
index b0c9a481f2..949da71852 100644
--- a/macros/latex/contrib/asmejour/asmewide_example/asmewide.sty
+++ b/macros/latex/contrib/asmejour/asmewide_example/asmewide.sty
@@ -1,7 +1,7 @@
%%
-%% This file is `asmewide.sty'.
+%% This file is `asmewide.sty'.
%%
-%% Copyright (c) 2022 John H. Lienhard. Use under the MIT license: https://ctan.org/license/mit
+%% Copyright (c) 2022 John H. Lienhard. Use under the MIT license: https://ctan.org/license/mit
%%
%% Defines a widetext environment within ASME dimensions
%% Use for material spanning both columns (i.e., for wide equations)
@@ -12,23 +12,32 @@
%% The modifications made were: follow ASME dimensions; remove revtex-specific macros; update/rework commands; adapt to most recent cuted.sty
%% (Leaders don't vanish at pagebreaks, as in revtex, evidently related to how cuted.sty handles strip construction. Have coded around this.)
%%
-%% Required packages: cuted.sty v2.0 and flushend.sty v4.0 [2021/10/04] or later; asmeconf.cls w/its required packages, esp. etoolbox, xparse
+%% Required packages: cuted.sty v2.0 and flushend.sty v4.0 [2021/10/04] or later; asmeconf.cls or asmejour.cls w/their required packages, esp. etoolbox, xparse
%%
-%% The widetext environment can only appear once per page. It clashes with floats and footnotes, requiring some hand-fitting of page layouts.
+%% The widetext environment can only appear once per page. It clashes with floats and footnotes, and often requires some hand-fitting of page layouts.
%%
%% USAGE: * \begin{widetext} ...wide material here... \end{widetext}
%% OPTIONAL ARGUMENTS:
%% * \begin{widetext[N] .. changes upper/lower separation of wide material from default Xpt to Npt (X = 5pt asmeconf.cls; X = 10pt asmejour.cls)
%% * \begin{widetext}[][tbn]: t = top line only; b = bottom line only; n = no lines. BOTH arguments are REQUIRED, even if first is left empty.
%%
+%% asmewide,sty supports one option, [raggedend], which suppresses final page column balancing: \usepackage[raggedend]{asmewide}
+%% NB: remove the option [balance] when using [raggedend]!
+%%
%% NB: the strip environment from cuted is incompatible with the [lineno] option to asmeconf and asmejour!
%%
\NeedsTeXFormat{LaTeX2e}
-\def\AW@versionno{1.0}
-\def\AW@versiondate{2021/12/26\space}
+\def\AW@versionno{1.1}
+\def\AW@versiondate{2022/06/26\space}
\ProvidesPackage{asmewide}[\AW@versiondate\space v\AW@versionno\space ASME wide equation environment (JHL)]
+\DeclareOption{raggedend}{% Added 2022/05/08, to suppressed flushend on last page, if desired
+ \AfterEndPreamble{\raggedend}
+}
+\DeclareOption*{}
+\ProcessOptions \relax
+
\ifdefined\NewDocumentCommand\else
\RequirePackage{xparse}
\fi
@@ -37,7 +46,7 @@
\@ifpackagelater{cuted}{2021/10/04}{%
\relax
}{%
- \PackageError{asmewide}{Your version of cuted.sty is too old. You can get an update at https://ctan.org/pkg/cuted}{You need an up-to-date version of cuted.sty to run asmewide.sty.}%
+ \PackageError{asmewide}{The asmewide package has detected that the version of cuted.sty you are using is too old to be compatible. You can get an update at https://ctan.org/pkg/sttools}{You need at least v2.0 of cuted.sty to run asmewide.sty. Without it, you will get more errors. See discussion of installation process here: https://github.com/John02139/asmeconf/issues/4}%
}
\RequirePackage{flushend}[2021/10/04]