Preparing Your Article with LaTeX
Introduction
The ACM article template allows authors to use LaTeX or Microsoft Word to prepare high-quality articles for publication in the ACM Digital Library. An important concept for authors to understand is the separation of content and style. The input format - whether Word or LaTeX - is intentionally simple in appearance, making creation and editing simpler, as well as reviewing. Authors provide metadata - through LaTeX commands - \title{}, \section{} and so on - and associating styles with content in a Word document - "this is a paragraph, this is a subtitle," and so on. TAPS takes Word or LaTeX documents as input, and produces well-formatted, high-quality PDF and HTML5 documents for publication. For more information on TAPS, please review our TAPS Workflow page.
The article creation process can be summed up in a few steps.
- Prepare your source material using Word or LaTeX, starting with the Word submission template or a LaTeX document that uses the "acmart" document class. The submission version is one column, with minimal styling of content.
- Submit your article for review to a conference or journal.
- If your article is accepted for publication, you will be asked to complete the ACM rights form, then prepare a final version of your article and submit the source to TAPS for processing.
- Review the PDF and HTML versions of your article generated by TAPS, correct errors necessary and, once you deem the output as acceptable approve your article in TAPS. Depending on the workflow of your event, the proceedings production editor or PC may also review the material either prior to or after your approval of the output and request changes based on the requirements of the specific publication.
Communication between the author and TAPS, the production vendor, or production editor is done via e-mail; please make sure that e-mail from "[email protected]" are delivered to your inbox, so that you don't miss any communication from TAPS.
This document explains how to use LaTeX to prepare your ACM article for submission, and for publication. If you are using Microsoft Word to prepare your ACM article, you should review Preparing Your Article with MS Word instead. The same topics are covered, and the emphasis there is on using Microsoft Word to accomplish the task.
The ACM Article Template: Using LaTeX
Authors who use LaTeX to prepare their articles can obtain the "acmart" class version 2.08 (June 4, 2024) files in several ways: download the template files or they can be added to a new or existing TeX installation - MikTeX, TeX Live, etc. - by installing the "acmart" LaTeX class and its dependencies.
An alternative to using the LaTex or MS Word template to prepare your article is Overleaf, an online and interactive LaTeX application that runs in your Web browser. Overleaf allows authors to share their work and collaborate on their documents.
The TeX User Guide, prepared by the maintainer of the "acmart" LaTeX class, is essential reading for authors using LaTeX to prepare their article. It includes detailed documentation of the commands available to authors.
LaTeX Packages
ACM maintains a list of approved LaTeX packages that can be used in the preparation of your article. These packages have been approved for use by the Aptara development team with respect to the successful conversion of your LaTeX source to XML and HTML5.
Important to Note: As packages are updated periodically, you should check the page before creating your article to see if additional packages have been added since you last submitted an article for review/publication. If there is a specific package you would like to see added to this list, please reach out to Aptara by e-mail at [email protected] and request the package(s) to be considered.
If your article is prepared with a LaTeX package that is not on this list, it will be returned for correction.
The following LaTeX packages are already part of the "acmart" document class and authors need not include them explicitly in their LaTeX source:
amsmath, array, booktabs, caption, fancyvrb, graphicx, hypdoc, libertine, longtable, newtxmath, tabularx, zi4
Authors should also refrain from defining their own LaTeX commands with the \newcommand
command, as these will also generate a validation error.
One Column or Two
Your article should be prepared in a one-column format. You must add the "manuscript" parameter to the \documentclass command:
\documentclass[manuscript]{acmart}
when you prepare your article for submission to a conference or journal for review. Additionally, please include this command in the preamble of your document:
\setcopyright{none}
so that no rights information is generated.
Important to Note: TAPS will convert the LaTeX source into the familiar two-column article format - a PDF document - as well as a responsive HTML5 version. Both will be made available in the ACM Digital Library.
Review Version and Final Document Version: What's the Difference?
There are a number of differences between the version of your article submitted for review and the version submitted to TAPS for publication.
As mentioned just above, you must remove the "manuscript" parameter from the \documentclass
command, in order for TAPS to generate your article in the template style for the specific ACM publication.
After acceptance, you will be directed to complete the ACM Rights Form for the publication and presentation of this content, and will need to add a set of LaTeX commands to your article's source, replacing \setcopyright{none}
. These commands will be used to create the rights text and the "ACM Reference Format" text in your final article.
All figures must have \Description{}
commands, defining the "alt-text" used by screen readers.
Which Template Style to Use?
The majority of ACM conferences use the "sigconf" template style:
\documentclass[sigconf]{acmart}
Only SIGPLAN has a specific variant on the "sigconf" template style; they use "sigplan."
Important to Note: Please do not modify the "acmart" template or attempt to override its definitions. Changing the column and page margins, changing line spacing, and the like are not permitted. If accepted for publication, your article's source will be delivered to TAPS and the PDF and HTML versions of your final article will be prepared with an unmodified version of the article template.
Estimating the Word and Page Counts
Sponsored events and journal publications often use page counts to segregate articles into several classes - "long papers," "short papers," "abstracts" and the like. The "manuscript" input format of LaTeX documents may make it difficult to determine a correspondence between "word count" and the "page count" of a well-formatted PDF document.
The following table illustrates - in general terms - a correspondence between word count and page count. These estimations do not include figures, tables, or other elements typically found in an article, and this was exclusive of references or appendices.
Word Count | Page Count (approximate) |
---|---|
1,300 words | 2 pages of formatted, two-column output. |
2,000 words | 3 pages of formatted, two-column output. |
3,100 words | 4 pages of formatted, two-column output. |
4,000 words | 5 pages of formatted, two-column output. |
7,000 words | 8 pages of formatted, two-column output. |
8,000 words | 9 pages of formatted, two-column output. |
10,000 words | 11 pages of formatted, two-column output. |
Authors and Affiliations
When preparing the author list for an article, please keep the following in mind:
- Authors' full names - "Donald E. Knuth" - should be used, without abbreviation - "D. E. Knuth." (This is true of references as well; authors' full names are easier to clearly identify for citation linking.)
- We need a separate email for each author listed in your paper. The author, affiliation, and email address must match the data in the rights form. If there are discrepancies, there will be delays in approving the output PDF/HTML files in TAPS.
- The following fields are required for each author: \institution, \city, and \country.
- Authors who use LaTeX must not put multiple authors OR e-mail addresses in a single command.
\author{Donald E. Knuth, Leslie Lamport}
, for example, is not allowed, nor is\email{dave,linda,[email protected]}
or\email{[email protected]}
. The TeX User Guide provides guidelines for grouping authors by a common affiliation, and for setting the number of columns of authors and affiliations.
The "shortauthors" command is a shortened version of the author list, and is used in the page headers. Please add this command - one of these variants, with your authors' names - after the last \author{} definition:
\renewcommand{\shortauthors}{Richard Thompson}
\renewcommand{\shortauthors}{Simon and Garfunkel}
\renewcommand{\shortauthors}{Lennon, McCartney, et al.}
\renewcommand{\shortauthors}{Medeski, et al.}
If you wish to attach a note to one or more authors' names - denoting equal contribution, for example - please use the \authornote{} command as shown in the TeX User Guide.
If your conference’s review process will be double-anonymous: The submitted document should not include author information and should not include acknowledgements, citations or discussion of related work that would make the authorship apparent. Submissions containing author identifying information may be subject to rejection without review. You can enable the double-anonymous mode in the LaTeX template by adding the “anonymous” option (e.g., \documentclass[manuscript, anonymous, review]{acmart}). Upon acceptance, the author and affiliation information must be added to your paper.
Titles and Subtitles
The \title{} and \subtitle{} commands are to be used to define the title (and a subtitle, if necessary) for your article. Please do not put linebreaks - "\\" - in the title or subtitle field.
If your title is lengthy, you will want to define a shorter version of it for use in the page headers:
\title[short version]{full title}
If the TAPS-generated PDF contains overlapping text in the page headers, a shorter version of the title AND/OR a modification of the \shortauthors{} command may be necessary.
Important to Note:
- The "Author's Addresses" text block is a required element, and must not be suppressed.
- The "ACM Reference Format" text block will be added by TAPS when your article's source is processed. This is a required element, and must not be suppressed.
Citations and References
The default citation and reference format for ACM publications is the "numbered" format. Articles presented at conferences sponsored by ACM SIGGRAPH and ACM SIGPLAN use the "author year" format.
Authors who use LaTeX must add \citestyle{acmauthoryear}
before \begin{document}
to use the "author year" format. The absence of that \citestyle{acmauthoryear}
command will result in the "numbered" format being used.
Please use BibTeX to prepare your references, and as with the authors of your article, please use authors' full names in the references.
Many conferences and journals place no page limits on the references in articles, and to that end, please do not minimize the number of fields used to identify a reference in order to save space. A robust reference is essential for the reader.
The bibliography style and BibTeX file are identified with these two commands, placed after the last section or the Acknowledgments, and before any appendices:
\bibliographystyle{ACM-Reference-Format}
\bibliography{name-of-the-bibtex-file}
CCS Concepts and Keywords
ACM's Computing Classification System (CCS) is a taxonomy for the computing field. Authors are expected to select one or more descriptors (or "concepts") from the CCS and add them to your document.
A list of CCS descriptors can be built for your article from https://dl.acm.org/ccs/ccs.cfm. Authors can select one or more descriptors and assign a priority to them.
When a list of CCS descriptors has been built, that information must be added to your document. Select "view CCS TeX Code," copy the commands, and paste into your LaTeX source document.
Here is a simple example of a single selection from the CCS. All of this would be copied and pasted into your article's LaTeX source:
\begin{CCSXML}
<ccs2012>
<concept>
<concept_id>10010520.10010570.10010571</concept_id>
<concept_desc>Computer systems organization~Real-time operating systems</concept_desc>
<concept_significance>500</concept_significance>
</concept>
</ccs2012>
\end{CCSXML}
\ccsdesc[500]{Computer systems organization~Real-time operating systems}
Users may augment the ACM taxonomy with user-defined keywords. the \keywords{} command accepts a list of comma-separated words as parameters:
\keywords{ray tracing,global illumination,GPU,real-time graphics}
CCS concepts and keywords are required for all articles that are three pages in length or greater, and optional for one- and two-page articles.
The "Teaser" Figure
A column-spanning figure centered underneath the author and affiliation information and before the body of the article is called a "teaser" figure, and can be added to your LaTeX source immediately before the \maketitle
command:
\begin{teaserfigure}
\includegraphics[width=\textwidth]{sampleteaser}
\caption{figure caption}
\Description{figure description}
\end{teaserfigure}
The \caption{} command defines the figure's caption. The \Description{}
command defines a description - one or two sentences - used by screen readers to make the document more accessible.
Abstract
Your article should begin with a short - one or two paragraphs - abstract, providing an overview of the work to be presented. The abstract
environment is used to define the abstract.
Sectioning
There are four different sectioning levels available to authors: \section{}
, \subsection{}
, \subsubsection{}
, and \paragraph{}
(in hierarchy order).
Please use these "as is," and do not remove the numbering - \section*{}
- from the command. Additionally, do not create your own "faux" sectioning by making the first word(s) of a paragraph bold, or in other ways. This action communicates no metadata that says "this is a new section" and the XML and HTML created from your LaTeX source will look and act differently from the PDF output.
Paragraphs
The first paragraph of a section will not be indented, and subsequent paragraphs are indented. This is built into the "acmart" template.
The proper way to separate paragraphs is with a single blank line. The use of "\\" to force vertical spacing between "paragraphs" is not allowed. Similarly, the "parskip" package is not approved for use.
Math
Equations can be presented in three separate styles: inline, numbered, and non-numbered.
- Inline equations are part of the text of the article, and are enclosed with the
\begin{math} ... \end{math}
environment, often abbreviated with "$" characters before and after the math symbols. - Numbered equations are enclosed with the
\begin{equation} ... \end{equation}
environment. - Un-numbered equations are enclosed with the
\begin{displaymath} ... \end{displaymath}
environment.
Algorithms
There are a number of LaTeX packages which can be used to typeset your algorithms. Several of them - algorithm,
algorithmic,
algorithm2e,
and listings
- are on the list of approved packages, and you are welcome to include one of them and use its commands in your article.
Figures and Tables
Figures and tables which are intended to span multiple columns should be created with the starred versions of the "figure" and "table" environments:
\begin{figure*} ... \end{figure*}
\begin{table*} ... \end{table*}
Figures and tables should include \Description{} commands, one or two sentences which describe the figure or table for screen reader applications.
Lists
LaTeX provides several list environments which can be used in your article: the "itemize" environment for a bulleted list, the "enumerate" environment for a numbered list, and the "description" environment for a descriptive list. Please keep modifications of the various list environments to a minimum.
Acknowledgments
Acknowledgments are placed before the references, and should include any required or desired mention of support, sponsorship, or funding.
You must use the "acks" environment for this section: \begin{acks} ... \end{acks}
and not a numbered or unnumbered \section{}
command.
Appendices
Appendices follow the references, and are started with the \appendix
command. The same sectioning commands are to be used in the appendices as in the body of your article, and section numbering begins with a letter in the appendices.
For Conference Proceedings Authors Only: Submitting Your Article to TAPS for Publication
Please see the TAPS Workflow page for the information on how to use TAPS.
Technical Support
ACM's production vendor has 24/7 technical support available via e-mail to "[email protected]".
[published March 2022; instructions written by Stephen Spencer, Univ. of Washington, Seattle Washington]
Production Information
TAPS Author Workflow
In the final step in the new ACM production workflow, authors will submit their validated paper to ACM's publishing system (TAPS). The publishing system produces and distributes the traditional PDF output as well as ACM's new responsive HTML5 design.