Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add arxiv target #51

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add arxiv target #51

wants to merge 1 commit into from

Conversation

musoke
Copy link

@musoke musoke commented Apr 30, 2024

The preprint target outputs a very plain file without any styling. It is nice when the preprint version of a paper has similar formatting to the published version.
There have been requests and discussions concerning a smooth way to do this:

Some issues were raised, the biggest one being possible confusion about the publication status of a preprint. (See for example openjournals/joss#132 (comment) and openjournals/joss#132 (comment).)

In this PR I have configured pandoc to output a LaTeX file somewhat closer to that which would generate the official PDFs. In order to distinguish it from a published article, this style:

  • Removes the journal logo from the header.
  • Replaces the DOI and review details in the sidebar with Preprint: Prepared for submission to $journal.title$.
    This is borrowed from JCAP's LaTeX style.
  • Removes the self-citation in the footer.

There are other minor differences in fonts and PDF tags because arxiv.org only supports pdflatex, not lualatex:

  • remove \pdfvariable omitcidset=*
  • remove \setmonofont{Hack}
  • remove \usepackage{fontsetup}

Possible issues/room for improvement:

  • I haven't tested this in the docker image. I could not build the docker image locally, even on main (possibly due to Cannot apk add - temporary error alpinelinux/docker-alpine#59).
  • Should the references go in a .bbl, more in line with arxiv's usual processes?
  • Is it acceptable to use the journal logo, DOI, etc for an arxiv submission after an article is accepted?
  • The arxiv stamp overlaps slightly with the sidebar.

Here is the PDF preview generated by arxiv:
image

This PR may not be merged here, but I figured I would put the changes out there in case they are useful to someone.

The `preprint` target outputs a very plain file, missing any
journal-specific styling.  It's nice when the arxiv version of a paper
has similar formatting to the published version.  There have been
requests and discussions concerning a smooth way to do this.

Some issues were raised, the biggest one being possible confusion about
the publication status of a preprint.

Configure pandoc to output a LaTeX file somewhat closer to that which
would generate the official PDFs.  In order to distinguish it from a
published article, this style:

- Removes the journal logo from the header.
- Replaces the DOI and review details in the sidebar with "Preprint:
  Prepared for submission to $journal.title$".  This is borrowed from
  JCAP's LaTeX style.
- Removes the self-citation in the footer.

There are other minor differences in fonts and PDF tags because
arxiv.org only supports `pdflatex`, not `lualatex`:
- remove `\pdfvariable omitcidset=*
- remove `\setmonofont{Hack}`
- remove `\usepackage{fontsetup}`
@cthoyt
Copy link
Contributor

cthoyt commented Sep 17, 2024

I really like this idea since it means that the regular publication and preprint can be managed in the same template

I would go even further and say that this should replace the preprint template completely

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants