13 Commits

21 changed files with 261 additions and 176 deletions

View File

@@ -1,5 +1,5 @@
# Clean Thesis
*-- A LaTeX Style for Thesis Documents --*
*-- A Clean LaTeX Style for Thesis Documents --*
## Readme:

View File

@@ -29,7 +29,7 @@
%
% **************************************************
\NeedsTeXFormat{LaTeX2e}
\ProvidesPackage{cleanthesis}[2015/08/26 v0.3.1 Clean-looking thesis style inspired by Apple's user guide documents]
\ProvidesPackage{cleanthesis}[2015/08/26 v0.3.1 A clean LaTeX style for thesis documents]
%
% **************************************************
% Package options
@@ -92,6 +92,10 @@
\define@choicekey*[ct]{cthesis}{bibstyle}[\val\bibstylenr]{alphabetic,numeric,authoryear}[alphabetic]{\def\cthesis@bibstyle{#1}}
\setkeys[ct]{cthesis}{bibstyle=alphabetic}
% OPTION wrapfooter
% --> values = true|false
\define@boolkey[ct]{cthesis}{wrapfooter}[false]{}
\setkeys[ct]{cthesis}{wrapfooter=false}
\DeclareOptionX*{
\PackageWarning{cleanthesis}{Unknown option \CurrentOption}%
@@ -228,10 +232,10 @@
% **************************************************
% Load Packages
% **************************************************
\RequirePackage{fixltx2e} % packages provides fixes to LaTeX2e
\RequirePackage{microtype} % typographic tuning
\RequirePackage{setspace} % for line spacing, e.g. \onehalfspacing
\RequirePackage[]{graphicx} % graphics import features
\RequirePackage{tabularx} % table features
\RequirePackage{fancyhdr} % for header and footer modifications
\RequirePackage{enumitem} % for simple list modifications
\RequirePackage{blindtext} % package for blind text
@@ -272,7 +276,7 @@
%
\RequirePackage[ % advanced quotes
strict=true, % - warning are errors now
style=german % - german quotes
style=english % - english quotes
]{csquotes}
%
\RequirePackage[ % use biblatex for bibliography
@@ -314,7 +318,7 @@
% **************************************************
\newenvironment{my_list}%
{\begin{enumerate}%
\setlength{\itemsep}{1pt}%
\setlength{\itemsep}{-1pt}%
\setlength{\parskip}{0pt}%
\setlength{\parsep}{0pt}%
}%
@@ -361,7 +365,11 @@
\footnotesize%
{\color{ctcolorfootermark}\textbf{\chaptername\ \thechapter}}%
\quad%
\ifct@cthesis@wrapfooter%
{\color{ctcolorfootertitle}\protect\parbox[t]{.7\textwidth}{#1}}%
\else%
{\color{ctcolorfootertitle}#1}%
\fi%
}{}%
}
\renewcommand{\sectionmark}[1]{%
@@ -626,6 +634,12 @@
% The tocloft package enables us to control the typographic design of the
% table of contents, list of figures and list of tables
\RequirePackage{tocloft}
% - fixes wrong fonts in the toc, thanks to magnucki
\renewcommand{\cftchapfont}{\usefont{T1}{bch}{b}{n}\selectfont}
\renewcommand{\cfttoctitlefont}{\thesischapterfont}
\renewcommand{\cftloftitlefont}{\thesischapterfont}
\renewcommand{\cftlottitlefont}{\thesischapterfont}
%
%
% > adjusts the indention for figure and table entries (lof and lot)
% -- \cftsetindents{entry}{indent}{numwidth} sets the entry's indent to

View File

@@ -1,4 +1,4 @@
% !TEX root = ../thesis-example.tex
% !TEX root = ../my-thesis.tex
%
\pdfbookmark[0]{Abstract}{Abstract}
\chapter*{Abstract}

View File

@@ -1,4 +1,4 @@
% !TEX root = ../thesis-example.tex
% !TEX root = ../my-thesis.tex
%
\pdfbookmark[0]{Acknowledgement}{Acknowledgement}
\chapter*{Acknowledgement}

View File

@@ -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]

View File

@@ -1,4 +1,4 @@
% !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}
\label{sec:concepts}

View File

@@ -1,4 +1,4 @@
% !TEX root = ../thesis-example.tex
% !TEX root = ../my-thesis.tex
%
\chapter{Conclusion}
\label{sec:conclusion}

View File

@@ -1,4 +1,4 @@
% !TEX root = ../thesis-example.tex
% !TEX root = ../my-thesis.tex
%
\chapter{Introduction}
\label{sec:intro}

View File

@@ -1,4 +1,4 @@
% !TEX root = ../thesis-example.tex
% !TEX root = ../my-thesis.tex
%
\chapter{Related Work}
\label{sec:related}

View File

@@ -1,4 +1,4 @@
% !TEX root = ../thesis-example.tex
% !TEX root = ../my-thesis.tex
%
\chapter{System}
\label{sec:system}

View File

@@ -1,4 +1,4 @@
% !TEX root = ../thesis-example.tex
% !TEX root = ../my-thesis.tex
%
\pagestyle{empty}
\hfill

View File

@@ -1,4 +1,4 @@
% !TEX root = ../thesis-example.tex
% !TEX root = ../my-thesis.tex
%
%************************************************
% Declaration

View File

@@ -1,4 +1,4 @@
% !TEX root = ../thesis-example.tex
% !TEX root = ../my-thesis.tex
%
% ------------------------------------ --> cover title page
\begin{titlepage}

Binary file not shown.

View File

@@ -25,6 +25,7 @@
\usepackage{booktabs}
\usepackage{shortvrb}
\usepackage{pifont}
\usepackage{graphicx}
\rcsid{$Id: cleanthesis.tex,v 0.3.1 2015/08/26 23:32:00 derric stable $}
@@ -34,7 +35,7 @@
\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},
@@ -43,7 +44,7 @@
\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}}
@@ -205,6 +206,15 @@ Sets whether to use an \texttt{alphabetic}, a \texttt{numeric}, or an \texttt{au
For further information please check out the biblatex documentation\footnote{\url{http://www.ctan.org/pkg/biblatex}}.
The default is \texttt{alphabetic}.
\begin{figure}[th!]
\includegraphics[width=\textwidth]{wrapfooter}
\caption{The package option \texttt{wrapfooter} can be used to wrap very long chapter titles in the footer.}\label{fig:wrapfooter}
\end{figure}
\boolitem[false]{wrapfooter}
Sets whether to wrap the name of a chapter in the footer or not (Figure \ref{fig:wrapfooter}).
\end{optionlist}
\end{document}

BIN
doc/wrapfooter.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

75
my-thesis-setup.tex Normal file
View File

@@ -0,0 +1,75 @@
% !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}{October 4, 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}{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,%
sansserif=false,%
hangfigurecaption=false,%
hangsection=true,%
hangsubsection=true,%
colorize=full,%
colortheme=bluemagenta,%
bibsys=bibtex,%
bibfile=bib-refs,%
bibstyle=alphabetic,%
wrapfooter=false,%
}{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 %
}

BIN
my-thesis.pdf Normal file

Binary file not shown.

104
my-thesis.tex Normal file
View File

@@ -0,0 +1,104 @@
% **************************************************
% 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}%
% **************************************************
% Setup YOUR thesis document in this file !
% **************************************************
\input{my-thesis-setup}
% **************************************************
% 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
% --------------------------
% Back matter
% --------------------------
\appendix\cleardoublepage
\input{content/chapter-appendix} % INCLUDE: appendix
%
{%
\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}

Binary file not shown.

View File

@@ -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}