summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/acmart/acmart.dtx
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2022-02-07 03:03:44 +0000
committerNorbert Preining <norbert@preining.info>2022-02-07 03:03:44 +0000
commitf689c91581665257602a841d03f73078c3495e14 (patch)
tree09c55c606b43f4f53c4c8f9e09625813e19fb2b0 /macros/latex/contrib/acmart/acmart.dtx
parent350b3e35109171f0edd6fe9d697b91d5e76561f9 (diff)
CTAN sync 202202070303
Diffstat (limited to 'macros/latex/contrib/acmart/acmart.dtx')
-rw-r--r--macros/latex/contrib/acmart/acmart.dtx183
1 files changed, 114 insertions, 69 deletions
diff --git a/macros/latex/contrib/acmart/acmart.dtx b/macros/latex/contrib/acmart/acmart.dtx
index 5ae318c715..0940dc856d 100644
--- a/macros/latex/contrib/acmart/acmart.dtx
+++ b/macros/latex/contrib/acmart/acmart.dtx
@@ -103,6 +103,7 @@
% Dirk Beyer,
% Andrew Black,
% Joachim Breitner,
+% Yegor Bugayenko,
% Benjamin Byholm,
% John Collins,
% Nils Anders Danielsson,
@@ -299,7 +300,7 @@
% \normalfont Value & Meaning\\
% \midrule
% manuscript & A manuscript. This is the default. \\
-% acmsmall & Small single-column format. Used for CIE, CSUR,
+% acmsmall & Small single-column format. Used for CIE, CSUR,
% DLT, FAC, JACM, JDIQ, JEA, JERIC,
% JETC, PACMCGIT, PACMHCI, PACMPL, TAAS, TACCESS, TACO,
% TALG, TALLIP (formerly TALIP), TCPS, TDS,
@@ -325,7 +326,7 @@
% SIGCHI conferences now use |sigconf| format for their publications.
% If a file uses |sigchi| format, a warning is issued, and the format
% is automatically switched to |sigconf|. Format |sigchi-a| can be
-% used for non-ACM documents only (see Section~\ref{sec:sigchi-a}).
+% used for non-ACM documents only (see Section~\ref{sec:sigchi-a}).
%
% There are several Boolean options that can take |true| or |false|
% values. They are listed in Table~\ref{tab:opts_bool}. The words
@@ -340,7 +341,7 @@
%
% Two samples in the |samples| directory, |manuscript| and
% |acmsmall-submission|, show manuscripts formatted for submission to
-% ACM.
+% ACM.
%
% The default for the option |screen| depends on the publication. At
% present it is |false| for all publications \emph{but} PACM, since
@@ -414,7 +415,7 @@
% mode\\
% pbalance & false & Whether to balance the last page in two column
% mode using pbalance package\\
-% urlbreakonhyphens & true & Whether to break urls on hyphens\\
+% urlbreakonhyphens & true & Whether to break urls on hyphens\\
% \bottomrule
% \end{tabularx}
% \end{table}
@@ -492,7 +493,7 @@
% formatting. In the samples directory there is a file
% |sample-acmsmall-conf.tex| with the example of this usage.
%
-%
+%
%
% \DescribeMacro{\editor}%
% In most cases, conference proceedings are edited. You can use the
@@ -749,7 +750,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.
@@ -782,7 +783,7 @@
% \end{verbatim}
% You can \emph{suppress} printing authors' addresses by setting them
% to an empty string: |\authorsaddresses{}|. Please note that
-% authors' addresses are mandatory for journal articles.
+% authors' addresses are mandatory for journal articles.
%
% \DescribeMacro{\titlenote}%
% \DescribeMacro{\subtitlenote}%
@@ -976,7 +977,7 @@
%
% 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).
+% articles (or abstracts).
%
% \DescribeMacro{\setcopyright}
% There are several possibilities for the copyright of the papers
@@ -987,7 +988,7 @@
% copyright status of the paper, for example,
% \verb|\setcopyright{acmcopyright}|. The possible values for this
% command are listed in Table~\ref{tab:setcopyright}. This command
-% must be placed in the preamble, before |\begin{document}|.
+% must be placed in the preamble, before |\begin{document}|.
%
% \begin{table}
% \centering
@@ -1102,7 +1103,7 @@
% 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).
+% for one-page articles (abstracts).
%
% \begin{table}
% \centering
@@ -1269,7 +1270,7 @@
% \end{figure}
% \end{verbatim}
% At present the lack of descriptions generates a warning at
-% compilation.
+% compilation.
%
%\subsection{Theorems}
%\label{sec:ug_theorems}
@@ -1294,6 +1295,17 @@
% defined, the option |acmthm=false| in the preamble will suppress
% them.
%
+% Sometimes authors want to define new theorem-like constructs that
+% use |theorem| counters. These constructs must be defined either after
+% |\begin{document}|, or delayed using \cs{AtEndPreamble} macro,
+% for example,
+% \begin{verbatim}
+% \AtEndPreamble{%
+% \theoremstyle{acmdefinition}
+% \newtheorem{remark}[theorem]{Remark}}
+% \end{verbatim}
+%
+%
%\subsection{Online-only and offline-only material}
%\label{sec:ug_screen}
%
@@ -1340,6 +1352,16 @@
% |\begin{anonsuppress}| and |\end{anonsuppress}| should start on a
% line of their own with no leading or trailing spaces.
%
+% \DescribeMacro{\anon}%
+% To suppress short snippets of information, use the command
+% \cs{anon}\oarg{substitute}\marg{suppressed-text}. By default
+% \oarg{substitute} is the word ANONYMOUS. Examples:
+% \begin{verbatim}
+% This work was performed at \anon{NSA}.
+% This work was performed at \anon[No Such Agency]{NSA}.
+% \end{verbatim}
+%
+%
%\subsection{Acknowledgments}
%\label{sec:ug_acks}
%
@@ -1459,7 +1481,7 @@
% \end{verbatim}
% Normally the printing of URL is suppressed if DOI is present.
% However, there is a special field \path{distinctURL}. If it is
-% present and is not zero, URL is printed even if DOI is present.
+% present and is not zero, URL is printed even if DOI is present.
%
%
% The style supports the arXiv-recommended fields \path{eprint} and
@@ -1482,7 +1504,7 @@
% lastaccessed = "March 2, 2005",
% }
% \end{verbatim}
-% Entry types \path{artifactsoftware}, \path{artifactdataset}
+% Entry types \path{artifactsoftware}, \path{artifactdataset}
% (with synonyms \path{software} and \path{dataset}) can be used to
% cite software artifacts and datasets, for example,
% \begin{verbatim}
@@ -1503,11 +1525,11 @@
% lastaccessed = {May 27, 2019}
% }
% \end{verbatim}
-%
+%
%
% For these entry types you can use the \path{lastaccessed} field to add
% the access date for the URL.
-%
+%
%
%
% There are two ways to enter video or audio sources in the
@@ -1600,8 +1622,8 @@
% The current bst style defines a number of macros for common journal
% names. In particular, all journals listed in Table~\ref{tab:pubs}
% are includes, so you can use strings like |journal = taccess| for
-% \emph{ACM Transactions on Accessible Computing}.
-%
+% \emph{ACM Transactions on Accessible Computing}.
+%
%
%\subsection{Colors}
%\label{sec:ug_colors}
@@ -1711,7 +1733,7 @@
% The script |texcount| provides a report of word count in the
% document.
%
-%
+%
%
%
%\subsection{Disabled or forbidden commands}
@@ -1782,7 +1804,7 @@
% \begin{verbatim}
% \AtBeginMaketitle{\acmPrice{125.00}}
% \end{verbatim}
-%
+%
%
%\subsection{Currently supported publications}
%\label{sec:pubs}
@@ -1806,7 +1828,7 @@
% \endfoot
% CIE & ACM Computers in Entertainment \\
% CSUR & ACM Computing Surveys\\
-% DLT & Distributed Ledger Technologies: Research and Practice\\
+% DLT & Distributed Ledger Technologies: Research and Practice\\
% DGOV & Digital Government: Research and Practice \\
% DTRAP & Digital Threats: Research and Practice\\
% FAC & Formal Aspects of Computing \\
@@ -1876,7 +1898,7 @@
%
% Besides the publications listed in Table~\ref{tab:pubs}, there is a
% special ``publication'' type FACMP, a forthcoming ACM publication,
-% reserved for new journals which are not assigned an ISSN yet.
+% reserved for new journals which are not assigned an ISSN yet.
%
%
%\subsection{A note about \texttt{sigchi-a} format}
@@ -1892,7 +1914,7 @@
% \documentclass[sigchi-a, nonacm]{acmart}
% \end{verbatim}
%
-%
+%
%
% \DescribeEnv{sidebar}%
% \DescribeEnv{marginfigure}%
@@ -1909,7 +1931,7 @@
% The environments |figure| and |table| produce figures and tables
% with the width of the text column. The environments |figure*| and
% |table*| produce ``wide'' figures and tables, which take a large
-% part of the margin.
+% part of the margin.
%
% The horizontal sizes of figures are:
% \begin{enumerate}
@@ -1917,8 +1939,8 @@
% \item |marginfigure|: \cs{marginparwidth},
% \item |figure*|: \cs{fulltextwidth}.
% \end{enumerate}
-%
-%
+%
+%
%
% \StopEventually{
% \clearpage
@@ -1943,7 +1965,7 @@
\ProvidesFile{acmart.dtx}
%</gobble>
%<class>\ProvidesClass{acmart}
-[2021/12/05 v1.81 Typesetting articles for the Association for Computing Machinery]
+[2022/02/05 v1.82 Typesetting articles for the Association for Computing Machinery]
% \end{macrocode}
%
% \changes{v1.00}{2016/04/14}{First released version}
@@ -2030,11 +2052,11 @@
% \changes{1.57}{2018/12/16}{Booktabs package is now the default}
% \changes{1.58}{2019/02/09}{Changes in samples (Enrico Gregorio)}
% \changes{1.58}{2019/03/29}{New journal: HEALTH. TDS is renamed to
-% TDSCI}
+% TDSCI}
% \changes{1.60}{2019/04/22}{New option: urlbreakonhyphens}
% \changes{1.62}{2019/07/31}{New journal: TELO}
% \changes{1.63}{2019/08/04}{New journal: TQUANT}
-% \changes{1.63}{2019/08/04}{New journal: FACMP}
+% \changes{1.63}{2019/08/04}{New journal: FACMP}
% \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}
@@ -2104,8 +2126,8 @@
% \begin{macrocode}
\RequirePackage{iftex}
% \end{macrocode}
-%
-%
+%
+%
%
% \begin{macro}{format}
% The possible formats
@@ -2147,7 +2169,7 @@
% \end{macro}
%
% \begin{macro}{\if@ACM@urlbreakonhyphens}
-% \changes{1.60}{2019/04/22}{introduced macro}
+% \changes{1.60}{2019/04/22}{introduced macro}
% \begin{macrocode}
\define@boolkey+{acmart.cls}[@ACM@]{urlbreakonhyphens}[true]{%
\if@ACM@urlbreakonhyphens
@@ -2241,7 +2263,7 @@
false}}
\ExecuteOptionsX{balance}
% \end{macrocode}
-%
+%
% \end{macro}
%
%
@@ -2254,9 +2276,9 @@
false}}
\ExecuteOptionsX{pbalance=false}
% \end{macrocode}
-%
+%
% \end{macro}
-%
+%
%
% \begin{macro}{\if@ACM@natbib@override}
% \changes{v1.12}{2016/05/30}{Added macro}
@@ -2386,7 +2408,7 @@
% \begin{macrocode}
\newif\if@ACM@journal@bibstrip
% \end{macrocode}
-%
+%
% \end{macro}
%
% \begin{macro}{\if@ACM@sigchiamode}
@@ -2508,7 +2530,7 @@
% \begin{macrocode}
\RequirePackage{booktabs}
% \end{macrocode}
-%
+%
%
% We need |totpages| to calculate the number of pages and
% |refcount| to use that number
@@ -2883,13 +2905,13 @@
% Adding |hyperxmp|
% \changes{v1.72}{2020/06/14}{Added hyperxmp}
% \changes{v1.76}{2021/02/21}{Moved before hyperref, see
-% https://github.com/borisveytsman/acmart/issues/425}
+% https://github.com/borisveytsman/acmart/issues/425}
% \begin{macrocode}
\RequirePackage{hyperxmp}
% \end{macrocode}
-%
%
-% And now, |hyperref|
+%
+% And now, |hyperref|
% \changes{v1.28}{2017/01/07}{Got rid of warnings in pdf keywords}
% \changes{v1.46}{2017/08/25}{Delayed hypersetup since journal options
% may change screen mode}
@@ -3023,7 +3045,7 @@
Legacy document. \\
Not for publication in an ACM venue}}
\fi
- \fi
+ \fi
\fi
% \end{macrocode}
%
@@ -3415,7 +3437,7 @@
\let\@vspacer\@vspacer@orig}
% \end{macrocode}
-%
+%
%
%\subsection{Floats}
%\label{sec:floats}
@@ -3700,7 +3722,7 @@
\newif\if@ACM@maketitle@typeset
\@ACM@maketitle@typesetfalse
% \end{macrocode}
-%
+%
% \end{macro}
%
% \changes{v1.24}{2016/11/16}{Add IMWUT journal option}
@@ -3713,6 +3735,8 @@
% \changes{1.70}{2020/02/22}{Name change for TDS}
% \changes{1.79}{2021/08/29}{Updated indormation for TAP, TCPS, TEAC}
% \changes{1.80}{2021/09/24}{Added DLT and FAC}
+% \changes{1.82}{2022/02/05}{Updated abbreviations and codes for
+% several journals}
%
% We use the |xkeyval| interface to define journal titles and the relevant
% information
@@ -3807,6 +3831,7 @@
\def\@journalName{Formal Aspects of Computing}%
\def\@journalNameShort{Form. Asp. Comput.}%
\def\@permissionCodeOne{0934-5043}%
+ \def\@permissionCodeTwo{1433-299X}%
\or % HEALTH
\def\@journalName{ACM Transactions on Computing for Healthcare}%
\def\@journalNameShort{ACM Trans. Comput. Healthcare}%
@@ -3876,6 +3901,8 @@
\or % TACO
\def\@journalName{ACM Transactions on Architecture and Code Optimization}%
\def\@journalNameShort{ACM Trans. Arch. Code Optim.}%
+ \def\@permissionCodeOne{1544-3566}%
+ \def\@permissionCodeTwo{1544-3973}%
\or % TALG
\def\@journalName{ACM Transactions on Algorithms}%
\def\@journalNameShort{ACM Trans. Algor.}%
@@ -3970,6 +3997,7 @@
\def\@permissionCodeOne{0730-0301}
\or % TOIS
\def\@journalName{ACM Transactions on Information Systems}%
+ \def\@journalNameShort{ACM Trans. Inf. Syst.}%
\def\@permissionCodeOne{1046-8188}%
\or % TOIT
\def\@journalName{ACM Transactions on Internet Technology}%
@@ -3978,6 +4006,8 @@
\or % TOMACS
\def\@journalName{ACM Transactions on Modeling and Computer Simulation}%
\def\@journalNameShort{ACM Trans. Model. Comput. Simul.}%
+ \def\@permissionCodeOne{1049-3301}%
+ \def\@permissionCodeTwo{1558-1195}%
\or % TOMM
\def\@journalName{ACM Transactions on Multimedia Computing, Communications and Applications}%
\def\@journalNameShort{ACM Trans. Multimedia Comput. Commun. Appl.}%
@@ -4081,7 +4111,7 @@
\ifx\acmConference@shortname\@empty
\gdef\acmConference@shortname{#2}%
\fi
- \global\@ACM@journal@bibstripfalse
+ \global\@ACM@journal@bibstripfalse
}
\if@ACM@journal\else
\acmConference[Conference'17]{ACM Conference}{July 2017}{Washington,
@@ -4103,7 +4133,7 @@
\acmBooktitle{Proceedings of \acmConference@name
\ifx\acmConference@name\acmConference@shortname\else
\ (\acmConference@shortname)\fi}
-\fi
+\fi
% \end{macrocode}
%
% \end{macro}
@@ -4199,7 +4229,7 @@
% entered. The trick is based on the idea that |\csname...\endcsname|
% is \cs{relax} unless defined. Therefore we typeset authors by the
% special macro |\csname typeset@author\the\num@authors\endcsname|,
-% which is defined by \cs{orcid} command.
+% which is defined by \cs{orcid} command.
% \begin{macrocode}
\renewcommand\author[2][]{%
\IfSubStr{\detokenize{#2}}{,}{\ClassWarning{\@classname}{Do not put several
@@ -4339,7 +4369,7 @@
\href{#1}{##1}}}{%
\expandafter\gdef\csname
typeset@author\the\num@authors\endcsname##1{%
- \href{https://orcid.org/#1}{##1}}}}
+ \href{https://orcid.org/#1}{##1}}}}
% \end{macrocode}
%
% \end{macro}
@@ -4662,7 +4692,7 @@
for papers over two pages}%
\fi\fi\fi}
% \end{macrocode}
-%
+%
% \end{macro}
%
%
@@ -5249,6 +5279,21 @@
%
% \end{macro}
%
+% \begin{macro}{\anon}
+% \changes{v1.82}{2022/01/11}{Introduced macro}%
+% We provide \cs{anon} command, which blinds parts of the text
+% if the package option |anonymous| is set
+% \begin{macrocode}
+\newcommand{\anon}[2][ANONYMIZED]{%
+ \if@ACM@anonymous%
+ {\color{ACMOrange}#1}%
+ \else%
+ #2%
+ \fi}
+% \end{macrocode}
+%
+% \end{macro}
+%
%
%\subsection{Maketitle hook}
%\label{sec:hook}
@@ -5320,9 +5365,9 @@
% \changes{v1.64}{2019/08/17}{Added a switch setting to show that
% \cs{maketitle} is typeset}
% \changes{v1.72}{2020/06/14}{Do not andify authors for pdf metadata
-% (Scott Pakin)}
+% (Scott Pakin)}
% \changes{v1.73}{2020/09/07}{Do not check again the presense of
-% address fields}
+% address fields}
% \changes{v1.75}{2020/11/15}{Added \cs{@beginmaketitlehook}}
% \changes{v1.76}{2021/04/05}{Put \cs{par} inside group for keywords}
% The (in)famous \cs{maketitle}. Note that in |sigchi-a| mode, authors
@@ -5502,7 +5547,7 @@
\section*{#1}%
\fi
\let\@vspace\@vspace@acm
- \let\@vspacer\@vspacer@acm
+ \let\@vspacer\@vspacer@acm
}
% \end{macrocode}
%
@@ -5530,7 +5575,7 @@
\@tempdima=\ht\mktitle@bx
\advance\@tempdima by \dp\mktitle@bx
\ifdim\@tempdima>0.9\textheight
- \loop
+ \loop
\setbox\@tempboxa=\vsplit \mktitle@bx to 0.9\textheight
\thispagestyle{firstpagestyle}%
\noindent\unvbox\@tempboxa
@@ -5967,7 +6012,7 @@
\newif\if@ACM@instpresent
\@ACM@instpresenttrue
% \end{macrocode}
-%
+%
% \end{macro}
%
%
@@ -5978,7 +6023,7 @@
\newif\if@ACM@citypresent
\@ACM@citypresenttrue
% \end{macrocode}
-%
+%
% \end{macro}
% \begin{macro}{\if@ACM@countrypresent}
% \changes{v1.73}{2020/09/07}{Added macro}
@@ -5987,9 +6032,9 @@
\newif\if@ACM@countrypresent
\@ACM@countrypresenttrue
% \end{macrocode}
-%
+%
% \end{macro}
-%
+%
%
% \begin{macro}{\@ACM@resetaffil}
% \changes{v1.73}{2020/09/07}{Added macro}
@@ -6001,7 +6046,7 @@
\global\@ACM@countrypresentfalse
}
% \end{macrocode}
-%
+%
% \end{macro}
%
% \begin{macro}{\@ACM@checkaffil}
@@ -6022,7 +6067,7 @@
\fi
}
% \end{macrocode}
-%
+%
% \end{macro}
%
%
@@ -6355,7 +6400,7 @@
\global\@undescribed@imagestrue
\ClassWarning{\@classname}{A possible image without
description}\fi
- \medskip}%
+ \medskip}%
\fi}
% \end{macrocode}
%
@@ -6739,7 +6784,7 @@
\acmConference@shortname,
\acmConference@date, \acmConference@venue\ACM@linecountR}%
\fi
- \fi
+ \fi
\if@ACM@sigchiamode
\fancyheadoffset[L]{\dimexpr(\marginparsep+\marginparwidth)}%
\fi
@@ -7356,7 +7401,7 @@
%
% We need balancing only if the user did not disable it, and we use a
% two column format. Note that |pbalance| uses a different
-% mechanism.
+% mechanism.
% \begin{macrocode}
\AtEndPreamble{%
\if@ACM@pbalance
@@ -7376,7 +7421,7 @@
\or % sigchi
\RequirePackage{pbalance}%
\or % sigchi-a
- \fi
+ \fi
\fi
\if@ACM@balance
\ifcase\ACM@format@nr
@@ -7397,7 +7442,7 @@
\or % sigchi
\RequirePackage{balance}%
\or % sigchi-a
- \global\@ACM@balancefalse
+ \global\@ACM@balancefalse
\fi
\fi
}
@@ -7407,7 +7452,7 @@
\balance
\fi\fi}
% \end{macrocode}
-%
+%
%
%\subsection{Acknowledgments}
%\label{sec:acks}
@@ -7478,7 +7523,7 @@
\fi}
% \end{macrocode}
%
-%
+%
%
%\subsection{Additional bibliography commands}
%\label{sec:bibliography}
@@ -7487,7 +7532,7 @@
% \changes{v1.21}{2016/09/04}{Added macro}
% The command \cs{showeprint} has two arguments: the (optional)
% prefix and the eprint number. Right now the only prefix we understand is
-% the (lowercase) word `arxiv'.
+% the (lowercase) word `arxiv'.
% \begin{macrocode}
\newcommand\showeprint[2][arxiv]{%
\def\@tempa{#1}%
@@ -7525,7 +7570,7 @@
\hyphenpenalty\@M
\footnotesize}
% \end{macrocode}
-%
+%
% \end{macro}
%
%\subsection{End of Class}
@@ -7542,14 +7587,14 @@
\let\@vspacer@orig=\@vspacer
\apptocmd{\@vspace}{\ClassWarning{\@classname}{\string\vspace\space should
only be used to provide space above/below surrounding
- objects}}{}{}
+ objects}}{}{}
\apptocmd{\@vspacer}{\ClassWarning{\@classname}{\string\vspace\space should
only be used to provide space above/below surrounding
objects}}{}{}
\let\@vspace@acm=\@vspace
\let\@vspacer@acm=\@vspacer
% \end{macrocode}
-%
+%
% \end{macro}
%
%
@@ -7564,7 +7609,7 @@
\string\baselinestretch\space detected. Please do not do this for
ACM submissions!}\fi}
% \end{macrocode}
-%
+%
% \end{macro}
%
% \changes{v1.30}{2017/02/10}{Added \cs{frenchspacing}}