diff options
Diffstat (limited to 'macros/latex/contrib/acmart')
23 files changed, 503 insertions, 30 deletions
diff --git a/macros/latex/contrib/acmart/ACM-Reference-Format.bst b/macros/latex/contrib/acmart/ACM-Reference-Format.bst index 7984639a6d..ef3470f542 100644 --- a/macros/latex/contrib/acmart/ACM-Reference-Format.bst +++ b/macros/latex/contrib/acmart/ACM-Reference-Format.bst @@ -152,7 +152,7 @@ FUNCTION { empty.or.unknown } } FUNCTION { empty.or.zero } -{ +{ %% Examine the top entry and push 1 if it is empty, or is zero duplicate$ empty$ { pop$ #1 } @@ -2005,7 +2005,7 @@ FUNCTION { calc.basic.label } if$ duplicate$ year empty.or.unknown - { "[n.\,d.]" } + { "{[n.\,d.]}" } { year field.or.null purify$ #-1 #4 substring$} if$ * @@ -2053,7 +2053,7 @@ FUNCTION { calc.label } % save the year for sort processing afterwards (adding a, b, c, etc.) % year empty.or.unknown - { "[n.\,d.]" } + { "{[n.\,d.]}" } { year field.or.null purify$ #-1 #4 substring$} if$ 'label.year := diff --git a/macros/latex/contrib/acmart/README b/macros/latex/contrib/acmart/README index fd58d1d82e..0b833bdd1b 100644 --- a/macros/latex/contrib/acmart/README +++ b/macros/latex/contrib/acmart/README @@ -12,6 +12,12 @@ The production version is the one on CTAN and ACM sites. Changes +Version 1.85. Bug fixes + Added support for Creative Commons licenses (requires + doclicense images) + New journals + New format acmengage for ACM Engage CSEdu course materials + Version 1.84 Support for BibLaTeX rewritten (thanks to Roberto Di Cosmo and Kartik Singhal) Corrected German translation (thanks to Dirk Beyer) @@ -45,7 +51,7 @@ Version 1.76 Added many journal abbreviations to the bst. New experimental option: pbalance ORCID linking code -Version 1.75 \country is now obligatory for addresses. +Version 1.75 Omitted \country now produces error. Added \AtBeginMaketitle Version 1.74 Bug fixes. A regression introduced in the font changes @@ -53,7 +59,7 @@ Version 1.74 Bug fixes. A regression introduced in the font changes Version 1.73 Bug fixes The elements institution, city and country are now obligatory - for affiliations + for affiliations. The absence of them produces a warning Version 1.72 Bug fixes. Better handling of metadata. diff --git a/macros/latex/contrib/acmart/acmart.dtx b/macros/latex/contrib/acmart/acmart.dtx index e33a089ce8..dcb00ec66c 100644 --- a/macros/latex/contrib/acmart/acmart.dtx +++ b/macros/latex/contrib/acmart/acmart.dtx @@ -222,6 +222,7 @@ % \item \textsl{comment}, \url{http://www.ctan.org/pkg/comment} % \item \textsl{cm-super}, \url{http://www.ctan.org/pkg/cm-super} % \item \textsl{cmap}, \url{http://www.ctan.org/pkg/cmap} +% \item \textsl{doclicense}, \url{http://www.ctan.org/pkg/doclicense} % \item \textsl{draftwatermark}, \url{http://www.ctan.org/pkg/draftwatermark} % \item \textsl{environ}, \url{http://www.ctan.org/pkg/environ} % \item \textsl{etoolbox}, \url{http://www.ctan.org/pkg/etoolbox} @@ -282,10 +283,10 @@ % \begin{verbatim} % \documentclass[acmtog, review=false]{acmart} % \end{verbatim} -% The possible formats are listed in -% Table~\ref{tab:opts_format}. Note that formats starting with |acm| -% are intended for journals and transactions, while formats starting -% with |sig| are intended for proceedings published as books. +% The possible formats are listed in Table~\ref{tab:opts_format}. +% Note that formats starting with |acm| are intended for journals, +% transactions, and course materials, while formats starting with +% |sig| are intended for proceedings published as books. % % Note that sometimes conference proceedings are published as a % special issue (or issues) of an ACM journal. In this case, you @@ -303,7 +304,7 @@ % manuscript & A manuscript. This is the default. \\ % acmsmall & Small single-column format. Used for CIE, CSUR, % DLT, FAC, GAMES, JACM, JDIQ, JDS, JEA, JERIC, -% JETC, PACMCGIT, PACMHCI, PACMPL, TAAS, TACCESS, TACO, +% JETC, JRC, PACMCGIT, PACMHCI, PACMPL, TAAS, TACCESS, TACO, % TALG, TALLIP (formerly TALIP), TCPS, TDS, % TEAC, TECS, TELO, THRI, TIIS, TIOT, TISSEC, TIST, TKDD, TMIS, % TOCE, TOCHI, TOCL, @@ -319,6 +320,7 @@ % conferences (with the exceptions listed below) and all ICPS % volumes.\\ % sigplan & Proceedings format for SIGPLAN conferences.\\ +%. acmengage & ACM EngageCSEdu Course materials.\\ % \bottomrule % \end{tabularx} % \end{table} @@ -488,6 +490,7 @@ % Art, Science and Engineering of Programming (Programming '17)} % \end{verbatim} % +% % An ACM paper should have either \cs{acmJournal} or % \cs{acmConference} command. If it has both (or more) commands, the % last one takes precedence. Note that if you have the command @@ -496,6 +499,11 @@ % formatting. In the samples directory there is a file % |sample-acmsmall-conf.tex| with the example of this usage. % +% An ACM Engage material should \emph{not} use \cs{acmJournal} or +% \cs{acmConference} command. It may use \cs{acmBooktitle} to +% override the default \emph{ACM EngageCSEdu}. It should use \cs{acmYear} +% to set the date of the material. +% % % % \DescribeMacro{\editor}% @@ -1033,9 +1041,30 @@ % by IW3C2.\\ % \texttt{iw3c2w3g} & Special statement for conferences organized % by IW3C2, when some authors are approved Google employees.\\ +% \texttt{cc} & Creative Commons license. If this key is set, +% \textsl{doclicense} images are used to typeset the license. See +% also \cs{setcctype} command.\\ % \bottomrule % \end{tabularx} % \end{table} +% +% \DescribeMacro{\setcctype}% +% If Creative Commons license is used, the package by default chooses +% CC-BY 4.0 Attribution 4.0 International license. You can override +% this choice by the command \cs{setcctype}\oarg{version}\marg{type}, +% where \oarg{version} can be either 3.0 or 4.0 (4.0 by default), and +% \marg{type} can be one of |zero|, |by|, |by-sa|, |by-nd|, +% |by-nc|, |by-nc-sa|, |by-nc-nd| (see +% \url{https://creativecommons.org/licenses/} for the explanation). +% This command should be used in the preamble only. +% +% Material published under Creative Commons license should include +% the corresponding icon. A modern \TeX\ distribution includes these +% icons in the package \textsl{doclicense}. In case your distribution +% does not have them, ACM provides a file \path{ccicons.zip} with +% these icons. Just unzip it in the same directory where your +% document is. +% % The ACM submission software should generate the right command for you % to paste into your file. % @@ -1156,6 +1185,31 @@ % \end{verbatim} % % +%\subsection{Top matter of ACM Engage materials} +%\label{sec:ug_engage} +% +% ACM Engage materials resemble conference proceedings, but have some +% special features. First, as a rule, they are released under a +% Creative Commons license. By default CC-BY is used. However, if +% you want to use another variant of CC license, use \cs{setcctype} +% command, for example, |\setcctype{by-nc}|. Second, abstract is +% called \emph{synopsis}. Third, there are special top matter items +% used for the materials, such as \emph{Course,} \emph{Resource Type,} +% \emph{Programming Language,} \emph{CS Topics}. +% +% \DescribeMacro{\setengagemetadata}% +% These items are set with the command +% \cs{setengagemetadata}\marg{name}\marg{value}, for example, +% \begin{verbatim} +% \setengagemetadata{Course}{CS1} +% \setengagemetadata{Programming Language}{Python} +% \setengagemetadata{Knowledge Unit}{Programming Concepts} +% \setengagemetadata{CS Topics}{Functions, Data Types, Expressions, +% Mathematical Reasoning} +% \end{verbatim} +% +% Note that the type of Creative Commons license, if such license is +% used, is automatically added to the metadata. % %\subsection{Internationalization} %\label{sec:ug_i13n} @@ -1963,6 +2017,7 @@ % JERIC & ACM Journal of Educational Resources in Computing\\ % JETC & ACM Journal on Emerging Technologies in Computing Systems \\ % JOCCH & ACM Journal on Computing and Cultural Heritage \\ +% JRC & ACM Journal on Responsible Computing \\ % PACMCGIT & Proceedings of the ACM on Computer Graphics and % Interactive Techniques\\ % PACMHCI & PACM on Human-Computer Interaction\\ @@ -2087,7 +2142,7 @@ \ProvidesFile{acmart.dtx} %</gobble> %<class>\ProvidesClass{acmart} -[2022/04/09 v1.84 Typesetting articles for the Association for Computing Machinery] +[2022/05/10 v1.85 Typesetting articles for the Association for Computing Machinery] % \end{macrocode} % % \changes{v1.00}{2016/04/14}{First released version} @@ -2196,6 +2251,7 @@ % \changes{1.75}{2020/10/29}{Documentation update} % \changes{1.78}{2021/05/01}{Documentation update: Word count} % \changes{1.84}{2022/04/09}{New journals: JDS, GAMES} +% \changes{1.85}{2022/05/08}{Added CC licenses} % % And the driver code: % \begin{macrocode} @@ -2253,11 +2309,12 @@ % % % \begin{macro}{format} +% \changes{1.85}{2022/05/08}{New format: acmengage} % The possible formats % \begin{macrocode} \define@choicekey*+{acmart.cls}{format}[\ACM@format\ACM@format@nr]{% manuscript, acmsmall, acmlarge, acmtog, sigconf, siggraph, - sigplan, sigchi, sigchi-a}[manuscript]{}{% + sigplan, sigchi, sigchi-a, acmengage}[manuscript]{}{% \ClassError{\@classname}{The option format must be manuscript, acmsmall, acmlarge, acmtog, sigconf, siggraph, sigplan, sigchi or sigchi-a}} @@ -2271,6 +2328,7 @@ \@DeclareACMFormat{sigplan} \@DeclareACMFormat{sigchi} \@DeclareACMFormat{sigchi-a} +\@DeclareACMFormat{acmengage} \ExecuteOptionsX{format} % \end{macrocode} % @@ -2558,6 +2616,15 @@ % % \end{macro} % +% \begin{macro}{\if@ACM@engage} +% \changes{v1.85}{2022/05/05}{Introduced macro} +% ACM Engage course materials have special formatting +% \begin{macrocode} +\newif\if@ACM@engage +\@ACM@engagefalse +% \end{macrocode} +% +% \end{macro} % % Setting up switches % \begin{macrocode} @@ -2612,6 +2679,9 @@ \or % sigchi-a \@ACM@journalfalse \@ACM@sigchiamodetrue +\or % acmengage + \@ACM@journalfalse + \@ACM@engagetrue \fi \if@ACM@journal \@ACM@journal@bibstriptrue @@ -2845,6 +2915,9 @@ \else \renewcommand\keywordsname{Keywords}% \fi +\if@ACM@engage + \renewcommand\abstractname{Synopsis}% +\fi \ifx\ACM@languages\@empty \else \RequirePackage[\ACM@languages]{babel}% @@ -2855,6 +2928,9 @@ \renewcommand\keywordsname{Keywords}% \fi \renewcommand\acksname{Acknowledgements}% + \if@ACM@engage + \renewcommand\abstractname{Synopsis}% + \fi }% \addto\captionsfrench{% \if@ACM@journal @@ -3225,6 +3301,7 @@ % \changes{v1.55}{2018/10/20}{Now we use purple color for links} % \changes{v1.58}{2019/26/01}{Suppressed \cs{addtocounter} in pdf % subject} +% \changes{1.85}{2022/05/08}{Added: acmengage} % \begin{macrocode} \let\@footnotemark@nolink\@footnotemark \let\@footnotetext@nolink\@footnotetext @@ -3249,6 +3326,7 @@ \or % sigchi \or % sigchi-a \urlstyle{sf} +\or % acmengage \fi \AtEndPreamble{% \if@ACM@urlbreakonhyphens @@ -3436,13 +3514,21 @@ }% \@mparswitchfalse \reversemarginpar +\or % acmengage + \geometry{twoside=true, head=13pt, + paperwidth=8.5in, paperheight=11in, + includeheadfoot, columnsep=2pc, + top=57pt, bottom=73pt, inner=54pt, outer=54pt, + marginparwidth=2pc,heightrounded + }% \fi % \end{macrocode} % % % \begin{macro}{\parindent} % \begin{macro}{\parskip} -% Paragraphing +% \changes{1.85}{2022/05/08}{Added: acmengage} +% Paragraphing % \begin{macrocode} \setlength\parindent{10\p@} \setlength\parskip{\z@} @@ -3457,6 +3543,7 @@ \or % sigplan \or % sigchi \or % sigchi-a +\or % acmengage \fi % \end{macrocode} % @@ -3563,6 +3650,8 @@ \or % sigchi \flushbottom \or % sigchi-a +\or % acmengage + \flushbottom \fi % \end{macrocode} % @@ -3788,6 +3877,7 @@ textfont={bf, small}} \captionsetup[table]{labelfont={bf, small}, textfont={bf, small}} + \or % acmengage \fi \fi % \end{macrocode} @@ -3938,6 +4028,7 @@ \def\labelenumiv{\theenumiv.} \or % sigchi \or % sigchi-a +\or % acmengage \fi % \end{macrocode} % @@ -4050,6 +4141,7 @@ % \changes{1.82}{2022/02/05}{Updated abbreviations and codes for % several journals} % \changes{1.84}{2022/04/09}{New journals: JDS, GAMES} +% \changes{1.85}{2022/05/08}{New journal: JRC} % % We use the |xkeyval| interface to define journal titles and the relevant % information @@ -4071,6 +4163,7 @@ JERIC,% JETC,% JOCCH,% + JRC,% PACMCGIT,% PACMHCI,% PACMPL,% @@ -4191,6 +4284,10 @@ \def\@journalNameShort{ACM J. Comput. Cult. Herit.}% \def\@permissionCodeOne{1556-4673}% \def\@permissionCodeTwo{1556-4711}% +\or % JRC + \def\@journalName{ACM Journal on Responsible Computing}% + \def\@journalNameShort{ACM J. Responsib. Comput.}% + \def\@permissionCodeOne{2832-0565}% \or % PACMCGIT \def\@journalName{Proceedings of the ACM on Computer Graphics and Interactive Techniques}% \def\@journalNameShort{Proc. ACM Comput. Graph. Interact. Tech.}% @@ -5307,6 +5404,7 @@ % \changes{v1.51}{2018/04/05}{Suppress price if the copyright is set % to iw3c2w3 or iw3c2w3g} % \changes{v1.51}{2018/04/05}{Corrected the bug with price suppression} +% \changes{v1.85}{2022/05/08}{Added CC licenses} % Keys: % \begin{macrocode} \define@choicekey*{ACM@}{acmcopyrightmode}[% @@ -5314,7 +5412,7 @@ acmcopyright,acmlicensed,rightsretained,% usgov,usgovmixed,cagov,cagovmixed,licensedusgovmixed,% licensedcagov,licensedcagovmixed,othergov,licensedothergov,% - iw3c2w3,iw3c2w3g}{% + iw3c2w3,iw3c2w3g,cc}{% \@printpermissiontrue \@printcopyrighttrue \@acmownedtrue @@ -5361,6 +5459,10 @@ \ifnum\acm@copyrightmode=14\relax % iw3c2w3g \@acmownedfalse \AtBeginDocument{\acmPrice{}}% + \fi + \ifnum\acm@copyrightmode=15\relax % cc + \@acmownedfalse + \AtBeginDocument{\acmPrice{}}% \fi} % \end{macrocode} % @@ -5373,11 +5475,23 @@ % % \end{macro} % +% \begin{macro}{\setcctype} +% \changes{v1.85}{2022/05/08}{Added macro} +% The type of Creative Commons license used +% \begin{macrocode} +\newcommand\setcctype[2][4.0]{% + \def\ACM@cc@version{#1}% + \def\ACM@cc@type{#2}} +\setcctype{by} +% \end{macrocode} +% +% \end{macro} % % \begin{macro}{\@copyrightowner} % \changes{v1.40}{2017/06/16}{Added new copyright version: % licensedcagov} % \changes{v1.52}{2018/04/09}{Rewording of licenses} +% \changes{v1.85}{2022/05/08}{Added CC licenses} % Here is the owner of the copyright % \begin{macrocode} \def\@copyrightowner{% @@ -5416,6 +5530,8 @@ \or % ic2w3wwwgoogle IW3C2 (International World Wide Web Conference Committee), published under Creative Commons CC-BY-NC-ND~4.0 License. + \or % cc + Copyright held by the owner/author(s). \fi} % \end{macrocode} % @@ -5436,6 +5552,7 @@ % \changes{v1.50}{2018/02/07}{New copyright statements for iw3c2w3[g]} % \changes{v1.52}{2018/04/09}{Another rewording of copyright % statements for iw3c2w3[g]} +% \changes{v1.85}{2022/05/08}{Added CC licenses} % The canned permission block. % \begin{macrocode} \def\@copyrightpermission{% @@ -5560,6 +5677,23 @@ (CC-BY-NC-ND~4.0) license. Authors reserve their rights to disseminate the work on their personal and corporate Web sites with the appropriate attribution. + \or % CC + \IfEq{\ACM@cc@type}{zero}{% + \def\ACM@CC@Url{https://creativecommons.org/publicdomain/zero/1.0/legalcode}}{% + \edef\ACM@CC@Url{https://creativecommons.org/licenses/\ACM@cc@type/\ACM@cc@version/legalcode}}% + \href{\ACM@CC@Url}{\includegraphics[height=5ex]{doclicense-CC-\ACM@cc@type-88x31}}\\ + \href{\ACM@CC@Url}{% + This work is licensed under a Creative Commons + \IfEq{\ACM@cc@type}{zero}{CC0 1.0 Universal}{% + \IfEq{\ACM@cc@type}{by}{Attribution}{}% + \IfEq{\ACM@cc@type}{by-sa}{Attribution-ShareAlike}{}% + \IfEq{\ACM@cc@type}{by-nd}{Attribution-NoDerivatives}{}% + \IfEq{\ACM@cc@type}{by-nc}{Attribution-NonCommercial}{}% + \IfEq{\ACM@cc@type}{by-nc-sa}{Attribution-NonCommercial-ShareAlike}{}% + \IfEq{\ACM@cc@type}{by-nc-nd}{Attribution-NonCommercial-NoDerivatives}{}% + ~\IfEq{\ACM@cc@version}{4.0}{4.0 International}{3.0 Unported}% + } + License.}% \fi} % \end{macrocode} % @@ -5657,6 +5791,30 @@ % \end{macrocode} % \end{macro} % +% +%\subsection{ACM Engage top matter} +%\label{sec:acmengagetop} +% +% \begin{macro}{\@acmengagemetadata} +% \changes{v1.85}{2022/05/08}{Introduced macro} +% The special metadata for ACM engage course materials +% \begin{macrocode} +\def\@acmengagemetadata{} +% \end{macrocode} +% +% \end{macro} +% +% \begin{macro}{\setengagemetadata} +% \changes{v1.85}{2022/05/08}{Introduced macro} +% Adding topic to engage metadata +% \begin{macrocode} +\def\setengagemetadata#1#2{% + \g@addto@macro{\@acmengagemetadata}{% + \@setengagemetadata{#1}{#2}}} +% \end{macrocode} +% +% \end{macro} +% % \subsection{Typesetting top matter} % \label{sec:maketitle} % @@ -5708,6 +5866,7 @@ % \changes{v1.75}{2020/11/15}{Added \cs{@beginmaketitlehook}} % \changes{v1.76}{2021/04/05}{Put \cs{par} inside group for keywords} % \changes{v1.83}{2022/02/20}{I13n} +% \changes{v1.85}{2022/05/08}{acmengage} % The (in)famous \cs{maketitle}. Note that in |sigchi-a| mode, authors % are \emph{not} in the title box. % @@ -5765,7 +5924,11 @@ \fi \if@ACM@manuscript\else \if@ACM@journal@bibstrip\else % Print the conference information + \if@ACM@engage + {\itshape \@acmBooktitle, \@acmYear.}\par + \else {\itshape \acmConference@shortname, \acmConference@date, \acmConference@venue}\par + \fi \fi \fi \if@printcopyright @@ -5806,6 +5969,7 @@ \fi} \fi \endgroup + \if@ACM@engage\@typesetengagemetadata\fi \setcounter{footnote}{0}% \@mkabstract \ifx\@translatedabstracts\@empty\else @@ -5860,7 +6024,8 @@ % \changes{v1.68}{2020/01/19}{Deleted grouping altogether} % \changes{v1.69}{2020/02/02}{Changed dot to colon for sigplan} % \changes{v1.78}{2021/05/02}{Again suppressed \cs{vspace} warning} -% This macro starts sections for proceedings and uses \cs{small} for journals +% \changes{1.85}{2022/05/08}{Added: acmengage} +% This macro starts sections for proceedings and uses \cs{small} for journals % \begin{macrocode} \def\@specialsection#1{% \let\@vspace\@vspace@orig @@ -5884,6 +6049,8 @@ \section*{#1}% \or % sigchi-a \section*{#1}% + \or % acmengage + \section*{#1}% \fi \let\@vspace\@vspace@acm \let\@vspacer\@vspacer@acm @@ -5897,7 +6064,8 @@ % \changes{v1.06}{2016/05/01}{Added processing badges} % \changes{v1.46}{2017/08/29}{Deleted rule} % \changes{v1.78}{2021/05/16}{Added processing the overflowing title box} -% The printing of top matter starts a new page and uses the given +% \changes{1.85}{2022/05/08}{Added: acmengage} +% The printing of top matter starts a new page and uses the given % title box. Note that for |sigchi-a| we print badges here rather % than in \cs{mktitle} since we want them in the margins. % @@ -5956,6 +6124,8 @@ \includegraphics[width=\@ACM@badge@width]{\@acmBadgeR@image}}% \fi}% \fi + \or % acmengage + \twocolumn[\box\mktitle@bx]% \fi } % \end{macrocode} @@ -5963,7 +6133,8 @@ % \end{macro} % % \begin{macro}{\@mktitle} -% The title of the article +% \changes{1.85}{2022/05/08}{Added: acmengage} +% The title of the article % \begin{macrocode} \def\@mktitle{% \ifcase\ACM@format@nr @@ -5985,6 +6156,8 @@ \@mktitle@iii \or % sigchi-a \@mktitle@iv + \or % acmengage + \@mktitle@iii \fi } % \end{macrocode} @@ -5995,7 +6168,8 @@ % \changes{v1.06}{2016/05/01}{Added macro} % \changes{v1.45}{2017/08/15}{Switched \cs{bfeseries}\cs{sffamily} to % \cs{sffamily}\cs{bfseries}} -% The font to typeset the title +% \changes{1.85}{2022/05/08}{Added: acmengage} +% The font to typeset the title % \begin{macrocode} \def\@titlefont{% \ifcase\ACM@format@nr @@ -6017,6 +6191,8 @@ \Huge\sffamily\bfseries \or % sigchi-a \Huge\bfseries + \or % acmengage + \Huge\sffamily\bfseries \fi} % \end{macrocode} % @@ -6025,7 +6201,8 @@ % \begin{macro}{\@subtitlefont} % \changes{v1.06}{2016/05/01}{Added macro} % \changes{v1.33}{2017/03/12}{Added \cs{normalsize}} -% The font to typeset the subtitle +% \changes{1.85}{2022/05/08}{Added: acmengage} +% The font to typeset the subtitle % \begin{macrocode} \def\@subtitlefont{\normalsize \ifcase\ACM@format@nr @@ -6047,6 +6224,8 @@ \LARGE\mdseries \or % sigchi-a \mdseries + \or % acmengage + \LARGE\mdseries \fi} % \end{macrocode} % @@ -6257,7 +6436,8 @@ % \begin{macro}{\@mkauthors} % \changes{v1.17}{2016/07/09}{TOG now uses the same authors block as % other journals} -% Typesetting the authors +% \changes{1.85}{2022/05/08}{Added: acmengage} +% Typesetting the authors % \begin{macrocode} \def\@mkauthors{\begingroup \hsize=\textwidth @@ -6280,6 +6460,8 @@ \@mkauthors@iii \or % sigchi-a \@mkauthors@iv + \or % acmengage + \@mkauthors@iii \fi \endgroup } @@ -6330,6 +6512,9 @@ \or % sigchi-a \def\@authorfont{\bfseries} \def\@affiliationfont{\mdseries} +\or % acmengage + \def\@authorfont{\LARGE} + \def\@affiliationfont{\large} \fi % \end{macrocode} % @@ -6877,7 +7062,16 @@ % % \end{macro} % -% +% \begin{macro}{\@typesetengagemetadata} +% \changes{v1.85}{2022/05/08}{Introduced macro} +% Typesetting special metadata for ACM Engage +% \begin{macrocode} +\def\@typesetengagemetadata{% + \def\@setengagemetadata##1##2{\par\noindent\textbf{##1} ##2\par}% + \@acmengagemetadata} +% \end{macrocode} +% +% \end{macro} % %\subsection{Headers and Footers} %\label{sec:head_foot} @@ -6957,7 +7151,8 @@ % \changes{v1.33}{2017/03/29}{Added macro} % \changes{v1.34}{2017/04/10}{Rulers now are continuous} % \changes{v1.69}{2020/02/02}{Do not increase numbers in one column format} -% How to display the box on the right. In one column formats we do +% \changes{1.85}{2022/05/08}{Added: acmengage} +% How to display the box on the right. In one column formats we do % not step the numbers. % \begin{macrocode} \def\ACM@linecountR{% @@ -6981,6 +7176,8 @@ \ACM@mk@linecount \or % sigchi-a \ACM@mk@linecount + \or % acmengage + \ACM@mk@linecount \fi \begin{picture}(0,0)% \put(20,-22){\usebox{\ACM@linecount@bx}}% @@ -7442,6 +7639,7 @@ % \changes{v1.45}{2017/08/15}{Switched \cs{bfeseries}\cs{sffamily} to % \cs{sffamily}\cs{bfseries}} % \changes{v1.67}{2020/01/11}{Deleted redefinitions of sections} +% \changes{1.85}{2022/05/08}{Added: acmengage} % Fonts for sections etc. are different for different formats. % \begin{macrocode} \def\@secfont{\sffamily\bfseries\section@raggedright\MakeTextUppercase} @@ -7478,6 +7676,9 @@ \setcounter{secnumdepth}{0} \def\@secfont{\sffamily\bfseries\section@raggedright\MakeTextUppercase} \def\@subsecfont{\sffamily\bfseries\section@raggedright} +\or % acmengage + \def\@secfont{\bfseries\Large\section@raggedright\MakeTextUppercase} + \def\@subsecfont{\bfseries\Large\section@raggedright} \fi % \end{macrocode} % @@ -7569,6 +7770,7 @@ \def\@acmplainnotefont{\normalfont} \or % sigchi \or % sigchi-a +\or % acmengage \fi % \end{macrocode} % @@ -7639,6 +7841,7 @@ \def\@acmdefinitionnotefont{\normalfont} \or % sigchi \or % sigchi-a +\or % acmengage \fi % \end{macrocode} % @@ -7737,6 +7940,7 @@ \def\@proofindent{\noindent} \or % sigchi \or % sigchi-a +\or % acmengage \fi % \end{macrocode} % @@ -7783,6 +7987,8 @@ \or % sigchi \RequirePackage{pbalance}% \or % sigchi-a + \or % acmengage + \RequirePackage{pbalance}% \fi \fi \if@ACM@balance @@ -7805,6 +8011,8 @@ \RequirePackage{balance}% \or % sigchi-a \global\@ACM@balancefalse + \or % acmengage + \RequirePackage{balance}% \fi \fi } diff --git a/macros/latex/contrib/acmart/acmart.pdf b/macros/latex/contrib/acmart/acmart.pdf Binary files differindex eff9c12b4a..1ea8df54c4 100644 --- a/macros/latex/contrib/acmart/acmart.pdf +++ b/macros/latex/contrib/acmart/acmart.pdf diff --git a/macros/latex/contrib/acmart/acmguide.pdf b/macros/latex/contrib/acmart/acmguide.pdf Binary files differindex 7ae163f224..2ad7f38b26 100644 --- a/macros/latex/contrib/acmart/acmguide.pdf +++ b/macros/latex/contrib/acmart/acmguide.pdf diff --git a/macros/latex/contrib/acmart/samples/sample-acmengage.pdf b/macros/latex/contrib/acmart/samples/sample-acmengage.pdf Binary files differnew file mode 100644 index 0000000000..cd50ae2a4e --- /dev/null +++ b/macros/latex/contrib/acmart/samples/sample-acmengage.pdf diff --git a/macros/latex/contrib/acmart/samples/sample-acmlarge.pdf b/macros/latex/contrib/acmart/samples/sample-acmlarge.pdf Binary files differindex 712051ef4b..63c033e8ea 100644 --- a/macros/latex/contrib/acmart/samples/sample-acmlarge.pdf +++ b/macros/latex/contrib/acmart/samples/sample-acmlarge.pdf diff --git a/macros/latex/contrib/acmart/samples/sample-acmsmall-biblatex.pdf b/macros/latex/contrib/acmart/samples/sample-acmsmall-biblatex.pdf Binary files differindex c8359ae059..8ca28a339b 100644 --- a/macros/latex/contrib/acmart/samples/sample-acmsmall-biblatex.pdf +++ b/macros/latex/contrib/acmart/samples/sample-acmsmall-biblatex.pdf diff --git a/macros/latex/contrib/acmart/samples/sample-acmsmall-conf.pdf b/macros/latex/contrib/acmart/samples/sample-acmsmall-conf.pdf Binary files differindex 6825c8a90f..7ce11c18ef 100644 --- a/macros/latex/contrib/acmart/samples/sample-acmsmall-conf.pdf +++ b/macros/latex/contrib/acmart/samples/sample-acmsmall-conf.pdf diff --git a/macros/latex/contrib/acmart/samples/sample-acmsmall-submission.pdf b/macros/latex/contrib/acmart/samples/sample-acmsmall-submission.pdf Binary files differindex bd3a38698d..a669bf6e70 100644 --- a/macros/latex/contrib/acmart/samples/sample-acmsmall-submission.pdf +++ b/macros/latex/contrib/acmart/samples/sample-acmsmall-submission.pdf diff --git a/macros/latex/contrib/acmart/samples/sample-acmsmall.pdf b/macros/latex/contrib/acmart/samples/sample-acmsmall.pdf Binary files differindex 627a0f494d..1d4570b898 100644 --- a/macros/latex/contrib/acmart/samples/sample-acmsmall.pdf +++ b/macros/latex/contrib/acmart/samples/sample-acmsmall.pdf diff --git a/macros/latex/contrib/acmart/samples/sample-acmtog.pdf b/macros/latex/contrib/acmart/samples/sample-acmtog.pdf Binary files differindex 8558edb183..78e6c02e70 100644 --- a/macros/latex/contrib/acmart/samples/sample-acmtog.pdf +++ b/macros/latex/contrib/acmart/samples/sample-acmtog.pdf diff --git a/macros/latex/contrib/acmart/samples/sample-authordraft.pdf b/macros/latex/contrib/acmart/samples/sample-authordraft.pdf Binary files differindex 37f660358a..a1894beb3a 100644 --- a/macros/latex/contrib/acmart/samples/sample-authordraft.pdf +++ b/macros/latex/contrib/acmart/samples/sample-authordraft.pdf diff --git a/macros/latex/contrib/acmart/samples/sample-base.bib b/macros/latex/contrib/acmart/samples/sample-base.bib index a782f26eda..6cebd818e2 100644 --- a/macros/latex/contrib/acmart/samples/sample-base.bib +++ b/macros/latex/contrib/acmart/samples/sample-base.bib @@ -1508,12 +1508,20 @@ pages = "24--31"} @online{CTANacmart, author = {Boris Veytsman}, - title = {acmart---{C}lass for typesetting publications of {ACM}}, + title = {acmart---{Class} for typesetting publications of {ACM}}, year = 2017, url = {http://www.ctan.org/pkg/acmart}, lastaccessed = {May 27, 2017} } +@online{doclicense, + author = {Robin Schneider}, + title = {The \textsl{doclicense} package}, + year = 2022, + url = {http://www.ctan.org/pkg/doclicense}, + lastaccessed = {May 27, 2022} + } + @ARTICLE{bowman:reasoning, author = {Bowman, Mic and Debray, Saumya K. and Peterson, Larry L.}, title = {Reasoning About Naming Systems}, diff --git a/macros/latex/contrib/acmart/samples/sample-lualatex.pdf b/macros/latex/contrib/acmart/samples/sample-lualatex.pdf Binary files differindex e52aea57e9..678fa91b4c 100644 --- a/macros/latex/contrib/acmart/samples/sample-lualatex.pdf +++ b/macros/latex/contrib/acmart/samples/sample-lualatex.pdf diff --git a/macros/latex/contrib/acmart/samples/sample-manuscript.pdf b/macros/latex/contrib/acmart/samples/sample-manuscript.pdf Binary files differindex ae1d5b4670..1e4e320907 100644 --- a/macros/latex/contrib/acmart/samples/sample-manuscript.pdf +++ b/macros/latex/contrib/acmart/samples/sample-manuscript.pdf diff --git a/macros/latex/contrib/acmart/samples/sample-sigconf-biblatex.pdf b/macros/latex/contrib/acmart/samples/sample-sigconf-biblatex.pdf Binary files differindex 77e4cc038b..830091259d 100644 --- a/macros/latex/contrib/acmart/samples/sample-sigconf-biblatex.pdf +++ b/macros/latex/contrib/acmart/samples/sample-sigconf-biblatex.pdf diff --git a/macros/latex/contrib/acmart/samples/sample-sigconf-i13n.pdf b/macros/latex/contrib/acmart/samples/sample-sigconf-i13n.pdf Binary files differindex 54f5fdf09c..d809b00c0c 100644 --- a/macros/latex/contrib/acmart/samples/sample-sigconf-i13n.pdf +++ b/macros/latex/contrib/acmart/samples/sample-sigconf-i13n.pdf diff --git a/macros/latex/contrib/acmart/samples/sample-sigconf.pdf b/macros/latex/contrib/acmart/samples/sample-sigconf.pdf Binary files differindex 0267a91592..c2405c25d6 100644 --- a/macros/latex/contrib/acmart/samples/sample-sigconf.pdf +++ b/macros/latex/contrib/acmart/samples/sample-sigconf.pdf diff --git a/macros/latex/contrib/acmart/samples/sample-sigplan.pdf b/macros/latex/contrib/acmart/samples/sample-sigplan.pdf Binary files differindex df60a4d500..126b953ab3 100644 --- a/macros/latex/contrib/acmart/samples/sample-sigplan.pdf +++ b/macros/latex/contrib/acmart/samples/sample-sigplan.pdf diff --git a/macros/latex/contrib/acmart/samples/sample-xelatex.pdf b/macros/latex/contrib/acmart/samples/sample-xelatex.pdf Binary files differindex 3a4a9dc312..246ab3e7be 100644 --- a/macros/latex/contrib/acmart/samples/sample-xelatex.pdf +++ b/macros/latex/contrib/acmart/samples/sample-xelatex.pdf diff --git a/macros/latex/contrib/acmart/samples/samples.dtx b/macros/latex/contrib/acmart/samples/samples.dtx index a0f638aecb..a6738fc897 100644 --- a/macros/latex/contrib/acmart/samples/samples.dtx +++ b/macros/latex/contrib/acmart/samples/samples.dtx @@ -54,12 +54,12 @@ \acmConference[Conference acronym 'XX]{Make sure to enter the correct conference title from your rights confirmation emai}{June 03--05, 2018}{Woodstock, NY} -% -% Uncomment \acmBooktitle if th title of the proceedings is different -% from ``Proceedings of ...''! -% -%\acmBooktitle{Woodstock '18: ACM Symposium on Neural Gaze Detection, -% June 03--05, 2018, Woodstock, NY} +%% +%% Uncomment \acmBooktitle if the title of the proceedings is different +%% from ``Proceedings of ...''! +%% +%%\acmBooktitle{Woodstock '18: ACM Symposium on Neural Gaze Detection, +%% June 03--05, 2018, Woodstock, NY} \acmPrice{15.00} \acmISBN{978-1-4503-XXXX-X/18/06} %</manuscript|sigconf|authordraft|sigplan|sigchi|sigchi-a|acmsmall-conf|sigconf-i13n> @@ -400,7 +400,6 @@ The majority of conference proceedings documentation will use the {\verb|acmconf \begin{itemize} \item {\texttt{acmconf}}: The default proceedings template style. \item{\texttt{sigchi}}: Used for SIGCHI conference articles. -\item{\texttt{sigchi-a}}: Used for SIGCHI ``Extended Abstract'' articles. \item{\texttt{sigplan}}: Used for SIGPLAN conference articles. \end{itemize} @@ -961,3 +960,254 @@ massa et mattis lacinia. \end{document} %</manuscript|acmsmall|acmsmall-submission|acmsmall-biblatex|acmlarge|acmtog|sigconf|sigconf-biblatex|authordraft|sigplan|sigchi|sigchi-a|acmsmall-conf|sigconf-i13n> +% +% ACM Engage course material +% +%<*acmengage> +%% +%% +%% Commands for TeXCount +%<<TCMACROS +%TC:macro \cite [option:text,text] +%TC:macro \citep [option:text,text] +%TC:macro \citet [option:text,text] +%TC:envir table 0 1 +%TC:envir table* 0 1 +%TC:envir tabular [ignore] word +%TC:envir displaymath 0 word +%TC:envir math 0 word +%TC:envir comment 0 0 +%TCMACROS +%% +%% +%% The first command in your LaTeX source must be the \documentclass command. +\documentclass[acmengage]{acmart} + +%% \BibTeX command to typeset BibTeX logo in the docs +\AtBeginDocument{% + \providecommand\BibTeX{{% + Bib\TeX}}} + +%% Rights management information. This information is sent to you +%% when you complete the rights form. These commands have SAMPLE +%% values in them; it is your responsibility as an author to replace +%% the commands and values with those provided to you when you +%% complete the rights form. Note that by default course materials +%% use Creative Commons license +% +\setcopyright{cc} +\setcctype{by} +\copyrightyear{2022} +\acmYear{May 2022} +\acmBooktitle{ACM EngageCSEdu} +\acmDOI{XXXXXXX.XXXXXXX} + +\begin{document} +\title{EngageCSEdu Submission Title (600 char limit)} +\author{Author One} +\email{author1@institution.edu} +\affiliation{% + \institution{University of XXX} + \city{SomeCity} + \country{SomeCountry}} + +\author{Author Two} +\email{author2@institution.xxx} +\affiliation{% + \institution{Some School} + \city{SomeCity} + \country{SomeCountry}} + +\author{Author Three} +\email{author3@school.xxx} +\affiliation{% + \institution{A3 affiliation} + \city{SomeCity} + \country{SomeCountry}} + +%% The synopsis is a name for the abstract +\begin{abstract} +A required section. The synopsis is similar to a paper abstract. The synop- +sis will display in the digital library as the abstract. The synopsis should +be copied into ScholarOne as the abstract for submission. The synopsis +should contain an overall description of the Open Educational Resource +(OER). The synopsis lets other instructors quickly understand what this +material is about. Include any learning objectives and a description of the +approach taken. Put details about implementation and necessary prerequi- +site knowledge in the Recommendations section. The following template is +a suggested format: +This [assignment/project/homework/lab] helps students gain experience +and proficiency with [ e.g. arrays, for/while loops, conditional statements.] +Students will learn how to [skills acquired]. +The reader should get an understanding of what topic is associated with +the OER and what, if anything, the students will be asked to do. +\end{abstract} + +%% Metadata for the course +\setengagemetadata{Course}{CS1} +\setengagemetadata{Programming Language}{Python} +\setengagemetadata{Knowledge Unit}{Programming Concepts} +\setengagemetadata{CS Topics}{Functions, Data Types, Expressions, + Mathematical Reasoning} + +%% Keywords +\keywords{Arithmetic Operators, Assignment Statements, Comprehension, + Student Voice} +\maketitle + +\section{Engagement Highlights} + +A required section. This section of the paper should detail how the OER engages the students. The engagement must be based on at least one evidenced-based teaching practice known to broaden participation or improve student learning. Examples include the practices from the NCWIT Engagement Practices Framework: using meaningful and relevant content, making interdisciplinary connections to CS, addressing misconceptions about the field of CS, incorporating student choice, giving effective encouragement, mitigating stereotype threat, offering student-centered assessments, providing opportunities for interaction with faculty, avoiding stereotypes, using well-structured collaborative learning, or encouraging student interaction. Other potential evidence-based practices include using culturally relevant pedagogy, or universal design for learning. All submissions must identify what evidence-based practice they incorporate and be specific in how the practice is included within the OER. + +Information on how to differentiate this assignment (i.e. provide different versions for students of differing abilities) could also go in this section. It could also outline how instructors might modify +the assignment to increase enhance student engagement. If these modifications are extensive, they could also be discussed in their own section. + +\section{Recommendations} + +A required section. In this section authors should give specific recommendations and advice to other instructors who might want to adapt this resource for their own classroom. Important information to include in this section includes identifying how much time is required to introduce or complete the task, potential pitfalls or student struggles, lessons learned from using the OER, and any information on extensions or differentiation for students. Think of this section as the information you would provide a colleague before they use this OER in their classroom. + +\section{Additional Sections} + +Optional. Authors may add additional sections to fully explain all the pieces of their OER. It can (and probably should) have multiple sections and the section headers are at the discretion of the authors. Sections may expand on information presented in the synopsis, recommendations, and engagement highlights. Suggested sections include: Introduction, Background Material, Implementation Guidelines, Marking Guidelines, Extensions and Modifications, Pitfalls, Acknowledgements, Student Feedback, and References. + +\section{Related Online Resources} + +EngageCSEdu requires that all materials that are part of the OER submission be included with the submission and not just URL links to materials stored on other sites. However, any related background or reference material used to provide instructor or student knowledge as opposed to instructional material may be included as citations within the paper +(see section \ref{sec:citations}) +or you may include a numbered list of external links and extensions in an optional section titled ``Auxilary Materials" that should come immediately before "References". + +\section{Materials} + +A required section. You must provide a list of the contents of the zipped file including a description of each contained file. This may be provided as text or as an unordered list. + +A single zipped file containing all the OER instructional materials including assignment handouts / specification, starter code, rubric, solution, etc. will also be submitted. + +\section{Meta-Data} + +This section is included in the template to explain the choices for the meta-data at the top of the paper. It should not be included in the final paper submission. + +\subsection{Course} + +Current courses are: + +\begin{itemize} + \item CS0 -- a breadth first introductory computing course similar to Exploring Computer Science or AP CS Principles + \item CS1 -- an introductory programming course covering topics normally associated with an imperative or functional programming course. Similar to an AP CS A course + \item Data Structures -- a follow-on course occurring after CS1 that introduces linear and non-linear data structures including implementation and usage + \item Discrete Math -- a course covering discrete mathematical structures such as integers, graphs and logic statements. This may include logic, set theory, combinatorics, graphy theory, number theory, topology, etc. +\end{itemize} + +More than one course may be selected. If you are submitting an OER for a special topics issue of Engage, please discuss the appropriate course choice with the guest editors of the special issue. + +\subsection{Programming Language} +Authors may select all that apply from the following list: +\begin{itemize} + \item C + \item C++ + \item C\# + \item Java + \item JavaScript + \item Processing + \item Python + \item Racket (DrScheme) + \item Scheme + \item Scratch + \item Pseudocode + \item Other + \item None +\end{itemize} + +\subsection{Resource Type} +One resource type must be selected. Current list to select from includes: + +\begin{itemize} + \item Assignment -- the most common OER type. Typically represents a task assigned to individual or groups of students that will be completed outside of class time. + \item Lecture slides -- an annotated set of presentation slides to introduce or explain a topic, typically a cutting-edge research topic, to a more lay audience. An example might be explaining a specific cryptography algorithm, blockchain, or an AI / ML solution to a problem. + \item Lab -- this represents a task assigned to an individual or group of students to be completed under supervision, usually during a closed-lab model + \item Project -- an assignment that is of a longer duration, perhaps multiple weeks to an entire term + \item Tutorial -- a task usually completed by an individual to learn some material on their own + \item Other -- any other type of OER that does not fit into one of the above categories +\end{itemize} + +\subsection{CS Concepts} +This is selectable from the ontology of topics found at \url{https://www.engage-csedu.org/ontology}. Up to three topics may be selected. Eventually this page will be a tool allowing you to select up to three nodes in the tree and then copy / paste the descriptive text into your document and the submission system. + +\subsection{Knowledge Unit} +Authors will select the most appropriate one from the following list: + +\begin{itemize} + \item Programming Concepts -- anything involving programming + \item Data Structures -- anything involving data structures + \item Software Development Methods -- if the OER centers around software development (i.e., requirements gathering, testing, maintenance, code reviews) rather than the actual programming content + \item Discrete Math -- anything involving discrete math + \item N/A -- not applicable +\end{itemize} + +\subsection{Creative Commons License} +During the submission process on ScholarOne, authors will select one create commons license from the following list: + +\begin{itemize} + \item CC BY-SA + \item CC BY-NC + \item CC BY-NC-ND + \item CC BY-NC-SA + \item CC BY-ND + \item CC BY +\end{itemize} + +The correct typesetting of materials under creative commons license +requires the corresponding CC icon. A modern \TeX\ distribution +includes these icons in the package \textsl{doclicense} +\cite{doclicense}. In case your distribution does not have them, ACM +provides a file \path{ccicons.zip} with these icons. Just unzip it in +the same directory where your document is. + +More information on Creative Common Licensing may be found at \url{https://creativecommons.org/licenses/}. + +\section{Submission} +When you make a submission using ScholarOne you must upload: + +\begin{itemize} + \item an anonymized version of this paper for review + \item a zipped file containing all the student-facing materials. The materials in this file must also be anonymized for the purposes of fully anonymous review. +\end{itemize} + +\section{Citations and References} +\label{sec:citations} +We recommend using \BibTeX\ to prepare your references. The bibliography is included +in your source document with these two commands, placed just before +the \verb|\end{document}| command: +\begin{verbatim} + \bibliographystyle{ACM-Reference-Format} + \bibliography{bibfile} +\end{verbatim} +where ``\verb|bibfile|'' is the name, without the ``\verb|.bib|'' +suffix, of the \BibTeX\ file. + +Here are a few examples of the types of things you might cite in an EngageCSEdu submission: + a book \cite{Kosiur01}, + a journal article \cite{Abril07}, + an informally published work \cite{Harel78}, + an online document / world wide web resource \cite{Thornburg01, Ablamowicz07}, + a video \cite{Obama08}, + a software package \cite{R}, and an online dataset \cite{UMassCitations}. + +For other examples, see the file sample-acmsmall-conf.tex \cite{CTANacmart}. + +\section{Auxiliary Materials} +This section is optional, but if included must immediately precede the References section. If there are no References, Auxiliary Materials should be last. This should be +a numbered list of URLs with an optional brief description of the content found at each URL. Here is an example. +\begin{enumerate} +\item \url{https://somenews.org/xxx/} A news article relevant to this OER. +\item \url{https://somesite.gov/xxx/} A relevant government report. +\item \url{https://someplace.edu/xxxx/} A public data set of interest. +\item \url{https://github.com/xxxx/} A public github project that is related. +\end{enumerate} + +\bibliographystyle{ACM-Reference-Format} +\bibliography{sample-base} + + + +\end{document} +%</acmengage> diff --git a/macros/latex/contrib/acmart/samples/samples.ins b/macros/latex/contrib/acmart/samples/samples.ins index af2d55e4d9..f2331d1088 100644 --- a/macros/latex/contrib/acmart/samples/samples.ins +++ b/macros/latex/contrib/acmart/samples/samples.ins @@ -21,5 +21,6 @@ \file{sample-sigplan.tex}{\from{samples.dtx}{sigplan}} \file{sample-acmsmall-conf.tex}{\from{samples.dtx}{acmsmall-conf}} \file{sample-sigconf-i13n.tex}{\from{samples.dtx}{sigconf-i13n}} + \file{sample-acmengage.tex}{\from{samples.dtx}{acmengage}} } |