fresher_guide.tex 6.9 KB
Newer Older
Sam Moore's avatar
Sam Moore committed
1
2
3
4
% HERE BE DRAGONS
% This is complicated because it is based on [SZM]'s 2012 Honours Thesis template, which in turn was based on a template written by a Physics Professor.
% ~50% of this isn't actually needed, but it's too much effort to clean it up.

5
\documentclass[a5paper,10pt,openany]{extreport}
6
\usepackage[margin=0.75in,headsep=0.25in,footskip=0.25in]{geometry}
Sam Moore's avatar
Sam Moore committed
7
8
\renewcommand{\familydefault}{\sfdefault}
%\renewcommand{\familydefault}{\ttdefault}
Sam Moore's avatar
Sam Moore committed
9
10
11
%\linespread{1.3}
%\usepackage{setspace}
%\onehalfspacing 
12
 \parskip 8pt           % sets spacing between paragraphs
Sam Moore's avatar
Sam Moore committed
13
14
15
 %\renewcommand{\baselinestretch}{1.5} 	% Uncomment for 1.5 spacing between lines
 %\parindent 0pt		  % sets leading space for paragraphs

16
\usepackage{anyfontsize}
Sam Moore's avatar
Sam Moore committed
17
18
19

\usepackage{mdframed}

Sam Moore's avatar
Sam Moore committed
20

Sam Moore's avatar
Sam Moore committed
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
%\usepackage{natbib}
\usepackage{makeidx}
\usepackage{graphicx}
\usepackage{caption}
%\usepackage{subfigure}
\usepackage{rotating}
%\usepackage{lscape}
\usepackage{pdflscape} % Needed for landscaping - in pdf viewer
\usepackage{verbatim}
\usepackage{amsmath, amsthm,amssymb}
\usepackage{mathrsfs}
\usepackage{hyperref}

\usepackage{epstopdf}
\usepackage{float}
\usepackage[compact]{titlesec}
37
\titlespacing{\chapter}{0pt}{-50pt}{0pt}
38
39
40
41
% spacing glue: how to read {12pt plus 4pt minus 2pt}
%           12pt is what we would like the spacing to be
%           plus 4pt means that TeX can stretch it by at most 4pt
%           minus 2pt means that TeX can shrink it by at most 2pt
42
\titlespacing\section{0pt}{0pt plus 0pt minus 10pt}{0pt plus 0pt minus 10pt}
Sam Moore's avatar
Sam Moore committed
43
44
45
\titleformat{\chapter}
{\normalfont\LARGE\bfseries}{\thechapter.}{1em}{}

Sam Moore's avatar
Sam Moore committed
46
47
48
49
%\usepackage[usenames,dvipsnames]{color}
%\usepackage{listings} % For code snippets
\definecolor{pink}{rgb}{1.0,0.5,0.5}
\definecolor{darkgray}{rgb}{0.1,0.1,0.1}
Sam Moore's avatar
Sam Moore committed
50
\definecolor{lightgray}{rgb}{0.95,0.95,0.95}
51
\definecolor{gray}{rgb}{0.5,0.5,0.5}
Sam Moore's avatar
Sam Moore committed
52
\definecolor{darkred}{rgb}{0.75,0,0}
53
\definecolor{darkblue}{rgb}{0,0,0.35}
Sam Moore's avatar
Sam Moore committed
54
55
56
57
58
59
60
\definecolor{green}{rgb}{0,0.70,0}
\definecolor{black}{rgb}{0,0,0}
%\lstset{language=Java}
%\lstset{backgroundcolor=\color{darkgray}}
%\lstset{numbers=left, numberstyle=\tiny, stepnumber=1, numbersep=5pt}
%\lstset{keywordstyle=\color{darkred}\bfseries}
%\lstset{commentstyle=\color{darkblue}}
Sam Moore's avatar
Sam Moore committed
61
%\lstset{stringsyle=\color{red}}
Sam Moore's avatar
Sam Moore committed
62
63
%\lstset{showstringspaces=false}
%\lstset{basicstyle=\small}
Sam Moore's avatar
Sam Moore committed
64

Sam Moore's avatar
Sam Moore committed
65
\usepackage[table]{xcolor}
Sam Moore's avatar
Sam Moore committed
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

\newtheorem{theorem}{Theorem}[section]
\newtheorem{lemma}[theorem]{Lemma}
\theoremstyle{definition}\newtheorem{definition}[theorem]{Definition}
\newtheorem{proposition}[theorem]{Proposition}
\newtheorem{corollary}[theorem]{Corollary}
\newtheorem{example}{Example}
\theoremstyle{remark}\newtheorem*{remark}{Remark}

\newcommand{\Phid}[0]{\dot{\Phi}}
\newcommand{\Phib}[0]{\bar{\Phi}}

\newcommand{\de}[0]{\delta}
\newcommand{\deb}[0]{\bar{\delta}}

\newcommand{\that}[0]{\hat{\theta}}

\newcommand{\vect}[1]{\boldsymbol{#1}} % Draw a vector
\newcommand{\divg}[1]{\nabla \cdot #1} % divergence
\newcommand{\curl}[1]{\nabla \times #1} % curl
\newcommand{\grad}[1]{\nabla #1} %gradient
\newcommand{\pd}[3][ ]{\frac{\partial^{#1} #2}{\partial #3^{#1}}} %partial derivative
\newcommand{\der}[3][ ]{\frac{d^{#1} #2}{d #3^{#1}}} %full derivative
\newcommand{\phasor}[1]{\tilde{#1}} % make a phasor
\newcommand{\laplacian}[1]{\nabla^2 {#1}} % The laplacian operator



% Reference things in GitHub
Sam Moore's avatar
Sam Moore committed
95
\newcommand{\gitref}[2]{\href{https://github.com/UniversityComputerClub/FresherGuide/master/#1/#2}{  \textcolor{black}{\emph{#2}}}}
Sam Moore's avatar
Sam Moore committed
96
97
% Refer to API commands
\newcommand{\api}[1]{  ``\textcolor{black}{\texttt{/api/#1}}''}
Sam Moore's avatar
Sam Moore committed
98
% Pun alert
99
\newcommand{\pun}[1]{#1} % Emphasising it is kind of unnecessary
Sam Moore's avatar
Sam Moore committed
100
101
% Shell command
\newcommand{\shell}[1]{\texttt{#1}}
102
\newcommand{\server}[1]{\texttt{#1}}
Sam Moore's avatar
Sam Moore committed
103
104
% Rants
\newcommand{\rant}[1]{\textsc{#1}}
Sam Moore's avatar
Sam Moore committed
105
106
% URL
\renewcommand{\url}[1]{<\href{#1}{\underline{\color{black}{#1}}}>}
107

Sam Moore's avatar
Sam Moore committed
108
109
110
% Reference things.
\newcommand{\figref}[1]{(Figure \ref{#1})}
\newcommand{\seeref}[1]{(See \ref{#1})}
Sam Moore's avatar
Sam Moore committed
111
112

\newcommand{\setfont}[1]{\fontfamily{#1}\selectfont}
Sam Moore's avatar
Sam Moore committed
113
114
115
116
117
118
119
120
121
122
123
124
125
126

% To make underscores printable without escaping them
\usepackage[T1]{fontenc}
\catcode`\_=12

% Refer to code (can change each one as needed)
\newcommand{\funct}[1]{  \texttt{#1}}
\newcommand{\var}[1]{  \texttt{#1}}
\newcommand{\type}[1]{  \texttt{#1}}
\newcommand{\code}[1]{  \texttt{#1}}


%\usepackage{endfloat}
%\nomarkersintext
127
128
129
130
131
132
133
134
%\pagestyle{plain}
%\topmargin -0.6true in
%\textwidth 15true cm
%\textheight 9.5true in
%\oddsidemargin 0.25true in
%\evensidemargin 0.25true in
%\headsep 0.4true in

Sam Moore's avatar
Sam Moore committed
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

\usepackage{fancyheadings}
\pagestyle{fancy}
\addtolength{\headheight}{2.5pt}
\renewcommand{\chaptermark}[1]{\markboth{\thechapter~~#1}{}}
\renewcommand{\sectionmark}[1]{\markright{\thesection~~#1}{}}
\ifthenelse{\boolean{@twoside}}
{
        \rhead[\bfseries \rightmark]{\bfseries \thepage}
        \lhead[\bfseries \leftmark]{\bfseries \thepage}
        \addtolength{\headwidth}{\marginparsep}
        \addtolength{\headwidth}{\marginparwidth}
}{
        \lhead{\bfseries \leftmark}
        \rhead{\bfseries \thepage}
}
\cfoot{}

Sam Moore's avatar
Sam Moore committed
153
154
155
156
157
\usepackage{etoolbox}
\makeatletter
\patchcmd{\chapter}{\if@openright\cleardoublepage\else\clearpage\fi}{}{}{}
\makeatother

158
159
\newcommand{\zchapter}[1]{\chapter{#1} \setcounter{section}{-1}}

160
\usepackage{tocloft}
161
162
\renewcommand\cftchapfont{\small\bfseries}
\renewcommand\cftsecfont{\small}
163

164
165
\renewcommand\cftchappagefont{\small\bfseries}
\renewcommand\cftsecpagefont{\small}
Sam Moore's avatar
Sam Moore committed
166
167
168
169
%---------------------------------------------------------
%---------------------------------------------------------
\begin{document}

170
171
172
% keeps text within our margins
\sloppy

Sam Moore's avatar
Sam Moore committed
173
174
\include{titlepage/Titlepage}               % This is who you are

mpomery's avatar
mpomery committed
175
176
\pagenumbering{arabic}
\pagebreak
177

Sam Moore's avatar
Sam Moore committed
178
179
180
%---------------------------------------------------------
% Do the table of Contents and lists of figures and tables
%---------------------------------------------------------
181
\linespread{0.3}
Sam Moore's avatar
Sam Moore committed
182
% Do we need these for a fresher guide?
183
{\small\tableofcontents}
Sam Moore's avatar
Sam Moore committed
184
185
%\listoffigures
\markboth{}{}
186
\linespread{1.5}
187

188
\emph{"Interroga de Consensum Gradu Servitium nostra"}
189

Sam Moore's avatar
Sam Moore committed
190
191
\newpage

mpomery's avatar
mpomery committed
192
%\pagenumbering{arabic}
Sam Moore's avatar
Sam Moore committed
193
194
195
196
%---------------------------------------------------------
%---------------------------------------------------------
%Include the chapters!

197
198
199
200
\setcounter{chapter}{-1}


\include{chapters/Introduction} % Chapter 0
Sam Moore's avatar
Sam Moore committed
201
202
203
\include{chapters/FindClubroom} % Chapter 1
\include{chapters/SetupAccount}
\include{chapters/Dispense101}
Sam Moore's avatar
Sam Moore committed
204
\include{chapters/Events}
Sam Moore's avatar
Sam Moore committed
205
206
207
208
209
210
211
212
213
%\include{chapters/Groups}
%\include{chapters/Clubroom}
%\include{chapters/Communications}
%\include{chapters/Games}
\include{chapters/Services}

%\linespread{1.0}
%\include{chapters/UnixCommands}
%\include{chapters/Glossary}
Sam Moore's avatar
Sam Moore committed
214
215
216
217
% ETC

%\newpage
%---------------------------------------------------------
Sam Moore's avatar
Sam Moore committed
218
219
220
%\renewcommand{\bibname}{References}
%\bibliography{references/refs}
%\bibliographystyle{ieeetr}  
Sam Moore's avatar
Sam Moore committed
221
%\addcontentsline{toc}{part}{References}
Sam Moore's avatar
Sam Moore committed
222
223
224
%---------------------------------------------------------

% Appendices
Sam Moore's avatar
Sam Moore committed
225
226
%\appendix
%\include{appendices/Glossary}
Sam Moore's avatar
Sam Moore committed
227
228
229
230
231
232
%\include{appendices/figures}

%---------------------------------------------------------

\end{document}