|
|
|
|
@@ -13,15 +13,14 @@
|
|
|
|
|
\newcommand{\TIheadofgrad}{TBA}
|
|
|
|
|
\newcommand{\TItvdadmin}{Sigrún Þorgeirsdóttir~\formatemail{sigrunth}}
|
|
|
|
|
|
|
|
|
|
%% setup development environment
|
|
|
|
|
%% Template Developers
|
|
|
|
|
%% Warning: overleaf only accepts branch Master
|
|
|
|
|
% 1. git clone <overleaf repo>
|
|
|
|
|
% 2. git remote add gitea <gitea repo>
|
|
|
|
|
% 3. git checkout -b gitea --track gitea/master
|
|
|
|
|
% 4. <DO SOME WORK>
|
|
|
|
|
% 5. <COMMIT AND PUSH TO GITEA>
|
|
|
|
|
% 6. git checkout master
|
|
|
|
|
% 7. git merge gitea
|
|
|
|
|
% 6. git push origin
|
|
|
|
|
% 7. git push gitea
|
|
|
|
|
|
|
|
|
|
% \begin{document} % this tells the compiler that it is time to make
|
|
|
|
|
% % text to print instead of just getting ready.
|
|
|
|
|
@@ -46,7 +45,7 @@ If you are writing a PhD dissertation, you will want to edit \path{main-disserta
|
|
|
|
|
\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 [Current maintainer:] Joseph Timothy Foley.
|
|
|
|
|
His email is his last name AT \textt{ru.is}
|
|
|
|
|
His email is his last name AT \texttt{ru.is}
|
|
|
|
|
\end{description}
|
|
|
|
|
|
|
|
|
|
\section{Frequently Asked Questions}
|
|
|
|
|
@@ -175,45 +174,33 @@ Some information is at the top of \path{main.tex} file, this file is for a gener
|
|
|
|
|
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.}.
|
|
|
|
|
|
|
|
|
|
\item Get a LaTeX installation. We recommend TeXlive \url{https://www.tug.org/texlive/}
|
|
|
|
|
\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.
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
Under linux this is the ``texlive'' package.
|
|
|
|
|
Under Mac/OSX this is the ``MacTeX'' distribution.
|
|
|
|
|
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,eepic,gitinfo2,fixme,makeglos,nomencl,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
|
|
|
|
|
\end{lstlisting}
|
|
|
|
|
|
|
|
|
|
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{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}
|
|
|
|
|
\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
|
|
|
|
|
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
|
|
|
|
|
Many people like TeXStudio \url{http://texstudio.sourceforge.net/}.
|
|
|
|
|
Some other code editors and IDEs may include LaTeX support.
|
|
|
|
|
If you want to learn a very powerful (but old-fashioned) editor, consider GNU Emacs: \url{http://www.gnu.org/software/emacs/}.
|
|
|
|
|
Of note, the author used Emacs to write this template.
|
|
|
|
|
|
|
|
|
|
\item Get a references manager (recommended, but not required)\label{list:refmanager}
|
|
|
|
|
\url{http://jabref.sourceforge.net/} (You may have to install a Java JRE first.)
|
|
|
|
|
@@ -226,14 +213,13 @@ framed,boondox,printlen}
|
|
|
|
|
\url{http://www.activestate.com/activeperl}
|
|
|
|
|
|
|
|
|
|
\item Get supporting programs for some tools.
|
|
|
|
|
For glossaries under windows, you will need to install Perl
|
|
|
|
|
For glossaries under Windows, you will need to install Perl
|
|
|
|
|
\url{http://strawberryperl.com/}
|
|
|
|
|
(it is already installed on the other platforms.)
|
|
|
|
|
|
|
|
|
|
\item Try building the \path{main.tex} file. If you get errors, there
|
|
|
|
|
\item Try building the \path{main.tex} file with lualatex. If you get errors, there
|
|
|
|
|
is something wrong with your LaTeX installation. Fix those first.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
\item Rename the \path{main.tex} file with your information (optional).
|
|
|
|
|
DEGREE-NAME-YEAR is the recommended scheme
|
|
|
|
|
e.g. \path{msc-foley-2025.tex}.
|
|
|
|
|
@@ -247,19 +233,17 @@ framed,boondox,printlen}
|
|
|
|
|
|
|
|
|
|
\item Start editing all of the \path{.tex} files with your content.
|
|
|
|
|
|
|
|
|
|
\item Compile the document by running lualatex on the Main file, run the bibliography tool, then view the result.
|
|
|
|
|
\item Compile the document by running lualatex on the Main file, run \path{biber}, then view the result.
|
|
|
|
|
|
|
|
|
|
\item When you print, make sure that the scale is 100\%.
|
|
|
|
|
If you allow it to resize when printing, the margins won't be right.
|
|
|
|
|
If the margins aren't right, then the RU logo will not look right on the
|
|
|
|
|
cover.
|
|
|
|
|
|
|
|
|
|
\end{enumerate}
|
|
|
|
|
|
|
|
|
|
\subsection{Important Details}
|
|
|
|
|
|
|
|
|
|
\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.
|
|
|
|
|
\item Make absolutely sure that your \path{references.bib} is in UTF-8. If it is another format (CP1251, EBDIC) 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.
|
|
|
|
|
@@ -268,12 +252,12 @@ framed,boondox,printlen}
|
|
|
|
|
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.
|
|
|
|
|
\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.
|
|
|
|
|
Preferably just use the 26 English letters, 10 numbers, dash ``-'', and underscore ``\_'' to avoid filename issues.
|
|
|
|
|
Windows doesn't care (but some programs in Windows do).
|
|
|
|
|
OSX sometimes cares.
|
|
|
|
|
Linux always cares.
|
|
|
|
|
\item \LaTeX{} generates a bunch of temporary files that you don't want to put into version control.
|
|
|
|
|
Look at Appendix~\label{src:gitignore-example} for a list of extensions.
|
|
|
|
|
Look at Appendix~\ref{src:gitignore-example} for a list of extensions.
|
|
|
|
|
\end{itemize}
|
|
|
|
|
|
|
|
|
|
\section{Department of Engineering Information}
|
|
|
|
|
|
