This is a hackish quarto
template for ASCE publications based on the ascelike-new
class.
This template is intended to be used before the official rticle
-like quarto
template mechanism is released (see here, here, and here).
The majority of the qmd
file was directly converted from ascexmpl-new.tex
from the overleaf template using pandoc
.
The following tweaks are made:
- The tables are now prepared using the pipe style;
- Cross-referencing now follows the quarto syntax;
- A figure from an embedded python code is included;
- An
pdf
figure is used to replace the original figure placeholder; - The original
ascelike-new.bst
file is not included since the citation style is now handled using aCSL
file; - The styles related to citation in the
ascelike-new.cls
are also commented out.
To use this template, fork, clone or click the Use this template
button.
A more convenient way is to use github cli
gh repo create "new-repo-name" --private --clone -p "https://github.com/juliantao/asce-quarto"
gh repo create "new-repo-name"
creates a new github repo with the namenew-repo-name
--private
makes the github repo private before submission--clone
clones the remote repo to a local repo in the current directory and links the two-p "https://github.com/juliantao/asce-quarto"
uses theasce-quarto
repo as a template
In the shared matadata _quarto.yml
,
- Set
classoption: [NewProceedings, letterpaper]
for conference paper - Set
classoption: [Journal, letterpaper]
for journal paper - by default, the rendered files will be in the
_output
folder, change as you wish
-
In the
yaml
header of the mainqmd
file,- do not include the title field
- ONLY include the first author for the
author
field
-
Right after the
yaml
header in the mainqmd
and before the# Abstract
section, include the remaining parts of thetitle
block using rawLaTex
:
\title{Template for Preparing Your Submission to the American Society Of Civil Engineers (ASCE)}
% do not redefine author one again
\author[2]{Author Two}
\author[3]{Author Three}
\affil[1]{First affiliation address, with corresponding author email. Email: author.one@email.com}
\affil[2]{Second affiliation address}
\affil[2]{Third affiliation address}
\maketitle
- Add
\appendix
before the appendix sections so that the section titles can be properly rendered. When referencing an appendix section, use syntaxAppendix [-@sec-label]
, this will be rendered to something likeAppendix I
.
-
Update the
references.bib
file in the./assets/
directory -
Add a section title for the references at the end of the main
qmd
file
# References {-}
::: {.refs}
:::
It is suggested to have a meaningful structure of the directory.
For example, this template has the following tree structure.
The data
and code
directories are empty but should be updated for your paper.
.
├── assets
│ ├── american-society-of-civil-engineers.csl
│ ├── ascelike-new.cls
│ └── references.bib
├── code
├── data
├── example-original.tex
├── example.qmd
├── example.tex
├── img
│ └── asce-logo.pdf
├── LICENSE
├── _output
│ ├── example_files
│ │ └── figure-pdf
│ │ └── fig-fill-between-output-1.pdf
│ └── example.pdf
├── _quarto.yml
└── README.md
-
This template works only for
pdf
andtex
format now. Although a word template file is also provided, the rendered docx file is not ideal. Currently, the best way to generate adocx
file with comparable layout is using Acrobat DC from Adobe to convert the generated pdf file directly to docx file. -
If you have an old
texlive
distribution, there may be a warning on option crash. Please updatetexlive
. It is also recommended that you use the latest version of Quarto. -
Alternatively, you can comment out the line
- \usepackage{newtxtext,newtxmath}
in_quarto.yml
. Thelmodern
fonts will be used, which will look different from the official template. But it is not a great deal...
-
figure out the numbering for appendix -
figure out a better way to cross-reference appendices - also ensure
html
format can be rendered with the title block - improve
docx
output format