foley/ru-thesis
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated instructions with more FAQ and coverpage info.

Browse Source
This commit is contained in:
Joseph Timothy Foley
2024-11-15 18:53:05 +00:00
parent 0eda7f3848
commit bdd9a20695
1 changed files with 67 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

85
instructions.tex
View File

@@ -10,7 +10,7 @@
% \usepackage[hidelinks]{hyperref} % must be last package loaded!
%% Macros for filling in commonly changed items
\newcommand{\TIheadofgrad}{Slawomir Koziel~\formatemail{slawomir} or TD Person}
\newcommand{\TIheadofgrad}{TBA}
\newcommand{\TItvdadmin}{Sigrún Þorgeirsdóttir~\formatemail{sigrunth}}
% \begin{document} % this tells the compiler that it is time to make
@@ -42,21 +42,73 @@ On debian based systems, you will need to install the \verb|texlive-luatex| pack
\begin{itemize}
\item {\em How do I use APA citations?}
The template is setup to use IEEE citations by default.
For those who want to use APA, you will need to use the \texttt{apacite} package.
In the \path{main.tex}, uncomment the package line near the top: \path{\usepackage{apacite}}, then go to the bottom of the file and comment out the: \path{\bibliographystyle{IEEEtran/bibtex/ieeetran}}
For those who want to use APA, you will need to adjust lines at the top of \path{main.tex}
See the comments in the file right after \verb|\usepackage[backend=biber,style=ieee]{biblatex}|
\item {\em Why does the margins and page size look weird?}
As mentioned in the Abstract, this template was optimized for the B5 paper size so that it in print copy it has the same size as a standard textbook that fits on a standard bookshelf.
This size also has the benefit of being similar to an e-Reader screen.
\item {\em Why isn't there the RU logo on the front of the template on Overleaf/Git?}
The official cover for these documents is generated by the Reykjavik University department.
Putting the RU logo on GitHub or Overleaf's templates is incompatible with their licensing rules, so we cannot legally include it.
See Section~\ref{sec:coverpage} about how to integrate the cover with the RU logo into your document.
\item {\em My advisor doesn't like this format and asked me to change it.
What should I do?}
Please contact the head of Graduate Affairs in your Department about what is required in the thesis format and who determines the formatting.
\item {\em Why are there all these blank pages?}
In printed books, content in the main body of the book traditionally starts on the Right i.e. ``Recto'' side.
The template puts blank pages so that the Abstract, Table of Contents, and Chapters always start on the right side which may involve putting blank pages.
\item {\em I've been told to use a Word Template. Where is it?}
There is no officially supported MS Word Template as of 2024-10-23 as far as the authors know.
The template authors tested MS Word to see if could properly typeset according to standard practice and found it had insufficient enforcement of formatting and margins.
In addition, MS Word is unable to hyphenate Icelandic properly which results in very ugly typesetting.
If you need a WYSIWYG editor to generate an Icelandic document, we recommend OpenOffice or LibreOffice with the extension developed at University of Iceland: \url{https://extensions.openoffice.org/fr/project/icelandic-hyphenation-dictionary}
The authors do not recommend using MS Word for any document that must be printed as a book\footnote{Publishers accept MS Word documents then pay people in Asia to extract the content and convert it into XML or LaTeX.}.
\item {\em Everything suddenly broke while I was trying to fix a citation}
The most common causes of this problem:
\begin{itemize}
\item \texttt{.bib} file has a weird UTF-8 character in it like a dash character "--" (which is different than "-" or "---" separator).
This can even be space characters that are non standard.
\item Forgetting to end each field with a ",".
\item Putting anything except "a-Z0-9" in the citation id field. (the first one)
\item Putting a URL in anything except the URL field
\item Using ``\&'' to separate author names.
Names are separated with the word ``and''.
Only use ``,'' when you are reversing the order e.g. ``Foley, Joseph''
\item Having ``\&'' or underscore or ``\verb|\|'' in a field
\end{itemize}
There are so many ways the citations can go wrong that Joe recommends using Zotero to export the \texttt{.bib} for beginning users.
The JabRef tool is also very helpful for finding issues and managing the \texttt{.bib} files.
\end{itemize}
\section{Coverpage}
\section{Coverpage}\label{sec:coverpage}
Reykjavik University's communications department insists on a common outer appearance of all our theses.
This class supports their desire through the \texttt{rucover} package.
To generate a conforming cover page, follow the instructions at
\url{https://en.ru.is/media/skjol-td/Instructions_2020.pdf}, enter the relevant information into \url{https://en.ru.is/media/skjol-td/TD_E-cover_2019.pdf} and save the file as \texttt{cover.pdf}.
A detailed explanation of what the cover should look like is at \url{https://en.ru.is/media/tvd/Instructions.pdf} though this document is from when the School of Technology was the School of Science and Engineering.
Instructions for specific schools or departments:
\begin{description}
\item[Department of Computer Science:] To generate the cover with the RU logo, follow the instructions at
\url{https://en.ru.is/media/skjol-td/Instructions_2020.pdf}, enter the relevant information into \url{https://en.ru.is/media/skjol-td/TD_E-cover_2019.pdf} and save the file as \texttt{cover.pdf}.
\item[Department of Engineering:]
\begin{description}
\item[M.Sc.] students be given a fill-in PDF cover in CANVAS under the Module ``Templates'' for the course T-901-MEI2 or equivalent. It will have the name ``afræn forsíða á lokaverkefni'' for the Icelandic version or ``Cover Page for MSc thesis - English'' for the English one.
\item[Ph.D.] students need to contact the RU Communications department for slightly different custom cover PDF before the document is to be published\footnote{Author Joseph highly suggests doing this 2 weeks before it is due.}.
\end{description}
\end{description}
This class supports the RU Communication's desire for the common appearance through the \texttt{rucover} package.
Place \texttt{cover.pdf} into the same directory that you have your thesis' main file.
\LaTeX{} includes the file automatically if you add \texttt{\textbackslash usepackage\{rucover\}} to your preamble.
You can control the filename with \texttt{\textbackslash usepackage[filename=name.pdf]\{rucover\}}.
\LaTeX{} includes the file automatically if you add \verb|\usepackage{rucover}| to your preamble.
You can control the filename with \verb|\usepackage[filename=name.pdf]{rucover}|.
\section{Files and Directories/Folders}
@@ -89,14 +141,14 @@ Make sure the document is something you would be proud to have associated with y
The general submission sequence is:
\begin{enumerate}
\item Defense complete, minor corrections complete after 3 days of work.
\item Defense complete, minor corrections complete after X days of work.
\item Save the completed thesis text as \path{main.pdf}
%\item Get signature pages signed by supervisor(s) and examiner.
%\item Sign the library release page.
%\item Scan the pages in, put them into the document in the appropriate places.
%\item Open the official cover files in \path{cover}, fill in the appropriate fields, and save as a \path{cover.pdf}
\item Use a PDF binding tool such as PDFsam \url{https://pdfsam.org} to putthe cover before the first page and save as \path{thesis.pdf}
\item Upload the finished \path{thesis.pdf} to Skemman.
\item Open the official cover files in \path{cover}, fill in the appropriate fields, and save as a \path{cover.pdf}
% \item Use a PDF binding tool such as PDFsam \url{https://pdfsam.org} to putthe cover before the first page and save as \path{thesis.pdf}
\item Upload the finished \path{main.pdf} to Skemman.
\item An autogenerated email is sent from Skemman.
This email should be forwarded to your admin such at \TItvdadmin{}.
\item Grade for the thesis is published.
@@ -106,14 +158,11 @@ The general submission sequence is:
\section{LaTeX Template Instructions}
Some information is at the top of \path{main.tex} file, this file is for a general overview and common problems.
%More information on working with LaTeX at
%\url{http://afs.rnd.ru.is/project/htgaru/trunk/how-to-get-around-projects.pdf}
\subsection{Getting started:}
\begin{enumerate}
\item Find a safe place to work on your thesis document.
The author recommends Git on Overleaf, but anywhere data is backed up is a appropriate.
% If you wish to have a repository to be setup for your thesis on \url{openproject.cs.ru.is}, email csit AT ru.is.
If you are working with sensitive information, you should avoid bitbucket, google drive, dropbox, and any other free cloud service.
If you think this is unnecessary, just consider how much time you will lose if your computer crashes.
Due to Murphy's law, this is likely to happen just before your thesis is due\footnote{This has happened many times.}.