-
Notifications
You must be signed in to change notification settings - Fork 0
/
instructions.tex
216 lines (170 loc) · 7.53 KB
/
instructions.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
\documentclass[11pt]{article}
% This file will be kept up-to-date at the following GitHub repository:
%
% https://github.com/alexhernandezgarcia/latex-simple
%
% Please file any issues/bug reports, etc. you may have at:
%
% https://github.com/alexhernandezgarcia/latex-simple/issues
\usepackage{microtype} % microtypography
\usepackage{booktabs} % tables
\usepackage{url} % urls
% AMS math
\usepackage{amsmath}
\usepackage{amsthm}
% With no package options, the submission will be anonymized, the supplemental
% material will be suppressed, and line numbers will be added to the manuscript.
%
% To hide the supplementary material (e.g., for the first submission deadline),
% use the [hidesupplement] option:
%
% \usepackage[hidesupplement]{latex-simple}
%
% To compile a non-anonymized camera-ready version, add the [final] option (for
% the main track) e.g.,
%
% \usepackage[final]{latex-simple}
%
% or
%
% \usepackage[final, hidesupplement]{latex-simple}
\usepackage[final]{latex-simple}
% You may use any reference style as long as you are consistent throughout the
% document. As a default we suggest author--year citations; for bibtex and
% natbib you may use:
\usepackage{natbib}
% and for biber and biblatex you may use:
% \usepackage[%
% backend=biber,
% style=authoryear-comp,
% sortcites=true,
% natbib=true,
% giveninits=true,
% maxcitenames=2,
% doi=false,
% url=true,
% isbn=false,
% dashed=false
% ]{biblatex}
% \addbibresource{references.bib}
\title{Documentation for the \texttt{latex-simple} package}
% The syntax for adding an author is
%
% \author[i]{\nameemail{author name}{author email}}
%
% where i is an affiliation counter. Authors may have
% multiple affiliations; e.g.:
%
% \author[1,2]{\nameemail{Anonymous}{[email protected]}}
\author[1]{\nameemail{Author 1}{[email protected]}}
\author[2,3]{\nameemail{Author 2}{[email protected]}}
\author[3]{\nameemail{Author 3}{[email protected]}}
\author[4]{\nameemail{Author 4}{[email protected]}}
% if you need to force a linebreak in the author list, prepend an \author entry
% with \\:
\author[3]{\\\nameemail{Author 5}{[email protected]}}
% Specify corresponding affiliations after authors, referring to counter used in
% \author:
\affil[1]{Institution 1}
\affil[2]{Institution 2}
\affil[3]{Institution 3}
\affil[4]{Institution 4}
% define PDF metadata, aids in accessibility of the resulting PDF
\hypersetup{%
pdfauthor={Authors}, % will be reset to "Anonymous" unless the "final" package option is given
pdftitle={Documentation for the latex-simple Package},
pdfsubject={Documentation for latex-simple Package},
pdfkeywords={LaTeX, style}
}
\begin{document}
\maketitle
\begin{abstract}
Documentation for \texttt{latex-simple} Package.
\end{abstract}
To ensure that line numbering works correctly with display math mode, please do \emph{not} use \TeX{} primitives such as \verb|$$| and \texttt{eqnarray}. (Using these is not good practice anyway.)%
%
\footnote{\url{https://tex.stackexchange.com/questions/196/eqnarray-vs-align}}%
\footnote{\url{https://tex.stackexchange.com/questions/503/why-is-preferable-to}}
%
Please use \LaTeX{} equivalents such as \verb|\[ ... \]| (or \verb|\begin{equation} ... \end{equation}|) and the \texttt{align} environment from the \texttt{amsmath} package.%
%
\footnote{\url{http://tug.ctan.org/info/short-math-guide/short-math-guide.pdf}}
\section{References}
Authors may use any citation style as long as it is consistent throughout the
document. By default, we propose the style defined in `latex-simple.bst` which uses \texttt{natbib/bibtex}, which can be used by including the following at the end of the document:
\begin{verbatim}
\bibliography{references}
\bibliographystyle{latex-simple}
\end{verbatim}
where `latex-simple` refers to the file `latex-simple.bst` and references to `references.bib`, a BibTeX file containing bibliographical entries.
You may create a parenthetical reference with \verb|\citep|, such as appears at the end of this sentence \citep{mitchell2003venus}. You may create a textual reference using \verb|\citet|, as \citet{mitchell2003venus} also demonstrated.
\section{Tables}
We recommend the \texttt{booktabs} package for creating tables, as demonstrated in Table \ref{example_table}. Note that we recommend that tables are centered, that captions appear \emph{above} the tables, and that horizontal rules are placed above and below the table and after the column names. However, horizontal lines for each row are not recommended and vertical rules are discouraged.
\begin{table}
\caption{An example table using the \texttt{booktabs} package.}
\label{example_table}
\centering
\begin{tabular}{lrr}
\toprule
& \multicolumn{2}{c}{Metric} \\
\cmidrule{2-3}
Method & Accuracy & Time \\
\midrule
Baseline & 10 & 100 \\
Our method & 100 & 10 \\
\bottomrule
\end{tabular}
\end{table}
\section{Figures and subfigures}
The \texttt{latex-simple} style loads the \texttt{subcaption} package, which may be used to create and caption subfigures. Please note that this is \emph{incompatible} with the (obsolete and deprecated) \texttt{subfigure} package. A figure with subfigures is demonstrated in Figure \ref{example_figure}. Note that figure captions appear \emph{below} figures.
Please ensure that all text appearing in figures (axis labels, legends, etc.) is legible and be mindful of the use of colour: favour palettes that are colour-blind friendly and legible if printed in black/white.
\begin{figure}
\begin{subfigure}[t]{0.5\linewidth}
\centering
\framebox{Imagine this is a nice figure}
\caption{Subfigure caption.}
\label{example_figure_left}
\end{subfigure}
\begin{subfigure}[t]{0.5\linewidth}
\centering
\framebox{Imagine this is another nice figure}
\caption{Another subfigure caption.}
\label{example_figure_right}
\end{subfigure}
\caption{An example figure with subfigures. \subref{example_figure_left}: left figure. \subref{example_figure_right}: right figure.}
\label{example_figure}
\end{figure}
\section{Pseudocode}
\label{sec:code}
To add pseudocode, you may make use of any package you see fit---the \texttt{latex-simple} package should be compatible with any of them. In particular, you may want to check out the \texttt{algorithm2e}%
%
\footnote{\url{https://ctan.org/pkg/algorithm2e}}
%
and/or the \texttt{algorithmicx}%
%
\footnote{\url{https://ctan.org/pkg/algorithmicx}}
%
packages, both of which can produce nicely typeset pseudocode. You may also wish
to load the \texttt{algorithm}%
%
\footnote{\url{https://ctan.org/pkg/algorithms}}
%
package, which creates an \texttt{algorithm} floating environment you can access
with \verb|\begin{algorithm} ... \end{algorithm}|. This environment supports
\verb|\caption{}|, \verb|\label{}| and \verb|\ref{}|, etc.
\section{Adding acknowledgments}
You may add acknowledgments of funding, etc.\ using the \texttt{acknowledgments} environment. Acknowledgments will be automatically commented out at submission time. An example is given below in the source code for this document; it will be hidden in the \textsc{pdf} unless the \texttt{final} option is given.
\begin{acknowledgements}
Thank y'all!
\end{acknowledgements}
% print bibliography -- for bibtex / natbib, use:
\bibliography{references}
\bibliographystyle{latex-simple}
% and for biber / biblatex, use:
% \printbibliography
% supplemental material -- everything hereafter will be suppressed during
% submission time if the hidesupplement option is provided!
\appendix
\section{Proof of theorem 1}
This material will be hidden if \texttt{hidesupplement} is provided.
\end{document}