cion-thesis.tex

%% This document gives an example on how to use the ntnubachelorthesis
%% LaTeX document class.
%% Use oneside for PDF delivery and twoside for printing in a book style
%% use language english, norsk, nynorsk and one of the following shortenings
%%  ``BSP'' Bachelor i Spillprogrammering,\\
%%  ``BRD'' Bachelor i drift av nettverk og datasystemer,\\
%%  ``BIS'' Bachelor i Informasjonssikkerhet,\\
%%  ``BPU'' Bachelor i Programvareutvikling, \\
%%  ``BIND'' Bachelor i Ingeniorfad - data, \\
%%  ``BADR'' Bachelor i drift av datasystemer, \\
%%  ``BIT'' Bachelor i informatikk, \\
%%  ``BABED'' Bachelor i IT-støttet bedriftsutvikling.
%%  ``BMS'' Bachelor i material science.
%%  ``BCE'' Bachelor i chemical science.  
%%   BPROG  Bachelor in Programming [Games|Applications]
%%   for example \documentclass[BCE,norsk,twoside]{ntnuthesis/ntnubachelorthesis}

\documentclass[BIND,english,oneside]{ntnuthesis/ntnubachelorthesis}

\usepackage{csvsimple}
\usepackage{booktabs}
\usepackage{wrapfig}

\usepackage{gnuplottex}
\usepackage{pgfplots}
\usepackage[titletoc]{appendix}

\usepackage[numberedsection]{glossaries}
\renewcommand{\glossarypreamble}{\label{appendix:glos}}

\usepackage{doi}

\usepackage{svg}

\usepackage{imakeidx}

\usepackage{csquotes}
\usepackage{epigraph}
\usepackage{tabularx}
\usepackage{tikz}
\usetikzlibrary{graphs,graphdrawing,graphdrawing.trees}
\usepackage[super]{nth}

\definecolor{darkgreen}{rgb}{0,0.5,0}
\definecolor{darkred}{rgb}{0.5,0.0,0}

\lstset{ basicstyle=\ttfamily,
                keywordstyle=\color{blue}\ttfamily,
                stringstyle=\color{darkred}\ttfamily,
                commentstyle=\color{darkgreen}\ttfamily,
}


%Typesetting of C++
\newcommand{\CPP}[0]{{C\nolinebreak[4]\hspace{-.1em}\raisebox{.1ex}{\small\bf +\hspace{-.1em}+\ }}}

%\newcommand{\comment}[1]{\textcolor{blue}{\emph{#1}}}  %% use of the colour and you can see how to use commands with parts \comment{so what}

%% The class files defines these two
%% \newcommand{\NTNU}{Norwegian University for Science and Technology} %

% you can create you one #define like structures using the \newcommand feature
% you can change behaviour using \renewcommand

\newcommand{\com}[1]{{\color{red}#1}} % supervisor comment
%\renewcommand{\com}[1]{} %remove starting % to remove supervisor comments
% This will appear in text \com{Lecuters comment} and be visible unless you uncomment
% the renewcommand line.

\newcommand{\todo}[1]{{\color{green}#1}} % items to do
%\renewcommand{\todo}[1]{} %remove starting % to remove items to do

\newcommand{\n}[1]{{\color{blue}#1}} % other comment
%\renewcommand{\n}[1]{} %remove starting % to remove notes

\newcommand{\dn}[1]{} % add the d to a note to say that you have finished with it.

\newcommand{\gj}{NTNU i Trondheim}

\makeglossaries
\setglossarysection{chapter}


% TODO: fix toclevel and chapter sub
\indexsetup{level=\section*,toclevel=section}
\makeindex[title=Terms and Explanations Index]

\usepackage{idxlayout}


\input{inc/glossary}

% Norwegian Characters,  needs the {} or to be separate from the next letters
% \o{}   \aa{}   \ae{}   so at the end of a word you can use \o  \aa   \ae
% \O{}   \AA{}   \AE{}   you can also just leave a space and latex will remove it
%    eg, NTNU i Gj\o vik  or NTNU i Gj\o{}vik
\begin{document}

\input{inc/BachelorThesisData} % this is the file which contains all the details about your thesis

\makefrontpages % make the frontpages

% Don't indent paragraphs
\setlength{\parindent}{0em}
\setlength{\parskip}{8pt}

\input{inc/preface}


\tableofcontents
\listoffigures
\listoftables

\input{inc/introduction}
\input{inc/theory}
\input{inc/technologyandmethod}
\input{inc/results}
\input{inc/discussion}
\input{inc/conclusion}

\bibliographystyle{ntnuthesis/ntnubachelorthesis}
\bibliography{inc/BachelorExample}

\appendix %after this line all chapters will have letters instead of numbers
\begin{appendices}
\addtocontents{toc}{\protect\setcounter{tocdepth}{1}}

\printglossary

\chapter{Product vision document}
\label{appendix:vision}
\includepdf[pages=-]{inc/appendices/vision.pdf}

\chapter{Requirements document}
\label{appendix:requirement}
\includepdf[pages=-]{inc/appendices/requirement.pdf}

\chapter{Feature discussion and decisions}
\label{appendix:plansndecisions}
\includepdf[pages=-]{inc/appendices/permissionskubernetes.pdf}

\chapter{Autumn project report}
\label{appendix:autumn}
\includepdf[pages=-]{inc/appendices/cion-report.pdf}

\chapter{User test}
\label{appendix:usertest}
\includepdf[pages=-]{inc/appendices/user_test.pdf}

\chapter{Code documentation}
cion-api is the only project with extensive inline- and "docstring" code documentation. Which is why it is the only project included here
\section{cion-api}
\includepdf[pages=-]{inc/appendices/cion-api-code-doc.pdf}

\input{inc/appendices/system-doc/system-doc.tex}
\input{inc/appendices/projecthandbook.tex}
\input{inc/appendices/terms-explanations.tex}

\end{appendices}
\end{document}