summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/acmart/acmart.dtx
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2020-05-05 03:00:58 +0000
committerNorbert Preining <norbert@preining.info>2020-05-05 03:00:58 +0000
commit12fef7aa53e3695c36d3650fa4fb98f991bc223e (patch)
tree851ce6216775d5d7b763952c5c861e86a7f48a03 /macros/latex/contrib/acmart/acmart.dtx
parent47af91cb8475b7352015cf05ce881e6b8415112d (diff)
CTAN sync 202005050300
Diffstat (limited to 'macros/latex/contrib/acmart/acmart.dtx')
-rw-r--r--macros/latex/contrib/acmart/acmart.dtx173
1 files changed, 124 insertions, 49 deletions
diff --git a/macros/latex/contrib/acmart/acmart.dtx b/macros/latex/contrib/acmart/acmart.dtx
index 72e256f18c..36b1cbe6a6 100644
--- a/macros/latex/contrib/acmart/acmart.dtx
+++ b/macros/latex/contrib/acmart/acmart.dtx
@@ -1,6 +1,6 @@
% \iffalse
%
-% Copyright 2016-2019, Association for Computing Machinery
+% Copyright 2016-2020, Association for Computing Machinery
% This work may be distributed and/or modified under the
% conditions of the LaTeX Project Public License, either
% version 1.3 of this license or (at your option) any
@@ -19,7 +19,6 @@
% acmart.cls, the files ACM-Reference-Format.bst, and templates
% sample-acmlarge.tex, sample-acmsmall.tex, sample-acmtog.tex,
% samplebody-conf.tex, samplebody-journals.tex, sample-manuscript.tex,
-% sample-sigchi-a.tex, sample-sigchi.tex,
% sample-sigconf-authordraft.tex, sample-sigconf.tex,
% sample-sigplan.tex
%
@@ -58,7 +57,7 @@
% \ifx\currentjob\guide\OnlyDescription\fi
% \GetFileInfo{acmart.dtx}
% \title{\LaTeX{} Class for the \emph{Association for Computing
-% Machinery}\thanks{\copyright 2016--2019, Association for Computing Machinery}}
+% Machinery}\thanks{\copyright 2016--2020, Association for Computing Machinery}}
% \author{Boris Veytsman\thanks{%
% \href{mailto:borisv@lk.net}{\texttt{borisv@lk.net}},
% \href{mailto:boris@varphi.com}{\texttt{boris@varphi.com}}}}
@@ -102,6 +101,7 @@
% Leif Andersen,
% Lawrence Christopher Angrave,
% Dirk Beyer,
+% Andrew Black,
% Joachim Breitner,
% Benjamin Byholm,
% Nils Anders Danielsson,
@@ -111,6 +111,7 @@
% Ben Greenman,
% Enrico Gregorio,
% Jamie Davis,
+% Jason Hemann,
% Peter Kemp,
% Luis Leiva,
% Ben Liblit,
@@ -137,6 +138,7 @@
% Stephen Spencer,
% Shin Hwei Tan,
% Daniel Thomas,
+% Shari Trewin,
% Zack Weinberg,
% John Wickerson
% and many others for their invaluable help.
@@ -221,8 +223,7 @@
% \item \textsl{geometry}, \url{http://www.ctan.org/pkg/geometry}
% \item \textsl{graphics}, \url{http://www.ctan.org/pkg/graphics}
% \item \textsl{hyperref}, \url{http://www.ctan.org/pkg/hyperref}
-% \item \textsl{ifluatex}, \url{http://www.ctan.org/pkg/ifluatex}
-% \item \textsl{ifxetex}, \url{http://www.ctan.org/pkg/ifxetex}
+% \item \textsl{iftex}, \url{http://www.ctan.org/pkg/iftex}
% \item \textsl{inconsolata}, \url{http://www.ctan.org/pkg/inconsolata}
% \item \textsl{libertine}, \url{http://www.ctan.org/pkg/libertine}
% \item \textsl{manyfoot}, \url{http://www.ctan.org/pkg/manyfoot}
@@ -309,12 +310,16 @@
% conferences (with the exceptions listed below) and all ICPS
% volumes.\\
% sigplan & Proceedings format for SIGPLAN conferences.\\
-% sigchi & Proceedings format for SIGCHI conferences.\\
-% sigchi-a & Format for SIGCHI extended abstracts.\\
% \bottomrule
% \end{tabularx}
% \end{table}
%
+% Starting in 2020, ACM retired formats |sigchi| and |sigchi-a|.
+% 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}).
+%
% There are several Boolean options that can take |true| or |false|
% values. They are listed in Table~\ref{tab:opts_bool}. The words
% |=true| can be omitted when setting a Boolean option, so instead of
@@ -875,13 +880,12 @@
% \cs{acmBadgeR}\oarg{url}\marg{graphics} and
% \cs{acmBadgeL}\oarg{url}\marg{graphics}. The first command puts the
% badge to the right of the title, and the second one---to the left.
-% The exception is the |sigchi-a| mode for SIGCHI extended abstracts,
-% which puts the badges on the left margin. The arguments have the
-% following meaning: \oarg{url}, if provided, sets the link to the
-% badge authority in the screen version, while \marg{graphics} sets
-% the graphics file with the badge image. The file must be a cropped
-% square, which is scaled to a standard size in the output. For
-% example, if the badge image is |ae-logo.pdf|, the command is
+% The arguments have the following meaning: \oarg{url}, if provided,
+% sets the link to the badge authority in the screen version, while
+% \marg{graphics} sets the graphics file with the badge image. The
+% file must be a cropped square, which is scaled to a standard size in
+% the output. For example, if the badge image is |ae-logo.pdf|, the
+% command is
% \begin{verbatim}
% \acmBadgeR[http://ctuning.org/ae/ppopp2016.html]{ae-logo}
% \end{verbatim}
@@ -1154,8 +1158,6 @@
% \item[figure*, table*] in two-column formats, a special figure or
% table taking a full text width.
% \item[teaserfigure:] a special figure before \cs{maketitle}.
-% \item[sidebar, marginfigure, margintable:] in the |sigchi-a| format,
-% special sidebars, tables and figures in the margin.
% \end{description}
%
% \item Accordingly, when scaling images, one should use the
@@ -1166,9 +1168,6 @@
% use \cs{columnwidth}, which coincides with \cs{textwidth} in this
% case.
% \item For |figure| in two-column mode, use \cs{columnwidth}.
-% \item For |marginfigure|, use \cs{marginparwidth}.
-% \item For |figure*| in SIGCHI extended
-% abstracts, use \cs{fulltextwidth}.
% \end{enumerate}
%
% \end{enumerate}
@@ -1217,23 +1216,11 @@
% \end{table}
% \end{verbatim}
%
-% \DescribeEnv{sidebar}%
-% \DescribeEnv{marginfigure}%
-% \DescribeEnv{margintable}%
-% SIGCHI extended abstracts use margin space extensively. This package
-% provides three environments for this with optional captions:
-% \begin{description}
-% \item[sidebar:] textual information in the margin
-% \item[marginfigure:] a figure in the margin
-% \item[margintable:] a table in the margin
-% \end{description}
-%
%
-% Tables and figures (including margin tables and margin figures) are
-% by default centered. However, in some cases (for example, when you
-% use several subimages per figure) you may need to override this.
-% A good way to do so is to put the contents into a
-% \cs{minipage} of the width \cs{columnwidth}.
+% Tables and figures are by default centered. However, in some cases
+% (for example, when you use several subimages per figure) you may
+% need to override this. A good way to do so is to put the contents
+% into a \cs{minipage} of the width \cs{columnwidth}.
%
%
%\subsection{Descriptions of images}
@@ -1819,6 +1806,48 @@
% special ``publication'' type FACMP, a forthcoming ACM publication,
% reserved for new journals which are not assigned an ISSN yet.
%
+%
+%\subsection{A note about \texttt{sigchi-a} format}
+%\label{sec:sigchi-a}
+%
+% Starting in Spring 2020 ACM retired SIGCHI Extended Abstract format
+% (|sigchi-a|). ACM will not, under any circumstances, accept
+% documents in this format for publication and will not offer
+% technical support to the authors who use this template.
+%
+% You may use this format in the |nonacm| mode only, as in
+% \begin{verbatim}
+% \documentclass[sigchi-a, nonacm]{acmart}
+% \end{verbatim}
+%
+%
+%
+% \DescribeEnv{sidebar}%
+% \DescribeEnv{marginfigure}%
+% \DescribeEnv{margintable}%
+% This format has large margin uses for special figures and
+% tables. This package provides three environments for this with
+% optional captions:
+% \begin{description}
+% \item[sidebar:] textual information in the margin,
+% \item[marginfigure:] a figure in the margin,
+% \item[margintable:] a table in the margin.
+% \end{description}
+%
+% 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.
+%
+% The horizontal sizes of figures are:
+% \begin{enumerate}
+% \item |figure|: \cs{columnwidth},
+% \item |marginfigure|: \cs{marginparwidth},
+% \item |figure*|: \cs{fulltextwidth}.
+% \end{enumerate}
+%
+%
+%
% \StopEventually{
% \clearpage
% \bibliography{acmart}
@@ -1842,7 +1871,7 @@
\ProvidesFile{acmart.dtx}
%</gobble>
%<class>\ProvidesClass{acmart}
-[2020/02/22 v1.70 Typesetting articles for the Association for Computing Machinery]
+[2020/04/30 v1.71 Typesetting articles for the Association for Computing Machinery]
% \end{macrocode}
%
% \changes{v1.00}{2016/04/14}{First released version}
@@ -1943,6 +1972,10 @@
% papers over two pages}
% \changes{1.66}{2019/12/18}{Authors' addresses are mandatory for
% journal articles}
+% \changes{1.71}{2020/05/01}{Retired sigchi and sigchi-a}
+% \changes{1.71}{2020/05/02}{Bibliography change: volume for
+% @inproceedings is now in brackets together with series}
+% \changes{1.71}{2020/05/02}{LuaTeX now uses the OTF versions of fonts}
%
% And the driver code:
% \begin{macrocode}
@@ -1992,6 +2025,11 @@
\RequirePackage{xstring}
% \end{macrocode}
%
+% We need |iftex| to check the engine
+% \begin{macrocode}
+\RequirePackage{iftex}
+% \end{macrocode}
+%
%
%
% \begin{macro}{format}
@@ -2276,10 +2314,30 @@
% Setting up switches
% \begin{macrocode}
\ifnum\ACM@format@nr=5\relax % siggraph
- \ClassWarning{\@classname}{The format siggraph is now obsolete.
- I am switching to sigconf.}
+\ClassWarning{\@classname}{%
+ The format siggraph is now obsolete.\MessageBreak
+ I am switching to sigconf.}
+ \setkeys{acmart.cls}{format=sigconf}
+\fi
+\ifnum\ACM@format@nr=7\relax % sigchi
+\ClassWarning{\@classname}{%
+ The format sigchi is now obsolete.\MessageBreak
+ I am switching to sigconf.}
\setkeys{acmart.cls}{format=sigconf}
\fi
+\ifnum\ACM@format@nr=8\relax % sigchi
+\ClassWarning{\@classname}{%
+ ACM SIGCHI has retired the SIGCHI-A template\MessageBreak
+ effective immediately. ACM is keeping this template\MessageBreak
+ option available to authors who are working on legacy\MessageBreak
+ documents only. ACM will not, under any circumstances,\MessageBreak
+ accept documents in this format for publication and\MessageBreak
+ will not offer technical support to the authors who use\MessageBreak
+ this template.\MessageBreak
+ ACM SIGCHI is directing Conference leaders and\MessageBreak
+ authors to publish their articles using the SIGCONF\MessageBreak
+ template call.}
+\fi
\ifnum\ACM@format@nr=0\relax
\@ACM@manuscripttrue
\else
@@ -2342,7 +2400,7 @@
\or % sigplan
\def\ACM@fontsize{10pt}%
\or % sigchi
- \def\ACM@fontsize{10pt}%
+ \def\ACM@fontsize{9pt}%
\or % sigchi-a
\def\ACM@fontsize{10pt}%
\fi
@@ -2667,9 +2725,10 @@
% \end{macro}
% \begin{macro}{\l@subsubsection}
% \changes{v1.31}{2017/03/04}{Redefined macro}
+% \changes{v1.71}{2020/04/30}{Bug fixed (thanks to Andrew Black)}
% The spacing in |amsart| is too large
% \begin{macrocode}
-\def\l@subsubsection{\@tocline{2}{0pt}{1pc}{5pc}{}}
+\def\l@subsubsection{\@tocline{3}{0pt}{1pc}{5pc}{}}
% \end{macrocode}
%
% \end{macro}
@@ -2847,7 +2906,7 @@
% \end{macrocode}
%
%
-% Author-draft mode
+% Author-draft mode or sigchi-a mode
% \begin{macrocode}
\if@ACM@authordraft
\RequirePackage{draftwatermark}
@@ -2856,6 +2915,17 @@
\SetWatermarkText{\parbox{12em}{\centering
Unpublished working draft.\\
Not for distribution.}}
+\else
+ \if@ACM@sigchiamode
+ \if@ACM@nonacm\else
+ \RequirePackage{draftwatermark}
+ \SetWatermarkFontSize{0.5in}
+ \SetWatermarkColor[gray]{.9}
+ \SetWatermarkText{\parbox{12em}{\centering
+ Legacy document. \\
+ Not for publication in an ACM venue}}
+ \fi
+ \fi
\fi
% \end{macrocode}
%
@@ -3125,14 +3195,19 @@
% \begin{macrocode}
\if@ACM@newfonts
\RequirePackage[T1]{fontenc}
-\ifxetex
- \RequirePackage[tt=false]{libertine}
- \setmonofont{inconsolata}
-\else
- \RequirePackage[tt=false, type1=true]{libertine}
-\fi
-\RequirePackage[varqu]{zi4}
-\RequirePackage[libertine]{newtxmath}
+ \ifxetex
+ \RequirePackage[tt=false]{libertine}
+ \setmonofont[StylisticSet=3]{inconsolata}
+ \else
+ \ifluatex
+ \RequirePackage[tt=false]{libertine}
+ \setmonofont[StylisticSet=3]{inconsolata}
+ \else
+ \RequirePackage[tt=false, type1=true]{libertine}
+ \RequirePackage[varqu]{zi4}
+ \fi
+ \fi
+ \RequirePackage[libertine]{newtxmath}
\fi
% \end{macrocode}
%