fresher_guide.tex 5.61 KB
Newer Older
Sam Moore's avatar
Sam Moore committed
1
2
3
4
5
% 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.

\documentclass[a4paper,10pt,titlepage]{report}
Sam Moore's avatar
Sam Moore committed
6
\renewcommand{\familydefault}{\ttdefault}
Sam Moore's avatar
Sam Moore committed
7
8
9
10
11
12
13
14
%\linespread{1.3}
%\usepackage{setspace}
%\onehalfspacing 
 \parskip 10pt           % sets spacing between paragraphs
 %\renewcommand{\baselinestretch}{1.5} 	% Uncomment for 1.5 spacing between lines
 %\parindent 0pt		  % sets leading space for paragraphs


Sam Moore's avatar
Sam Moore committed
15
16
17

\usepackage{mdframed}

Sam Moore's avatar
Sam Moore committed
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
%\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}
\titlespacing{\chapter}{0pt}{0pt}{0pt}
\titleformat{\chapter}
{\normalfont\LARGE\bfseries}{\thechapter.}{1em}{}

Sam Moore's avatar
Sam Moore committed
38
39
40
41
%\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}
42
\definecolor{lightgray}{rgb}{0.7,0.7,0.7}
Sam Moore's avatar
Sam Moore committed
43
\definecolor{darkred}{rgb}{0.75,0,0}
44
\definecolor{darkblue}{rgb}{0,0,0.35}
Sam Moore's avatar
Sam Moore committed
45
46
47
48
49
50
51
\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
52
%\lstset{stringsyle=\color{red}}
Sam Moore's avatar
Sam Moore committed
53
54
%\lstset{showstringspaces=false}
%\lstset{basicstyle=\small}
Sam Moore's avatar
Sam Moore committed
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



\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
\newcommand{\gitref}[2]{\href{https://github.com/UniversityComputerClub/FresherGuide/master/#1/#2}{  \textcolor{blue}{\emph{#2}}}}
% Refer to API commands
\newcommand{\api}[1]{  ``\textcolor{black}{\texttt{/api/#1}}''}
Sam Moore's avatar
Sam Moore committed
89
90
91
92
93
94
% Pun alert
\newcommand{\pun}[1]{\emph{#1}}
% Shell command
\newcommand{\shell}[1]{\texttt{#1}}
% Rants
\newcommand{\rant}[1]{\textsc{#1}}
Sam Moore's avatar
Sam Moore committed
95
96
97
\renewcommand{\url}[1]{\href{#1}{#1}}

\newcommand{\setfont}[1]{\fontfamily{#1}\selectfont}
Sam Moore's avatar
Sam Moore committed
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

% 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
\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

\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
137
138
139
140
141
\usepackage{etoolbox}
\makeatletter
\patchcmd{\chapter}{\if@openright\cleardoublepage\else\clearpage\fi}{}{}{}
\makeatother

Sam Moore's avatar
Sam Moore committed
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
%---------------------------------------------------------
%---------------------------------------------------------
\begin{document}

\include{titlepage/Titlepage}               % This is who you are

\pagenumbering{roman}
\newpage
%---------------------------------------------------------
% Do the table of Contents and lists of figures and tables
%---------------------------------------------------------
\linespread{0.8}
% Do we need these for a fresher guide?
\tableofcontents
%\listoffigures
\markboth{}{}
\linespread{1.0}
\newpage

\pagenumbering{arabic}
%---------------------------------------------------------
%---------------------------------------------------------
%Include the chapters!

Sam Moore's avatar
Sam Moore committed
166
167
168
\include{chapters/FindClubroom} % Chapter 1
\include{chapters/SetupAccount}
\include{chapters/Dispense101}
Sam Moore's avatar
Sam Moore committed
169
\include{chapters/Events}
Sam Moore's avatar
Sam Moore committed
170
171
172
\include{chapters/Groups}
\include{chapters/Clubroom}
\include{chapters/Communications}
Sam Moore's avatar
Sam Moore committed
173
174
175
176
177
178
179
% ETC

%\newpage
%---------------------------------------------------------
\renewcommand{\bibname}{References}
\bibliography{references/refs}
\bibliographystyle{ieeetr}  
Sam Moore's avatar
Sam Moore committed
180
%\addcontentsline{toc}{part}{References}
Sam Moore's avatar
Sam Moore committed
181
182
183
184
%---------------------------------------------------------

% Appendices
\appendix
Sam Moore's avatar
Sam Moore committed
185
\include{appendices/Glossary}
Sam Moore's avatar
Sam Moore committed
186
187
188
189
190
191
%\include{appendices/figures}

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

\end{document}