Compare commits

...

5 Commits

3 changed files with 42 additions and 83 deletions

View File

@@ -30,11 +30,12 @@ If you are in another school, you should make sure that the template meets your
Critical information: The current version of the template uses Lua\LaTeX{} for enhanced font, code, and language support.
{\em It will not work on PDF\LaTeX{} nor classic \LaTeX.}
On debian based systems, you will need to install the \verb|texlive-luatex| package.
If you are writing a PhD dissertation, you will want to edit \path{main-dissertation.tex} rather than \path{main.tex}
\begin{description}
\item [Overleaf Template:] \url{https://www.overleaf.com/latex/templates/reykjavik-university-project-report-and-thesis-template/fcwvcgnstrjs}
\item [Actively developed code:] \url{https://github.com/foleyj2/ru-thesis}
\item Current maintainers: Joseph Timothy Foley and Marcel Kyas.
\item [Actively developed code:] \url{https://gitea.cs.ru.is/foley/ru-thesis}
\item Current maintainer: Joseph Timothy Foley.
Questions, comments, complaints should be submitted at \url{https://github.com/foleyj2/ru-thesis/issues}
\end{description}
@@ -93,21 +94,11 @@ On debian based systems, you will need to install the \verb|texlive-luatex| pack
\end{itemize}
\section{Coverpage}\label{sec:coverpage}
Reykjavik University's communications department insists on a common outer appearance of official printed documentation, which includes Doctoral Dissertations.
The library has been delegated the role of deciding what the non-printed student theses and project reports should look like.
They have stated that since most never are printed, the focus should be on suitability for displaying on a screen and e-reader.
Reykjavik University's communications department insists on a common outer appearance of all our theses.
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}
Doctoral students need to contact the RU Communications department for slightly different custom cover PDF before the document is to be published\footnote{The author highly suggests doing this 2 weeks before it is due.}.
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 \verb|\usepackage{rucover}| to your preamble.
@@ -131,10 +122,9 @@ This is no longer required for most electronic submissions except perhaps PhD.
\section{Printing}
If you decide to print, make sure you are doing it on archival acid-free paper.
Otherwise, your document will yellow and fall apart in the library over time.
Traditionally, the student prints out and binds a copy for each advisor and examiner.
This may also be required if the research was funded or in certain circumstances.
Traditionally, the student prints out and binds a copy for each advisor and examiner: this varies significantly.
This may also be required if the research was funded in some cases.
If you are using a printing house to take care of the binding, they may be able to take the completed PDFs (cover and inside text) and print them for you.
Check with the printing house if they want it as A4 (to be trimmed) or as B5 (which they will take care of resizing).
\section{Submission}
When your document is finished and approved by your advisor, it needs to be uploaded to Skemman~\url{https://skemman.is}.
@@ -181,28 +171,31 @@ Some information is at the top of \path{main.tex} file, this file is for a gener
Alternatively, if nothing you are doing is particularly private or proprietary, you can do development online using Overleaf.
In this case, you won't need to setup the rest of the tools mentioned below except perhaps the Reference Manager mentioned in step~\ref{list:refmanager}.
\begin{enumerate}
\item RedHat: sudo yum -y install
\begin{description}
\item[RedHat]
\begin{lstlisting}
sudo yum -y install
texlive-collection-fontsrecommended
texlive-biblatex-{apa,apa-doc,ieee,ieee-doc}
texlive-{xargs,lipsum,lastpage,luatex,pseudocode,url,examplep,listings,xspace,pgf,tikz,amsfonts,amsmath,amssymb,siunitx,svn-multi,subfig,fixme,textpos,biblatex,makeglos,nomencl,xwatermark,ltxkeys,framed,boondox,printlen}
Getting biber installed on older RedHat systems is a bit tricky
for unclear reasons. The metapackage you need is at
https://copr.fedoraproject.org/coprs/cbm/Biber/
\item Debian/Ubuntu:
sudo apt-get -y install texlive-full pgf latex-xcolor
If you don't want to install everything, this list of packages is known
to work: sudo apt-get -y install texlive texlive-luatex texlive-latex-extra
texlive-{xargs,lipsum,lastpage,luatex,pseudocode,url,examplep,
listings,xspace,pgf,tikz,amsfonts,amsmath,amssymb,siunitx,svn-multi,
subfig,fixme,textpos,biblatex,makeglos,nomencl,xwatermark,ltxkeys,
framed,boondox,printlen}
\end{lstlisting}
\item[Debian/Ubuntu]
\end{description}
\begin{lstlisting}
sudo apt-get -y install texlive texlive-luatex texlive-latex-extra
texlive-science texlive-generic-extra texlive-lang-european
texlive-lang-german latex-xcolor texlive-pictures pgf
texlive-bibtex-extra texlive-publishers chktex evince
fonts-lmodern lmodern biber
\end{lstlisting}
\begin{enumerate}
\item Debian/Ubuntu:
\end{enumerate}
\item Get a LaTeX Integrated Development Environment (recommended, but not required)
\url{http://texstudio.sourceforge.net/} or
\url{http://www.xm1math.net/texmaker/}
Some editors may include LaTeX support.
If you want to learn a very powerful (but old-fashioned) editor \url{http://www.gnu.org/software/emacs/}
Install the auctex package by: M-x list-packages, click on AUCTeX
@@ -228,8 +221,8 @@ Some information is at the top of \path{main.tex} file, this file is for a gener
\item Rename the \path{main.tex} file with your information (optional).
DEGREE-NAME-YEAR is the recommended scheme
e.g. \path{msc-foley-2015.tex}.
This is referred to as the "Main" file.
e.g. \path{msc-foley-2025.tex}.
This is referred to as the ``Main'' file.
\item Set your UI to use \path{lualatex} as the processor.
If you are typing commands in manually, this is by typing in \path{lualatex main.tex}
@@ -253,18 +246,14 @@ Some information is at the top of \path{main.tex} file, this file is for a gener
\begin{itemize}
\item Make absolutely sure that your \path{references.bib} is in UTF-8. If it is another format (CP1251,etc) you may get weird problems with any accented characters.
{\em Students have run into encoding issues in the past and it has taken a surprisingly long time to debug.}
\item Make sure the rest of the files, particularly the \path{.tex} file are in UTF8 or are at least in the same encoding.
If the files are in different encoding, you will discover errors with accented characters when you try to include them together.
Watch out for line endings. Linux, Windows, and OSX all use different line endings in text files.
\item You may wish biber/biblatex instead of bibtex.
(The template may already do this.)
Otherwise Icelandic characters may not work properly in your \path{references.bib} file.
\item Reference managed management uses biber/biblatex instead of bibtex.
Icelandic characters may not work properly in your \path{references.bib} file if you use BibTeX.
TexMaker and TeXStudio require a configuration change to do this.
%Refer to the ``...Projects'' guide above.
\item Be consistent about UPPER and lower case in naming files.
Preferably just use the 26 English letters, 10 numbers, and ``-'' to avoid filename issues.
Windows doesn't care (but some programs in Windows do).
OSX sometimes cares.
Linux always cares.
@@ -272,41 +261,10 @@ TexMaker and TeXStudio require a configuration change to do this.
\end{itemize}
\subsection{Limited Access}
In general, access to the MSc thesis shall be open.
In general, access to the project report, thesis, or dissertation shall be open.
If restricting access to a thesis is sought, e.g.\ for the purpose of protecting intellectual property or protecting commercial interests of an industrial partner participating in the MSc project, permission needs to be acquired, see {\em Reglur um skil á lokaritgerðum og lokaverkefnum við Háskólann í Reykjavík\/} (\url{http://www.ru.is/bokasafn/skemman}).
If restriction of access to a thesis is granted it should be clearly stated in the thesis right after the keywords following the abstract with specification of the date at which the restriction of access should be lifted.
% \subsection{Submission and Deadlines}
% The official completion of the MSc thesis is signified by the student submitting the final electronic (PDF) version of the thesis, signed by himself/herself, the supervisor(s) and the examiner to the SSE office and uploaded to Skemman, (see \url{https://www.skemman.is}).
% See also RU's rules for submission of theses and final projects ({\em Reglur um skil á lokaritgerðum og lokaverkefnum við Háskólann í Reykjavík\/}, \url{http://www.ru.is/bokasafn/skemman}).
% If a student plans to graduate in a particular graduation ceremony, the following deadlines must be respected.
% Should any of the deadlines below not be respected the student will have to wait for the following graduation ceremony before he/she can graduate.
% Students are responsible for adhering to these deadlines and are advised to deliver their work in good time.
% The deadline schedule for the purpose of graduation is as follows (where $t$ is the graduation date and the
% numbers refer to the number of days prior to graduation) as shown on Table~\ref{tab:deadlines}.
% \begin{table}
% \centering
% \begin{threeparttable}
% \begin{tabular}{ll}
% Final draft of thesis delivered to supervisor\tnote{a} &$t-50$\tnote{b}\\
% Supervisors comments delivered to student &$t-40$\tnote{c,d}\\
% Thesis delivered to supervisor(s), examiner and department head\tnote{a} &$t-20$\tnote{c}\\
% Examiner confirms that thesis may be put up for defense &$t-17$\tnote{c}\\
% Defense &$t-14$\tnote{c}\\
% Grade posted to the Registrar by SSE office &$t-11$\tnote{c}\\
% Graduation &$t$\tnote{c}\\
% \end{tabular}
% \begin{tablenotes}
% \item[a] Paper and/or electronic form, as requested by the supervisor(s) and/or examiner.
% \item[b] Date can be modified by mutual agreement of the supervisor, student and examiner.
% \item[c] Firm deadlines.
% \item[d] Or within 10 days after the supervisor has received the final draft, whichever comes first.
% \item[e] Or within 5 days after the defence, whichever comes first.
% \end{tablenotes}
% \caption{Schedule for thesis according to expected graduation date.}\label{tab:deadlines}
% \end{threeparttable}
% \end{table}
\subsection{Thesis Defense (Oral Examination Procedure)}
The examiner is selected by the Department Head in consultation with the supervisor(s).
@@ -318,6 +276,7 @@ The audience then leaves the room and the examiner(s), supervisor and School rep
Subsequently, the candidate leaves the room and the examiner, School representative and supervisor(s) deliberate and decide upon the grade.
Normally, the student will be informed of the grade the next day.
If the thesis is subject to confidentiality, or for other valid reasons approved by the Director of Graduate Studies, the oral examination may be closed to the public.
\subsection{Grading}
The appointed examiner shall evaluate the thesis and the oral defense of the thesis, together with the
supervisor(s) and the department's representative.

View File

@@ -91,13 +91,13 @@ ISBN 978-XXXX-XXXX-X-X (electronic version)}{Printing: RU Printing osf.}{Printed
%\end{dedications}
% RUM: "Acknowledgements (optional)"%start numbering
\tableofcontents{}
\listoffigures{}
\listoftables{}
\tableofcontents*{}%* means no TOC entry
\listoffigures*{}
\listoftables*{}
%% A list of abbreviations is an example of a special list
%% Other lists may be added, such as lists of algorithms, symbols, theorems, etc.
%% IN CS PhD, this is sometimes centered.
\chapter{List of Symbols}
\chapter*{List of Symbols}%* means no TOC entry
%% This list demonstrates the "siunitx" package capabilities
\begin{tabular}{lll}\toprule
Symbol &Description &Value/Units\\\midrule

View File

@@ -20,7 +20,7 @@
%% \textcite{} is for when the information is part of a sentence.
%% \cite{} just puts the name and year
\addbibresource{references.bib}
\usepackage{biblatex-IS}%%loads Icelandic translations for things polyglossia missed
\usepackage{biblatex-IS}%%loads Icelandic translations for things polyglossia missed.
%%%%%% Packages and Macros %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\usepackage{custom}
@@ -60,7 +60,7 @@
\Examiners{Tough E. Questions}
\hyphenation{Jo-seph Fo-ley}
% If you need to enforce hyphenation in English or Icelandic, put a space separated list in the hyphenation macro.
% If you need to enforce hyphenation in English or Icelandic, put a space separated list in the hyphenation macro. You may also need to install the texlive-hyphen-icelandic package.
\begin{document}
%% TODO: get the official cover graphic and have the system fill in the fields for you
@@ -73,13 +73,13 @@
%\end{dedications}
% RUM: "Acknowledgements (optional)"%start numbering
\tableofcontents{}
\listoffigures{}
\listoftables{}
\tableofcontents*{}%* means no TOC entry
\listoffigures*{}
\listoftables*{}
%% A list of abbreviations is an example of a special list
%% Other lists may be added, such as lists of algorithms, symbols, theorems, etc.
%% IN CS PhD, this is sometimes centered.
\chapter{List of Symbols}
\chapter*{List of Symbols}%* means no TOC entry
%% This list demonstrates the "siunitx" package capabilities
\begin{tabular}{lll}\toprule
Symbol &Description &Value/Units\\\midrule