...
 
Commits (2)
......@@ -61,7 +61,7 @@
% true: document in styleguide mode
% false: dissertation or thesis mode
\setboolean{isSG}{false}
\newcommand{\version}{3.0}
\newcommand{\version}{3.0.1}
\ifthenelse{\boolean{isSG}}{\setboolean{isDiss}{true}}{}
% Subtitle English
\newcommand{\myengsubtitle}{Thesis in partial fulfillment of the requirements for the degree \\ \ifthenelse{\boolean{isMT}}{Master}{Bachelor} of Science (\ifthenelse{\boolean{isMT}}{M.Sc.}{B.Sc.})}
......
......@@ -326,12 +326,13 @@ The following sections introduce a few extra features. None of them are necessar
Dissertations are stored as PDF/A at the university library. To ensure compatibility of this template with PDF/A, the \verb+pdfx+\index{Packages!pdfx@\verb+pdfx+} package is used with the option \verb+a-2b+. The compiled PDF was successfully validated with Callas\footnote{\url{https://conversion.ub.tu-berlin.de/}, December 2018}, as recommended by the university library\footnote{\url{https://www.ub.tu-berlin.de/fileadmin/pdf/Verlag/UV_pdfaDE.pdf}, December 2018 \label{fn:PDFA}}. Note that contrary to the descriptions given in the linked document in \autoref{fn:PDFA}, a specific color profile is \emph{not} necessary if you use an up-to-date version of the \verb+pdfx+\index{Packages!pdfx@\verb+pdfx+} package as it automatically includes a free color profile. Check the documentation of the \verb+pdfx+\index{Packages!pdfx@\verb+pdfx+} package to find how to include other color profiles. Normally, the default should however suffice. The \verb+pdfx+\index{Packages!pdfx@\verb+pdfx+} package also loads the \verb+hyperref+\index{Packages!hyperref@\verb+hyperref+} package. \textbf{Note that the \texttt{pdfx} package cannot ensure that all your included PDFs fulfill the PDF/A standard. Hence, check your PDF for PDF/A compatibility whenever you included external files.}
\subsection{Support for Overleaf or other online editors}\label{subsec:overleaf}
This template is compatible with Overleaf\footnote{\url{https://de.overleaf.com/}, January 2019}, an online editor for \LaTeX\ documents. If you would like to write in such an online environment, upload the content of the subfolder \verb+LaTeX_template_thesis+ to an empty project and compile it online. This way, you do not have to install any \LaTeX\ distribution locally. \textbf{Note that this is not advised if you have sensitive data, for example from a company. In this case, your data should remain on your or your company's computer!}
\textbf{Attention:} Overleaf still runs \TeX Live 2018. Therefore, it is incompatible with the current syntax of the \verb+acro+\index{Packages!acro@\verb+acro+} package in up-to-date distributions of \TeX Live! Please use v2.3.4 of this template on Overleaf\footnote{\url{https://gitlab.tubit.tu-berlin.de/dbta/Thesis_template/commit/693cd819f62cc90d2dca166e7b927e4de4f4f759}} or manually upload a current version of this package into your Overleaf project.
\subsection{Automatic Indenting of .tex Files}\label{subsec:automatic_indenting_latexindent}
Indenting \emph{can} be used for structuring one's document, e.g.~by indenting everything within an \verb+equation+ environment, but is certainly \emph{not} a must-have for a thesis. If you do not need automatic indenting, you can skip this section.\\
Unfortunately, \LaTeX\ does not offer automatic indenting as do, for example, Matlab or Python. However, the perl script-based \verb+latexindent+\index{Scripts!latexindent@\verb+latexindent+}\footnote{\url{https://github.com/cmhughes/latexindent.pl}, February 2019} can be used for automatic indenting of the source code. This executable is part of every \LaTeX\ distribution. There are two ways of using \verb+latexindent+\index{Scripts!latexindent@\verb+latexindent+}: directly running \verb+latexindent+\index{Scripts!latexindent@\verb+latexindent+} or calling it via \verb+arara+\index{Scripts!arara@\verb+arara+}\footnote{\url{https://tex.stackexchange.com/questions/126241/autoindent-in-texmaker}, January 2019}. The arara\index{Scripts!arara@\verb+arara+} software is also part of every \LaTeX\ distribution and can be used for \TeX\ automation.\footnote{\url{https://github.com/cereda/arara}, February 2019} The first option is described here for a Windows operating system (the instructions for Linux and Mac should be similar; only the file extension .exe is propably different). With this option, it is only possible to indent one file at a time (the file that is currently open in Texmaker). The second option can automatically indent all files in the document and is described in \autoref{ch:automatic_indenting_arara}.\\
To get automatic indenting, add a user command in Texmaker (User $\rightarrow$ User Commands $\rightarrow$ Edit User Commands). You might call one menu item \verb+latexindent+\index{Scripts!latexindent@\verb+latexindent+}. The command is shown in \autoref{code:latexindent}. This means that \verb+latexindent+\index{Scripts!latexindent@\verb+latexindent+} is executed with writing rights (\verb+-w+) on the current \path{.tex} file with local settings (\verb+-l+) in the given path. These local settings are the only issue, because the absolute path can of course change if you move your folder. However, the relative path would always change depending on which file you actually want to indent.\\
The local settings are important as they specify that only one backup is created. For more information, please refer to the documentation of \verb+latexindent+\index{Scripts!latexindent@\verb+latexindent+}. You can then execute your new user command in Texmaker with the opened file in question. Afterwards, update your file by clicking on File $\rightarrow$ Reload document from file. The result is shown in \autoref{fig:automatic_indenting_latexindent}. \textbf{Note that automatic indenting might not be available for online editors.}
\clearpage
\begin{lstlisting}[breaklines, caption={Setting up \texttt{latexindent} in Texmaker}, float=tbh, label={code:latexindent}, language=latex]
"C:/path_to_texlive/year/bin/win32/latexindent.exe" -w %*\%*).tex -l="absolute_path_to_thesis_template/Thesis_template/LaTeX_template_thesis/00_Arara_and_Latexindent/localSettings.yaml"
\end{lstlisting}
......@@ -392,12 +393,13 @@ A template for a Figure is given in \autoref{fig:template_figure}. \Autoref{fig:
\end{itemize}
\myfigure[tbh][1]{Logo_dbta}[This is the caption of the figure in the List of Figures]{This is the caption of the Figure in the text. Is is placed \emph{below} the Figure. It can be longer here and contain additional information, such as references or keys for the graphs. Note that one-line captions are justified. A full stop is automatically added after the last sign}[fig:template_figure]
Although it is not seen on a regular basis in theses or dissertations, a Figure may also be surrounded by text. The \verb+wrapfig+\index{Packages!wrapfig@\verb+wrapfig+} package is used for this purpose. It depends on the Figure's size if this is a good or a bad idea. Make sure that readability of the Figure is still given. An example is given in \autoref{fig:wrapped_figure}.
\begin{wrapfigure}[8]{r}{0.4\textwidth}
\centering
\includegraphics[width=0.35\textwidth]{Logo_tub}
\caption{A wrapped figure}\label{fig:wrapped_figure}
\end{wrapfigure}
Although it is not seen on a regular basis in theses or dissertations, a Figure may also be surrounded by text. The \verb+wrapfig+\index{Packages!wrapfig@\verb+wrapfig+} package is used for this purpose. It depends on the Figure's size if this is a good or a bad idea. Make sure that readability of the Figure is still given. An example is given in \autoref{fig:wrapped_figure}.
Another possibility is putting descriptive text in an otherwise raw figure. This is illustrated in \autoref{fig:example_raw_figure}. The \verb+overpic+\index{Packages!overpic@\verb+overpic+} package provides the necessary environment of the same title and the \verb+\put+\index{Commands!put@\verb+\put(,){}+} command to add arbitrary text. If the environment is loaded with the additional options \verb+tics=10, grid+, a grid with ten tics is drawn to ease the positioning of the text. Thus, the inserted text automatically uses the same font type as the surrounding text.
......@@ -411,6 +413,7 @@ Another possibility is putting descriptive text in an otherwise raw figure. This
\end{overpic}
\caption{Example of overpic environment}\label{fig:example_raw_figure}
\end{figure}
\clearpage
\subsection{Tables}
\begin{wraptable}{r}{0.4\textwidth}
\centering
......@@ -535,6 +538,7 @@ All of these items are introduced in the following. Note that frames and their c
This statement is true, I guess.
\end{remarkenv}
\textbf{Definitions:} Definitions can be defined using the \verb+amsthm+\index{Packages!amsthm@\verb+amsthm+} package in combination with the \verb+mdframed+\index{Packages!mdframed@\verb+mdframed+} package for a possible frame. An exemplary Definition is given in \autoref{def:template_definition}. \Autoref{eq:template_equation_in_env} can also be referenced.
\clearpage
\begin{definition}[What the definition defines]
This is a definition. It defines itself.\label{def:template_definition}
\begin{equation}
......
No preview for this file type