summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/cleanthesis
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2019-06-26 20:40:49 +0000
committerKarl Berry <karl@freefriends.org>2019-06-26 20:40:49 +0000
commit970e8d821f0fe59d5e72a40a483d3c7460499bc2 (patch)
tree9e8f52c4c999d4f92c5c174e11177458b99c5c3a /Master/texmf-dist/doc/latex/cleanthesis
parent4bd24a7528ce2b7078296217539f9030c8995f46 (diff)
cleanthesis (26jun19)
git-svn-id: svn://tug.org/texlive/trunk@51472 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/cleanthesis')
-rw-r--r--Master/texmf-dist/doc/latex/cleanthesis/CHANGELOG.md15
-rw-r--r--Master/texmf-dist/doc/latex/cleanthesis/MANIFEST.md3
-rw-r--r--Master/texmf-dist/doc/latex/cleanthesis/README.md37
-rw-r--r--Master/texmf-dist/doc/latex/cleanthesis/VERSION1
-rw-r--r--Master/texmf-dist/doc/latex/cleanthesis/content/abstract.tex8
-rw-r--r--Master/texmf-dist/doc/latex/cleanthesis/content/acknowledgement.tex5
-rw-r--r--Master/texmf-dist/doc/latex/cleanthesis/content/chapter-appendix.tex40
-rw-r--r--Master/texmf-dist/doc/latex/cleanthesis/content/chapter-concepts.tex6
-rw-r--r--Master/texmf-dist/doc/latex/cleanthesis/content/chapter-conclusion.tex2
-rw-r--r--Master/texmf-dist/doc/latex/cleanthesis/content/chapter-introduction.tex35
-rw-r--r--Master/texmf-dist/doc/latex/cleanthesis/content/chapter-related-work.tex13
-rw-r--r--Master/texmf-dist/doc/latex/cleanthesis/content/chapter-system.tex2
-rw-r--r--Master/texmf-dist/doc/latex/cleanthesis/content/colophon.tex2
-rw-r--r--Master/texmf-dist/doc/latex/cleanthesis/content/declaration.tex4
-rw-r--r--Master/texmf-dist/doc/latex/cleanthesis/content/titlepages.tex2
-rw-r--r--Master/texmf-dist/doc/latex/cleanthesis/doc/cleanthesis-doc.pdfbin135752 -> 138482 bytes
-rw-r--r--Master/texmf-dist/doc/latex/cleanthesis/doc/cleanthesis-doc.tex83
-rw-r--r--Master/texmf-dist/doc/latex/cleanthesis/my-thesis-setup.tex77
-rw-r--r--Master/texmf-dist/doc/latex/cleanthesis/my-thesis.pdfbin0 -> 352944 bytes
-rw-r--r--Master/texmf-dist/doc/latex/cleanthesis/my-thesis.tex124
-rw-r--r--Master/texmf-dist/doc/latex/cleanthesis/thesis-example.pdfbin262226 -> 0 bytes
-rw-r--r--Master/texmf-dist/doc/latex/cleanthesis/thesis-example.tex158
22 files changed, 416 insertions, 201 deletions
diff --git a/Master/texmf-dist/doc/latex/cleanthesis/CHANGELOG.md b/Master/texmf-dist/doc/latex/cleanthesis/CHANGELOG.md
index 784b6a53b11..11484a2dca0 100644
--- a/Master/texmf-dist/doc/latex/cleanthesis/CHANGELOG.md
+++ b/Master/texmf-dist/doc/latex/cleanthesis/CHANGELOG.md
@@ -1,7 +1,7 @@
---
CHANGELOG.md
-Copyright 2015 R. Langner
+Copyright 2019 R. Langner
This work may be distributed and/or modified under the
conditions of the LaTeX Project Public License, either version 1.3
@@ -27,6 +27,19 @@ The latest version of this file can be found at the master branch of the
## Latest Dev
- ...
+## v0.4.0
+- Fixed compatibility to new version of KOMA script
+- Fixed code for headline/title styles (e.g., removed use of package titlesec)
+- Fixed code for footer style (e.g., removed use of package fancyhdr)
+- Fixed compatibility to new version of biblatex (e.g., obsolete options)
+- Fixed an issue with page breaks at headings (thanks @guillerodriguez)
+- Added style for part sections (often used for books)
+- Added new package options: quotation style, bibliography sorting,
+- Changed alignment of titles from justified to left aligned
+- Changed the documentation according the updates
+- Changed file structure of the repository in order to improve the development and release process
+- Example: several improvements, such as location of appendix, use of subsubsections and paragraphs, long section titles, listings, pdf bookmark for toc, or separate config file
+
## v0.3.1
- re-licensed cleanthesis using the LPPL 1.3, http://www.latex-project.org/lppl.txt
- moved documentation into a separate subfolder (doc/)
diff --git a/Master/texmf-dist/doc/latex/cleanthesis/MANIFEST.md b/Master/texmf-dist/doc/latex/cleanthesis/MANIFEST.md
index bfcce9491dd..a4ec746b550 100644
--- a/Master/texmf-dist/doc/latex/cleanthesis/MANIFEST.md
+++ b/Master/texmf-dist/doc/latex/cleanthesis/MANIFEST.md
@@ -1,7 +1,7 @@
---
MANIFEST.md
-Copyright 2015 R. Langner
+Copyright 2019 R. Langner
This work may be distributed and/or modified under the
conditions of the LaTeX Project Public License, either version 1.3
@@ -27,6 +27,7 @@ cleanthesis/
|-- cleanthesis.sty - the cleanthesis style
|-- MANIFEST.md - this file
|-- README.md - readme file
+|-- VERSION - the version of the style
|-- doc/
|-- cleanthesis-doc.tex - documentation source
|-- cleanthesis-doc.pdf - generated documentation
diff --git a/Master/texmf-dist/doc/latex/cleanthesis/README.md b/Master/texmf-dist/doc/latex/cleanthesis/README.md
index 27b2f2ca2b2..3e7ee50281c 100644
--- a/Master/texmf-dist/doc/latex/cleanthesis/README.md
+++ b/Master/texmf-dist/doc/latex/cleanthesis/README.md
@@ -1,7 +1,15 @@
# Clean Thesis
-*-- A LaTeX Style for Thesis Documents --*
+*-- A Clean LaTeX Style for Thesis Documents --*
-## Readme:
+## Table of contents
+
+* [About](#about)
+* [Getting started](#getting-started)
+* [Documentation and Support](#documentation-and-support)
+* [Contributing](#contributing)
+* [License Information](#license-information)
+
+## About
**Clean, Simple, Elegant**
*Clean Thesis* is a LaTeX style for thesis documents, developed for my diploma thesis (Diplomarbeit). The style can be understood as my personal compromise — a typical clean looking scientific document combined and polished with minor beautifications.
@@ -11,15 +19,32 @@ The design of this *Clean Thesis* style is inspired by user guide documents from
Note: If you are looking for an exact and correct style regarding typographic rules, please have a look at the "[Classic Thesis Style](see http://www.miede.de/#classicthesis)".
**Donation = Postcard**
-Based on the idea of André Miede: If you like the *Clean Thesis* style I would be very pleased about a donation in the form of a POSTCARD. You can find my address at the *Clean Thesis* [website](http://cleanthesis.der-ric.de/) as well as in the [documentation](Clean-Thesis.pdf). I am going to collect all postcards and exhibit them at the website I mentioned.
+Based on the idea of André Miede: If you like the *Clean Thesis* style I would be very pleased about a donation in the form of a POSTCARD. You can find my address at the *Clean Thesis* [website](http://cleanthesis.der-ric.de/) as well as in the [documentation](doc/cleanthesis-doc.pdf). I am going to collect all postcards and exhibit them at the website I mentioned.
**Idea and Inspiration**
-The idea of providing my customized style for thesis documents passed through my mind while writing my own thesis. Motivated and inspired by the superb "[Classic Thesis Style](see http://www.miede.de/#classicthesis)" by André Miede (thanks to André for doing a great job) I decided to collect all design and style related functionality in a separate LaTeX style and provide this style to other thesis writers.
+The idea of providing my customized style for thesis documents passed through my mind while writing my own thesis. Motivated and inspired by the superb "[Classic Thesis Style](http://www.miede.de/#classicthesis)" by André Miede (thanks to André for doing a great job) I decided to collect all design and style related functionality in a separate LaTeX style and provide this style to other thesis writers.
+
+## Getting started
+
+* Make sure you have an up-to-date TeX distribution
+* Download the latest [release](https://github.com/derric/cleanthesis/releases) or clone the repository with `git clone https://github.com/derric/cleanthesis.git`
+* Check out the included [example thesis](my-thesis.tex)
+* [Read the documentation](doc/cleanthesis-doc.pdf) to learn more about *Clean Thesis* and available package options
+
+## Documentation and Support
+
+The [documentation](doc/cleanthesis-doc.pdf) gives an overview of available package options.
+
+Please ask **questions** or start **discussions** about *Clean Thesis* at [Stack Exchange](http://tex.stackexchange.com/questions/tagged/cleanthesis) (tagged [cleanthesis](http://tex.stackexchange.com/questions/tagged/cleanthesis)). GitHub issues are for development purposes, e.g, reporting bugs or requesting new features.
+
+## Contributing
+
+Did you find an error or a bug? Do you have a feature request? Before opening a [new issue](https://github.com/derric/cleanthesis/issues/new), please check out the list of [existing](https://github.com/derric/cleanthesis/issues) and [closed](https://github.com/derric/cleanthesis/issues?q=is%3Aissue+is%3Aclosed) issues.
-## License Information:
+## License Information
README.md
-Copyright 2015 R. Langner
+Copyright 2019 R. Langner
This work may be distributed and/or modified under the
conditions of the LaTeX Project Public License, either version 1.3
diff --git a/Master/texmf-dist/doc/latex/cleanthesis/VERSION b/Master/texmf-dist/doc/latex/cleanthesis/VERSION
new file mode 100644
index 00000000000..60a2d3e96c8
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/cleanthesis/VERSION
@@ -0,0 +1 @@
+0.4.0 \ No newline at end of file
diff --git a/Master/texmf-dist/doc/latex/cleanthesis/content/abstract.tex b/Master/texmf-dist/doc/latex/cleanthesis/content/abstract.tex
index 00cb3d2169a..a011582632e 100644
--- a/Master/texmf-dist/doc/latex/cleanthesis/content/abstract.tex
+++ b/Master/texmf-dist/doc/latex/cleanthesis/content/abstract.tex
@@ -1,14 +1,14 @@
-% !TEX root = ../thesis-example.tex
+% !TEX root = ../my-thesis.tex
%
\pdfbookmark[0]{Abstract}{Abstract}
-\chapter*{Abstract}
+\addchap*{Abstract}
\label{sec:abstract}
-\vspace*{-10mm}
\blindtext
\vspace*{20mm}
-{\usekomafont{chapter}Abstract (different language)}\label{sec:abstract-diff} \\
+{\usekomafont{chapter}Abstract (different language)}
+\label{sec:abstract-diff}
\blindtext
diff --git a/Master/texmf-dist/doc/latex/cleanthesis/content/acknowledgement.tex b/Master/texmf-dist/doc/latex/cleanthesis/content/acknowledgement.tex
index 5f6d4cf4e33..09f29999d79 100644
--- a/Master/texmf-dist/doc/latex/cleanthesis/content/acknowledgement.tex
+++ b/Master/texmf-dist/doc/latex/cleanthesis/content/acknowledgement.tex
@@ -1,8 +1,7 @@
-% !TEX root = ../thesis-example.tex
+% !TEX root = ../my-thesis.tex
%
\pdfbookmark[0]{Acknowledgement}{Acknowledgement}
-\chapter*{Acknowledgement}
+\addchap*{Acknowledgement}
\label{sec:acknowledgement}
-\vspace*{-10mm}
\Blindtext[2][2]
diff --git a/Master/texmf-dist/doc/latex/cleanthesis/content/chapter-appendix.tex b/Master/texmf-dist/doc/latex/cleanthesis/content/chapter-appendix.tex
new file mode 100644
index 00000000000..e482c186410
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/cleanthesis/content/chapter-appendix.tex
@@ -0,0 +1,40 @@
+% !TEX root = ../my-thesis.tex
+%
+\chapter{Example Appendix}
+\label{sec:appendix}
+
+\Blindtext[1][1]
+
+\section{Appendix Section 1}
+\label{sec:appendix:sec1}
+
+\Blindtext[1][1]
+
+\begin{table}[h]
+ \begin{tabularx}{\textwidth}{X | X | X}
+ %\hline
+ Alpha & Beta & Gamma \\ \hline
+ 0 & 1 & 2 \\ \hline
+ 3 & 4 & 5 \\ %\hline
+ \end{tabularx}
+ \label{tab:table1}
+ \caption{This is a caption text.}
+\end{table}
+
+\section{Appendix Section 2}
+\label{sec:appendix:sec2}
+
+\Blindtext[1][1]
+
+\begin{table}[h]
+ \begin{tabularx}{\textwidth}{X | X | X}
+ %\hline
+ Alpha & Beta & Gamma \\ \hline
+ 0 & 1 & 2 \\ \hline
+ 3 & 4 & 5 \\ %\hline
+ \end{tabularx}
+ \label{tab:table2}
+ \caption{This is a caption text.}
+\end{table}
+
+\Blindtext[1][2]
diff --git a/Master/texmf-dist/doc/latex/cleanthesis/content/chapter-concepts.tex b/Master/texmf-dist/doc/latex/cleanthesis/content/chapter-concepts.tex
index 4464cdc5101..3255bf362bc 100644
--- a/Master/texmf-dist/doc/latex/cleanthesis/content/chapter-concepts.tex
+++ b/Master/texmf-dist/doc/latex/cleanthesis/content/chapter-concepts.tex
@@ -1,6 +1,6 @@
-% !TEX root = ../thesis-example.tex
+% !TEX root = ../my-thesis.tex
%
-\chapter{Concepts: This text is here to test a very long title, to simulate the line break behavior, to show that an extremely long tilte also works}
+\chapter{Concepts: This text is here to test a very long title, to simulate the line break behavior, to show that an extremely long title also works}
\label{sec:concepts}
\cleanchapterquote{Users do not care about what is inside the box, as long as the box does what they need done.}{Jef Raskin}{about Human Computer Interfaces}
@@ -12,7 +12,7 @@
\Blindtext[2][2]
-\section{Concepts Section 2}
+\section{Concepts Section 2 with a very very long title that illustrates how long section titles are handled in the footer}
\label{sec:concepts:sec2}
\Blindtext[3][2]
diff --git a/Master/texmf-dist/doc/latex/cleanthesis/content/chapter-conclusion.tex b/Master/texmf-dist/doc/latex/cleanthesis/content/chapter-conclusion.tex
index 20e2ec81099..a4b46b944f5 100644
--- a/Master/texmf-dist/doc/latex/cleanthesis/content/chapter-conclusion.tex
+++ b/Master/texmf-dist/doc/latex/cleanthesis/content/chapter-conclusion.tex
@@ -1,4 +1,4 @@
-% !TEX root = ../thesis-example.tex
+% !TEX root = ../my-thesis.tex
%
\chapter{Conclusion}
\label{sec:conclusion}
diff --git a/Master/texmf-dist/doc/latex/cleanthesis/content/chapter-introduction.tex b/Master/texmf-dist/doc/latex/cleanthesis/content/chapter-introduction.tex
index 9cd34ebad32..a10e2c4af08 100644
--- a/Master/texmf-dist/doc/latex/cleanthesis/content/chapter-introduction.tex
+++ b/Master/texmf-dist/doc/latex/cleanthesis/content/chapter-introduction.tex
@@ -1,4 +1,4 @@
-% !TEX root = ../thesis-example.tex
+% !TEX root = ../my-thesis.tex
%
\chapter{Introduction}
\label{sec:intro}
@@ -28,7 +28,40 @@ Germany
\subsection{Some References}
\label{sec:intro:results:refs}
+
\cite{WEB:GNU:GPL:2010,WEB:Miede:2011}
+\Blindtext[1][1]
+
+\subsubsection{Methodology}
+\label{sec:intro:results:refs:method}
+
+\Blindtext[1][2]
+
+\paragraph{Strategy 1}
+\Blindtext[1][1]
+
+\begin{lstlisting}[language=Python, caption={This simple helloworld.py file prints Hello World.}\label{lst:pyhelloworld}]
+#!/usr/bin/env python
+print "Hello World"
+\end{lstlisting}
+
+\paragraph{Strategy 2}
+\Blindtext[1][1]
+
+\begin{lstlisting}[language=Python, caption={This is a bubble sort function.}\label{lst:pybubblesort}]
+#!/usr/bin/env python
+def bubble_sort(list):
+ for num in range(len(list)-1,0,-1):
+ for i in range(num):
+ if list[i]>list[i+1]:
+ tmp = list[i]
+ list[i] = list[i+1]
+ list[i+1] = tmp
+
+alist = [34,67,2,4,65,16,17,95,20,31]
+bubble_sort(list)
+print(list)
+\end{lstlisting}
\section{Thesis Structure}
\label{sec:intro:structure}
diff --git a/Master/texmf-dist/doc/latex/cleanthesis/content/chapter-related-work.tex b/Master/texmf-dist/doc/latex/cleanthesis/content/chapter-related-work.tex
index 04c3c9142f0..5fe1cbfa80b 100644
--- a/Master/texmf-dist/doc/latex/cleanthesis/content/chapter-related-work.tex
+++ b/Master/texmf-dist/doc/latex/cleanthesis/content/chapter-related-work.tex
@@ -1,4 +1,4 @@
-% !TEX root = ../thesis-example.tex
+% !TEX root = ../my-thesis.tex
%
\chapter{Related Work}
\label{sec:related}
@@ -7,6 +7,17 @@
\Blindtext[2][1]
+\begin{lstlisting}[language=Java, caption={A simple Hellow World example in Java.}\label{lst:javahelloworld}]
+public class HelloWorld {
+ public static void main ( String[] args ) {
+ // Output Hello World!
+ System.out.println( "Hello World!" );
+ }
+}
+\end{lstlisting}
+
+\Blindtext[1][1]
+
\section{Related Work Section 1}
\label{sec:related:sec1}
diff --git a/Master/texmf-dist/doc/latex/cleanthesis/content/chapter-system.tex b/Master/texmf-dist/doc/latex/cleanthesis/content/chapter-system.tex
index 5fea8c9354a..641d8a9c07f 100644
--- a/Master/texmf-dist/doc/latex/cleanthesis/content/chapter-system.tex
+++ b/Master/texmf-dist/doc/latex/cleanthesis/content/chapter-system.tex
@@ -1,4 +1,4 @@
-% !TEX root = ../thesis-example.tex
+% !TEX root = ../my-thesis.tex
%
\chapter{System}
\label{sec:system}
diff --git a/Master/texmf-dist/doc/latex/cleanthesis/content/colophon.tex b/Master/texmf-dist/doc/latex/cleanthesis/content/colophon.tex
index 59fc99e7e4b..94fe0678788 100644
--- a/Master/texmf-dist/doc/latex/cleanthesis/content/colophon.tex
+++ b/Master/texmf-dist/doc/latex/cleanthesis/content/colophon.tex
@@ -1,4 +1,4 @@
-% !TEX root = ../thesis-example.tex
+% !TEX root = ../my-thesis.tex
%
\pagestyle{empty}
\hfill
diff --git a/Master/texmf-dist/doc/latex/cleanthesis/content/declaration.tex b/Master/texmf-dist/doc/latex/cleanthesis/content/declaration.tex
index db58183ea20..08905f468ea 100644
--- a/Master/texmf-dist/doc/latex/cleanthesis/content/declaration.tex
+++ b/Master/texmf-dist/doc/latex/cleanthesis/content/declaration.tex
@@ -1,10 +1,10 @@
-% !TEX root = ../thesis-example.tex
+% !TEX root = ../my-thesis.tex
%
%************************************************
% Declaration
%************************************************
\pdfbookmark[0]{Declaration}{Declaration}
-\chapter*{Declaration}
+\addchap{Declaration}
\label{sec:declaration}
\thispagestyle{empty}
diff --git a/Master/texmf-dist/doc/latex/cleanthesis/content/titlepages.tex b/Master/texmf-dist/doc/latex/cleanthesis/content/titlepages.tex
index 497b14e9642..3fe08353cd9 100644
--- a/Master/texmf-dist/doc/latex/cleanthesis/content/titlepages.tex
+++ b/Master/texmf-dist/doc/latex/cleanthesis/content/titlepages.tex
@@ -1,4 +1,4 @@
-% !TEX root = ../thesis-example.tex
+% !TEX root = ../my-thesis.tex
%
% ------------------------------------ --> cover title page
\begin{titlepage}
diff --git a/Master/texmf-dist/doc/latex/cleanthesis/doc/cleanthesis-doc.pdf b/Master/texmf-dist/doc/latex/cleanthesis/doc/cleanthesis-doc.pdf
index c38f8375973..d75851ad2b0 100644
--- a/Master/texmf-dist/doc/latex/cleanthesis/doc/cleanthesis-doc.pdf
+++ b/Master/texmf-dist/doc/latex/cleanthesis/doc/cleanthesis-doc.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/cleanthesis/doc/cleanthesis-doc.tex b/Master/texmf-dist/doc/latex/cleanthesis/doc/cleanthesis-doc.tex
index 49601243947..d153bbccb7e 100644
--- a/Master/texmf-dist/doc/latex/cleanthesis/doc/cleanthesis-doc.tex
+++ b/Master/texmf-dist/doc/latex/cleanthesis/doc/cleanthesis-doc.tex
@@ -1,5 +1,5 @@
%% cleanthesis-doc.tex
-%% Copyright 2015 R. Langner
+%% Copyright 2019 R. Langner
%
% This work may be distributed and/or modified under the
% conditions of the LaTeX Project Public License, either version 1.3
@@ -25,8 +25,7 @@
\usepackage{booktabs}
\usepackage{shortvrb}
\usepackage{pifont}
-
-\rcsid{$Id: cleanthesis.tex,v 0.3.1 2015/08/26 23:32:00 derric stable $}
+\usepackage{graphicx}
\newcommand*{\cleanthesis}{\emph{Clean Thesis}\xspace}
\newcommand*{\cthesishome}{http://cleanthesis.der-ric.de/}
@@ -34,21 +33,26 @@
\titlepage{%
title={The \sty{cleanthesis} Package},
- subtitle={A LaTeX Style for Thesis Documents},
+ subtitle={A Clean LaTeX Style for Thesis Documents},
url={\cthesishome},
author={Ricardo Langner},
email={info@cleanthesis.der-ric.de},
- revision={\rcsrevision},
- date={\rcstoday}}
+ revision={0.4.0},
+ date={2019/06/21}}
\hypersetup{%
pdftitle={The \cleanthesis Package},
- pdfsubject={A LaTeX Style for Thesis Documents},
+ pdfsubject={A Clean LaTeX Style for Thesis Documents},
pdfauthor={Ricardo Langner},
pdfkeywords={tex, latex, thesis, style}}
%\setcounter{secnumdepth}{4}
+% > adjust depth of the toc and removes the indention
+\setcounter{tocdepth}{3}
+\AtBeginToc{\setcounter{tocdepth}{3}}
+\AtEndToc{\setcounter{tocdepth}{5}}
+\KOMAoption{toc}{flat}
\begin{document}
@@ -83,7 +87,7 @@ Alfred-Schrapel-Str. 7 \\
\subsection{License}
\label{sec:intro:license}
-Copyright \textcopyright\ 2015 R. Langner
+Copyright \textcopyright\ 2019 R. Langner
This work may be distributed and/or modified under the
conditions of the LaTeX Project Public License, either version 1.3
@@ -107,7 +111,7 @@ This work consists of all files listed in MANIFEST.md.
First of all I would like to thank André Miede. He is the author of the Classic Thesis style. His Classic Thesis style inspired end encouraged me to publish my own thesis style. Thank you André for doing a great job.
-I would like to thank the following people for using the \cleanthesis style and giving important initial feedback to me, e.g., features, bugs: (1) \textbf{Sebastian Kleinau}\footnote{\url{http://www.sk-downloading.de/} (in German only)} in his bachelor thesis, (2) \textbf{Mathias Frisch}\footnote{\url{http://wwwpub.zih.tu-dresden.de/~frisch/}} in his dissertation (PhD), and (3) \textbf{Anton Augsburg}\footnote{\url{http://antonaugsburg.de/} (in German only)} in his project thesis.
+I would like to thank the following people for using the \cleanthesis style and providing me important initial feedback (e.g., features, bugs): (1) \textbf{Sebastian Kleinau} in his bachelor thesis, (2) \textbf{Mathias Frisch} in his dissertation (PhD), and (3) \textbf{Anton Augsburg} in his project thesis.
\subsection{Prerequisites}
\label{sec:intro:pre}
@@ -124,16 +128,12 @@ The following section gives an overview of all resources required by this packag
\label{sec:userguide:pkgopt}
All package options are given in \keyval notation.
-The value \texttt{true} can be omitted for all boolean keys, \eg \opt{sansserif} without a value is equivalent to \kvopt{sansserif}{true}.
+The value \texttt{true} can be omitted for all boolean keys, \eg \opt{hangsection} without a value is equivalent to \kvopt{hangsection}{true}.
All of the following options must be used as \sty{cthesis} is loaded, \ie in the optional argument to \cmd{usepackage}.
\begin{optionlist}
-\boolitem[false]{sansserif}
-
-Sets whether to use a sans serif font or not.
-
\boolitem[false]{hangfigurecaption}
Sets whether to use a hanging figure label (similar to headlines, placed in page margin) or not.
@@ -146,6 +146,14 @@ Sets whether to use a hanging section label (placed in page margin) or not.
Sets whether to use a hanging sub-section label (placed in page margin) or not.
+\boolitem[false]{sansserif}
+
+Sets whether to use a sans serif font or not.
+
+\boolitem[false]{configurelistings}
+
+Sets whether to use the package listings and to configure the visual appearance of lstlisting environments.
+
\optitem[endash]{figuresep}{\opt{none},\opt{colon},\opt{period},\opt{space},\opt{quad},\opt{endash}}
This option can be used to define a different label separator for cations of figures. The following value are allowed:
@@ -187,6 +195,23 @@ The following values are allowed:
\item[bluegreen] Headlines and titles use a blue color, figure labels use green.
\end{valuelist}
+\optitem[english]{quotesstyle}{csquotes style options}
+
+Sets the quote style.
+This is a direct interface to the corresponding style option of the csquotes package.
+For further information please check out the csquotes documentation \url{https://www.ctan.org/pkg/csquotes}.
+The default is \texttt{english}.
+For individual settings, for instance German quotes, you can use \texttt{quotesstyle=german}.
+
+
+\subsubsection{Setup Your Bibliography}
+
+\boolitem[false]{configurebiblatex}
+
+Sets whether to use and configure the package biblatex within the template.
+
+If this option is set to false, you can setup your bibliography environment by yourself depending on your individual needs or requirements. In this case, you have to include something like \cs{usepackage\{biblatex\}} and \cs{bibliography\{bib-refs\}} in your preamble (i.e., before the \cs{begin\{document\}} statement).
+
\optitem[bibtex]{bibsys}{\opt{biber},\opt{bibtex}}
Sets whether to use \texttt{biber} or \texttt{bibtex} as citation management tool (engine).
@@ -199,11 +224,35 @@ The default (still) is \texttt{bibtex}.
Sets the file name of the bibtex file used for the bibliography.
If this option is not used (defined), the package looks for the default bibliography \texttt{bib-refs.bib}.
-\optitem[alphabetic]{bibstyle}{\opt{alphabetic},\opt{numeric},\opt{authoryear}}
+\optitem[alphabetic]{bibstyle}{biblatex style options}
-Sets whether to use an \texttt{alphabetic}, a \texttt{numeric}, or an \texttt{authoryear} reference style for the bibliography.
-For further information please check out the biblatex documentation\footnote{\url{http://www.ctan.org/pkg/biblatex}}.
+Sets the bibliography style.
+This is a direct interface to the corresponding style option of the biblatex package.
+For further information please check out the biblatex documentation \url{http://www.ctan.org/pkg/biblatex}.
The default is \texttt{alphabetic}.
+Two popular options are:
+
+\begin{valuelist}
+\item[alphabetic] (default) Prints labels similar to the traditional BibTeX style \texttt{alpha.bst}, for instance \texttt{[Lan+15]} or \texttt{[LHD17]}
+\item[numeric] Uses numeric labels, such as \texttt{[1]} or \texttt{[37]}
+\end{valuelist}
+
+However, you can also pass non-standard options to make use of other bibliography packages for biblatex.
+For example, by setting the option \texttt{style=ieee} or \texttt{style=ieee-alphabetic} you can use the biblatex-ieee package (see \url{https://ctan.org/pkg/biblatex-ieee}).
+
+\optitem[nty]{bibsorting}{biblatex sorting options}
+
+Sets the sorting order of the bibliography.
+This is a direct interface to the corresponding option of the biblatex package.
+For further information please check out the biblatex documentation \url{http://www.ctan.org/pkg/biblatex}.
+The default is \texttt{nty}.
+Some popular options include:
+
+\begin{valuelist}
+\item[nty] (default) Sort by name, title, year
+\item[nyt] Sort by name, year, title
+\item[none] No sorting at all, entries are processed in the order of their citation
+\end{valuelist}
\end{optionlist}
diff --git a/Master/texmf-dist/doc/latex/cleanthesis/my-thesis-setup.tex b/Master/texmf-dist/doc/latex/cleanthesis/my-thesis-setup.tex
new file mode 100644
index 00000000000..b446bbf8631
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/cleanthesis/my-thesis-setup.tex
@@ -0,0 +1,77 @@
+% !TEX root = my-thesis.tex
+
+
+% **************************************************
+% Files' Character Encoding
+% **************************************************
+\PassOptionsToPackage{utf8}{inputenc}
+\usepackage{inputenc}
+
+
+% **************************************************
+% Information and Commands for Reuse
+% **************************************************
+\newcommand{\thesisTitle}{The Clean Thesis Style}
+\newcommand{\thesisName}{Ricardo Langner}
+\newcommand{\thesisSubject}{Documentation}
+\newcommand{\thesisDate}{June 21, 2016}
+\newcommand{\thesisVersion}{My First Draft}
+
+\newcommand{\thesisFirstReviewer}{Jane Doe}
+\newcommand{\thesisFirstReviewerUniversity}{\protect{Clean Thesis Style University}}
+\newcommand{\thesisFirstReviewerDepartment}{Department of Clean Thesis Style}
+
+\newcommand{\thesisSecondReviewer}{John Doe}
+\newcommand{\thesisSecondReviewerUniversity}{\protect{Clean Thesis Style University}}
+\newcommand{\thesisSecondReviewerDepartment}{Department of Clean Thesis Style}
+
+\newcommand{\thesisFirstSupervisor}{Jane Doe}
+\newcommand{\thesisSecondSupervisor}{John Smith}
+
+\newcommand{\thesisUniversity}{\protect{Clean Thesis Style University}}
+\newcommand{\thesisUniversityDepartment}{Department of Clean Thesis Style}
+\newcommand{\thesisUniversityInstitute}{Institute for Clean Thesis Dev}
+\newcommand{\thesisUniversityGroup}{Clean Thesis Group (CTG)}
+\newcommand{\thesisUniversityCity}{City}
+\newcommand{\thesisUniversityStreetAddress}{Street address}
+\newcommand{\thesisUniversityPostalCode}{Postal Code}
+
+
+% **************************************************
+% Debug LaTeX Information
+% **************************************************
+%\listfiles
+
+
+% **************************************************
+% Load and Configure Packages
+% **************************************************
+\usepackage[english]{babel} % babel system, adjust the language of the content
+\PassOptionsToPackage{% setup clean thesis style
+ figuresep=colon,%
+ hangfigurecaption=false,%
+ hangsection=true,%
+ hangsubsection=true,%
+ sansserif=false,%
+ configurelistings=true,%
+ colorize=full,%
+ colortheme=bluemagenta,%
+ configurebiblatex=true,%
+ bibsys=biber,%
+ bibfile=bib-refs,%
+ bibstyle=alphabetic,%
+ bibsorting=nty,%
+}{cleanthesis}
+\usepackage{cleanthesis}
+
+\hypersetup{% setup the hyperref-package options
+ pdftitle={\thesisTitle}, % - title (PDF meta)
+ pdfsubject={\thesisSubject},% - subject (PDF meta)
+ pdfauthor={\thesisName}, % - author (PDF meta)
+ plainpages=false, % -
+ colorlinks=false, % - colorize links?
+ pdfborder={0 0 0}, % -
+ breaklinks=true, % - allow line break inside links
+ bookmarksnumbered=true, %
+ bookmarksopen=true %
+}
diff --git a/Master/texmf-dist/doc/latex/cleanthesis/my-thesis.pdf b/Master/texmf-dist/doc/latex/cleanthesis/my-thesis.pdf
new file mode 100644
index 00000000000..6574034c159
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/cleanthesis/my-thesis.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/cleanthesis/my-thesis.tex b/Master/texmf-dist/doc/latex/cleanthesis/my-thesis.tex
new file mode 100644
index 00000000000..eedba725b57
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/cleanthesis/my-thesis.tex
@@ -0,0 +1,124 @@
+% **************************************************
+% Document Class Definition
+% **************************************************
+\documentclass[%
+ paper=A4, % paper size --> A4 is default in Germany
+ twoside=true, % onesite or twoside printing
+ openright, % doublepage cleaning ends up right side
+ parskip=half, % spacing value / method for paragraphs
+ chapterprefix=true, % prefix for chapter marks
+ 11pt, % font size
+ headings=normal, % size of headings
+ bibliography=totoc, % include bib in toc
+ listof=totoc, % include listof entries in toc
+ titlepage=on, % own page for each title page
+ captions=tableabove, % display table captions above the float env
+ chapterprefix=false, % do not display a prefix for chapters
+ appendixprefix=false, % but display a prefix for appendix chapter
+ draft=false, % value for draft version
+]{scrreprt}%
+
+
+% **************************************************
+% Setup YOUR thesis document in this file !
+% **************************************************
+\input{my-thesis-setup}
+
+
+% **************************************************
+% Document CONTENT
+% **************************************************
+\begin{document}
+
+% uncomment the following command to fill up pages with
+% whitespace instead of aligning the first and last lines
+% of a page (see \raggedbottom vs. \flushbottom)
+%\raggedbottom
+
+% --------------------------
+% rename document parts
+% --------------------------
+%\renewcaptionname{ngerman}{\figurename}{Abb.}
+%\renewcaptionname{ngerman}{\tablename}{Tab.}
+\renewcaptionname{english}{\figurename}{Fig.}
+\renewcaptionname{english}{\tablename}{Tab.}
+
+% --------------------------
+% Front matter
+% --------------------------
+\pagenumbering{roman} % roman page numbing (invisible for empty page style)
+\pagestyle{empty} % no header or footers
+\input{content/titlepages} % INCLUDE: all titlepages
+\cleardoublepage
+
+\pagestyle{plain} % display just page numbers
+\input{content/abstract} % INCLUDE: the abstracts (english and german)
+\cleardoublepage
+%
+\input{content/acknowledgement} % INCLUDE: acknowledgement
+\cleardoublepage
+%
+\currentpdfbookmark{\contentsname}{toc}
+\setcounter{tocdepth}{2} % define depth of toc
+\tableofcontents % display table of contents
+\cleardoublepage
+
+% --------------------------
+% Body matter
+% --------------------------
+\pagenumbering{arabic} % arabic page numbering
+\setcounter{page}{1} % set page counter
+\pagestyle{scrheadings} % header and footer style
+
+%% Uncomment the following lines using the \part command
+%% to add part sections
+%\part{Example Part}
+\input{content/chapter-introduction} % INCLUDE: introduction
+\input{content/chapter-related-work} % INCLUDE: related work
+
+%\part{Additional Example Part}
+\input{content/chapter-system} % INCLUDE: system
+\input{content/chapter-concepts} % INCLUDE: concepts
+\input{content/chapter-conclusion} % INCLUDE: conclusion
+
+% --------------------------
+% Back matter
+% --------------------------
+%
+{%
+\setstretch{1.1}
+\renewcommand{\bibfont}{\normalfont\small}
+\setlength{\biblabelsep}{0pt}
+\setlength{\bibitemsep}{0.5\baselineskip plus 0.5\baselineskip}
+\printbibliography[nottype=online]
+\newrefcontext[labelprefix={@}]
+\printbibliography[heading=subbibliography,title={Webpages},type=online]
+}
+\cleardoublepage
+
+\listoffigures
+\cleardoublepage
+
+\listoftables
+\cleardoublepage
+
+\lstlistoflistings
+\cleardoublepage
+
+\appendix\cleardoublepage
+\input{content/chapter-appendix} % INCLUDE: appendix
+
+\cleardoublepage
+\input{content/colophon}
+
+\cleardoublepage
+\input{content/declaration}
+\clearpage
+
+\newpage
+\mbox{}
+
+% **************************************************
+% End of Document CONTENT
+% **************************************************
+\end{document}
diff --git a/Master/texmf-dist/doc/latex/cleanthesis/thesis-example.pdf b/Master/texmf-dist/doc/latex/cleanthesis/thesis-example.pdf
deleted file mode 100644
index b028f8bac35..00000000000
--- a/Master/texmf-dist/doc/latex/cleanthesis/thesis-example.pdf
+++ /dev/null
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/cleanthesis/thesis-example.tex b/Master/texmf-dist/doc/latex/cleanthesis/thesis-example.tex
deleted file mode 100644
index 885b0c09bcd..00000000000
--- a/Master/texmf-dist/doc/latex/cleanthesis/thesis-example.tex
+++ /dev/null
@@ -1,158 +0,0 @@
-% **************************************************
-% Document Class Definition
-% **************************************************
-\documentclass[%
- paper=A4, % paper size --> A4 is default in Germany
- twoside=true, % onesite or twoside printing
- openright, % doublepage cleaning ends up right side
- parskip=full, % spacing value / method for paragraphs
- chapterprefix=true, % prefix for chapter marks
- 11pt, % font size
- headings=normal, % size of headings
- bibliography=totoc, % include bib in toc
- listof=totoc, % include listof entries in toc
- titlepage=on, % own page for each title page
- captions=tableabove, % display table captions above the float env
- draft=false, % value for draft version
-]{scrreprt}%
-
-% **************************************************
-% Debug LaTeX Information
-% **************************************************
-%\listfiles
-
-% **************************************************
-% Information and Commands for Reuse
-% **************************************************
-\newcommand{\thesisTitle}{The Clean Thesis Style}
-\newcommand{\thesisName}{Ricardo Langner}
-\newcommand{\thesisSubject}{Documentation}
-\newcommand{\thesisDate}{August 26, 2015}
-\newcommand{\thesisVersion}{My First Draft}
-
-\newcommand{\thesisFirstReviewer}{Jane Doe}
-\newcommand{\thesisFirstReviewerUniversity}{\protect{Clean Thesis Style University}}
-\newcommand{\thesisFirstReviewerDepartment}{Department of Clean Thesis Style}
-
-\newcommand{\thesisSecondReviewer}{John Doe}
-\newcommand{\thesisSecondReviewerUniversity}{\protect{Clean Thesis Style University}}
-\newcommand{\thesisSecondReviewerDepartment}{Department of Clean Thesis Style}
-
-\newcommand{\thesisFirstSupervisor}{Jane Doe}
-\newcommand{\thesisSecondSupervisor}{John Smith}
-
-\newcommand{\thesisUniversity}{\protect{Clean Thesis Style University}}
-\newcommand{\thesisUniversityDepartment}{Department of Clean Thesis Style}
-\newcommand{\thesisUniversityInstitute}{Institut for Clean Thesis Dev}
-\newcommand{\thesisUniversityGroup}{Clean Thesis Group (CTG)}
-\newcommand{\thesisUniversityCity}{City}
-\newcommand{\thesisUniversityStreetAddress}{Street address}
-\newcommand{\thesisUniversityPostalCode}{Postal Code}
-
-% **************************************************
-% Load and Configure Packages
-% **************************************************
-\usepackage[utf8]{inputenc} % defines file's character encoding
-\usepackage[english]{babel} % babel system, adjust the language of the content
-\usepackage[ % clean thesis style
- figuresep=colon,%
- sansserif=false,%
- hangfigurecaption=false,%
- hangsection=true,%
- hangsubsection=true,%
- colorize=full,%
- colortheme=bluemagenta,%
- bibsys=bibtex,%
- bibfile=bib-refs,%
- bibstyle=alphabetic,%
-]{cleanthesis}
-
-\hypersetup{ % setup the hyperref-package options
- pdftitle={\thesisTitle}, % - title (PDF meta)
- pdfsubject={\thesisSubject},% - subject (PDF meta)
- pdfauthor={\thesisName}, % - author (PDF meta)
- plainpages=false, % -
- colorlinks=false, % - colorize links?
- pdfborder={0 0 0}, % -
- breaklinks=true, % - allow line break inside links
- bookmarksnumbered=true, %
- bookmarksopen=true %
-}
-
-% **************************************************
-% Document CONTENT
-% **************************************************
-\begin{document}
-
-% --------------------------
-% rename document parts
-% --------------------------
-%\renewcaptionname{ngerman}{\figurename}{Abb.}
-%\renewcaptionname{ngerman}{\tablename}{Tab.}
-\renewcaptionname{english}{\figurename}{Fig.}
-\renewcaptionname{english}{\tablename}{Tab.}
-
-% --------------------------
-% Front matter
-% --------------------------
-\pagenumbering{roman} % roman page numbing (invisible for empty page style)
-\pagestyle{empty} % no header or footers
-\input{content/titlepages} % INCLUDE: all titlepages
-\cleardoublepage
-
-\pagestyle{plain} % display just page numbers
-\input{content/abstract} % INCLUDE: the abstracts (english and german)
-\cleardoublepage
-%
-\input{content/acknowledgement} % INCLUDE: acknowledgement
-\cleardoublepage
-%
-\setcounter{tocdepth}{2} % define depth of toc
-\tableofcontents % display table of contents
-\cleardoublepage
-
-% --------------------------
-% Body matter
-% --------------------------
-\pagenumbering{arabic} % arabic page numbering
-\setcounter{page}{1} % set page counter
-\pagestyle{maincontentstyle} % fancy header and footer
-
-\input{content/chapter-introduction} % INCLUDE: introduction
-\input{content/chapter-related-work} % INCLUDE: related work
-\input{content/chapter-system} % INCLUDE: system
-\input{content/chapter-concepts} % INCLUDE: concepts
-\input{content/chapter-conclusion} % INCLUDE: conclusion
-\cleardoublepage
-
-% --------------------------
-% Back matter
-% --------------------------
-{%
-\setstretch{1.1}
-\renewcommand{\bibfont}{\normalfont\small}
-\setlength{\biblabelsep}{0pt}
-\setlength{\bibitemsep}{0.5\baselineskip plus 0.5\baselineskip}
-\printbibliography[nottype=online]
-\printbibliography[heading=subbibliography,title={Webseiten},type=online,prefixnumbers={@}]
-}
-\cleardoublepage
-
-\listoffigures
-\cleardoublepage
-
-\listoftables
-\cleardoublepage
-
-\input{content/colophon}
-\cleardoublepage
-
-\input{content/declaration}
-\clearpage
-\newpage
-\mbox{}
-
-% **************************************************
-% End of Document CONTENT
-% **************************************************
-\end{document}