Skip to content
Snippets Groups Projects
instructions_english.tex 4.76 KiB
Newer Older
Heikki Ahonen's avatar
Heikki Ahonen committed

\appendix{Instructions for LaTex}
Heikki Ahonen's avatar
Heikki Ahonen committed

\section{General Setup}
Heikki Ahonen's avatar
Heikki Ahonen committed

In the HY-CS-main.tex file you will find the following STEPS 0--5. Below you can find related instructions.
Heikki Ahonen's avatar
Heikki Ahonen committed
\vspace{0.5cm}

\textbf{STEP 0 -- Access the thesis template}
Heikki Ahonen's avatar
Heikki Ahonen committed

\begin{itemize}
\item Import the thesis template into a new Overleaf project.
\item The easiest way to do it is to:
\begin{itemize}
    \item Obtain a zip file of the LaTeX template from the webpage of your programme.
    \item Go to \url{https://www.overleaf.com/edu/helsinki} and login to Overleaf with your university credentials.
    \item Go to the list of your projects at \url{https://www.overleaf.com/project}, click ``New Project'' and ``Upload Project''.,  the projects under your account 
    \item Then upload the zip with the template.
    \item You are now ready to write your thesis in Overleaf by editing the template.
\end{itemize}
Heikki Ahonen's avatar
Heikki Ahonen committed
\end{itemize}


{\textbf{STEP 1 -- BSc or MSc thesis?}}
\begin{enumerate}
\item Select whether your are writing BSc (tkt) or MSc (csm for CS, dsm for data science) thesis.
Heikki Ahonen's avatar
Heikki Ahonen committed
\item Select your language: finnish, english, or swedish.
\item If you are writing MSc select your line / track.
\end{enumerate}


{\textbf{STEP 2 -- Set up your personal information}}

\begin{enumerate}
\item Specify the title of your thesis with \texttt{\textbackslash title\{\}}.
\item Specify your name to the author field with \texttt{\textbackslash author\{\}}.
\item Specify the names of your supervisors of the thesis with \texttt{\textbackslash supervisors\{\}}.
\item Specify the keywords of the thesis with \texttt{\textbackslash keywords\{\}}.
\item Specify the ACM classification terms of the thesis with \texttt{\textbackslash classification\{\}}. See \url{https://dl.acm.org/ccs} for more information.
Heikki Ahonen's avatar
Heikki Ahonen committed
\end{enumerate}

{\textbf{STEP 3 -- Write your abstract}}
Heikki Ahonen's avatar
Heikki Ahonen committed

\begin{itemize}
\item You can have the abstract in multiple languages with the \texttt{otherlanguages} environment. The example below shows how to provide an english abstract: 
Heikki Ahonen's avatar
Heikki Ahonen committed

\begin{verbatim}
\begin{otherlanguage}{english} 
\begin{abstract}
Your abstract text goes here. 
\end{abstract} 
\end{otherlanguage}
\end{verbatim}

\end{itemize}

{\textbf{STEP 4 -- Writing your thesis}}

\begin{enumerate}
\item There are some minimal contents and instructions in the [bsc/msc]\_[finnish/english]\_contents.tex files.
\item You can delete the contents of the [bsc/msc]\_[finnish/english]\_contents.tex file and write your thesis inside that file.
\item Remove this appendix from your thesis.
Heikki Ahonen's avatar
Heikki Ahonen committed
\end{enumerate}

{\textbf{STEP 5 -- Set your bibliography style}}

\begin{itemize}
\item The default is Numbering alphabetic order, which should be used in most cases.
\end{itemize}

\section{Bibliography in Latex}

The bibliography is defined in a separate .bib-file. For this template, it is named \texttt{bibliography.bib} and includes the following content:
\begin{verbatim}
@article{einstein,
    author =       "Albert Einstein",
    title =        "{Zur Elektrodynamik bewegter K{\"o}rper}. ({German})
        [{On} the electrodynamics of moving bodies]",
    journal =      "Annalen der Physik",
    volume =       "322",
    number =       "10",
    pages =        "891--921",
    year =         "1905",
    DOI =          "http://dx.doi.org/10.1002/andp.19053221004"
}
 
@book{latexcompanion,
    author    = "Michel Goossens and Frank Mittelbach and Alexander Samarin",
    title     = "The \LaTeX\ Companion",
    year      = "1993",
    publisher = "Addison-Wesley",
    address   = "Reading, Massachusetts"
}
 
@misc{knuthwebsite,
    author    = "Donald Knuth",
    title     = "Knuth: Computers and Typesetting",
    url       = "http://www-cs-faculty.stanford.edu/%7Eknuth/abcde.html"
}
\end{verbatim}

In the last reference url field the code \verb+%7E+ will translate into \verb+~+ once clicked in the final pdf.

References are created using command \texttt{\textbackslash cite\{einstein\}}, showing as \citep{einstein}. Other examples: \citep{latexcompanion,knuthwebsite}.

For the style of bibliography and citations, see some options in \url{https://www.overleaf.com/learn/latex/Bibtex_bibliography_styles}.


\section{Producing the thesis pdf}

This template has been prepared in LaTeX for usage with Overleaf. If your LaTeX source files contain no errors, then Overleaf produces the pdf file automatically.

You are allowed to use the LaTeX template and write your thesis in other systems, but make sure you know how to produce the pdf file there. 
For example, in Linux, you typically need to execute the commands \texttt{pdflatex mainfile.tex} and \texttt{biber mainfile.tex} repeatedly until no more warnings are shown. This process can be automised using make-command. 
Note that normally we would be using \texttt{bibtex} command instead of \texttt{biber} but because of the biblatex package \texttt{biber} should be used.