render_macros

Anoma Research Topics LaTex Template

This is a template for writing Anoma Research Topics, a.k.a ARTs in LaTeX.

Using the template

To begin, clone the repository:

git clone https://github.com/anoma/art-template

You may remove the examples/ directory:

git rm -rf examples

The document is defined in the main.tex file. Update the class options at the top, if necessary.

You may include here further .tex, '.md.tex and .org.tex files using \input statements.

The .md.tex and .org.tex files are generated using pandoc from their .md and .org counterparts. When including pandoc-generated files, make sure to also include templates/pandoc.tex.

Class options

• paper size: a4paper or letterpaper (must be present)
• add line numbers: lineno (optional)
• no date: nodate (optional)
• no authors: noauthors (optional)
• toc: toc (optional)
• document type:
  • article: Article (default)
  • techreport: Technical Report
  • report: Report
  • commun: Communication
  • persp: Perspective
  • review: Review
  • anonymous: Article (without metadata)

Tables & figures

Tables and figures may be wider than \textwidth, and should be centered. For this reason, add a \centerline{} around the \begin{tabular}...\end{tabular} and \includegraphics{...} statements.

For full-width figures set the width to 1.3\textwidth:

\centerline{\includegraphics[width=1.3\textwidth]{filename}}

References

References of already published ARTs and related papers are in art.bib. You may add your own references to ref.bib.

To update art.bib to the latest version, run:

make update-bib

Updating the template

To update to the latest version of the LaTeX template and ART references in an already existing repository using the template, run the following:

make update-template

If you're updating from an old version of the template that does not have a Makefile yet, run the following instead:

curl -O https://raw.githubusercontent.com/anoma/art-template/main/Makefile
make update-template-old

In addition to updating the template, this will also apply fixes to the *.tex files in the repository using bin/fix.sh:

• add paper size and remove font size class options
• center tables

LaTeX fixes

bin/fix.sh offers automatic fixes for common issues in LaTeX source files. To see the available options, run it without arguments.

Building

LaTeXMk and a PDF engine such as XeTeX, LuaTeX, or pdfTeX are necessary to build the PDF. XeTeX is the recommended engine that produces best results and used to build the final published PDF.

To build the PDF file with the recommended XeTeX engine, use one of the following commands:

make
make xelatex

latexmk
latexmk -pdfxe

To build the PDF with LuaTeX, use either of these commands:

make lualatex

latexmk -pdflua

To build the PDF with pdfTeX, use either of these commands:

make pdflatex

latexmk -pdf

This will generate the main.pdf output file.

To continously rebuild main.pdf when a source file changes, run:

make watch

Then open the PDF file with a viewer that reloads the file on change.

To remove all output files generated during the build process, use either of the following:

make clean

latexmk -C

To remove output files generated by LaTeX, but keep the PDF:

make clean-latex

latexmk -c