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

Restructured instructions a bit and cleaned up the gitignore reference

Browse Source
This commit is contained in:
Joseph Timothy Foley
2025-10-17 15:13:47 +00:00
parent 46572adf66
commit 1d5cd98676
2 changed files with 37 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
code.tex
View File

@@ -68,6 +68,10 @@ anything.
} }
%% I have put the source code in the \directory{src/} folder. %% I have put the source code in the \directory{src/} folder.
\lstinputlisting[language={bash}, firstline=1,
caption={File extensions to ignore of LaTeX temporary files},
label={src:gitignore-example}]{src/gitignore-example}
\lstinputlisting[language=Java, firstline=1, \lstinputlisting[language=Java, firstline=1,
lastline=40, caption={Data\_Bus.java: Setting up the class.}, lastline=40, caption={Data\_Bus.java: Setting up the class.},
label={src:Data_Bus.java}]{src/Data_Bus.java} label={src:Data_Bus.java}]{src/Data_Bus.java}
@@ -76,6 +80,8 @@ label={src:Data_Bus.java}]{src/Data_Bus.java}
caption={AndroidManifest.xml: Configuration for the Android UI.}, caption={AndroidManifest.xml: Configuration for the Android UI.},
label={src:AndroidManifest.xml}]{src/AndroidManifest.xml} label={src:AndroidManifest.xml}]{src/AndroidManifest.xml}
%% TODO: fix wrapping from custom.sty %% TODO: fix wrapping from custom.sty
%%% Local Variables: %%% Local Variables:

29
instructions.tex
View File

@@ -39,17 +39,17 @@ 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. 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.} {\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. We also have discovered that Overleaf's LiveTex 2025 does not work with StiX2 so you should use the 2024 version.
If you are writing a PhD dissertation, you will want to edit \path{main-dissertation.tex} rather than \path{main.tex} If you are writing a PhD dissertation, you will want to edit \path{main-dissertation.tex} rather than \path{main.tex}
\begin{description} \begin{description}
\item [Overleaf Template:] \url{https://www.overleaf.com/latex/templates/reykjavik-university-project-report-and-thesis-template/fcwvcgnstrjs} \item [Overleaf Template:] \url{https://www.overleaf.com/latex/templates/reykjavik-university-project-report-and-thesis-template/fcwvcgnstrjs}
\item [Actively developed code:] \url{https://gitea.cs.ru.is/foley/ru-thesis} \item [Actively developed code:] \url{https://gitea.cs.ru.is/foley/ru-thesis}
\item Current maintainer: Joseph Timothy Foley. \item [Current maintainer:] Joseph Timothy Foley.
Questions, comments, complaints should be submitted at \url{https://github.com/foleyj2/ru-thesis/issues} His email is his last name AT \textt{ru.is}
\end{description} \end{description}
\subsection{Frequently Asked Questions} \section{Frequently Asked Questions}
\begin{itemize} \begin{itemize}
\item {\em Why isn't there the RU logo on the front of the template on Overleaf/Git?} \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. The official cover for these documents is generated by the Reykjavik University department.
@@ -107,6 +107,7 @@ If you are writing a PhD dissertation, you will want to edit \path{main-disserta
Reykjavik University's communications department insists on a common outer appearance of official printed documentation, which includes Doctoral Dissertations. 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 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. 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.}. 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. This class supports the RU Communication's desire for the common appearance through the \texttt{rucover} package.
@@ -125,11 +126,15 @@ You can control the filename with \verb|\usepackage[filename=name.pdf]{rucover}|
%graduation date %graduation date
\end{itemize} \end{itemize}
\section{Signatures} \section{Limited Access}
If you are making a print copy, you may need a signature page. 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.
\section{Printing and Binding}
If you are making a print copy to be bound into a book, you may need a signature page.
This is no longer required for most electronic submissions except perhaps PhD. 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. 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. 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 varies significantly. Traditionally, the student prints out and binds a copy for each advisor and examiner: this varies significantly.
@@ -162,7 +167,7 @@ The general submission sequence is:
\section{LaTeX Template Instructions} \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. Some information is at the top of \path{main.tex} file, this file is for a general overview and common problems.
\subsection{Getting started:} \subsection{Preparation}
\begin{enumerate} \begin{enumerate}
\item Find a safe place to work on your thesis document. \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. The author recommends Git on Overleaf, but anywhere data is backed up is a appropriate.
@@ -267,9 +272,8 @@ TexMaker and TeXStudio require a configuration change to do this.
Windows doesn't care (but some programs in Windows do). Windows doesn't care (but some programs in Windows do).
OSX sometimes cares. OSX sometimes cares.
Linux always cares. Linux always cares.
\item When using this template with SVN, you will want to tell it to ignore the extensions listed in Appendix~\ref{appendix:latex-gen}
\item \LaTeX{} generates a bunch of temporary files that you don't want to put into version control. \item \LaTeX{} generates a bunch of temporary files that you don't want to put into version control.
Look at \path{src/gitignore-example} for a list of extensions. Look at Appendix~\label{src:gitignore-example} for a list of extensions.
\end{itemize} \end{itemize}
\section{Department of Engineering Information} \section{Department of Engineering Information}
@@ -389,9 +393,10 @@ Lýsinging þarf ekki að eiga við verkefnið í öllum atriðum til að verkef
Frammistaða nemanda í vörninni sæmileg eða slök. Frammistaða nemanda í vörninni sæmileg eða slök.
\end{description} \end{description}
\section{PhD Special Instructions} \section{Doctorate Special Instructions}
Final Preparation for PhD Dissertations:\footnote{Always refer to the website in case details have changed} Final Preparation for PhD Dissertations:\footnote{Always refer to the website in case details have changed}
\begin{enumerate} \begin{enumerate}
\item Use \path{main-dissertation.tex} not \path{main.tex}!
\item Send PDF to Administrative person \TItvdadmin{} \item Send PDF to Administrative person \TItvdadmin{}
% \item Get signature pages signed, and scan them into PDF % \item Get signature pages signed, and scan them into PDF
\item Talk to one of the printing companies in Iceland and ask if they can do a B4 booklet with a printed cover. \item Talk to one of the printing companies in Iceland and ask if they can do a B4 booklet with a printed cover.
@@ -399,7 +404,7 @@ Final Preparation for PhD Dissertations:\footnote{Always refer to the website in
\item Make clear which elements are the outside cover and which are the inside contents. \item Make clear which elements are the outside cover and which are the inside contents.
\textbf{You want to make sure they don't print a copy of the cover inside the book.} \textbf{You want to make sure they don't print a copy of the cover inside the book.}
\item They will insert your signature pages into the PDF and start the printing process; \item They will insert your signature pages into the PDF and start the printing process;
The paper you want is archival-quality acid-free 240$\times$\SI{170}{\milli\meter} (aka B5, Programme, or Book Economy). The paper you want is archival-quality acid-free 240$\times$\SI{170}{\milli\meter} (aka B5, Programme, or Book Economy.
\item If you can, get a proof of the print to check that the layout is correct and the quality is acceptable, particularly any figures. \item If you can, get a proof of the print to check that the layout is correct and the quality is acceptable, particularly any figures.
\item If is acceptable, then get them to print out the required number of copies. \item If is acceptable, then get them to print out the required number of copies.
\item Finally bring the copies to head of graduate studies(\TIheadofgrad{}), who should forward them as appropriate. \item Finally bring the copies to head of graduate studies(\TIheadofgrad{}), who should forward them as appropriate.