forked from chiehrosswang/TRB_LaTeX_tex
-
Notifications
You must be signed in to change notification settings - Fork 1
/
trb_template.tex
147 lines (110 loc) · 10.6 KB
/
trb_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
% Repository: https://github.com/chiehrosswang/TRB_LaTeX_tex
%
% Transportation Research Board conference paper template
% version 4.0 Lite (updates made to be compatible in Overleaf and ShareLaTeX)
%
% When numbered option is activated, lines are numbered.
\documentclass[numbered]{trbunofficial}
\usepackage{graphicx}
% \usepackage[colorlinks=true,linkcolor=blue,citecolor=blue]{hyperref}
% For TRB version hide links
\usepackage[hidelinks]{hyperref}
% Put here what will go to headers as author
\AuthorHeaders{Pritchard, Macfarlane, and Wang}
\title{A \LaTeX\ Template for Papers Submitted to the Transportation
Research Board}
% TODO: add macros for easier formatting of \author.
\author{%
\textbf{David Pritchard}\\
davidpritchard.org\\
\hfill\break% this is a way to add line numbering on empty line
\textbf{Gregory S. Macfarlane, Ph.D.}\\
\hfill\break%
\textbf{Chieh (Ross) Wang, Ph.D., Corresponding Author}\\
}
% If necessary modify the number of words per table or figure default is set to
% 250 words per table
% \WordsPerTable{250}
% If words are counted manually, put that number here. This does not include
% figures and tables. This can also be used to avoid problems with texcount
% program i.e. if one does not have it installed.
% \TotalWords{200}
\begin{document}
\maketitle
\section{Abstract}
The Transportation Research Board (TRB) has unique and seemingly arbitrary requirements for manuscripts submitted for review. These requirements make it difficult to write the manuscripts quickly, and no existing \LaTeX\ style comes close to fooling the guidelines. This represents an initial effort at creating a template to meet the requirements of TRB authors using \LaTeX, R, Sweave, and/or other literate programming software.
\hfill\break%
\noindent\textit{Keywords}: Keyword1, Keyword2
\newpage
\section{Introduction}
The \citep{TRBGuide} has unique and somewhat arbitrary requirements for papers submitted for review and publication. While the initial submission is required to be in PDF format, submissions for publication in Transportation Research Record must be in Microsoft Office format. On top of this, the manuscripts must be line-numbered, captions are bolded and employ atypical punctuation, and the references must be numbered when cited and then printed in order. More details about the manuscript details can be found online at~\url{http://onlinepubs.trb.org/onlinepubs/AM/InfoForAuthors.pdf}.
It is assumed that the readers of this document have some significant level of experience in \LaTeX~and \verb1bibtex1. As use of literate programming becomes more widespread in engineering and planning, it is possible that this template may need to be made more robust.
\subsection{History}
David Pritchard posted the original versions of this template in 2009 and updated it in 2011, soon after TRB began allowing PDF submissions. Gregory Macfarlane made significant adaptations to it in March 2012, allowing for Sweave integration and automatic word and table counts. Ross Wang automated the total word count and made some formatting modifications in July 2015. Version 2.1.1 has been made available on GitHub in January, 2016. Version 3.1 has been made available on Github (\url{https://github.com/chiehrosswang/TRB_LaTeX_rnw}) in June, 2017. Versions 2.1.1 Lite and 3.1 Lite were made available on GitHub (\url{https://github.com/chiehrosswang/TRB_LaTeX_tex}) in June, 2017 for users who do not need R and Sweave functions provided in the original verions.
\section{Features}
The template has a number of features that enable quick and painless manuscript authoring.
\subsection{Title Page}
The standard \LaTeX\ \verb1\maketitle1 command is not very versatile, so we have replaced it with a \verb1titlepage1 environment. This means that the writers will be required to manually enter spacings based on the number of contributors, but the current settings (12pt between authors, 36pt before, and 60pt after them) seems to work well.
Near the bottom of the title page, TRB requires a count of the manuscript's words, figures, and tables. This template generates these counts automatically. The figure and table counts are simply pulled from the \LaTeX\ counters using the \verb1totcount1 package. The word count feature is not as straight-forward, as it utilizes a call to the system command \verb1texcount1. Thus to compile the document writers must enable \verb#\write18# in their \verb1pdflatex1 call.
In the newest version of this template, we added the total count automatically. The total count basically adds not only the word count, but also the equivalent count (250 words) for each table. Note that starting from 2018, Figures no longer count toward total word counts. However, each paper can have only up to 6 figures in total. The total word count is implemented using a customized command \verb1\totalwordcount1. Please see the original code for more information.
\subsection{Page Layout}
The document has 1 inch margins as required, with the author's names in the left heading and the page number in the right. The authors heading will need to be edited by the writers; automating this from the title page command is not currently possible. Paragraphs leading sections and subsections are not indented, while all subsequent paragraphs in that section are. Section types are defined as outlined by the \citep{TRBGuide}.
The document is single-spaced in 12 point Times font. Times New Roman is a proprietary font and is therefore not available by installation in open-source software. While the differences between Times variants are negligible, Times New Roman itself can be used in Mac OSX by compiling under \verb1xelatex1.
\subsubsection{Line Numbers}
Manuscript line numbering is implemented using the \verb1lineno1 package. There are options to change the font style and type, but the current settings work well. Note that the line numbers refresh each page, and that blank lines do not receive a number. Currently, line numbers and headers are not shown on the title page, but can be easily added by adding \verb1\pagewiselinenumbers1 command right before the beginning of the title page.
\section{Captions}
Figure~\ref{fig:trial} shows a Gumbel distribution as an example of captioning. As demonstrated, figure captions ought to be sentence capitalized, balded, and can be somewhat longer than in other journals.
\begin{figure}[!ht]
\centering
\includegraphics[width=0.6\textwidth]{trb_template-gumbel}
\caption{This is a random figure to test the counting functionality on the title page. It shows a Gumbel distribution with mode 0 and scale 1. The multinomial logit model assumes that the error terms are distributed identically and independently following this pattern.}\label{fig:trial}
\end{figure}
Table captions are somewhat different, requiring initial capitals and are more of a title. An example of this is given in Table~\ref{tab:versions}, showing the history of this template.
\begin{table}[!ht]
\caption{A History of this Template}\label{tab:versions}
\begin{center}
\begin{tabular}{l l l l}
Version & Date & Author & Contributions \\\hline
1.0 & Sep 2009 & Pritchard & Initial work \\
1.1 & Mar 2011 & Pritchard & Captions \\
2.0 & Mar 2012 & Macfarlane& Automation, documentation\\
2.1 & Jul 2015 & Wang & More automation and formatting\\
2.1.1 & Jan 2016 & Wang & Minor modifications and uploaded to Github\\
2.1.1 Lite & Jun 2017 & Wang & \TeX-only template \\
3.1 & Jun 2017 & Wang & Addition of \verb1trbunofficial.cls1\\
3.1 Lite & Jun 2017 & Wang & Addition of \verb1trbunofficial.cls1\\
4.0 Lite & Jul 2019 & Wang & Word count updates for Overleaf/ShareLaTeX compatibility\\\hline
\end{tabular}
\end{center}
\end{table}
\subsection{Bibliography}
The TRB bibliography style is defined in the \verb1trb.bst1 file which should be in your document folder. A renewed command is specified, \verb1\citep{}1 which will print the authors and the number of the reference in the order in which it is supplied. Note that \verb1\citep{}1 prints both the author names and the reference number, if you simply need the number of the reference, use command
\verb|\cite{}|. The References section will be appended to the end of the document.
It is very easy to add reference to papers programs written by \citep{Bierlaire2003} and \citep{Bierlaire2008} or to papers like those written by \citep{Garrow2009} and \citep{Koppelman2005}. You can even go back and refer to Biog\'eme by \citep{Bierlaire2008} a second time. You can also cite a group of similar references without printing author names \cite{TRBGuide,Bierlaire2003}. This template also groups multiple reference numbers together if there are three or more consecutive numbers \cite{Bierlaire2003,Bierlaire2008,Garrow2009,Koppelman2005}.
\subsection{Equations}
Intelligent driver model equations from wikipedia (\url{https://en.wikipedia.org/wiki/Intelligent_driver_model}) moved to the left using \verb1amsmath1 package with \verb1fleqn1 options.
\begin{linenomath}
\begin{flalign}
&\dot{x}_\alpha = \frac{\mathrm{d}x_\alpha}{\mathrm{d}t} = v_\alpha \\
&\dot{v}_\alpha = \frac{\mathrm{d}v_\alpha}{\mathrm{d}t} = a\,\left( 1 - \left(\frac{v_\alpha}{v_0}\right)^\delta - \left(\frac{s^*(v_\alpha,\Delta v_\alpha)}{s_\alpha}\right)^2 \right)
\end{flalign}
\end{linenomath}
\begin{equation}
s^*(v_\alpha,\Delta v_\alpha) = s_0 + v_\alpha\,T + \frac{v_\alpha\,\Delta v_\alpha}{2\,\sqrt{a\,b}}
\end{equation}
\section{To Do's}
Two document types, extending from the \verb1[numbered]1 option, can be defined to differentiate the initial submission (i.e., with line numbers and in-line figures and tables) and the final manuscript (i.e., without line numbers and all figures and tables are attached to the end).
\section{Conclusion}
To make the document from source in a Unix-like OS, issue the following commands:
\begin{verbatim}
latexmk trb_template.tex -pdf -pvc -shell-escape
\end{verbatim}
The \verb1--shell-escape1 option is required to access the command line for the word count. Normally this feature is disabled because it is a route of entry for malicious software. We promise that there is no such debilitating code in this document, and we encourage you to examine any scripts for suspicious code before permitting \verb1pdflatex1 from accessing your system.
Perl is necessary for ``texcount'' to work and needs a Perl interpreter e.g. [ActivePerl](\url{http://www.activestate.com/activeperl/downloads}).
\section{Acknowledgements}
The authors would like to thank Aleksandar Trifunovic (\url{https://github.com/akstrfn}) for creating the \verb1trbunofficial1 class document, which has been a very helpful improvement.
\newpage
\bibliographystyle{trb}
\bibliography{trb_template}
\end{document}