Template for Physical Review Journals
- Author: Frank Zimmer
- Author Website: https://www.frankzimmer.net
- Submission Guidelines
- 🆕 Create this repository. Nailed it. 🚀
- 📑 Replace the
template.tex
with your existing LaTeX template/article - 👯♀️ Copy in any other style, definitions or images necessary for the template
- 👩🔬 Add the files necessary into
files
list in thetemplate.yml
(documentation) - 🧙♀️ Start replacing template values with
[-options.my_value-]
and put in[# if parts.abstract #]
conditions to toggle sections on and off (documentation) - 👩🏿💻 Install jtex (
npm install -g jtex
) and runjtex check
(documentation) - 🪄 Continue to improve the options in your template for
parts
andoptions
(documentation) - 💾 When ready, save your
template.yml
and runjtex check --fix
, this will add various packages that are auto detected and fix document options (documentation) - 🧪 Test with real content:
myst build my-document.md --template ../path/to/template
(documentation) - 📸 Create a
thumbnail.png
with an accurate screenshot of the template - 🧭 Update this README, and check all values in the
template.yml
- 🚀 Push to GitHub, and contribute to the community templates repository
The RevTex documentation used to setup this template can be found here:
This is a table of options the template provides based on the REVTeX 4.2e release:
Option | Type | Default | Required | Functionality |
---|---|---|---|---|
draft |
boolean | false | false | Marks the document as draft (preprint) |
preprint |
string | false | Institutional report numbers can be specified using this (see preprint revtex4-2 documentation). | |
linenumbers |
boolean | false | false | Allows adding line numbers to the generated article. |
superscriptaddress |
boolean | false | false | A major way of displaying authors and affiliations information is to use superscripts on the authors and affiliations. It should be mentioned that the affiliations for the superscriptaddress are presented and numbered in the order that they are encountered. |
groupedaddress |
boolean | true | false | To group authors with the same affiliation together this option can be chosen. This is the default behavior for most journals. |
unsortedaddress |
boolean | false | false | Grouping of authors into specific groups (see groupedaddress ) is disabled. |
runinaddress |
boolean | false | false | Like groupedaddress , but joins multiple affiliations together into a single sequence separated by commas. |
footinbib |
boolean | false | false | The footnote text can either appear at the bottom of a page or as part of the bibliography. This option results it in only showing up in the bibliography. This can be used to override the default behavior of the journal. |
nofootinbib |
boolean | false | false | The footnote text can either appear at the bottom of a page or as part of the bibliography. This option results it in only showing up on the bottom of the page. This can be used to override the default behavior of the journal. |
bibnotes |
boolean | false | false | Specifies whether additional author information such as email or homepage are put on the first page or at the start of the bibliography. For instance, the prb option puts all such footnotes at the start of the bibliography while the prl journal styles displays them on the first page. One can override a journal style’s default behavior by specifying explicitly the class option bibnotes (puts the footnotes at the start of the bibliography) or nobibnotes (puts them on the first page). |
nobibnotes |
boolean | false | false | Specifies whether additional author information such as email or homepage are put on the first page or at the start of the bibliography. For instance, the prb option puts all such footnotes at the start of the bibliography while the prl journal styles displays them on the first page. One can override a journal style’s default behavior by specifying explicitly the class option bibnotes (puts the footnotes at the start of the bibliography) or nobibnotes (puts them on the first page). |
reprint |
boolean | false | false | Closely approximate a given journal’s style. Can be either single or two-column formatting depending on the journal. |
footnote_title |
boolean | false | false | Adds footnote for the article title. |
styling |
choice | aps | true | Allows choosing the type of American Physical Society journal. The following choices are available:
|
aps_journal_type |
choice | pra | false | Allows choosing the type of APS Journal. The following choices are available:
|
aip_journal_type |
choice | apl | false | Allows to choose the AIP Journal type. The following choices are available:
|
aapm_journal_type |
choice | mph | false | Allows choosing the American Association of Physicists in Medicine journal type. The following choices are available:
|
sor_journal_type |
choice | jor | false | Allows choosing the Society of Rheology journal type. The following choices are available:
|
formatting |
choice | onecolumn | false | Allows choosing the type of column formatting (one- or two-column article). The following choices are available:
|