forked from search-rug/student-report-template
-
Notifications
You must be signed in to change notification settings - Fork 0
/
content.tex
175 lines (144 loc) · 5.87 KB
/
content.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
\chapter{Introduction}
\label{chap:introduction}
This chapter provide the main tips and guidelines for writing theses and reports using \LaTeX.
\section{Theses Structure}
\label{sec:c1:thesesguidelines}
You should shop around and look at theses or ask your supervisor for suggestions.
That said, here is an example of how you can structure your thesis.
\begin{enumerate}
\item Introduction
\item Background / Related Work
\item Study Design / Methodology
\begin{enumerate}
\item Objective and Research Questions
\item Data Collection
\item Data Analysis
\end{enumerate}
\item Results
\item Discussion
\begin{enumerate}
\item Interpretation of Results
\item Implications to Practitioners and Researchers
\item Threats to Validity
\end{enumerate}
\item Conclusions
\end{enumerate}
A \textbf{research internship} comprise a work similar to a thesis but at a smaller scale. Thus, the structure is usually very similar. Key differences are commonly related to the amount of workload. Thus, consider the same structure suggested for thesis.
\section{Short Programming Project Structure}
\label{sec:c1:sppguidelines}
{\color{red} To be written...}.
\section{\LaTeX{} Formatting}
\label{sec:c1:latex}
There are some great resources to help with \LaTeX,
so this guide will not include general instructions.
For those, consult the Latex Wikibook\footnote{\url{https://en.wikibooks.org/wiki/LaTeX}}
and the excellent guidelines by Spinellis~\cite{spinellis:latexadvice}.
That said, there are some small pointers that are particular to this template.
These are mentioned in the subsection below.
\subsection{References}
\label{sec:c1:References}
\noindent
\textbf{Indirect citation}
These look like ``\verb|... in related work~\cite{source}|'' and generate something like ``\dots in related work~[2].''
Do not forget the ``\verb|~|'' before ``\verb|\cite|'' to not let the next line start with ``\verb|[2]|''.
\vspace{0.5cm}
\noindent
\textbf{Direct citation}
These look like ``\texttt{according to Author et} \verb|al.~\cite{source}|'' and generate something like ``according to Author et al. [2].''
Only add ``et al.'' if the reference by three or more people.
\subsection{Tables}
\label{sec:c1:latex_tables}
Avoid cumbersome table formatting (e.g. using vertical lines).
In general, simpler is better.
\autoref{tab:c1:simpleexample} and \autoref{tab:c1:multicolexample} are some examples.
Also, look at the tables' source for code formatting tips.
\begin{table} [h]
\caption{Example of a simple table (based on~\cite{spinellis:latexadvice})}
\label{tab:c1:simpleexample}
\noindent
\centering
\footnotesize%if needed
% put the header on a \parbox to center and break lines
\newcommand{\hb}[2]{\parbox[c][0.8cm][c]{#1}{\centering #2}}
\begin{tabular}{lccccc}
\toprule
% Column labels (using separate lines to align label with data)
\hb{2cm}{Command\\and options}
& \hb{2cm}{Input\\requirements}
& Matched
& Connected
& Matched
& Connected \\
\midrule
tr -cs & 1 & \X & -- & \V & 1 \\
sort w & 0 & & -- & \X & 0 \\
fmt & 1 & \X & -- & \V & 1 \\
tr A-Z & 1 & \V & 1 & & 1 \\
sort -u & fmt & \X & -- & \V & 1 \\
\bottomrule
\end{tabular}
\end{table}
\begin{table} [h]
\caption{Example of multi-column table}
\label{tab:c1:multicolexample}
\noindent
\centering
\begin{tabular}{lSSSS}
\toprule
{} & \multicolumn{2}{c}{\textbf{Group 1}}
& \multicolumn{2}{c}{\textbf{Group 2}} \\
\cmidrule(r){2-3} \cmidrule(r){4-5}
{} & {Average} & {Max} & {Average} & {Max} \\
\midrule
\textbf{Factor 1} & 853 & 2443 & 1760 & 3799 \\
\textbf{Factor 2} & 14983 & 74658 & 110881 & 316552 \\
\textbf{Factor 3} & 18 & 85 & 89 & 319 \\
\textbf{Rate} & 51.91\% & 86.34\% & 44.44\% & 81.08\% \\
\bottomrule
\end{tabular}
\end{table}
\subsection{Figures}
\label{sec:c1:latex_figures}
The main tips in a nutshell are as follows.
\begin{itemize}
\item Put all your figures inside the \texttt{figs} folder,
and use subfolders to organize them per chapter.
\item Prefer vectorized images (e.g. PS or PDF).
Bear in mind that saving a PNG or JPG as PDF
will not vectorize your image.
\end{itemize}
See \autoref{fig:c1:simpleexample} for a simple example.
\autoref{fig:c1:allauthors} shows an example using sub-figures.
Notice that you can also cite them individually
(see \autoref{fig:c1:auth1}, \autoref{fig:c1:auth2} and \autoref{fig:c1:auth3}).
\begin{figure}
\centering
\includegraphics[width=.2\textwidth]{figs/author}
\caption{A figure example}
\label{fig:c1:simpleexample}
\end{figure}
\begin{figure}
\centering
\begin{subfigure}[b]{0.2\textwidth}
\centering
\includegraphics[width=\textwidth]{figs/author}
\caption{Author 1}
\label{fig:c1:auth1}
\end{subfigure}
\hfill
\begin{subfigure}[b]{0.2\textwidth}
\centering
\includegraphics[width=\textwidth]{figs/author}
\caption{Author 2}
\label{fig:c1:auth2}
\end{subfigure}
\hfill
\begin{subfigure}[b]{0.2\textwidth}
\centering
\includegraphics[width=\textwidth]{figs/author}
\caption{Author 3}
\label{fig:c1:auth3}
\end{subfigure}
\caption{All authors}
\label{fig:c1:allauthors}
\end{figure}