Skip to article frontmatterSkip to article content

elsarticle

elsarticle template

UsageΒΆ

See MyST Guide for creating Documents for instructions on how to set up a MyST project.

In the elsarticle template, the following options are available:

CategoryOptionTypeRequiredDefaultDescription
DocumenttitlestringYesTitle of your document
authorslistYesList of authors
keywordsstringYesList of keywords
bibliographystringNoPath to your bibliography file (*.bib)
OptionsstylechoiceNoreviewStyle of your document, preprint or review
reference_stylechoiceNoharvReference style, harv, num-names, or num
other_optionsstringNo12ptOther options for the document class
journal_namestringNoNuclear Physics BJournal name
linenobooleanNofalseWhether to show line numbers
PartsabstractstringYesAbstract of your document
graphical_abstractstringNoGraphical abstract of your document
highlightsstringNoHighlights of your document
availabilitystringNoData availability statement
acknowledgementsstringNoAcknowledgements
appendixstringNoAppendix

Steps to creating your own template!ΒΆ

  • πŸ†• 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 the template.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 run jtex check (documentation)
  • πŸͺ„ Continue to improve the options in your template for parts and options (documentation)
  • πŸ’Ύ 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)
  • πŸ§ͺ 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