Compare commits

...

6 Commits

6 changed files with 100 additions and 77 deletions

3
delete-generatedfiles.sh Executable file
View File

@@ -0,0 +1,3 @@
#!/bin/bash
echo "deleting LaTeX generated files (except pdfs)"
rm *.aux *.bbl *.bcf *.blg *.fdb_latexmk *.fls *.idx *.ilg *.ind *.lof *.log *.lot *.lox *.out *.run.xml *.synctex.gz *.toc *.xdv

View File

@@ -62,7 +62,7 @@ If you are writing a PhD dissertation, you will want to edit \path{main-disserta
\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 adjust lines at the top of \path{main.tex}
See the comments in the file right after \verb|\usepackage[backend=biber,style=ieee]{biblatex}|
See the line: \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.
@@ -106,25 +106,17 @@ If you are writing a PhD dissertation, you will want to edit \path{main-disserta
\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.
The library has been delegated the role of deciding what the 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.
The current template in \path{main.tex} implements the cover page and copyright page that go on the inside.
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.
You can control the filename with \verb|\usepackage[filename=name.pdf]{rucover}|.
Previously, doctoral students needed contact RU Communications for the outside cover that is printed on heavier paper and bound around the book.
This is now included in the template \path{main-dissertation.tex} as of 2026-01-27.
\section{Files and Directories/Folders}
\begin{itemize}
%\item \path{cls/}: contains the \path{rureport.cls} template used to format these instructions.
\item \path{graphics/:} contains the graphics to generate this document.
%\item \path{covers/:} contains the official covers (from RU Communications) to be put on the outside of the finished book.
\item \path{IEEEtran/:} contains the IEEE citation style files
%\item \path{deadlines.xlsx}: A deadline calculator that uses the semester's
%graduation date
\end{itemize}
\section{Limited Access}
@@ -152,10 +144,10 @@ The general submission sequence is:
\begin{enumerate}
\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 PhD: Get signature pages signed by supervisor(s) and examiner on physical copies.
%\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 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.
@@ -171,26 +163,27 @@ Some information is at the top of \path{main.tex} file, this file is for a gener
\subsection{Preparation}
\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 are working with sensitive information, you should avoid bitbucket, google drive, dropbox, and any other free cloud service.
The author recommends Overleaf with the git integration\footnote{So you have a copy locally on your computer with all of its history}, but anywhere data is backed up is a appropriate.
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.}.
If you are working with sensitive information, you should avoid bitbucket, google drive, dropbox, and any other free cloud service.
\item Get a LaTeX installation.
We recommend TeXlive \url{https://www.tug.org/texlive/}
For this template on windows, MiKTeX will also work, but will run very slowly the first time you render the template.
{\em As of September 2024, both MikTeX and TexLive did not want to install properly on the author's Windows 11 computer.}
You will need to enable the ``miktex'' option in the template to substitute packages.
We recommend TeXlive \url{https://www.tug.org/texlive/} in general.
You will need to figure out which packages you need or just install the whole distribution which is around 6~GB.
If you wish to install packages as needed, you can use MiKTeX \url{https://miktex.org} by Christian Schenk which exists for Windows, Linux, and Mac.
MiKTeX will run very slowly the first time you render the template.
It is very very important that you run the ``MikTeX Update Wizard'' before you start.
Otherwise you may get errors when you try to build the document.
A Mac-focused installer can be found at MacTeX \url{https://tug.org/mactex}
Under Apple iOS and linux this is the TexLive series of packages.
Linux distributions name the packages differently.
The author's recommendations for RedHat distributions such as Redhat Enterprise Linux, Centos, Fedora are in Listing~\ref{code:texlive-redhat}.
Debian-based distributions including Ubuntu and PopOS would use the packages in Listing~\ref{code:texlive-debian}.
\begin{lstlisting}[caption={RedHat Packages},label={code:texlive-redhat}]
sudo dnf -y install texlive-scheme-medium texlive-collection-{fontsrecommended,luatex,latexrecommended} texlive-biblatex-{apa,apa-doc,ieee,ieee-doc} texlive-{amsfonts,amsmath,canoniclayout,ccicons,eepic,gitinfo2,fixme,makeglos,nomencl,orcidlink,lastpage,lipsum,listings,ltxkeys,pgf,pseudocode,stix2-otf,stix2-type1,siunitx,xurl}
sudo dnf -y install texlive-scheme-medium texlive-collection-{fontsrecommended,luatex,latexrecommended} texlive-biblatex-{apa,apa-doc,ieee,ieee-doc} texlive-{amsfonts,amsmath,babel-latin,canoniclayout,ccicons,eepic,gitinfo2,fixme,makeglos,nomencl,orcidlink,lastpage,lipsum,listings,ltxkeys,pgf,pseudocode,stix2-otf,stix2-type1,siunitx,xurl}
\end{lstlisting}
\begin{lstlisting}[caption={Debian/Ubuntu Packages},label={code:texlive-debian}]
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

View File

@@ -42,14 +42,15 @@ This image will scale according to the width of the text on the page.
There is a helpful list of squared numbers in Table~\ref{tab:numbers}.
This table is formatted in the style of a book, which is very differerent than the style one is used to in Excel.
The test text ``Lorem Ipsum''\index{Lorem Ipsum} is from an ancient text from 45 B.C. \cite{cicero46deFinibus, lipsomwebsite}\\
\lipsum[1-5]
\subsection{Subsection}
\lipsum[6-10]
Some text
\subsubsection{SubSubsection}
\lipsum[11-15]
Even more text
\section[Section with an extremely long name]{Section with a very very very very very very very very very very very very very very very very very very very very long name}
\lipsum[11-18]
Lots and lots of text!
I took out the Lore Ipsum because of the latin confusing polyglossia and biblatex.
%%% Local Variables:
%%% mode: latex

View File

@@ -11,7 +11,6 @@
\usepackage{polyglossia}
\setdefaultlanguage{english}
\setotherlanguage{icelandic}
%%% Setup citations: pick one format
%% IEEE Format
\usepackage[backend=biber,style=ieee]{biblatex}
@@ -57,6 +56,8 @@
submitted to the \theSchool{} at \theInstitution{} in partial fulfillment
of the requirements for the degree of \theDegreeLong}
% Change \DocumentDescription if you need a custom title or if it needs to be in Icelandic
\bookissn{ISSN XXXX-XXXX}%You need to register for an ISSN to publish a Dissertation
%% PhD only have Thesis Committee with roles. Examiner is part of committee.
\SupervisorHeading{Thesis Committee}
@@ -71,11 +72,12 @@
\begin{document}
\printedcover{\thetitle}{ISSN XXXX-XXXX}%Cover title and ISSN number
\printedcover{\thetitle}{ISSN XXXX-XXXX}%Cover title and ISSN number
\printedcover{\thetitle}%Cover title (in case you have to adjust formatting)
\maketitle{}
\disableindents{}%frontmatter material mostly doesn't need indents
\copyrightpage{\thetitle}{0000-0000-0000-0000}{100}{ISBN 978-XXXX-XXXX-X-X (print version)\\
ISBN 978-XXXX-XXXX-X-X (electronic version)}{Printing: RU Printing osf.}{Printed on 900g Cardboard paper}
% If this is a PhD, register for an ISSN and ISBN, then:
@@ -84,10 +86,6 @@ ISBN 978-XXXX-XXXX-X-X (electronic version)}{Printing: RU Printing osf.}{Printed
% For submitting in Skemman the ISBN can be replaced with the url handle ( \url{http://hdl.handle.net/1946/xxxx} )
% Inside ruthesis.sty, the copyrightpage can be edited - there is an option to include a stamp/icon of the printer
% If this is a PhD, register for an ISSN and ISBN, then:
% \copyrightpage{ISSN xxxx-yyyy\\ISBN 978-xxxxxxxxxx\\\url{http://hdl.handle.net/1946/xxxx}\\}
%\signaturepage{} %Generally only for Print copies and needs the rusignaturepage package
% \begin{dedications}% Optional
% I dedicate this to my spouse/child/pet/power animal.
%\end{dedications}
@@ -174,7 +172,7 @@ It is likely to save you a lot of frustration and errors.
%% Index, optional. A good idea on longer documents
\clearforchapter{}
\printindex{}%%RUM: Not mentioned
\backcover{}
\end{document}
%%% Local Variables:
%%% mode: latex

View File

@@ -8,7 +8,6 @@
\usepackage{polyglossia}
\setdefaultlanguage{english}
\setotherlanguage{icelandic}
%%% Setup citations: pick one format
%% IEEE Format
\usepackage[backend=biber,style=ieee]{biblatex}

View File

@@ -73,6 +73,43 @@
%\makeoddhead{chapter}{}{}{} %to change only one side
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Information about Institution, Author, Degree, and Program
\newcommand{\theInstitution}{Reykjav\'{\i}k University}%
\newcommand{\theInstitutionAddress}{Menntavegur 1\\102 Reykjav\'{\i}k\\Iceland}
\newcommand{\theInstitutionPhone}{+354-599-6200}
\newcommand{\theInstitutionURL}{www.ru.is}
\newcommand{\theDocumentType}{Dissertation}
\newcommand{\theDegreeAbbrv}{Ph.D.}
\newcommand{\theDegreeLong}{Doctorate}
\newcommand{\theProgram}{\LaTeX{} Magic}
\newcommand{\theECTS}{30}
\newcommand{\theSchool}{School of Awesomeness}
\newcommand{\DocumentInfo}[6]{
\renewcommand{\theDocumentType}{#1}
\renewcommand{\theDegreeAbbrv}{#2}
\renewcommand{\theDegreeLong}{#3}
\renewcommand{\theProgram}{#4}
\renewcommand{\theECTS}{#5}
% ECTS Only applicable on BSc. and MSc.
% Leave blank
\renewcommand{\theSchool}{#6}
}
\newcommand{\theISSN}{XXXX-XXXX}
\newcommand{\bookissn}[1]{\renewcommand{\theISSN}{#1}}
\newcommand{\supervisors@rudissertation}{\item No Advisor}
\newcommand{\Supervisors}[1]{\renewcommand{\supervisors@rudissertation}[1]{#1}}
\newcommand{\supervisorheading@rudissertation}{Supervisor}
\newcommand{\SupervisorHeading}[1]{\renewcommand{\supervisorheading@rudissertation}{#1}}
\newcommand{\examiners@rudissertation}{\item No Examiner}
\newcommand{\Examiners}[1]{\renewcommand{\examiners@rudissertation}[1]{#1}}
\newcommand{\examinerheading@rudissertation}{Examiner}
\newcommand{\ExaminerHeading}[1]{\renewcommand{\examinerheading@rudissertation}{#1}}
\newcommand{\personinfo}[5]{
\item[] #1, #2\\#3, #4, #5 %Stub to be customized later
}
%%%%%%%%%%%%%%%%%%%%%%%% COVER %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\RequirePackage{calc}%arithmetic in commands like lengths
%\RequirePackage{printlen}% display lengths in arbitrary units
@@ -105,7 +142,7 @@
%% ----- PRINTED FRONT COVER ----------------------------------------------------------
%% This cover will be on the outside (not with window)
\newcommand{\printedcover}[2]{%
\newcommand{\printedcover}[1]{%
\pagestyle{empty}\thispagestyle{empty}\SingleSpacing%
\sffamily%
\disableindents\titletextfont\SingleSpacing%
@@ -126,13 +163,39 @@
\vspace*{\baselineskip}%
{\color{rured}\frontcovertitlefont\theDegreeAbbrv{}~\theDocumentType}\par%
\vspace*{\baselineskip}%
\color{rugray}\frontcovertitletextfont\scriptsize#2\par%ISSN
\color{rugray}\frontcovertitletextfont\scriptsize\theISSN\par%ISSN
\end{textblock*}
\rmfamily\quad%need empty text show that it is a page
\enableindents{}
\newpage
%% TODO: isolate font and spacing changes from the rest of the document
}
%% This command makes the back-cover materials
\newcommand{\backcover}{%
\thispagestyle{empty}%
\pagestyle{empty}%
\cleartoevenpage{}% clear to chapter setting
\disableindents%
\quad%ensure page has content
\begin{textblock*}{\textwidth}[0,1](\printcoverlmargin,\paperheight+\trimtop-35mm)%
\titleinfofont\SingleSpacing%
% \vplace[0.8]{
\begin{tabular}{ll}
\rulogo{}&
\begin{minipage}[b]{10cm}%
{\titletextfont\color{rugray}%
\theSchool\par
\theInstitution\par
\theInstitutionAddress\par
\theInstitutionPhone\par
\theInstitutionURL\par
\theISSN\par
}
\end{minipage}\\%
\end{tabular}
\enableindents{}%
\end{textblock*}
}
@@ -307,40 +370,6 @@ in this publication does not imply, even in the absence of a specific statement
%% Allowing ragged bottoms keeps the spacing consistent between paragraphs
%% Alternatively: \setlength{\parskip}{0pt}
%% Information about Institution, Author, Degree, and Program
\newcommand{\theInstitution}{Reykjav\'{\i}k University}%
\newcommand{\theDocumentType}{Dissertation}
\newcommand{\theDegreeAbbrv}{Ph.D.}
\newcommand{\theDegreeLong}{Doctorate}
\newcommand{\theProgram}{\LaTeX{} Magic}
\newcommand{\theECTS}{30}
\newcommand{\theSchool}{School of Awesomeness}
\newcommand{\DocumentInfo}[6]{
\renewcommand{\theDocumentType}{#1}
\renewcommand{\theDegreeAbbrv}{#2}
\renewcommand{\theDegreeLong}{#3}
\renewcommand{\theProgram}{#4}
\renewcommand{\theECTS}{#5}
% ECTS Only applicable on BSc. and MSc.
% Leave blank
\renewcommand{\theSchool}{#6}
}
\newcommand{\supervisors@rudissertation}{\item No Advisor}
\newcommand{\Supervisors}[1]{\renewcommand{\supervisors@rudissertation}[1]{#1}}
\newcommand{\supervisorheading@rudissertation}{Supervisor}
\newcommand{\SupervisorHeading}[1]{\renewcommand{\supervisorheading@rudissertation}{#1}}
\newcommand{\examiners@rudissertation}{\item No Examiner}
\newcommand{\Examiners}[1]{\renewcommand{\examiners@rudissertation}[1]{#1}}
\newcommand{\examinerheading@rudissertation}{Examiner}
\newcommand{\ExaminerHeading}[1]{\renewcommand{\examinerheading@rudissertation}{#1}}
\newcommand{\personinfo}[5]{
\item[] #1, #2\\#3, #4, #5 %Stub to be customized later
}
%% Clean up some formatting for the text
\renewcommand{\thepage}{\roman{page}}