diff --git a/README.md b/README.md index c164672..7d822e3 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Template for Physical Review Journals ![](thumbnail.png) -- Author: Frank Zimmer +- Author: Frank Zimmer - Author Website: https://www.frankzimmer.net - [Submission Guidelines](https://journals.aps.org/prl/authors) @@ -19,11 +19,10 @@ Template for Physical Review Journals - [x] 🪄 Continue to improve the options in your template for `parts` and `options` ([documentation](https://js.myst.tools/jtex/document)) - [x] 💾 When ready, save your `template.yml` and run `jtex check --fix`, this will add various packages that are auto detected and fix document options ([documentation](https://js.myst.tools/jtex/command-line)) - [x] 🧪 Test with real content: `myst build my-document.md --template ../path/to/template` ([documentation](https://js.myst.tools/guide/creating-pdf-documents)) -- [ ] 📸 Create a `thumbnail.png` with an accurate screenshot of the template +- [x] 📸 Create a `thumbnail.png` with an accurate screenshot of the template - [x] 🧭 Update this README, and check all values in the `template.yml` - [x] 🚀 Push to GitHub, and contribute to the [community templates repository](https://github.com/myst-templates/templates) - ## Options provided by Physical Review Journals `myst`-Template The RevTex documentation used to setup this template can be found here: @@ -33,24 +32,24 @@ 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](https://journals.aps.org/revtex) release: -| Option | Type | Default | Required | Functionality | -| ------ | ---- | ------- | -------- | ------------- | -| `draft` | boolean| false | false | Marks the document as drift (preprint) | -| `preprint` | string | | false | Institutional report numbers can be specified using this (see prepint revtex4-2 documentation). | -| `linenumbers` | boolean| false | false | Allows to add 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 st 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 st 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 to choose the types of American Physical Society journals. The following choices are available:| -| `aps_journal_type` | choice | pra | false | Allows to choose the APS Journal type. 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 to choose the American Association of Physicists in Medicine journal type. The following choices are available:| -| `sor_journal_type` | choice | jor | false | Allows to choose the Society of Rheology journal type. The following choices are available:| -| `formatting` | choice | onecolumn | false | Allows to choose the type of column formatting (one- or two-column article). The following choices are available:| +| Option | Type | Default | Required | Functionality | +| -------------------- | ------- | --------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `draft` | boolean | false | false | Marks the document as drift (preprint) | +| `preprint` | string | | false | Institutional report numbers can be specified using this (see prepint revtex4-2 documentation). | +| `linenumbers` | boolean | false | false | Allows to add 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 st 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 st 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 to choose the types of American Physical Society journals. The following choices are available: | +| `aps_journal_type` | choice | pra | false | Allows to choose the APS Journal type. 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 to choose the American Association of Physicists in Medicine journal type. The following choices are available: | +| `sor_journal_type` | choice | jor | false | Allows to choose the Society of Rheology journal type. The following choices are available: | +| `formatting` | choice | onecolumn | false | Allows to choose the type of column formatting (one- or two-column article). The following choices are available: | diff --git a/examples/paper.md b/examples/paper.md index efddb73..2506a68 100644 --- a/examples/paper.md +++ b/examples/paper.md @@ -1,6 +1,22 @@ --- title: Title short_title: Short title +authors: + - name: Jane Doe + affiliations: + - University A + - Institute B + corresponding: true + email: jane@myweb.com + website: https://myweb.com + - name: John Dee + affiliations: + - Institute B + - Place C +keywords: + - keyword1 + - keyword2 + - keyword3 export: - format: pdf+tex template: ../. @@ -22,13 +38,14 @@ export: styling: aps aps_journal_type: prl # the aip_journal_type only is used when styling is aip - # aip_journal_type: apl + # aip_journal_type: apl # the aapm_journal_type only is used when styling is aip - # aapm_journal_type: mph + # aapm_journal_type: mph # the sor_journal_type only is used when styling is sor # sor_journal_type: jor formatting: twocolumn paper_size: a4paper + linenumbers: true --- +++ {"part": "abstract"} @@ -49,17 +66,17 @@ pampineae rite non [](https://doi.org/10.1007/BF02650179). ## Ibis hoc ultra tulit Mygdoniusque caeli concutiens -Ora hac quoque, in *ipsos iura nec* egreditur Mygdoniusque [pudet sui +Ora hac quoque, in _ipsos iura nec_ egreditur Mygdoniusque [pudet sui relictae](http://anilibus.net/) superata Festa animorum cum animos variat. Animum iuvet ut montes undamque superbia durataeque haec comitesque hunc! Niger ait postquam [Echidnaeae fovebam](https://www.google.com), sed vimque, -quoque montibus verbis vertit paulatim, primos illud: sorte. *Ossibus* voce +quoque montibus verbis vertit paulatim, primos illud: sorte. _Ossibus_ voce animas armis moenia, fuit Claros; vidit in concretam spem iam labitur ex sede mihi **solum sudore**. Terga progenies collo spretarumque: poscor. Ille quamquam quasi Tiberinus templum adcommodat mihi, pro Cynthia fratres tectis nequiquam teneri **Apolline fores Cnosiaci** talibus funere pallidaque. -Tantum *inde osque* finxit egesto. +Tantum _inde osque_ finxit egesto. ## Gladio famulumque manus resupinus illius @@ -75,7 +92,7 @@ Accipiunt [](#emc2) acuta. Dixit circumdata annis ditissimus. Samos se ictu, ill ## Tune ursos -Acutae *regni rerum*. Nec septem pudoris saxo potior nimbosi, et lata frenis +Acutae _regni rerum_. Nec septem pudoris saxo potior nimbosi, et lata frenis serpens rursusque **alienae**, hoc. Et membris cessantem facinus tigno. Non meae, pumice bellum reddita, quod vultusque gestu misi! Aut circo! @@ -85,8 +102,7 @@ meae, pumice bellum reddita, quod vultusque gestu misi! Aut circo! Some random data ::: - -Felicem locum fessos me Alcyonen est *sed*, debueram amplexu? +Felicem locum fessos me Alcyonen est _sed_, debueram amplexu? Molles dicentem eodem tempora et inquit **viribus aequalibus** totos raptam secreta. Reperitur murmur. @@ -107,17 +123,17 @@ inclinatoque decimum enim non tenax ut dinumerat, sole [](https://doi.org/10.217 - Qualescumque atque - In germanam aeratis -*Quotiensque* incubat esse tendentem audito, Aurora ratione cupit refoventque +_Quotiensque_ incubat esse tendentem audito, Aurora ratione cupit refoventque locis antemnas neve, idonea quae. **Ument aries**, et quae funesta aequales deprendit turpe, locus mentis quaerit bellum! Bonis cernis quoniam in parente -ipse incurrere e habemus amoris animalia urbesque senes, maius *lupi tauros* +ipse incurrere e habemus amoris animalia urbesque senes, maius _lupi tauros_ operatus advehar ferro! Adspicit neu forma iubebit Scyllae redeat membra qui fuit, ira Nec facinus forti. +++ {"part": "acknowledgments"} The Lorem Markdownum for this example was generated using https://jaspervdj.be/lorem-markdownum/. -The graphic in [](#test-fig1) are created using the Matplotlib example that can be found +The graphic in [](#test-fig1) are created using the Matplotlib example that can be found [here](https://matplotlib.org/stable/gallery/lines_bars_and_markers/scatter_hist.html#sphx-glr-gallery-lines-bars-and-markers-scatter-hist-py). +++ @@ -130,4 +146,4 @@ Lorem markdownum atque loquendi est; bos Leucosiamque, et non fatebar lecti. Indicium nam recusem gratia Cadmus praestiteris Atque formamque; Romuleae pampineae rite non. -+++ \ No newline at end of file ++++ diff --git a/template.tex b/template.tex index 1095638..7287ecc 100644 --- a/template.tex +++ b/template.tex @@ -1,66 +1,65 @@ -\documentclass[ - amsmath,amssymb - [#- if options.styling == "aps"#], aps - [#- if options.aps_journal_type #] +\documentclass[amsmath,amssymb + [#- if options.styling == "aps" -#], aps + [#- if options.aps_journal_type -#] ,[-options.aps_journal_type-] - [# endif -#] + [#- endif -#] [# endif -#] [#- if options.styling == "aip"#], aip - [#- if options.aip_journal_type #] + [#- if options.aip_journal_type -#] ,[-options.aip_journal_type-] - [# endif -#] - [# endif -#] - [#- if options.styling == "aapm"#], aapm - [#- if options.aapm_journal_type #] + [#- endif -#] + [#- endif -#] + [#- if options.styling == "aapm" -#], aapm + [#- if options.aapm_journal_type -#] ,[-options.aapm_journal_type-] - [# endif -#] - [# endif -#] - [#- if options.styling == "sor"#], sor - [#- if options.sor_journal_type #] + [#- endif -#] + [#- endif -#] + [#- if options.styling == "sor" -#], sor + [#- if options.sor_journal_type -#] ,[-options.sor_journal_type-] - [# endif -#] - [# endif -#] - [#- if options.formatting #] + [#- endif -#] + [#- endif -#] + [#- if options.formatting -#] ,[-options.formatting-] - [# endif -#] - [#- if options.draft #],preprint - [# endif -#] - [#- if options.reprint #],reprint - [# endif -#] - [#- if options.preprint #],preprintnumbers - [# endif -#] - [#- if options.linenumbers #] + [#- endif -#] + [#- if options.draft -#],preprint + [#- endif -#] + [#- if options.reprint -#],reprint + [#- endif -#] + [#- if options.preprint -#],preprintnumbers + [#- endif -#] + [#- if options.linenumbers -#] ,linenumbers - [# endif -#] - [#- if options.superscriptaddress #] + [#- endif -#] + [#- if options.superscriptaddress -#] ,superscriptaddress - [# endif -#] - [#- if options.groupedaddress #] + [#- endif -#] + [#- if options.groupedaddress -#] ,groupedaddress - [# endif -#] - [#- if options.unsortedaddress #] + [#- endif -#] + [#- if options.unsortedaddress -#] ,unsortedaddress - [# endif -#] - [#- if options.runinaddress #] + [#- endif -#] + [#- if options.runinaddress -#] ,runinaddress - [# endif -#] - [#- if options.footinbib #] + [#- endif -#] + [#- if options.footinbib -#] ,footinbib - [# endif -#] - [#- if options.nofootinbib #] + [#- endif -#] + [#- if options.nofootinbib -#] ,nofootinbib - [# endif -#] - [#- if options.bibnotes #] + [#- endif -#] + [#- if options.bibnotes -#] ,bibnotes - [# endif -#] - [#- if options.nobibnotes #] + [#- endif -#] + [#- if options.nobibnotes -#] ,nobibnotes - [# endif -#] - [#- if doc.keywords #],showkeys[# endif -#] - [#- if options.paper_size #] + [#- endif -#] + [#- if doc.keywords #],showkeys[#- endif -#] + [#- if options.paper_size -#] ,[-options.paper_size-] - [# endif -#] + [#- endif -#] ]{revtex4-2} \usepackage{orcidlink} diff --git a/template.yml b/template.yml index 47f8975..0155f4a 100644 --- a/template.yml +++ b/template.yml @@ -12,6 +12,7 @@ authors: - 'no' tags: - paper + - two-column parts: - id: abstract required: true @@ -101,7 +102,7 @@ options: description: >- 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 + bibliography. This can be used to override the default behavior of the journal. - id: nofootinbib type: boolean