This is a template for use with copier. If you want to use this template yourself, you first need to install copier (e.g. pip install copier), create a new directory, change into it, and then then run

copier gh:rutar-academic/template-preprint .

If this template has updated and you also want to update your local template, from the root of the project folder, run

copier update

You might also be interested in only the project files: these can be found on the releases page.

This class defines the following options.

1. toc: if passed, generates a table of contents

A \title command is given, which takes one mandatory argument (the title), and an optional argument for a short version of the title. For example,

\title[My Short Title]{My Very Long and Unwieldy Full Title}

An \author command is also given, which takes three mandatory arguments (name, physical address, email), and an optional argument for a short version of your name. For example,

\author[Rutar]
  {Alex Rutar}
  {Mathematical Instutite, University of St Andrews, St Andrews KY16 9SS, Scotland}
  {alex@rutar.org}

The long forms of the title and names are used to render the title page and the address list at the end of the document. The short forms of the title and names are used for the page headers within the document.

Not including a \title and at least one \author will result in rendering errors.

This class defines an acknowledgements environment, which is by default an un-numbered section which is added to the table of contents. This environment is designed to be used as the final section in the document. You can of course simply use a manual \section{Acknowledgements} if you want a numbered Acknowledgements somewhere earlier in the document.

BibLaTeX is automatically loaded with a number of settings. Notably, the biber backend is used. To include .bib files, just use \addbibresource{your-file.bib} somewhere in the preamble.

The BibLaTeX code defines a non-standard @preprint entry. The citation key inside the document appends a + to the year, to indicate non-published status. An example entry is

@preprint{example,
  author = {Rutar, Alex},
  eprint = {1111.11111},
  eprinttype = {arxiv},
  title = {An example article},
  year = {2023}
}

which will be rendered in the bibliography as

A. Rutar. An example article. Preprint. arxiv:1111.11111.

You can also include a journal entry (e.g. journal = {Journal Name}) in which case it will be rendered as

A. Rutar. An example article. To appear in: Journal Name. arxiv:1111.11111.

This template (ab)uses the eprint and eprinttype entries in order to render archive information. For example, if you include the lines

eprint = {1337.28015},
eprinttype = {zbl}

the corresponding record will be accompanied by a link zbl:1337.28015.

The supported eprinttype options are: arxiv, zbl, zbmath, doi, mr.

1. Empty bibliography warnings are suppressed.
2. The \textcite command is modified to print the journal name, the pages, and the archive.
3. You can include a journal reference on the first page using \journal command in the preamble, which takes exactly one argument. If you have the journal reference in your .bib file, you can use the \journalcite shortcut command in the preamble, which takes exactly one argument.

The packages hyperref, cleveref, and ntheorem are loaded with proper ordering and dependencies. It is recommended to use the \cref command to make proper citations.

1. The defined standard environments are: theorem, lemma, corollary, conjecture, proposition, question, definition, notation, example, remark, proof, solution.
2. The defined introduction theorem environments are itheorem and icorollary which are rendered with letters instead of numbers.
3. There are a few special environments: nmproof defines a proof environment without a mark, and the proofpart environment is designed to be used inside a proof environment to render separate Parts
4. \hypersetup is used to generate PDF metadata, which is generated from the authors and the title. If your title has math characters in it, you need to use \texorpdfstring{<tex>}{<string>} to avoid hyperref errors.

This template uses \allowdisplaybreaks. In order to prevent unwanted display breaks on certain newlines, use \\*.