summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/acmart/acmart.dtx
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-12-20 03:00:48 +0000
committerNorbert Preining <norbert@preining.info>2019-12-20 03:00:48 +0000
commit18d9ec0eba21e6b8c55cdd50afb91c56e02ce7bf (patch)
tree56de5f55a6575a68557d5a384f57e3e8566c536d /macros/latex/contrib/acmart/acmart.dtx
parent3b24b0599bb35e1a3338fa33bfb24044a6125ba4 (diff)
CTAN sync 201912200300
Diffstat (limited to 'macros/latex/contrib/acmart/acmart.dtx')
-rw-r--r--macros/latex/contrib/acmart/acmart.dtx90
1 files changed, 77 insertions, 13 deletions
diff --git a/macros/latex/contrib/acmart/acmart.dtx b/macros/latex/contrib/acmart/acmart.dtx
index 3988394321..f659f3f668 100644
--- a/macros/latex/contrib/acmart/acmart.dtx
+++ b/macros/latex/contrib/acmart/acmart.dtx
@@ -112,7 +112,6 @@
% Enrico Gregorio,
% Jamie Davis,
% Peter Kemp,
-% Kerry A. Seitz, Jr.,
% Luis Leiva,
% Ben Liblit,
% Rholais Lii,
@@ -130,8 +129,11 @@
% Matteo Riondato,
% Craig Rodkin,
% Bernard Rous,
+% Feras Saad,
+% Kerry A. Seitz, Jr.,
% David Shamma,
% Gabriel Scherer,
+% Kartik Singhal,
% Stephen Spencer,
% Shin Hwei Tan,
% Daniel Thomas,
@@ -617,7 +619,7 @@
% copy, but they \emph{are} necessary since they are used by the XML
% metadata extraction programs. Do \emph{not} put commas or |\\|
% between the elements of \cs{affiliation}. They will be provided
-% automatically.
+% automatically.
%
%
% An example of the author block:
@@ -722,7 +724,7 @@
% 123456 Helm, Germany
% \end{verbatim}
%
-% Note that you should \emph{not} use this option for journals.
+% Note that you should \emph{not} use this option for journals.
%
% It is expected that these commands are inserted by the author of the
% manuscript.
@@ -754,7 +756,8 @@
% Moffett Field, California 94035.}
% \end{verbatim}
% You can \emph{suppress} printing authors' addresses by setting them
-% to an empty string: |\authorsaddresses{}|.
+% to an empty string: |\authorsaddresses{}|. Please note that
+% authors' addresses are mandatory for journal articles.
%
% \DescribeMacro{\titlenote}%
% \DescribeMacro{\subtitlenote}%
@@ -947,6 +950,10 @@
% You just need to copy this code and paste it in your paper anywhere
% before \verb|\maketitle|.
%
+% CCS Concepts and user-defined keywords are required for all articles
+% over two pages in length, and are optional for one- and two-page
+% articles (or abstracts).
+%
% \DescribeMacro{\setcopyright}
% There are several possibilities for the copyright of the papers
% published by the ACM: the authors may transfer the rights to the ACM,
@@ -1068,6 +1075,11 @@
% default settings. Setting |authorsperrow| to $0$ will revert it to the
% default settings.
%
+% The parameter |printacmref| specifies whether to print the ACM
+% bibliographic entry (default), or not. Note that this entry is
+% required for all articles over one page in length, and is optional
+% for one-page articles (abstracts).
+%
% \begin{table}
% \centering
% \caption{Settings for the \cs{settopmatter} command}
@@ -1830,7 +1842,7 @@
\ProvidesFile{acmart.dtx}
%</gobble>
%<class>\ProvidesClass{acmart}
-[2019/10/19 v1.65 Typesetting articles for the Association for Computing Machinery]
+[2019/12/18 v1.66 Typesetting articles for the Association for Computing Machinery]
% \end{macrocode}
%
% \changes{v1.00}{2016/04/14}{First released version}
@@ -1925,7 +1937,12 @@
% \changes{1.63a}{2019/08/05}{Move: TQUANT to TQC}
% \changes{1.64}{2019/08/17}{Putting abstract after \cs{maketitle} now
% causes an error}
-% \changes{1.65}{2019/10/19}{New journal: DGOV}
+% \changes{1.65}{2019/10/19}{New journal: DGOV}
+% \changes{1.66}{2019/12/18}{ACM reference format is now mandatory for
+% papers over one page; CCS concepts and keywords are now mandatory for
+% papers over two pages}
+% \changes{1.66}{2019/12/18}{Authors' addresses are mandatory for
+% journal articles}
%
% And the driver code:
% \begin{macrocode}
@@ -3176,7 +3193,10 @@
\ClassWarningNoLine{\@classname}{Some images may lack descriptions}\fi}
% \end{macrocode}
%
-% Hooks for figures and tables
+% Hooks for figures and tables. We also patch |algorithm| and
+% |algorithm*| in case somebody uses them.
+% \changes{v1.66}{2019/11/23}{Patching algorithm and algorithm*
+% to prevent spurious space warnings}
% \begin{macrocode}
\AtBeginEnvironment{figure}{\@Description@presentfalse
\let\@vspace\@vspace@orig
@@ -3194,6 +3214,11 @@
\let\@vspacer\@vspacer@orig}
\AtBeginEnvironment{table*}{\let\@vspace\@vspace@orig
\let\@vspacer\@vspacer@orig}
+\AtBeginEnvironment{algorithm}{\let\@vspace\@vspace@orig
+ \let\@vspacer\@vspacer@orig}
+\AtBeginEnvironment{algorithm*}{\let\@vspace\@vspace@orig
+ \let\@vspacer\@vspacer@orig}
+
% \end{macrocode}
%
%
@@ -4388,9 +4413,18 @@
% sense to keep them for compatibility.
% \begin{macrocode}
\def\keywords#1{\def\@keywords{#1}}
-\keywords{}
+\let\@keywords\@empty
% \end{macrocode}
%
+% \changes{1.66}{2019/12/18}{Added warning for missing keywords}
+% \begin{macrocode}
+\AtEndDocument{\if@ACM@nonacm\else\ifx\@keywords\@empty
+ \ifnum\getrefnumber{TotPages}>2\relax
+ \ClassWarningNoLine{\@classname}{ACM keywords are mandatory
+ for papers over two pages}%
+ \fi\fi\fi}
+% \end{macrocode}
+%
% \end{macro}
%
%
@@ -4448,6 +4482,15 @@
\fi}{\ClassError{\@classname}{The option printacmref can be either true or false}}
% \end{macrocode}
%
+% \changes{1.66}{2019/12/18}{Added warning for longer papers}
+% \begin{macrocode}
+\AtEndDocument{\if@ACM@nonacm\else\if@ACM@printacmref\else
+ \ifnum\getrefnumber{TotPages}>1\relax
+ \ClassWarningNoLine{\@classname}{ACM reference format is mandatory
+ for papers over one page}%
+ \fi\fi\fi}
+% \end{macrocode}
+%
% \end{macro}
%
% \begin{macro}{\if@ACM@printfolios}
@@ -4598,6 +4641,14 @@
\ccsdesc@parse@finish}
% \end{macrocode}
%
+% \changes{1.66}{2019/12/18}{Added warning for missing concepts}
+% \begin{macrocode}
+\AtEndDocument{\if@ACM@nonacm\else\ifx\@concepts\@empty\relax
+ \ifnum\getrefnumber{TotPages}>2\relax
+ \ClassWarningNoLine{\@classname}{CCS concepts are mandatory
+ for papers over two pages}%
+ \fi\fi\fi}
+% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\ccdesc@parse@finish}
@@ -4818,10 +4869,10 @@
source.
\or % usgovmixed
ACM acknowledges that this contribution was authored or co-authored
- by an employee, contractor, or affiliate of the United States government. As such,
- the United States government retains a nonexclusive, royalty-free right to
- publish or reproduce this article, or to allow others to do so, for
- government purposes only.
+ by an employee, contractor, or affiliate of the United States
+ government. As such, the United States government retains a
+ nonexclusive, royalty-free right to publish or reproduce this
+ article, or to allow others to do so, for government purposes only.
\or % cagov
This article was authored by employees of the Government of Canada.
As such, the Canadian government retains all interest in the
@@ -5142,9 +5193,13 @@
% \end{macro}
%
% \begin{macro}{\@specialsection}
+% \changes{v1.66}{2019/11/23}{Suppress warnings about \cs{vspace}}
% This macro starts sections for proceedings and uses \cs{small} for journals
% \begin{macrocode}
\def\@specialsection#1{%
+ \bgroup
+ \let\@vspace\@vspace@orig
+ \let\@vspacer\@vspacer@orig
\ifcase\ACM@format@nr
\relax % manuscript
\par\medskip\small\noindent#1: %
@@ -5164,7 +5219,8 @@
\section*{#1}%
\or % sigchi-a
\section*{#1}%
- \fi}
+ \fi
+ \egroup}
% \end{macrocode}
%
% \end{macro}
@@ -5858,6 +5914,14 @@
\egroup}
% \end{macrocode}
%
+% \changes{1.66}{2019/12/18}{Added warning for missing addresses}
+% \begin{macrocode}
+\AtEndDocument{\if@ACM@nonacm\else\if@ACM@journal
+ \ifx\@authorsaddresses\@empty
+ \ClassWarningNoLine{\@classname}{Authors'
+ addresses are mandatory for ACM journals}%
+ \fi\fi\fi}
+% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@setaddresses}