ascelike-new template
- Author: American Society of Civil Engineers
- Author Website: https://
www .asce .org / - Submission Guidelines
Usage¶
See MyST Guide for creating Documents for instructions on how to set up a MyST project.
In the ascelike-new template, the following options are available:
| Category | Option | Type | Required | Default | Description |
|---|---|---|---|---|---|
| Document | title | string | Yes | Title of your document | |
authors | list | Yes | List of authors | ||
keywords | string | Yes | List of keywords | ||
bibliography | string | No | Path to your bibliography file (*.bib) | ||
| Options | style | choice | No | Journal | Style of your document, Journal, NewProceedings or Proceedings |
lists_placement | choice | No | InsideFigs | Placement for list of figures and tables, BackFigs or InsideFigs | |
spacing | choice | No | DoubleSpace | Spacing between lines, SingleSpace or DoubleSpace | |
font_size | choice | No | 12pt | Font size, 10pt, 11pt, or 12pt | |
other_options | string | No | letterpaper | Other options for the document class | |
name_tag | string | No | AuthorOneLastName | The first author’s last name for the footer | |
| Parts | abstract | string | Yes | Abstract of your document | |
availability | string | No | Data availability statement | ||
acknowledgements | string | No | Acknowledgements | ||
appendix | string | No | Appendix |
Steps to creating your own template!¶
- 🆕 Create this repository. Nailed it. 🚀
- 📑 Replace the
template.texwith your existing LaTeX template/article - 👯♀️ Copy in any other style, definitions or images necessary for the template
- 👩🔬 Add the files necessary into
fileslist 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
partsandoptions(documentation) - 💾 When ready, save your
template.ymland 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.pngwith 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
- (2014). American Society of Civil Engineers. 10.1061/9780784479018