diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000000000000000000000000000000000..7ce0e8dd01e976ae3b04b5bc538e1eabb408aed1 --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +*.out +*.dvi +*.aux +*.log +*.toc +*.bbl +*.blg +*~ diff --git a/Makefile b/Makefile new file mode 100644 index 0000000000000000000000000000000000000000..b42bf096933d3b64be730c60bd37e2ad87c16a3e --- /dev/null +++ b/Makefile @@ -0,0 +1,25 @@ +#Makefile for Fresher Guide + +NAME=fresher_guide + +all : + make clean + make $(NAME).pdf + +fresher_guide.pdf : fresher_guide.tex + rm -f *.aux *.bbl *.log *.toc *.lof *.blg *.lot + + pdflatex -shell-escape $(NAME) + bibtex $(NAME) + pdflatex --shell-escape $(NAME) + pdflatex --shell-escape $(NAME) + bibtex $(NAME) + pdflatex --shell-escape $(NAME) + pdflatex --shell-escape $(NAME) + + + rm -f *.bbl *.log *.toc *.lof *.blg *.lot + + +clean : + rm -f $(NAME).pdf diff --git a/chapters/README.md b/chapters/README.md new file mode 100644 index 0000000000000000000000000000000000000000..3c6c53181b3c2c65978fd5d073e7685e3f5bec22 --- /dev/null +++ b/chapters/README.md @@ -0,0 +1,3 @@ +This is where each "chapter" goes. + +In theory they don't need scary tex stuff because that is all in the file "../fresher_guide.tex" which includes them. diff --git a/figures/README.md b/figures/README.md new file mode 100644 index 0000000000000000000000000000000000000000..b25360ecc72c5f24912919c0854c703e944667f8 --- /dev/null +++ b/figures/README.md @@ -0,0 +1 @@ +Figures go here. diff --git a/fresher_guide.pdf b/fresher_guide.pdf new file mode 100644 index 0000000000000000000000000000000000000000..bb90b6f56573434fc71e533cd315e2d139b95f75 Binary files /dev/null and b/fresher_guide.pdf differ diff --git a/fresher_guide.tex b/fresher_guide.tex new file mode 100644 index 0000000000000000000000000000000000000000..bad7ebdb049e40f011238b9207b2c8338037bd11 --- /dev/null +++ b/fresher_guide.tex @@ -0,0 +1,165 @@ +% 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} +%\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 + + +%\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}{} + +\usepackage[usenames,dvipsnames]{color} +\usepackage{listings} % For code snippets + +\definecolor{darkgray}{rgb}{0.95,0.95,0.95} +\definecolor{darkred}{rgb}{0.75,0,0} +\definecolor{darkblue}{rgb}{0,0,0.75} +\definecolor{pink}{rgb}{1,0.5,0.5} +\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}} +%\lstset{stringsyle=\color{red}} +\lstset{showstringspaces=false} +\lstset{basicstyle=\small} + + + +\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}}''} + +% 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{} + +%--------------------------------------------------------- +%--------------------------------------------------------- +\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! + +\include{chapters/Introduction} % Chapter 1 +% ETC + +%\newpage +%--------------------------------------------------------- +\renewcommand{\bibname}{References} +\bibliography{references/refs} +\bibliographystyle{ieeetr} +\addcontentsline{toc}{part}{References} +%--------------------------------------------------------- + +% Appendices +\appendix +%\include{appendices/glossary} +%\include{appendices/figures} + +%--------------------------------------------------------- + +\end{document} + diff --git a/references/README.md b/references/README.md new file mode 100644 index 0000000000000000000000000000000000000000..b9ba506a644b048977b6480b7246a3367c2db0ff --- /dev/null +++ b/references/README.md @@ -0,0 +1 @@ +References go in the file "refs.bib" diff --git a/references/refs.bib b/references/refs.bib new file mode 100644 index 0000000000000000000000000000000000000000..52dfc99fbec6e4b663d869f3edc24b09afa016e9 --- /dev/null +++ b/references/refs.bib @@ -0,0 +1 @@ +% References go here. If we actually use them diff --git a/titlepage/README.md b/titlepage/README.md new file mode 100644 index 0000000000000000000000000000000000000000..85cd333772953029df13dc5590d73c5904ab911e --- /dev/null +++ b/titlepage/README.md @@ -0,0 +1 @@ +This is where the Titlepage goes. diff --git a/titlepage/Titlepage.tex b/titlepage/Titlepage.tex new file mode 100644 index 0000000000000000000000000000000000000000..3270dff5bb11161d76cff0ef3ecd98eba42d2a2e --- /dev/null +++ b/titlepage/Titlepage.tex @@ -0,0 +1,10 @@ +\begin{titlepage} +\title{UCC::FresherGuide} +\author{The Ghosts of Committee Past \\ <\href{mailto:committee@ucc.asn.au}{committee@ucc.asn.au}>} + +\date{January 2014} + +\maketitle +\centering + +\end{titlepage}