Skip to content

Commit

Permalink
Restructuring template
Browse files Browse the repository at this point in the history
  • Loading branch information
koppor committed Dec 18, 2017
1 parent e8b747b commit ff56184
Show file tree
Hide file tree
Showing 11 changed files with 151 additions and 102 deletions.
8 changes: 7 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,16 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
### Fixed
- Remove outdated section "Using with your own git repository"

### Changed

- The main file for works is `main-german.tex` for German documents.
- No text content in sub files. Most users do not need the split. Advanced users can split the content by themselves.
- All configuration files put in the root folder.

## [1.3.0] - 2017-12-11

### Added
- New course "Medieninformatik"
- New course "Medieninformatik" (`medinf`)

### Fixed
- Translate float name of 'Algorithmus' environment in English thesis
Expand Down
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ editor = gedit


# Main file name
MASTER_TEX = ausarbeitung.tex
MASTER_TEX = main-german.tex
LITERATURE = bibliography.bib


Expand All @@ -26,7 +26,7 @@ AUX = $(SRC).aux

date=$(shell date +%Y%m%d%H%M)

# was wird gemacht, falls nur make aufgerufen wird
# was wird gemacht, falls nur make aufgerufen wird
#hier sollte noch der aspell check rein für jedes file einzeln über for schleife
all: $(PDF)
.PHONY: $(PDF)
Expand Down
49 changes: 25 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,11 @@
# LaTeX Template for Scientific Theses

This template is a general template for scientific theses.
Currently, it is the unoffical LaTeX template for Master, Bachelor, Diploma, and Student Theses at the University of Stuttgart, Computer Science.
It will be extended to support theses from different universities.
Currently, it is the unoffical LaTeX template for Master, Bachelor, Diploma, and Student Theses at following institutions:

- University of Stuttgart, Computer Science.

It will be extended to support theses from different institutions.

More information at <https://github.com/latextemplates/scientific-thesis-template>.

Expand Down Expand Up @@ -168,7 +171,7 @@ Edit `preambel/chapterheads.tex`.

- If you included some version control statements, please remove them. Currently, the template does not support any, but it used to support SVN.
- By using `\largepage` and `\shortpage`, single lines at the bottom or at the top of the page can be manually fixed.
- Search the PDF for "TODO" or similar things. Remove `\usepackage{todonotes}` in `preambel/packages_and_options`.
- Search the PDF for "TODO" or similar things. Remove `\usepackage{todonotes}` in `config.tex`.
- Ensure that you run `pdflatex` at least three times and that there are no "undefined references".
- The margins are intended for a duplex printing. **Do not change them** (or do exactly know what you are doing).

Expand Down Expand Up @@ -221,29 +224,27 @@ However, this style is not common in natural sciences and information science.

## Contained Files and Directories

* ausarbeitung.tex
### Directories

* `graphics` Directory containing the figures.
By using PDFLaTeX it is possible to use PDFs, JPGs, PNGs, ... We recommend to use PDFs to enable smooth scaling.

### Files

- `main-german.tex` - the start file for a German thesis
* Main file
* New chapters are added by using `\input`
* Add text here
* Adjust title etc. here
* Makefile: The Makefile.
* README.md: This file.
* uni-stuttgart-cs-cover.sty: Verbatim copy of uni-stuttgart-cs-cover.sty available at https://github.com/latextemplates/uni-stuttgart-computer-science-cover
* `bibliography.bib`. Bibliography. [biblatex] format. Manage it with [JabRef].
* content/: Place for the actual content
* content/einleitung.tex: First chapter: The introduction
* content/kapitel2.tex: Second chapter
* content/zusammenfassung`_`und`_`ausblick.tex: Conclusion and outlook.
* content/anhang.tex
* graphics/: Directory containing the figures.
By using PDFLaTeX it is possible to use PDFs, JPGs, PNGs, ... We recommend to use PDFs to enable smooth scaling.
* macros/: Directory for macros.
* macros/commands.tex: Example macros
* preambel/: Latex header of the document ("preambel" in latex)
* preambel/chapterheads.tex: Definition for the chapter headings.
* preambel/fonts.tex: Font selection
* preambel/margins.tex: Margin settings / Einstellung der Seitenränder
* preambel/packages`_`and`_`options.tex: Includes required packages and their options.
* preambel/pagestyle.tex: Defines the head and the foot of a page.
- `bibliography.bib`. Bibliography. [biblatex] format. Manage it with [JabRef].
- `acronyms.tex`: Abbreviations.
- `commands.tex`: Example macros
- `config.tex`: The place to add packages etc.

Following additional files are included, which do not need to be adapted:

- `Makefile`: The Makefile.
- `README.md` - explaining the template
- `uni-stuttgart-cs-cover.sty`: Verbatim copy of uni-stuttgart-cs-cover.sty available at https://github.com/latextemplates/uni-stuttgart-computer-science-cover

[biber]: https://www.ctan.org/pkg/biber
[biblatex]: http://tex.stackexchange.com/tags/biblatex/info
Expand Down
File renamed without changes.
17 changes: 1 addition & 16 deletions config.tex
Original file line number Diff line number Diff line change
Expand Up @@ -547,7 +547,7 @@
breaklinks=true,
colorlinks=true,
pdfstartview=Fit,
pdfpagelayout=TwoPageRight, % zweiseitige Darstellung: ungerade Seiten rechts im PDF-Viewer - siehe auch http://tex.stackexchange.com/a/21109/9075
%pdfpagelayout=TwoPageRight, % zweiseitige Darstellung: ungerade Seiten rechts im PDF-Viewer - siehe auch http://tex.stackexchange.com/a/21109/9075
filecolor=darkblue,
urlcolor=darkblue,
linkcolor=black,
Expand Down Expand Up @@ -714,21 +714,6 @@
\PassOptionsToPackage{language=english}{uni-stuttgart-cs-cover}
\fi

\usepackage[
title={Förderungswürdigkeit der F\"{o}rderung von Öl},
author={Lars K.},
type=bachelor,
institute=iaas,
course=se,
examiner={Prof.\ Dr.\ Uwe Fessor},
supervisor={Dipl.-Inf.\ Roman Tiker,\\Dipl.-Inf.\ Laura Stern,\\Otto Normalverbraucher,\ M.Sc.},
startdate={5.\ Juli 2013}, % English: July 5, 2013; ISO: 2013-07-05
enddate={5.\ Januar 2014}, % English: January 5, 2014; ISO: 2014-01-05
crk={I.7.2}
]{uni-stuttgart-cs-cover}
%
%%%


%%%
%Bugfixes packages
Expand Down
17 changes: 0 additions & 17 deletions content/einleitung.tex

This file was deleted.

11 changes: 0 additions & 11 deletions content/kapitel2.tex

This file was deleted.

8 changes: 0 additions & 8 deletions content/zusammenfassung_und_ausblick.tex

This file was deleted.

File renamed without changes.
137 changes: 114 additions & 23 deletions ausarbeitung.tex → main-german.tex
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
% !TeX spellcheck = de-DE
% !BIB program = biber
%


% vv scroll down to line 200 for content vv



\input{pre-documentclass}
\documentclass[
% fontsize=11pt is the standard
Expand All @@ -12,9 +19,24 @@
cleardoublepage=empty,
parskip=half,
% draft % um zu sehen, wo noch nachgebessert werden muss - wichtig, da Bindungskorrektur mit drin
final % ACHTUNG! - in pagestyle.tex noch Seitenstil anpassen
final
]{scrbook}
\input{config}


\usepackage[
title={Förderungswürdigkeit der F\"{o}rderung von Öl},
author={Lars K.},
type=bachelor,
institute=iaas,
course={Medieninformatik},
examiner={Prof.\ Dr.\ Uwe Fessor},
supervisor={Dipl.-Inf.\ Roman Tiker,\\Dipl.-Inf.\ Laura Stern,\\Otto Normalverbraucher,\ M.Sc.},
startdate={5.\ Juli 2013}, % English: July 5, 2013; ISO: 2013-07-05
enddate={5.\ Januar 2014} % English: January 5, 2014; ISO: 2014-01-05
]{uni-stuttgart-cs-cover}


\input{acronyms}

\makeindex
Expand Down Expand Up @@ -49,7 +71,7 @@
%\VerbatimFootnotes %verbatim text in Fußnoten erlauben. Geht normalerweise nicht.
\input{macros/commands}
\input{commands}
\pagenumbering{arabic}
\Titelblatt
Expand Down Expand Up @@ -134,42 +156,111 @@ \section*{Abstract}
% END: Verzeichnisse
% Headline and footline
\renewcommand*{\chapterpagestyle}{scrplain}
\pagestyle{scrheadings}
\pagestyle{scrheadings}
%ihead aufgeteilt - Bezeichnungen: 4.1, S. 119, scrguide
%für die Teilversionen - nur bei Verwendung von RCS/CVS
%\ihead[Version \RCSRevision]{Version \RCSRevision}
%Für die finale Version oder bei Verwendung von SVN
\ihead[]{}
% Sowohl für die Teilversionen als auch die finale Version:
\chead[]{}
\ohead[]{\headmark}
%
\cfoot[]{}
\ofoot[\usekomafont{pagenumber}\thepage]{\usekomafont{pagenumber}\thepage}
\ifoot[]{}
%% vv scroll down for content vv %%
%% vv scroll down for content vv %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Main content starts here
%
% ** Hier wird der Text eingebunden **
%
\input{content/einleitung}
%\input{...weitere Kapitel...}
\input{content/kapitel2}
\input{content/zusammenfassung_und_ausblick}
%
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\chapter{Einleitung}
In diesem Kapitel steht die Einleitung zu dieser Arbeit.
Sie soll nur als Beispiel dienen und hat nichts mit dem Buch \cite{WSPA} zu tun.
Nun viel Erfolg bei der Arbeit!
Bei \LaTeX\ werden Absätze durch freie Zeilen angegeben.
Da die Arbeit über ein Versionskontrollsystem versioniert wird, ist es sinnvoll, pro \emph{Satz} eine neue Zeile im \texttt{.tex}-Dokument anzufangen.
So kann einfacher ein Vergleich von Versionsständen vorgenommen werden.
\section*{Gliederung}
Die Arbeit ist in folgender Weise gegliedert:
\begin{description}
\item[Kapitel~\ref{chap:k2} -- \nameref{chap:k2}:] Hier werden werden die Grundlagen dieser Arbeit beschrieben.
\item[Kapitel~\ref{chap:zusfas} -- \nameref{chap:zusfas}] fasst die Ergebnisse der Arbeit zusammen und stellt Anknüpfungspunkte vor.
\end{description}
\chapter{Kapitel zwei}
\label{chap:k2}
Hier wird der Hauptteil stehen. Falls mehrere Kapitel gewünscht, entweder mehrmals \texttt{\textbackslash{}chapter} benutzen oder pro Kapitel eine eigene Datei anlegen und \texttt{ausarbeitung.tex} anpassen.
LaTeX-Hinweise stehen in \cref{chap:latextipps}.
%noch etwas Fülltext
\blinddocument
\chapter{Zusammenfassung und Ausblick}\label{chap:zusfas}
Hier bitte einen kurzen Durchgang durch die Arbeit.
\section*{Ausblick}
...und anschließend einen Ausblick
%\renewcommand{\appendixtocname}{Anhang}
%\renewcommand{\appendixname}{Anhang}
%\renewcommand{\appendixpagename}{Anhang}
\appendix
\input{content/latex-tipps}
\input{latex-hints-de}
\clearpage
Expand Down
2 changes: 2 additions & 0 deletions pre-documentclass.tex
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
% This file is loaded before the \documentclass command in the main document

% The following package allows \\ at the title page
% For more information see https://github.com/latextemplates/uni-stuttgart-cs-cover/issues/4
\RequirePackage{kvoptions-patch}
Expand Down

0 comments on commit ff56184

Please sign in to comment.