This template is for TCD School of Engineering MAI students for writing up their Engineering Research Project. It should be used by all disciplines. It is an agreed evolution of previous templates from Harun Siljak and Mike Brady.
\documentclass[a4paper,oneside,12pt]{book}
%----------------------------------------------------------------------------------------
% README!
% Welcome. It's worth having a read through this file
% to set up the broad parameters, such as the name of
% the degree, the school/department, the type of work
% (dissertation/Final Year Project/report, etc. as well
% as your own details.
%----------------------------------------------------------------------------------------
%----------------------------------------------------------------------------------------
% COVER PAGE
% The cover page is laid out in title/title.tex. You can choose a colour
% or black and white logo
%----------------------------------------------------------------------------------------
%----------------------------------------------------------------------------------------
% THESIS INFORMATION
% Put title, author name, supervisor name, degree, type of work, school, department in here
% It will be used for the title page and for the embedded PDF information
%----------------------------------------------------------------------------------------
\newcommand{\thesistitle}{Title of Work} % Your thesis title, this is used in the title and abstract
\newcommand{\degree}{MAI (XXXXX Engineering)} % Replace with your degree name, this is used in the title page and abstract
\newcommand{\typeofthesis}{dissertation} % dissertation, Final Year Project, report, etc.
\newcommand{\authorname}{Dara \'O S\'uilleabh\'ain} % Your name, this is used in the title page and PDF stuff
%% Do not put your Student ID in the document, as TCD will not publish
%% documents that contain both your name and your Student ID.
\newcommand{\supervisor}{Associate Prof. Jane Kelly} % replace with the name of your supervisor
%\newcommand{\cosupervisor}{Dr Alex Lee} % replace with the name of your co-supervisor if you have one
\newcommand{\keywords}{this, that, more} % Replace with keywords for your thesis
\newcommand{\school}{\href{https://www.tcd.ie/Engineering/}{School of Engineering}} % Your school's name and URL, this is used in the title page
%Edited by HS for engineering
%% Comment out the next line if you don't want a department to appear
%\newcommand{\department}{\href{http://researchgroup.university.com}{Department Name}} % Your research group's name and URL, this is used in the title page
%% Language and font encodings
\usepackage[T1]{fontenc}
\usepackage[utf8]{inputenc}
\usepackage[english]{babel}
%% Bibliographical stuff
\usepackage[]{cite}
%% Document size
% include showframe as an option if you want to see the boxes
\usepackage[a4paper,top=2.54cm,bottom=2.54cm,left=2.54cm,right=2.54cm,headheight=16pt]{geometry}
\setlength{\marginparwidth}{2cm}
%% Useful packages
\usepackage{amsmath}
\usepackage[autostyle=true]{csquotes} % Required to generate language-dependent quotes in the bibliography
\usepackage[pdftex]{graphicx}
\usepackage[colorinlistoftodos]{todonotes}
\usepackage[colorlinks=true, allcolors=black]{hyperref}
\usepackage{hyperxmp}
\usepackage{caption} % if no caption, no colon
\usepackage{sfmath} %use sans-serif in the maths sections too
\usepackage[parfill]{parskip} % Begin paragraphs with an empty line rather than an indent
\usepackage{setspace} % to permit one-and-a-half or double spacing
\usepackage{enumerate} % fancy enumerations like (i) (ii) or (a) (b) and suchlike
\usepackage{booktabs} % To thicken table lines
\usepackage{fancyhdr}
\usepackage{xcolor} % to get TCD colour on headings
\numberwithin{equation}{chapter} %HS edit for (chapter.equation)
\pagestyle{plain} % Embrace simplicity!
\definecolor{tcd_blue}{RGB}{5, 105, 185}
%% It's personal taste but...
%% Uncomment the following block if you want your name and ID at the top of
%% (almost) every page.
%\pagestyle{fancy}
%\fancyhf{} % sets both header and footer to nothing
%\renewcommand{\headrulewidth}{0pt}
%\cfoot{\thepage}
%\ifdefined\authorid
%\chead{\it \authorname\ (\authorid)}
%\else
%\chead{\it \authorname}
%\fi
%% End of block
%% It is good practise to make your font sans-serif to improve the accessibility of your document. Comment out the following line to disable it (but you really should not)
\renewcommand{\familydefault}{\sfdefault} %use the sans-serif font as default
%% If you insist on not using sans-serif (please don't), consider using Palatino instead of the LaTeX standard
%\usepackage{mathpazo} % Use the Palatino font by default if you prefer it to Computer Modern
%% Format Chapter headings appropriately
\usepackage{titlesec}
\titleformat{\chapter}[hang]{\normalfont\huge\bfseries\color{tcd_blue}}{\thechapter}{1cm}{}{}
\title{\thesistitle}
\author{\authorname}
\hypersetup{
pdftitle=\thesistitle, % Set the PDF's title to your title
pdfauthor=\authorname, % Set the PDF's author to your name
pdfkeywords=\keywords, % Set the PDF's keywords to your keywords
pdfsubject=\degree, % Set the PDF's keywords to your keywords
pdfinfo={
pdfsupervisor=\supervisor, % Set the PDF's supervisor to your supervisor
%pdfcosupervisor=\cosupervisor, % Set the PDF's cosupervisor to your cosupervisor if using
}
}
\frontmatter
\begin{document}
\input{title/title.tex}
\pagenumbering{roman}
\section*{\Huge\textcolor{tcd_blue}{Declaration}}
\vspace{1cm}
I hereby declare that this \typeofthesis\ is entirely my own work and that it has not been submitted as an exercise for a degree at this or any other university.
\vspace{1cm}
I have read and I understand the plagiarism provisions in the General Regulations of the University Calendar for the current year, found at \url{http://www.tcd.ie/calendar}.
\vspace{1cm}
I have completed the Online Tutorial on avoiding plagiarism `Ready Steady Write', located at \url{http://tcd-ie.libguides.com/plagiarism/ready-steady-write}.
\vspace{1cm}
I consent / do not consent to the examiner retaining a copy of the thesis beyond the examining period, should they so wish (EU GDPR May 2018).
\vspace{1cm}
I agree that this thesis will not be publicly available, but will be available to TCD staff and students in the University’s open access institutional repository on the Trinity domain only, subject to Irish Copyright Legislation and Trinity College Library conditions of use and acknowledgement. \textbf{Please consult with your supervisor on this last item before agreeing, and delete if you do not consent}
\vspace{3cm}
Signed:~\rule{5cm}{0.3pt}\hfill Date:~\rule{5cm}{0.3pt}
\chapter*{Abstract}
A short summary of the problem investigated, the approach taken and the key findings. This should not be more that around 400 words.
This must be on a separate page.
\chapter*{Lay Abstract}
Similar to the actual abstract in terms of the information, but written for a non-specialist. So no jargon, no acronyms. Explain to a member of the general public what this project entailed. Should be no longer than the actual abstract.
This must be on a separate page.
\newpage
\onehalfspacing\raggedright %\raggedright turns off justification and hyphenation
\section*{\Huge\textcolor{tcd_blue}{Acknowledgements}}
Thanks Everyone!
You should acknowledge any help that you have received (for example from technical staff), or input provided by, for example, a company.
\tableofcontents
\listoffigures
\listoftables
\newpage
\section*{\Huge\textcolor{tcd_blue}{Nomenclature}}
\begin{tabular}{lp{9cm}l}
A&Area of the wing&$m^{2}$\\
B\\
C& Roman letters first, with capitals\ldots\\
a&then lower case.\\
b\\
c\\
$\Gamma$&Followed by Greek capitals\ldots\\
$\alpha$&then lower case greek symbols.\\
$\beta$\\
$\epsilon$\\
TLA&Finally, three letter acronyms and other abbreviations arranged alphabetically\\
\end{tabular}
\vspace{2cm}
If a parameter has a typical unit that is used throughout your report, then it should be included here on the right hand side.
If you have a very mathematical report, then you may wish to divide the nomenclature list into functions and variables, and then sub- and super-scripts.
If you have a large number of acronyms, check out \href{https://www.overleaf.com/learn/latex/Glossaries} to make that more robust.
Note that Roman mathematical symbols are typically in a serif font in italics.
\mainmatter
% maintaining separate .tex files for each chapter is good practice
\input{introduction/introduction.tex}
\input{background/background.tex}
\input{project/project.tex}
\input{evaluation/evaluation.tex}
\input{conclusion/conclusion.tex}
% note that your supervisor may have a strong opinion on the style of referencing you use. Some background is available at https://www.overleaf.com/learn/latex/Bibtex_bibliography_styles
\bibliographystyle{IEEEtran} %Changed to IEEETran by HS
%\bibliographystyle{unsrt}
\bibliography{bibs/sample}
\appendix
\renewcommand{\thechapter}{A\arabic{chapter}}
\input{appendix/appendix.tex}
\end{document}