This guide has been created to provide *CL Conferences (ACL, NAACL, EMNLP, ... ) and Workshops organisers with the instructions to follow to generate proceedings in aclpub2 format.
The provided Python tool to generate the proceedings takes as input a set of files containing all information on the event (in the .yml format) and generates a .tex file containing the conference details, sponsors, prefaces, organizing and program committees, as well as the concatenation of all the watermarked accepted papers and the author index. Such .tex file is then compiled to generate the pdf file of the proceedings (to be sent to ACL Anthology following these instructions).
- OpenReview. This guide is for you, we will explain you how to use the provided tool to generate the proceedings (and the handbook) automatically from OpenReview.
- EasyChair (or any other reviewing platform). This guide is for you, we will explain you how to generate the proceedings starting from manually edited files.
- SoftConf. You can either follow the istructions provided by this guide to generate the proceedings starting from manually edited files (this is the suggested option for small-medium size events) or follow the ACLPUB instructions.
The scripts to generate the proceedings accept as input a set of .yml files and directories. A YML file is a text document that contains data formatted using YAML (YAML Ain't Markup Language), a human-readable data format used for data serialization. You can open a YML file in any text editor (or source code editor).
Examples and usage of YAML syntax can be found here.
The following .yml files should be provided to the generation scripts. Files 1, 2, 3, 4 and 6 should be manually edited with information concerning your conference/workshops, while files 5 and 7 can be automatically exported from OpenReview (or manually edited if you are not using OpenReview).
conference_details.ymlsponsors.yml(optional)prefaces.ymlorganizing_committee.ymlprogram_committee.ymlinvited_talks.yml(optional)papers.yml
We strongly suggest taking a look at this link, where you can find examples of all the above files initialized for a past conference.
In addition, for the handbook, a file program.yml should be created Jump to Handbook generation instructions.
The generated proceedings should be sent to the ACL Anthology (instructions) as a .zip file containing a repository named with the conference/workshop acronym. Such repository should contain:
- A folder named
inputcontaining all the input files (i.e., the*.ymland*.texfiles used to generate the proceedings) - A folder named
watermarked_pdfcontaining all the pdfs of the watermarked camera ready papers - A PDF file named
proceedings.pdfcontaining the whole conference/workshop proceedings (i.e., the introduction and all the watermarked PDFs of the camera ready papers).
Important: Before generating the final proceedings, please carefully check the input pdfs of the camera ready papers with the ACLPUBCHECK tool, a Python tool that automatically detects author formatting errors, margin violations as well as many other common formatting errors in papers that are using the LaTeX sty file associated with ACL venues. The tool and instructions to use it can be found here. We strongly suggest to share with the authors this tool before the sumbission of their final camera ready, in order to reduce the effort of controlling possibly hundreds of papers.
Below you can find instructions (and examples) on how you should edit the .yml files with information on your conference/workshop.
This file should contain the key information about the conference, as its name, abbreviation and so on. It is used to build the cover of the proceedings, watermarks, and other items.
Note that the ISBN of your conference/workshop will be provided by ACL.
name: Name of the Conference
abbreviation: Conference abbreviation or acronym, e.g. EMNLP
volume: Volume name, e.g. "Proceedings of the Conference, Vol. 1 (Long Papers)"
start_date: Conference start date YYYY-MM-dd
end_date: Conference end date YYYY-MM-dd
isbn: ISBN number of the proceeding.This file should list the sponsors (if any). A directory containing the related logos should be created in the same directory of the .yml files (named sponsor_logos/).
- tier: Name of the tier, e.g. Diamond Level or In Collaboration With
logos:
- Path to a logo file relative to the sponsor_logos/ directory, e.g. facebook.pngThis file should list the prefaces that will be included in the proceedings. A directory containing the .tex files that provide the text of the prefaces should be created in the same directory of the .yml files (named prefaces/).
- title: Title of the preface, e.g. "Preface by the General Chair"
file: Name of the file relative to the prefaces/ directory containing the preface text, e.g. general_chair.texThe contents of the .tex files should not include usual headers and footers found within LaTeX files.
Instead, they should only contain the contents between the \begin{document} and \end{document} directives.
Frequently, this will simply be plaintext, with a few formulas, figures, or tables.
This file should list the members of the organizaing committee. You should edit this file manually.
- role: Name of role, e.g. General Chair
members:
- name: Committee member name as it should appear, e.g. John Doe
institution: Committee member's institution name as it should appear, e.g. University of California Berkeley, USAThis file should list the members of the program committee. You can edit this file manually, or export it from OpenReview Jump to How to export yml files from OpenReview.
- role: Name of role, e.g. General Chair
members:
- name: Committee member name as it should appear, e.g. John Doe
institution: Committee member's institution name as it should appear, e.g. University of California Berkeley, USA
- role: Reviewers
type: name_block # By adding the name_block type in the role, names will be output in alphabetized blocks.
entries:
- Committee Member NameThis optional file should list the invited talks and associated abstracts and bios. A directory containing the .tex files that provide the text of the abstract and the bios should be created in the same directory of the .yml files (named invited_talks/).
As with the prefaces, the contents of the .tex files should not include usual headers and footers found within LaTeX files,
and only what is usually found between the \begin{document} and \end{document} directives.
- speaker_name: Speaker name as it should appear, e.g. Jane Doe
institution: Speaker's institution name as it should appear, e.g. University of California Berkeley, USA
title: The title of the talk.
abstract_file: Path to abstract LaTeX file relative to the invited_talks/ directory.
bio_file: Path to bio LaTeX file relative to the invited_talks/ directory.This file should list the accepted papers, along with a directory (named papers/) containing the associated PDFs.
Each of the listed papers must have a unique ID so that they may be referred to by ID within the program.yml file later on. You can edit this file manually, or export it from OpenReview Jump to How to export yml files from OpenReview.
- id: Unique ID for the paper.
authors: # List of authors, structure detailed below.
- first_name: First name e.g. Jane
middle_name: (opt) Middle name e.g. Emily
last_name: Last name e.g. Doe
preferred_name: (opt) Prefered name, if not the same as first_name.
institution: Name of the author's institution.
email: Author's email.
openreview: (opt) Author's OpenReview username.
google_scholar: (opt) Author's Google Scholar ID.
orcid: (opt) Author's ORCID ID.
dblp: (opt) Author's DBLP ID.
semantic_scholar: (opt) Author's Semantic Scholar ID.
attributes:
# Key-value pairs used to manage other aspects of
# the publication process. Below are examples of possible
# attributes.
paper_type: long | short
presentation_type: oral | poster
submitted_area: Semantics | Machine Learning | ...
file: File name relative to the papers/ directory, e.g. 1.pdf
attachments:
# A list of additional files associated with the paper.
# The type, along with one of file or url must be specified.
- type: Dataset | Note | Poster | Presentation | Software | Attachment
file: Local file path, e.g. attachments/5.zip
url: URL pointing to the file, e.g. https://openreview.net/attachment?id=abcdefg
title: Title of the paper.
abstract: Abstract of the paper, usually a LaTeX fragment.TBC (Rodrigo)
Now that you know the expected structure of the proceedings and you know how to edit/export the required .yml input files, you are ready to test the tool to automatically generate the proceedings. First of all, follow the Setup procedures.
Then, as a training example, we made at your disposal in the examples/sigdial repository all the files you would need to correctly generate the proceedings.
Could you compile the sigdial proceedings? 🎊
Excellent, you are now ready to run the generation scripts on the files you have just edited/exported for your conference/workshop.
python -m pip install -r requirements.txt
Java is required to use the pax latex library, which is responsible for extracting and reinserting PDF links. Visit the Java website for instructions on how to install.
sudo apt-get install texlive-latex-base texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended texlive-fonts-extra texlive-bibtex-extra
Install mactex.
One way this is to install Homebrew first and then:
brew install mactex
Ensure that PYTHONPATH includes ., for example export PYTHONPATH=.:$PYTHONPATH.
Run the CLI on the SIGDIAL example directory:
./bin/generate examples/sigdial --proceedings --handbook
The generated results, along with intermediate files and links, can then be found in
the build directory in the directory in which you ran the command.
As said before, the generation scripts accepts as input the path to a directory, containing a set of .yml files and directories.
This expected input directory structure and the CLI are detailed below.
# Generates the proceedings.
./bin/generate examples/sigdial --proceedings
# Generates the handbook.
./bin/generate examples/sigdial --handbook
# Generates both.
./bin/generate examples/sigdial --proceedings --handbook
# Generates both and overwrites the existing contents of the build directory.
./bin/generate examples/sigdial --proceedings --handbook --overwriteUsers may wish to make modifications to the output .tex files.
Though we recommend first copying the .tex files to a new working directory,
the --overwrite flag helps ensure that local modifications are not accidentally erased.
The above describe a reasonable default usage of this package, but the behavior can easily be extended or modified by adjusting the contents of the aclpub2/ directory.
The main files to keep in mind are aclpub2/templates/proceedings.tex which contains the core Jinja template file, and aclpub2/generate.py which is responsible for rendering the template.
This project makes extensive use of Jinja to produce readable Latex templates. Before contributing or forking, it is generally helpful to familiarize yourself with the Jinja library. Documentation can be found here.
Additional configuration for Jinja can be found in the aclpub2/templates.py file.
The purpose of this file are to set up the Jinja environment with LaTeX-like block delimiters so that the proceedings.tex file can be syntax highlighted and otherwise interacted with in a fashion that is more natural for LaTeX users.
In addition, it is also responsible for configuring some convenience functions that allow us to create some LaTeX structures in the final output .tex file that are easier to write in native Python than either the Jinja base syntax, or LaTeX alone.
TBC (Marco)
Describes the conference program. This file is organized in blocks, each with a title, start, and end time, followed by a list of papers IDs. Instead of defining presentations, sessions may define subsessions, which have the same structure as the top-level session.
- title: Title of the conference session, e.g. Opening Remarks
start_time: Start time of the session as an ISO datestring.
end_time: End time of the session as an ISO datestring.
location: Location that the session is taking place in, e.g. Main Hall or Online
chair: (opt) Name of the chair of the session, e.g. Jane Doe.
url: (opt) URL to join or view the session, if applicable.
papers:
- id: Paper ID
start_time: Optional start time of the paper slot as an ISO datestring.
end_time: Optional start time of the paper slot as an ISO datestring.
# Or, if this is a session that is broken into subsessions:
- title: Title of the conference session, e.g. Opening Remarks
start_time: Start time of the session as an ISO datestring.
end_time: End time of the session as an ISO datestring.
subsessions:
- title: Title of the conference session, e.g. Opening Remarks
start_time: Start time of the session as an ISO datestring.
end_time: End time of the session as an ISO datestring.
chair: (opt) Name of the chair of the session, e.g. Jane Doe.
location: Location that the session is taking place in.
papers:
- id: Paper ID
start_time: Optional start time of the paper slot as an ISO datestring.
end_time: Optional start time of the paper slot as an ISO datestring.