Final changes for public release

LICENSE.md

@@ -1,23 +1,38 @@
 # License of Template and Guide
 
-The PSIThesis.cls class file is made available under LPPL v1.3c
-(http://www.latex-project.org/lppl).
+We have chosen a license that  allows you to use the template 
+for your thesis and make changes as needed. You are *not* 
+required to publish your thesis or its source code under the 
+same license. If you fork the template or the guide, however, 
+you have to comply with the following licensing restrictions.
+
+This guide and the template are made available
+under the Creative Commons license CC BY-SA 4.0 (http://creativecommons.org/licenses/by-sa/4.0/)
+with two exceptions:
 
-All other TeX source code, the supplementary material, and the content
-of the guide are made available under the Creative Commons License
-CC BY-SA 4.0 (http://creativecommons.org/licenses/by-sa/4.0/) with
-the following two exceptions:
+  - Some excerpts, figures, and tables in Chapter 2 and 
+    Appendix B have been taken from the literature. The
+    respective elements are explicitly marked with a citation 
+    and a note regarding the permission to re-use. They are not
+    covered by the CC license. Permission to re-use and 
+    distribute these figures, tables, and excerpts must be 
+    obtained from the respective copyright holders.
 
-  - Some excerpts, figures, and tables in Chapter 2 and Appendix B of
-    the guide have been taken from the literature. These contents are
-    marked with a citation in the caption and are not covered by the
-    CC License. Permission to re-use and distribute these figures,
-    tables, and excerpts must be obtained from the respective copyright
-    holders.
-
   - Parts of Chapter 1 and Appendix C contain content from the
-    MastersDoctoralThesis template mentioned above, which is licensed
-    under CC BY-SA 3.0 (http://creativecommons.org/licenses/by-nc-sa/3.0/).
-    The original content has been written by Sunil Patel
-    (http://www.sunilpatel.co.uk) and Vel (http://www.LaTeXTemplates.com).
+    MastersDoctoralThesis template, which is licensed under 
+    CC BY-SA 3.0. The original content has been written by
+    Sunil Patel (www.sunilpatel.co.uk) and Vel 
+    (LaTeXTemplates.com).
+
+As this guide contains copyrighted material from third parties, 
+you cannot host your own copy of this guide online. Please use 
+the URLs printed on the title page of the Guide to link to it.
+
+The files PSIThesis.cls, setup.tex, and titlepage.tex
+are made available under the LPPL v1.3c 
+(http://www.latex-project.org/lppl).
 
+The fonts that are included in this template in the fonts 
+directory are licensed under the Apache License 2.0 (Roboto 
+sans-serif font) and the SIL OFL Version 1.1 (Iosevka monospace 
+font).

README.md

@@ -3,19 +3,29 @@
 This repository contains a LaTeX template and a guide for writing a thesis.
 For now, there is only an English version of this template.
 
-Read Chapters 1 and 2 in the file guide.pdf for instructions on using this
-template.
+Read Chapters 1 and 2 in the Guide for instructions on using the
+template. The Guide contains a lot of concrete recommendations that may
+help you write a compelling scientific thesis. A particular focus is
+on the topic of designing useful figures and tables.
 
-This template has been created mainly for students who want to submit a
+The template has been created mainly for students who want to submit a
 high-quality thesis to the Chair of Privacy and Security in Information
 Systems (PSI) at University of Bamberg (https://www.uni-bamberg.de/psi/).
-The design of the template and the recommendations in this guide reflect,
-at least to some degree, the personal taste of members of the chair. If
-you submit a thesis to PSI, you can use the template without any changes.
+The template can also be used for seminar reports and PhD dissertations.
 
-The template and the guide are, however, available under an open license
-(cf. Chapter 1 in guide.pdf and LICENSE.md). If you want to use the
-template for a thesis submitted at a different department or organization, feel free to make changes at your discretion.
+The PSIThesis template and the guide reflect, at least to some degree, the
+personal taste of members of the chair. We encourage our students to use
+the template without any changes. If you \emph{do} have a different opinion
+on a particular aspect of the template or the guide, we will be happy to hear
+you out.
+
+The template and the guide are available under an open license (CC BY SA 4.0). 
+If you want to use the template for a thesis submitted at a different 
+department or organization, feel free to make changes at your discretion.
+Redistribution of the guide and the template is subject to the license (see
+details explained in LICENSE.md and the Guide).
+
+If you wish to contribute to the template or the guide, you may create an Issue or a Pull Request in the GitHub repository.
 
 The PSIThesis template consists of a document class (PSIThesis.cls) and
 additional TeX files. The template is based on the MastersDoctoralThesis

degree-thesis/en/PSIThesis.cls

@@ -1,7 +1,7 @@
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 % 
 % PSI Chair Thesis Template
-% Version 2019-12
+% Version 2020-08
 % 
 % based on MastersDoctoralThesis.cls
 % Version 1.6 (27/8/17)
@@ -14,7 +14,7 @@
 % Johannes Böttcher
 %
 % Changes for PSI Chair @ University of Bamberg by
-% Dominik Herrmann
+% Dominik Herrmann and Fabian Lamprecht
 % - Simplified Layout of Abstract page
 % - Changed Caption Setup
 %

degree-thesis/en/appendices/appendixA.tex

@@ -43,7 +43,7 @@ \subsection{Conclusion Chapter}
 
 \section{Thesis Length}
 
-Typical theses range from 25 to 100 pages. Do not worry too much about the page count. Write everything that is necessary to assess and reproduce your work, but no more. Less is more!
+Typical theses range from 25 to 150 pages. There have been excellent theses at both ends of this spectrum. Do not worry too much about the page count. Write everything that is necessary to assess and reproduce your work, but no more. Less is more!
 
 Check the individual parts for an appropriate length: Do not write five pages in the introduction if the main part has only 15 pages.
 

degree-thesis/en/appendices/appendixC.tex

@@ -58,6 +58,8 @@ \section{Contributors and History}
 \section{License}
 \label{sec:license}
 
+We have chosen a license that  allows you to use the template for your thesis and make changes as needed. You are \emph{not} required to publish your thesis or its source code under the same license. If you fork the template or the guide, however, you have to comply with the following licensing restrictions.
+
 This guide and the template are made available under the Creative Commons license 
 CC BY-SA 4.0 (\url{http://creativecommons.org/licenses/by-sa/4.0/}) with two exceptions:
 
@@ -77,7 +79,7 @@ \section{License}
 Vel (\href{http://www.LaTeXTemplates.com}{LaTeXTemplates.com}).
 \end{enumerate}
 
-As the guide contains copyrighted material, you should not host your own copy of this guide online.
+As this guide contains copyrighted material from third parties, you cannot host your own copy of this guide online. Please use the URLs printed on the title page to link to this document.
 
 The files \texttt{PSIThesis.cls}, \texttt{setup.tex}, and \texttt{titlepage.tex} are made available under
 the LPPL v1.3c (\url{http://www.latex-project.org/lppl}).

degree-thesis/en/chapters/chapter1.tex

@@ -8,19 +8,20 @@ \chapter{The PSIThesis Template} % Main chapter title
 
 The remainder of this document presents conventions and recommendations that will help you create a coherent and visually appealing thesis. \Cref{Chapter2} explains the most critical aspects of scientific writing, including citations, URLs, tables, figures, typography, and layout.
 
-Additional advice, which our students found useful in the past, follows in \Cref{appendixa}. Advice on designing compelling figures and tables follows in \Cref{appendixb}. Less-often needed details about the template, its history, and licensing details conclude this guide in \Cref{appendixc}.
+Additional advice, which our students found useful in the past, follows in \Cref{appendixa}. Advice on designing compelling figures and tables follows in \Cref{appendixb}. Less-often needed details about the template, its history, and licensing details can be found in \Cref{appendixc}.
 
 \section{A Quick Welcome}
 
 Welcome to this LaTeX thesis template guide.%
 \sidenote{It is based on the guide of the \emph{MastersDoctoralThesis} template. The original text has been revised and extended. \emph{MastersDoctoralThesis} is available at \url{https://www.latextemplates.com/template/masters-doctoral-thesis}.}
-This template has been created mainly for students who want to submit a high-quality thesis to the \emph{Chair of Privacy and Security in Information Systems} at the University of Bamberg (\url{https://www.uni-bamberg.de/psi/}).
-Template and enclosed guide reflect, at least to some degree, the personal taste of members of the chair.
+The PSIThesis template has been created mainly for students who want to submit a high-quality Bachelor's or Master's thesis to the \emph{Chair of Privacy and Security in Information Systems} at the University of Bamberg (\url{https://www.uni-bamberg.de/psi/}). The template can also be used for seminar reports and PhD dissertations.
+
+The PSITemplate and this thesis guide reflect, at least to some degree, the personal taste of members of the chair.
 We encourage our students to use the template without any changes.\sidenote{If you \emph{do} have a different opinion on a particular aspect of the template or the guide, we will be happy to hear you out.}
 
-The template and the guide are, however, available under an open license (cf. Sect.~\ref{sec:license}). If you want to use the template for a thesis submitted at a different department or organization, feel free to make changes at your discretion.\sidenote{Redistribution of this guide and the template is subject to the details outlined in Sect.~\ref{sec:license}.}
+The template and the guide are available under an open license (cf. Sect.~\ref{sec:license}). If you want to use the template for a thesis submitted at a different department or organization, feel free to make changes at your discretion.\sidenote{Redistribution of this guide and the template is subject to the details outlined in Sect.~\ref{sec:license}.}
 
-If you wish to contribute to the template or the guide, you may also create an Issue or a Pull Request in the public GitHub repository at \url{https://github.com/UBA-PSI/psi-thesis-guide}.
+If you wish to contribute to the template or the guide, you may create an Issue or a Pull Request in the public GitHub repository at \url{\githuburl}.
 
 \section{Learning LaTeX}
 
@@ -35,14 +36,14 @@ \section{Learning LaTeX}
 
 \subsection{Introduction to LaTeX}
 
-If you are new to LaTeX, there is an excellent eBook, \enquote{The Not So Short Introduction to LaTeX} (aka ``lshort''), which is freely available online.\marginnote{\url{http://www.ctan.org/tex-archive/info/lshort/english/lshort.pdf}.}
+If you are new to LaTeX, there is an excellent eBook, \enquote{The Not So Short Introduction to LaTeX} (aka ``lshort''), which is freely available online.\sidenote{\url{http://www.ctan.org/tex-archive/info/lshort/english/lshort.pdf}.}
 
 To learn how LaTeX works, we recommend creating small test documents to reduce complexity. You can also learn from others by looking at other templates.
 
 \paragraph{A Short Math Guide for LaTeX}
 
 If you are writing a technical or mathematical thesis, you may want to read \enquote{A Short Math Guide for LaTeX}.\sidenote{Find it under the \enquote{Additional Documentation} section towards the bottom of the page at \url{http://www.ams.org/tex/amslatex.html}.}
-LaTeX supports many mathematical symbols, and it would take a great effort to memorize the commands for all of them. Sunil Patel's website shows the most common ones.\marginnote{%
+LaTeX supports many mathematical symbols, and it would take a great effort to memorize the commands for all of them. Sunil Patel's website shows the most common ones.\sidenote{%
 \url{http://www.sunilpatel.co.uk/latex-type/latex-math-symbols/}}
 You can use Sunil's page as a reference or crib sheet. The symbols are rendered as large, high-quality images, so you can quickly find the LaTeX command for the symbol you need.
 
@@ -59,8 +60,8 @@ \section{Required Software}
 \label{sec:requirements}
 
 To use the PSIThesis template, you need a working LaTeX installation with \textbf{LuaLaTeX}, \textbf{biblatex}, and \textbf{biber}.%
-\sidenote{We have compiled this guide with TeX Live 2019 (LuaLaTeX 1.10.0, biber 2.14).}
-Usually, these tools are available in a typical LaTeX installation. We have tested the template with TeX Live 2019 in July~2020.
+\sidenote{We have compiled this guide with TeX Live 2019 (LuaLaTeX 1.10.0, biber 2.14), which was installed in January~2020.}
+Usually, these tools are available in a typical LaTeX installation. We have tested the template with TeX Live 2019. We recommend to perform a \textbf{full installation} to ensure that all required LaTeX packages are available right away.
 
 Use a current version of TeX Live that is available at \url{https://www.tug.org/texlive/}. Note that the TeX Live version packaged by major Linux distributions, such as Debian Linux, may contain an outdated version of lualatex.
 
@@ -155,7 +156,7 @@ \subsection{Compiling the PDF}
 Otherwise, \code{make} may refuse to compile a new version because it believes that \file{main.pdf} is already up to date. In this case, a call to \code{make clean} will help: It removes all files generated during compilation. After that, a call to \code{make} will regenerate them, including \file{main.pdf}.
 
 
-We haven't prepared the template to be used with the convenient LaTeX editor \textsc{LyX}.\marginnote{\url{https://www.lyx.org}} LyX hides the LaTeX code from authors and offers a user interface that resembles a word processor.
+We haven't prepared the template to be used with the convenient LaTeX editor \textsc{LyX}.\sidenote{\url{https://www.lyx.org}} LyX hides the LaTeX code from authors and offers a user interface that resembles a word processor.
 If LaTeX code puts you off, check out LyX and start writing there. Eventually, you can still export the LaTeX source code and copy and paste it into the PSIThesis template. Be sure to reserve some days to debug compatibility issues.
 
 \subsection{Filling in Your Information in \emph{main.tex}}\label{sec:fillingdetails}

degree-thesis/en/main.tex

@@ -1,7 +1,7 @@
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %
 % PSI Chair Thesis Template
-% Version 2020-01
+% Version 20200807
 %
 % based on MastersDoctoralThesis.cls
 % Version 2.5 (27/8/17)
@@ -55,6 +55,12 @@
 %final, % Uncomment to hide all todo notes
 ]{PSIThesis} % The class file specifying the document structure
 
+% version of the guide
+\def\tversion{v20200807}
+
+% long-term stable URL to the thesis guide
+\def\doiurl{https://doi.org/10.20378/irb-48428}
+\def\githuburl{https://github.com/UBA-PSI/psi-thesis-guide}
 
 \input{misc/setup.tex} % Load the settings from Misc/setup.tex
 \input{misc/commands.tex} % Load the custom commands from Misc/commands.tex
@@ -73,7 +79,7 @@
 
 %%% CHANGE THIS:
 % Your thesis title, this is used in the title and abstract, print it elsewhere with \ttitle
-\thesistitle{Guidelines for Writing a High-Quality Thesis with the PSITemplate}
+\thesistitle{Guidelines for Writing a High-Quality Thesis with the PSIThesis Template}
 
 % date to be printed on the title, this will automatically update and be in the correct format
 % If any changes to this format (Month JJJJ) are necessary the definition can be found in line 337

degree-thesis/en/misc/titlepage.tex

@@ -82,6 +82,18 @@
 
 {\large \tdate} % Date
 
+% TODO remove the following lines when you write a thesis
+\vspace{0.25ex}
+
+{\small \tversion}
+
+\vspace{0.25ex}
+
+{\small Links to this document:}\\
+{\small \url{\doiurl}}\\
+{\small \url{\githuburl}}
+% Remove lines up to this line
+
 \vfill
 \end{center}