generated from quarto-journals/article-format-template
-
Notifications
You must be signed in to change notification settings - Fork 1
/
asce-template.tex
1169 lines (999 loc) · 46.4 KB
/
asce-template.tex
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
% Options for packages loaded elsewhere
\PassOptionsToPackage{unicode}{hyperref}
\PassOptionsToPackage{hyphens}{url}
\PassOptionsToPackage{dvipsnames,svgnames,x11names}{xcolor}
%
\documentclass[NewProceedings, InsideFigs,LineNumbers]{asce-quarto}
\usepackage{amsmath,amssymb}
\usepackage{iftex}
\ifPDFTeX
\usepackage[T1]{fontenc}
\usepackage[utf8]{inputenc}
\usepackage{textcomp} % provide euro and other symbols
\else % if luatex or xetex
\usepackage{unicode-math}
\defaultfontfeatures{Scale=MatchLowercase}
\defaultfontfeatures[\rmfamily]{Ligatures=TeX,Scale=1}
\fi
\usepackage{lmodern}
\ifPDFTeX\else
% xetex/luatex font selection
\fi
% Use upquote if available, for straight quotes in verbatim environments
\IfFileExists{upquote.sty}{\usepackage{upquote}}{}
\IfFileExists{microtype.sty}{% use microtype if available
\usepackage[]{microtype}
\UseMicrotypeSet[protrusion]{basicmath} % disable protrusion for tt fonts
}{}
\makeatletter
\@ifundefined{KOMAClassName}{% if non-KOMA class
\IfFileExists{parskip.sty}{%
\usepackage{parskip}
}{% else
\setlength{\parindent}{0pt}
\setlength{\parskip}{6pt plus 2pt minus 1pt}}
}{% if KOMA class
\KOMAoptions{parskip=half}}
\makeatother
\usepackage{xcolor}
\setlength{\emergencystretch}{3em} % prevent overfull lines
\setcounter{secnumdepth}{-\maxdimen} % remove section numbering
% Make \paragraph and \subparagraph free-standing
\makeatletter
\ifx\paragraph\undefined\else
\let\oldparagraph\paragraph
\renewcommand{\paragraph}{
\@ifstar
\xxxParagraphStar
\xxxParagraphNoStar
}
\newcommand{\xxxParagraphStar}[1]{\oldparagraph*{#1}\mbox{}}
\newcommand{\xxxParagraphNoStar}[1]{\oldparagraph{#1}\mbox{}}
\fi
\ifx\subparagraph\undefined\else
\let\oldsubparagraph\subparagraph
\renewcommand{\subparagraph}{
\@ifstar
\xxxSubParagraphStar
\xxxSubParagraphNoStar
}
\newcommand{\xxxSubParagraphStar}[1]{\oldsubparagraph*{#1}\mbox{}}
\newcommand{\xxxSubParagraphNoStar}[1]{\oldsubparagraph{#1}\mbox{}}
\fi
\makeatother
\usepackage{color}
\usepackage{fancyvrb}
\newcommand{\VerbBar}{|}
\newcommand{\VERB}{\Verb[commandchars=\\\{\}]}
\DefineVerbatimEnvironment{Highlighting}{Verbatim}{commandchars=\\\{\}}
% Add ',fontsize=\small' for more characters per line
\usepackage{framed}
\definecolor{shadecolor}{RGB}{241,243,245}
\newenvironment{Shaded}{\begin{snugshade}}{\end{snugshade}}
\newcommand{\AlertTok}[1]{\textcolor[rgb]{0.68,0.00,0.00}{#1}}
\newcommand{\AnnotationTok}[1]{\textcolor[rgb]{0.37,0.37,0.37}{#1}}
\newcommand{\AttributeTok}[1]{\textcolor[rgb]{0.40,0.45,0.13}{#1}}
\newcommand{\BaseNTok}[1]{\textcolor[rgb]{0.68,0.00,0.00}{#1}}
\newcommand{\BuiltInTok}[1]{\textcolor[rgb]{0.00,0.23,0.31}{#1}}
\newcommand{\CharTok}[1]{\textcolor[rgb]{0.13,0.47,0.30}{#1}}
\newcommand{\CommentTok}[1]{\textcolor[rgb]{0.37,0.37,0.37}{#1}}
\newcommand{\CommentVarTok}[1]{\textcolor[rgb]{0.37,0.37,0.37}{\textit{#1}}}
\newcommand{\ConstantTok}[1]{\textcolor[rgb]{0.56,0.35,0.01}{#1}}
\newcommand{\ControlFlowTok}[1]{\textcolor[rgb]{0.00,0.23,0.31}{\textbf{#1}}}
\newcommand{\DataTypeTok}[1]{\textcolor[rgb]{0.68,0.00,0.00}{#1}}
\newcommand{\DecValTok}[1]{\textcolor[rgb]{0.68,0.00,0.00}{#1}}
\newcommand{\DocumentationTok}[1]{\textcolor[rgb]{0.37,0.37,0.37}{\textit{#1}}}
\newcommand{\ErrorTok}[1]{\textcolor[rgb]{0.68,0.00,0.00}{#1}}
\newcommand{\ExtensionTok}[1]{\textcolor[rgb]{0.00,0.23,0.31}{#1}}
\newcommand{\FloatTok}[1]{\textcolor[rgb]{0.68,0.00,0.00}{#1}}
\newcommand{\FunctionTok}[1]{\textcolor[rgb]{0.28,0.35,0.67}{#1}}
\newcommand{\ImportTok}[1]{\textcolor[rgb]{0.00,0.46,0.62}{#1}}
\newcommand{\InformationTok}[1]{\textcolor[rgb]{0.37,0.37,0.37}{#1}}
\newcommand{\KeywordTok}[1]{\textcolor[rgb]{0.00,0.23,0.31}{\textbf{#1}}}
\newcommand{\NormalTok}[1]{\textcolor[rgb]{0.00,0.23,0.31}{#1}}
\newcommand{\OperatorTok}[1]{\textcolor[rgb]{0.37,0.37,0.37}{#1}}
\newcommand{\OtherTok}[1]{\textcolor[rgb]{0.00,0.23,0.31}{#1}}
\newcommand{\PreprocessorTok}[1]{\textcolor[rgb]{0.68,0.00,0.00}{#1}}
\newcommand{\RegionMarkerTok}[1]{\textcolor[rgb]{0.00,0.23,0.31}{#1}}
\newcommand{\SpecialCharTok}[1]{\textcolor[rgb]{0.37,0.37,0.37}{#1}}
\newcommand{\SpecialStringTok}[1]{\textcolor[rgb]{0.13,0.47,0.30}{#1}}
\newcommand{\StringTok}[1]{\textcolor[rgb]{0.13,0.47,0.30}{#1}}
\newcommand{\VariableTok}[1]{\textcolor[rgb]{0.07,0.07,0.07}{#1}}
\newcommand{\VerbatimStringTok}[1]{\textcolor[rgb]{0.13,0.47,0.30}{#1}}
\newcommand{\WarningTok}[1]{\textcolor[rgb]{0.37,0.37,0.37}{\textit{#1}}}
\providecommand{\tightlist}{%
\setlength{\itemsep}{0pt}\setlength{\parskip}{0pt}}\usepackage{longtable,booktabs,array}
\usepackage{calc} % for calculating minipage widths
% Correct order of tables after \paragraph or \subparagraph
\usepackage{etoolbox}
\makeatletter
\patchcmd\longtable{\par}{\if@noskipsec\mbox{}\fi\par}{}{}
\makeatother
% Allow footnotes in longtable head/foot
\IfFileExists{footnotehyper.sty}{\usepackage{footnotehyper}}{\usepackage{footnote}}
\makesavenoteenv{longtable}
\usepackage{graphicx}
\makeatletter
\def\maxwidth{\ifdim\Gin@nat@width>\linewidth\linewidth\else\Gin@nat@width\fi}
\def\maxheight{\ifdim\Gin@nat@height>\textheight\textheight\else\Gin@nat@height\fi}
\makeatother
% Scale images if necessary, so that they will not overflow the page
% margins by default, and it is still possible to overwrite the defaults
% using explicit options in \includegraphics[width, height, ...]{}
\setkeys{Gin}{width=\maxwidth,height=\maxheight,keepaspectratio}
% Set default figure placement to htbp
\makeatletter
\def\fps@figure{htbp}
\makeatother
% definitions for citeproc citations
\NewDocumentCommand\citeproctext{}{}
\NewDocumentCommand\citeproc{mm}{%
\begingroup\def\citeproctext{#2}\cite{#1}\endgroup}
\makeatletter
% allow citations to break across lines
\let\@cite@ofmt\@firstofone
% avoid brackets around text for \cite:
\def\@biblabel#1{}
\def\@cite#1#2{{#1\if@tempswa , #2\fi}}
\makeatother
\newlength{\cslhangindent}
\setlength{\cslhangindent}{1.5em}
\newlength{\csllabelwidth}
\setlength{\csllabelwidth}{3em}
\newenvironment{CSLReferences}[2] % #1 hanging-indent, #2 entry-spacing
{\begin{list}{}{%
\setlength{\itemindent}{0pt}
\setlength{\leftmargin}{0pt}
\setlength{\parsep}{0pt}
% turn on hanging indent if param 1 is 1
\ifodd #1
\setlength{\leftmargin}{\cslhangindent}
\setlength{\itemindent}{-1\cslhangindent}
\fi
% set entry spacing
\setlength{\itemsep}{#2\baselineskip}}}
{\end{list}}
\usepackage{calc}
\newcommand{\CSLBlock}[1]{\hfill\break\parbox[t]{\linewidth}{\strut\ignorespaces#1\strut}}
\newcommand{\CSLLeftMargin}[1]{\parbox[t]{\csllabelwidth}{\strut#1\strut}}
\newcommand{\CSLRightInline}[1]{\parbox[t]{\linewidth - \csllabelwidth}{\strut#1\strut}}
\newcommand{\CSLIndent}[1]{\hspace{\cslhangindent}#1}
\usepackage[figurename=Fig.,labelfont=bf,labelsep=period]{caption}
\usepackage{newtxtext,newtxmath}
\makeatletter
\@ifpackageloaded{caption}{}{\usepackage{caption}}
\AtBeginDocument{%
\ifdefined\contentsname
\renewcommand*\contentsname{Table of contents}
\else
\newcommand\contentsname{Table of contents}
\fi
\ifdefined\listfigurename
\renewcommand*\listfigurename{List of Figures}
\else
\newcommand\listfigurename{List of Figures}
\fi
\ifdefined\listtablename
\renewcommand*\listtablename{List of Tables}
\else
\newcommand\listtablename{List of Tables}
\fi
\ifdefined\figurename
\renewcommand*\figurename{\textbf{Fig.}}
\else
\newcommand\figurename{\textbf{Fig.}}
\fi
\ifdefined\tablename
\renewcommand*\tablename{\textbf{Table}}
\else
\newcommand\tablename{\textbf{Table}}
\fi
}
\@ifpackageloaded{float}{}{\usepackage{float}}
\floatstyle{ruled}
\@ifundefined{c@chapter}{\newfloat{codelisting}{h}{lop}}{\newfloat{codelisting}{h}{lop}[chapter]}
\floatname{codelisting}{Listing}
\newcommand*\listoflistings{\listof{codelisting}{List of Listings}}
\captionsetup{labelsep=period}
\makeatother
\makeatletter
\makeatother
\makeatletter
\@ifpackageloaded{caption}{}{\usepackage{caption}}
\@ifpackageloaded{subcaption}{}{\usepackage{subcaption}}
\makeatother
\ifLuaTeX
\usepackage{selnolig} % disable illegal ligatures
\fi
\usepackage{bookmark}
\IfFileExists{xurl.sty}{\usepackage{xurl}}{} % add URL line breaks if available
\urlstyle{same} % disable monospaced font for URLs
\hypersetup{
pdftitle={Template for Preparing Your Submission to the American Society Of Civil Engineers (ASCE)},
pdfauthor={Author One, S.M. ASCE; Author Two, M. ASCE; Author three, A.M. ASCE},
pdfkeywords={template, quarto, asce},
colorlinks=true,
linkcolor={NavyBlue},
filecolor={Maroon},
citecolor={NavyBlue},
urlcolor={NavyBlue},
pdfcreator={LaTeX via pandoc}}
\title{Template for Preparing Your Submission to the American Society Of
Civil Engineers (ASCE)}
\author[1]{Author One, S.M. ASCE}%
\affil[1]{
Graduate Research Associate, First affiliation address;
Email: author.one@email.com
}
\author[2]{Author Two, M. ASCE}%
\affil[2]{
Assistant Professor, Second affiliation address;
Email: author.two@email.com
}
\author[3*]{Author three, A.M. ASCE}%
\affil[3*]{
Associate Professor, Third affiliation address;
Email: author.three@email.com
; Corresponding author}
\NameTag{Author1, \today}
\begin{document}
\maketitle
\begin{abstract}
The abstract should be a single paragraph (150-175 words long) written
in plain language and include a summary of the key conclusions of the
manuscript. It should clearly state the purpose of the work, the scope
of the effort, the procedures used to execute the work, and major
findings. The abstract is the second most important online search
discovery element, after the title. Authors should review the abstract
to ensure that it accurately reflects the revised paper and should
strive to include any applicable keywords that would likely be used
during an online search. Mathematics and references are not permitted in
the abstract and will be removed by the copyeditors.
\end{abstract}
\KeyWords{template, quarto, asce}
\par
\vspace{1em}
\section{Introduction}\label{introduction}
This template and class file ``\texttt{asce-quarto.cls}'', based on
Matthew R. Kuhn's ``\texttt{ascelike-new.cls}'',produce manuscripts that
comply with the guidelines of the American Society of Civil Engineers
(ASCE). The original ``\texttt{ascelike-new.cls}'' class has been
produced by \href{https://www.overleaf.com}{Overleaf} in conjunction
with the ``\texttt{ascelike-new.bst}'' citation style developed by
Matthew R. Kuhn.
The ``\texttt{asce-quarto.cls}'' differs from
``\texttt{ascelike-new.cls}'' in that, the citation and bibliography
related contents in the latter have been removed. Citation and
bibliography styles are now handled using citation language style
``\texttt{ascelike.cls}'' with Pandoc's \texttt{citproc} via Quarto.
This template provides guidance on how to prepare your manuscript
according to the ASCE requirements, including details on how to use
various LaTeX commands to achieve the appropriate formatting. Additional
template options are given in Appendix \ref{sec-app-options}. If you
have any questions about this template, or need help with LaTeX, please
\href{https://www.overleaf.com/contact}{contact Overleaf} who can
provide assistance as required.
Once your work is complete, please use the ``Submit to ASCE'' option in
Overleaf to select the appropriate journal for your manuscript and
follow the instructions to complete your submission.
For more information on the ASCE, and to access additional resources for
authors, please visit the
\href{http://ascelibrary.org/page/authors}{ASCE Library website}.
\section{Preparing Your Manuscript}\label{preparing-your-manuscript}
\subsection{Length}\label{length}
For most ASCE journals, the maximum length for technical papers and case
studies is 30 double-spaced manuscript pages including references,
figures, tables, and captions; 7 double-spaced manuscript pages for
technical notes; and 4 double-spaced manuscript pages for discussions
and closures. The editor may waive these restrictions to encourage
manuscripts on topics that cannot be treated within these limitations.
See the
\href{https://ascelibrary.org/doi/pdf/10.1061/9780784479018}{``Publishing
in ASCE Journals: A Guide for Authors''} for information on other
article types.
\subsection{General Flow of the Paper}\label{general-flow-of-the-paper}
Sections of the article should not be numbered and use word headings
only. Article sections should appear in the following order:
\begin{itemize}
\item
Title page content (includes title, author byline \& affiliation,
abstract)
\item
Introduction
\item
Main text sections
\item
Conclusion
\item
Appendix(es)
\item
Data Availability Statement
\item
Acknowledgments
\item
Disclaimers
\item
Notation list
\item
Supplemental Materials
\item
References
\end{itemize}
\subsection{Title}\label{title}
Titles should be no longer than 100 characters including spaces. The
title of a paper is the first ``description'' of a paper found via
search engine. Authors should take care to ensure that the title is
specific and accurately reflects the final, post-peer reviewed version
of the paper. Authors should try to include relevant search terms in the
title of the paper to maximize discoverability online. Titles should not
begin with ``A,'' ``An,'' ``The,'' ``Analysis of,'' ``Theory of,'' ``On
the,'' ``Toward,'' etc.
\subsection{Author Bylines}\label{author-bylines}
Under the title of the manuscript, the full name of each author and his
or her affiliation and professional designation, if applicable, must be
included. The following academic and professional designations are
currently acceptable for all journals: Ph.D., Dr.Tech., Dr.Eng., D.Sc.,
Sc.D., J.D., P.E., S.E., D.WRE, Hon.D.WRE, D.GE, D.CE, D.OE, D.PE, D.NE,
NAE, DEE, P.Eng., CEng, L.S., P.L.S., G.E., P.G., P.H., RA, AICP, and
CPEng.
Former affiliations are permissible only if an author's affiliation has
changed after a manuscript has been submitted for publication. If a
coauthor has passed away, include the date of death in the affiliation
line. Any manuscript submitted without a separate affiliation statement
for each author will be returned to the corresponding author for
correction.
\subsection{Gender-specific Words}\label{gender-specific-words}
Authors should avoid ``he,'' ``she,'' ``his,'' ``her,'' and ``hers.''
Alternatively, words such as ``author,'' ``discusser,'' ``engineer,''
and ``researcher'' should be used.
\subsection{Footnotes and Endnotes}\label{footnotes-and-endnotes}
Footnotes and endnotes are not permitted in the text. Authors must
incorporate any necessary information within the text of the manuscript.
\textbf{Exception} - Endnotes are only permitted for use in the
\emph{Journal of Legal Affairs and Dispute Resolution in Engineering and
Construction}.
\subsection{SI Units}\label{si-units}
The use of Système Internationale (SI) units as the primary units of
measure is mandatory. Other units of measurement may be given in
parentheses after the SI unit if the author desires. More information
about SI units can be found on the
\href{http://physics.nist.gov/cuu/Units/index.html}{NIST website}.
\subsection{Conclusions}\label{conclusions}
At the end of the manuscript text, authors must include a set of
conclusions, or summary and conclusion, in which the significant
implications of the information presented in the body of the text are
reviewed. Authors are encouraged to explicitly state in the conclusions
how the work presented contributes to the overall body of knowledge for
the profession.
\subsection{Data Availability
Statement}\label{data-availability-statement}
When submitting a new and revised manuscript, authors are asked to
include a data availability statement containing one or more of the
following statements, with specific items listed as appropriate. Please
include one or more of the statements below, deleting those which do not
apply. This section should appear directly before the Acknowledgments
section.
\begin{itemize}
\item
Some or all data, models, or code generated or used during the study
are available in a repository online in accordance with funder data
retention policies (provide full citations that include URLS or DOIs)
\item
Some or all data, models, or code used during the study were provided
by a third party (list items). Direct requests for these materials may
be made to the provider as indicated in the Acknowledgements.
\item
Some or all data, models, or code that support the findings of this
study are available from the corresponding author upon reasonable
request (list items).
\item
Some or all data, models, or code generated or used during the study
are proprietary or confidential in nature and may only be provided
with restrictions (e.g.~anonymized data) (List items and
restrictions).
\item
All data, models, and code generated or used during the study appear
in the submitted article.
\item
No data, models, or code were generated or used during the study
(e.g., opinion or data-less paper).
\end{itemize}
Please also see the guidelines at:
\url{https://ascelibrary.org/page/dataavailability}.
\subsection{Acknowledgments}\label{acknowledgments}
Acknowledgments are encouraged as a way to thank those who have
contributed to the research or project but did not merit being listed as
an author. The Acknowledgments should indicate what each person did to
contribute to the project.
Authors can include an Acknowledgments section to recognize any advisory
or financial help received. This section should appear after the
Conclusions and before the references. Authors are responsible for
ensuring that funding declarations match what was provided in the
manuscript submission system as part of the FundRef query. Discrepancies
may result in delays in publication.
\subsection{Mathematics}\label{mathematics}
All displayed equations should be numbered sequentially throughout the
entire manuscript, including Appendixes. Equations should be in the body
of a manuscript; complex equations in tables and figures are to be
avoided, and numbered equations are never permitted in figures and
tables. Here is an example of a displayed equation
(Eq.~\ref{eq-Einstein})
\begin{equation}\phantomsection\label{eq-Einstein}{
E = m c^{2}
}\end{equation}
Symbols should be listed alphabetically in a section called ``Notation''
at the end of the manuscript (preceding the references). See the
folliowing section for more details.
\subsection{Notation List}\label{notation-list}
Notation lists are optional; however, authors choosing to include one
should follow these guidelines:
\begin{itemize}
\item
List all items alphabetically.
\item
Capital letters should precede lowercase letters.
\item
The Greek alphabet begins after the last letter of the English
alphabet.
\item
Non-alphabetical symbols follow the Greek alphabet.
\end{itemize}
Notation lists should always begin with the phrase, ``\emph{The
following symbols are used in this paper:}''; acronyms and abbreviations
are not permitted in the Notation list except when they are used in
equations as variables. Definitions should end with a semicolon. An
example Notation list has been included in this template; see Appendix
\ref{sec-app-notation}.
\subsection{Appendixes}\label{appendixes}
Appendixes can be used to record details and data that are of secondary
importance or are needed to support assertions in the text. The main
body of the text must contain references to all Appendixes. Any tables
or figures in Appendixes should be numbered sequentially, following the
numbering of these elements in the text. Appendixes must contain some
text, and need to be more than just figures and/or tables. Appendixes
containing forms or questionnaires should be submitted as Supplemental
Materials instead.
\section{Sections, subsections, equations,
etc.}\label{sections-subsections-equations-etc.}
This section is included to explain and to test the formatting of
sections, subsections, subsubsections, equations, tables, and figures.
Section heading are automatically made uppercase; to include mathematics
or symbols in a section heading, you can use the
\texttt{\textbackslash{}lowercase\{\}} around the content,
e.g.~\texttt{\textbackslash{}lowercase\{\textbackslash{}boldmath\$c\^{}\{2\}\$\}}.
\subsection{An Example Subsection}\label{an-example-subsection}
No automatic capitalization occurs with subsection headings; you will
need to capitalize the first letter of each word, as in ``An Example
Subsection.''
\subsubsection{An example subsubsection}\label{an-example-subsubsection}
No automatic capitalization occurs with subsubsections; you will need to
capitalize only the first letter of subsubsection headings.
\section{Figures and Tables}\label{figures-and-tables}
This template includes two examples of figure
(Fig.~\ref{fig-fill-between}, Fig.~\ref{fig-asce-logo}) and a table
(Table~\ref{tbl-assembly}). Fig.~\ref{fig-fill-between} is a computed
figure with python. It has a caption with no more information than the
figure itself, a very poor practice indeed. A reference here
(\citeproc{ref-Stahl:2004a}{Stahl et al. 2004}).
\begin{figure}
\centering{
\includegraphics{asce-template_files/figure-pdf/fig-fill-between-output-1.pdf}
}
\caption{\label{fig-fill-between}An example figure.}
\end{figure}%
Fig.~\ref{fig-asce-logo} is a figure of \texttt{pdf} format.
\subsection{Figure Captions}\label{figure-captions}
Figure captions should be short and to the point; they need not include
a complete explanation of the figure.
\subsection{Figure Files}\label{figure-files}
Figures should be uploaded as separate files in TIFF, EPS, or PDF
format. If using PDF format, authors must ensure that all fonts are
embedded before submission. Every figure must have a figure number and
be cited sequentially in the text.
\begin{figure}
\centering{
\includegraphics{./img/asce-logo.pdf}
}
\caption{\label{fig-asce-logo}ASCE logo with signature on one line}
\end{figure}%
\subsection{Color Figures}\label{color-figures}
Figures submitted in color will be published in color in the online
journal at no cost. Color figures provided must be suitable for printing
in black and white. Color figures that are ambiguous in black and white
will be returned to the author for revision, and will delay publication.
Authors wishing to have figures printed in color must indicate this in
the submission questions. There is a fee for publishing color figures in
print.
\subsection{Table Format}\label{table-format}
The following is a guide to preparing tables as part of your submission
\begin{itemize}
\item
Vertical rules should not be used in tables. Horizontal rules are used
to offset column headings at the top of the table and footnotes (if
any) at the bottom of the table and to separate major sections.
\item
All columns must have a heading. Each table should have only one set
of column headings at the top of the table. Using additional column
headings within the body of the table should be avoided.
\item
Photographs, sketches, line art, or other graphic elements are not
permitted in tables. Any table that includes graphics must be treated
and numbered as a figure.
\item
Highlighting and shading are also not permitted and will not be
reproduced in print. Boldface font should be used for emphasis
sparingly.
\item
Equations are allowed in the table body, but should be avoided if
possible. Numbered equations are never allowed in tables.
\item
Tables should not be submitted in multiple parts (Table 1a, 1b, etc.).
Tables with multiple parts should either be combined into one table or
split into separate tables.
\end{itemize}
\begin{longtable}[]{@{}
>{\raggedright\arraybackslash}p{(\columnwidth - 2\tabcolsep) * \real{0.6000}}
>{\raggedright\arraybackslash}p{(\columnwidth - 2\tabcolsep) * \real{0.4000}}@{}}
\caption{An example table}\label{tbl-assembly}\tabularnewline
\toprule\noalign{}
\begin{minipage}[b]{\linewidth}\raggedright
Assembly Attribute (1)
\end{minipage} & \begin{minipage}[b]{\linewidth}\raggedright
Values (2)
\end{minipage} \\
\midrule\noalign{}
\endfirsthead
\toprule\noalign{}
\begin{minipage}[b]{\linewidth}\raggedright
Assembly Attribute (1)
\end{minipage} & \begin{minipage}[b]{\linewidth}\raggedright
Values (2)
\end{minipage} \\
\midrule\noalign{}
\endhead
\bottomrule\noalign{}
\endlastfoot
Number of particles & 4008 \\
Particle sizes & Multiple \\
Particle size range & \(0.45D_{50}^{\:\ast}\) to \(1.40D_{50}\) \\
Initial void ratio, \(e_{\mathrm{init}}\) & \(0.179\) \\
Assembly size & \(54D_{50} \times 54D_{50} \times 54D_{50}\) \\
\(\ast\) \(D_{50}\) represents the median particle diameter & \\
\end{longtable}
\section{Figure, Table and Text
Permissions}\label{figure-table-and-text-permissions}
Authors are responsible for obtaining permission for each figure,
photograph, table, map, material from a Web page, or significant amount
of text published previously or created by someone other than the
author. Permission statements must indicate permission for use online as
well as in print.
ASCE will not publish a manuscript if any text, graphic, table, or
photograph has unclear permission status. Authors are responsible for
paying any fees associated with permission to publish any material. If
the copyright holder requests a copy of the journal in which his or her
figure is used, the corresponding author is responsible for obtaining a
copy of the journal.
\section{Supplemental Materials}\label{supplemental-materials}
Supplemental Materials are considered to be data too large to be
submitted comfortably for print publication (e.g., movie files, audio
files, animated .gifs, 3D rendering files) as well as color figures,
data tables, and text (e.g., Appendixes) that serve to enhance the
article, but are not considered vital to support the science presented
in the article. A complete understanding of the article does not depend
upon viewing or hearing the Supplemental Materials.
Supplemental Materials must be submitted for inclusion in the online
version of any ASCE journal via Editorial Manager at the time of
submission.
Decisions about whether to include Supplemental Materials will be made
by the relevant journal editor as part of the article acceptance
process. Supplemental Materials files will be posted online as supplied.
They will not be checked for accuracy, copyedited, typeset, or
proofread. The responsibility for scientific accuracy and file
functionality remains with the authors. A disclaimer will be displayed
to this effect with any supplemental materials published online. ASCE
does not provide technical support for the creation of supplemental
materials.
ASCE will only publish Supplemental Materials subject to full copyright
clearance. This means that if the content of the file is not original to
the author, then the author will be responsible for clearing all
permissions prior to publication. The author will be required to provide
written copies of permissions and details of the correct copyright
acknowledgment. If the content of the file is original to the author,
then it will be covered by the same Copyright Transfer Agreement as the
rest of the article.
Supplemental Materials must be briefly described in the manuscript with
direct reference to each item, such as Figure S1, Table S1, Protocol S1,
Audio S1, and Video S1 (numbering should always start at 1, since these
elements will be numbered independently from those that will appear in
the printed version of the article). Text within the supplemental
materials must follow journal style. Links to websites other than a
permanent public repository are not an acceptable alternative because
they are not permanent archives.
When an author submits supplemental materials along with a manuscript,
the author must include a section entitled ``Supplemental Materials''
within the manuscript. This section should be placed immediately before
the References section. This section should only contain a direct list
of what is included in the supplemental materials, and where those
materials can be found online. Descriptions of the supplemental
materials should not be included here. An example of appropriate text
for this section is ``Figs. S1--S22 are available online in the ASCE
Library (\href{http://ascelibrary.org/}{ascelibrary.org}).''
\section{References, Citations and bibliographic
entries}\label{references-citations-and-bibliographic-entries}
ASCE uses the author-date method for in-text references, whereby the
source reads as the last names of the authors, then the year (e.g.,
Smith 2004 or Smith and Jones 2004). A References section must be
included that lists all references alphabetically by last name of the
first author.
When used together, \texttt{asce-quarto.cls} and \texttt{asce.csl}
produce citations and the References section in the correct format
automatically.
References must be published works only. Exceptions to this rule are
theses, dissertations, and ``in press'' articles, all of which are
allowed in the References list. References cited in text that are not
found in the reference list will be deleted but queried by the
copyeditor. Likewise, all references included in the References section
must be cited in the text.
The citation options are available at
\href{https://quarto.org/docs/authoring/citations.html}{Quarto website}.
For example, \texttt{{[}-@Ireland:1954a{]}} produces the year
information, (\citeproc{ref-Ireland:1954a}{1954}), only.
The bibliographic data base \texttt{ascexmpl-new.bib} gives examples of
bibliographic entries for different document types. These entries are
from the canonical set in the ASCE web document ``Instructions For
Preparation Of Electronic Manuscripts'' and from the ASCE website. The
References section of this document has been automatically created with
the \texttt{asce.csl} style for the following entries:
\begin{itemize}
\item
a book (\citeproc{ref-Goossens:1994a}{Goossens et al. 1994}),
\item
an anonymous book (\citeproc{ref-Moody:1988a}{\emph{Moody's municipal
\& government manual} 1988}),
\item
an anonymous report using \texttt{@MANUAL}
(\citeproc{ref-FHWA:1991a}{\emph{Evaluating scour at bridges} 1991}),
\item
a journal article (\citeproc{ref-Pennoni:1992a}{Pennoni 1992};
\citeproc{ref-Stahl:2004a}{Stahl et al. 2004}),
\item
a journal article in press (\citeproc{ref-Dasgupta:2008a}{Dasgupta
2008}),
\item
an article in an edited book using \texttt{@INCOLLECTION}
(\citeproc{ref-Zadeh:1981a}{Zadeh 1981}),
\item
a building code using \texttt{@MANUAL}
(\citeproc{ref-ICBO:1988a}{\emph{Uniform building code} 1988}),
\item
a discussion of an \texttt{@ARTICLE}
(\citeproc{ref-Vesilind:1992a}{Vesilind 1992}),
\item
a masters thesis using \texttt{@MASTERSTHESIS}
(\citeproc{ref-Sotiropulos:1991a}{Sotiropulos 1991}),
\item
a doctoral thesis using \texttt{@PHDTHESIS}
(\citeproc{ref-Chang:1987a}{Chang 1987}),
\item
a paper in a foreign journal (\citeproc{ref-Ireland:1954a}{Ireland
1954}),
\item
a paper in a proceedings using \texttt{@INPROCEEDINGS}
(\citeproc{ref-Eshenaur:1991a}{Eshenaur et al. 1991};
\citeproc{ref-Garrett:2003a}{Garrett 2003}),
\item
a standard using \texttt{@INCOLLECTION}
(\citeproc{ref-ASTM:1991a}{ASTM 1991}),
\item
a translated book (\citeproc{ref-Melan:1913a}{Melan 1913}),
\item
a two-part paper (\citeproc{ref-Frater:1992a}{Frater and Packer
1992a}; \citeproc{ref-Frater:1992b}{b}),
\item
a university report using \texttt{@TECHREPORT}
(\citeproc{ref-Duan:1990a}{Duan et al. 1990}),
\item
an untitled item in the Federal Register using \texttt{@MANUAL}
(\citeproc{ref-FR:1968a}{\emph{Federal register} 1988}),
\item
works in a foreign language (\citeproc{ref-Duvant:1972a}{Duvant and
Lions 1972}; \citeproc{ref-Reiffenstuhl:1982a}{Reiffenstuhl 1982}),
\item
software using \texttt{@MANUAL}
(\citeproc{ref-Lotus:1985a}{\emph{Lotus 1-2-3 reference manual;
release 2.01} 1985}),
\item
two works by the same author in the same year
(\citeproc{ref-Gaspar:2001b}{Gaspar and Koenders 2001a};
\citeproc{ref-Gaspar:2001a}{b}), and
\item
two works by three authors in the same year that only share the first
two authors (\citeproc{ref-Huang2009a}{Huang et al. 2009a};
\citeproc{ref-Huang2009b}{b}).
\end{itemize}
ASCE has added two types of bibliographic entries: webpages and CD-ROMs.
A webpage can be formated using the \texttt{@MISC} entry category, as
with the item (\citeproc{ref-Burka:1993a}{Burka 1993}) produced with the
following \texttt{*.bib} entry:
\begin{verbatim}
@MISC{Burka:1993a,
author = {Burka, L. P.},
title = {A hypertext history of multi-user dimensions},
journal = {MUD history},
year = {1993},
month = {Dec. 5, 1994},
url = {http://www.ccs.neu.edu}
}
\end{verbatim}
Notice the use of the ``\texttt{month}'' field to give the date that
material was downloaded and the use of a new ``\texttt{url}'' field. The
``\texttt{url}'' and \texttt{month}'' fields can also be used with other
entry types (i.e., \texttt{@BOOK}, \texttt{@INPROCEEDINGS},
\texttt{@MANUAL}, \texttt{@MASTERSTHESIS}, \texttt{@PHDTHESIS}, and
\texttt{@TECHREPORT}): for example, in the entry type
\texttt{@PHDTHESIS} for (\citeproc{ref-Wichtmann:2005a}{Wichtmann
2005}).
A CD-ROM can be referenced when using the \texttt{@BOOK},
\texttt{@INBOOK}, \texttt{@INCOLLECTION}, or \texttt{@INPROCEEDINGS}
categories, as in the entry (\citeproc{ref-Liggett:1998a}{Liggett and
Caughey 1998}). The field ``\texttt{howpublished}'' is used to designate
the medium in the \texttt{.bib} file:
\begin{verbatim}
howpublished = {CD-ROM},
\end{verbatim}
\appendix
\section{Notation}\label{sec-app-notation}
\emph{The following symbols are used in this paper:}
\begin{longtable}[]{@{}ll@{}}
\toprule\noalign{}
\endhead
\bottomrule\noalign{}
\endlastfoot
\(D\) & pile diameter (m); \\
\(R\) & distance (m); and \\
\(C_{\mathrm{Oh\;no!}}\) & fudge factor. \\
\end{longtable}
\section{Title block, publication types, and
options}\label{sec-app-options}
The title block, document classes, and other document options can be set
in the \texttt{yaml} header.
For example, to generate this example PDF file, the following
\texttt{yaml} header is used
\begin{Shaded}
\begin{Highlighting}[]
\FunctionTok{title}\KeywordTok{: }\CharTok{|}\AttributeTok{ }
\NormalTok{ Template for Preparing Your Submission to the }
\NormalTok{ American Society Of Civil Engineers (ASCE) }
\FunctionTok{author}\KeywordTok{:}
\AttributeTok{ }\KeywordTok{{-}}\AttributeTok{ }\FunctionTok{name}\KeywordTok{:}\AttributeTok{ Author One, S.M. ASCE}
\AttributeTok{ }\FunctionTok{affiliations}\KeywordTok{:}\AttributeTok{ Graduate Research Associate, First affiliation address}
\AttributeTok{ }\FunctionTok{email}\KeywordTok{:}\AttributeTok{ author.one@email.com}
\AttributeTok{ }\KeywordTok{{-}}\AttributeTok{ }\FunctionTok{name}\KeywordTok{:}\AttributeTok{ Author Two, M. ASCE}
\AttributeTok{ }\FunctionTok{affiliations}\KeywordTok{:}\AttributeTok{ Assistant Professor, Second affiliation address}
\AttributeTok{ }\FunctionTok{email}\KeywordTok{:}\AttributeTok{ author.two@email.com}
\AttributeTok{ }\KeywordTok{{-}}\AttributeTok{ }\FunctionTok{name}\KeywordTok{:}\AttributeTok{ Author three, A.M. ASCE}
\AttributeTok{ }\FunctionTok{affiliations}\KeywordTok{:}\AttributeTok{ Associate Professor, Third affiliation address}
\AttributeTok{ }\FunctionTok{email}\KeywordTok{:}\AttributeTok{ author.three@email.com}
\AttributeTok{ }\FunctionTok{corresponding}\KeywordTok{:}\AttributeTok{ }\CharTok{true}
\FunctionTok{abstract}\KeywordTok{: }\CharTok{|}
\NormalTok{ The abstract should be a single paragraph (150{-}175 words long) written}
\NormalTok{ in plain language and include a summary of the key conclusions of the}
\NormalTok{ manuscript. It should clearly state the purpose of the work, the scope}
\NormalTok{ of the effort, the procedures used to execute the work, and major}
\NormalTok{ findings. The abstract is the second most important online search}
\NormalTok{ discovery element, after the title. Authors should review the abstract}
\NormalTok{ to ensure that it accurately reflects the revised paper and should}
\NormalTok{ strive to include any applicable keywords that would likely be used}
\NormalTok{ during an online search. Mathematics and references are not permitted}
\NormalTok{ in the abstract and will be removed by the copyeditors.}
\FunctionTok{keywords}\KeywordTok{:}\AttributeTok{ template, quarto, asce}
\FunctionTok{bibliography}\KeywordTok{:}\AttributeTok{ references.bib}
\FunctionTok{format}\KeywordTok{:}\AttributeTok{ }
\AttributeTok{ }\FunctionTok{asce{-}pdf}\KeywordTok{:}
\AttributeTok{ }\FunctionTok{keep{-}tex}\KeywordTok{:}\AttributeTok{ }\CharTok{true}
\AttributeTok{ }\FunctionTok{publication{-}type}\KeywordTok{:}\AttributeTok{ NewProceedings}
\AttributeTok{ }\FunctionTok{footer{-}lastname}\KeywordTok{:}\AttributeTok{ Author1}
\AttributeTok{ }\FunctionTok{classoption}\KeywordTok{:}\AttributeTok{ }\KeywordTok{[}\AttributeTok{InsideFigs}\KeywordTok{,}\AttributeTok{ LineNumbers}\KeywordTok{]}
\end{Highlighting}
\end{Shaded}
\subsection{Authors and affiliations}\label{authors-and-affiliations}
For now, I prefer to use a simplified way to define the authors and
affiliations: just use \texttt{name}, \texttt{affiliations},
\texttt{email} and \texttt{corresponding} fields. See above
\texttt{yaml} header. I may change this in the future.
For more detailed setups, see
\href{https://quarto.org/docs/journals/authors.html}{quarto document}.
\subsection{Format options}\label{format-options}
The document class \texttt{asce-quarto.cls} provides several options
given below.
\subsubsection{Publication types}\label{publication-types}
The \texttt{Proceedings\textbar{}Journal\textbar{}NewProceedings} option
is the most important; the other options are largely incidental.
In a quarto document, use \texttt{publication-type} to specify the
overall format.
\begin{enumerate}
\def\labelenumi{\arabic{enumi}.}
\item
Options \texttt{Journal\textbar{}Proceedings\textbar{}NewProceedings}
specify the overall format of the output manuscript.
\texttt{Journal} produces double-spaced manuscripts for ASCE journals.
As default settings, it places tables and figures at the end of the
manuscript and produces lists of tables and figures. It places line
numbers within the left margin.
\texttt{Proceedings} produces older-style camera-ready single-spaced
manuscripts for ASCE conference proceedings. The newer ASCE style is
enacted with the \texttt{NewProceedings} option.
\texttt{NewProceedings} produces newer-style single-spaced manuscripts
for ASCE conference proceedings, as shown on the ASCE website
(\emph{ca.} 2013). As default settings, \texttt{NewProceedings} places
figures and tables within the text. It does not place line numbers
within the left margin.
If desired, the bottom right corner can be ``tagged'' with the
author's name (this can be done by inserting the command
\texttt{\textbackslash{}NameTag\{\textless{}}\emph{your
name}\texttt{\textgreater{}\}} within the preamble of your document).
All of the default settings can be altered with the options that are
described below.
\end{enumerate}
\subsubsection{Fine-tuning options}\label{fine-tuning-options}
Use \texttt{classoption} to specify the following options.
\begin{enumerate}
\def\labelenumi{\arabic{enumi}.}
\setcounter{enumi}{1}
\item
Options \texttt{BackFigs\textbar{}InsideFigs} can be used to override
the default placement of tables and figures in the \texttt{Journal},
\texttt{Proceedings}, and \texttt{NewProceedings} formats.
\item
Options \texttt{SingleSpace\textbar{}DoubleSpace} can be used to
override the default text spacing in the \texttt{Journal},
\texttt{Proceedings}, and \texttt{NewProceedings} formats.
\item
Options \texttt{10pt\textbar{}11pt\textbar{}12pt} can be used to
override the default text size (12pt).
\item
The option \texttt{NoLists} suppresses inclusion of lists of tables
and figures that would normally be included in the \texttt{Journal}
format.
\item
The option \texttt{NoPageNumbers} suppresses the printing of page
numbers.
\item
The option \texttt{SectionNumbers} produces an automatic numbering of
sections. Without the \texttt{SectionNumbers} option, sections will
\emph{not} be numbered, as this seems to be the usual formatting in
ASCE journals (note that the Appendixes will, however, be
automatically ``numbered'' with Roman numerals). With the