Compare commits
16 Commits
b0acd87f7e
...
8cbc99b6d0
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
8cbc99b6d0 | ||
|
|
68f9023c15 | ||
|
|
7a1892d4c1 | ||
|
|
acfe10fc0e | ||
|
|
49f6a1f4c1 | ||
|
|
3cb62681ee | ||
|
|
0d75c5e3ec | ||
|
|
647ee14980 | ||
|
|
61862e19c0 | ||
|
|
e20b5c86b7 | ||
|
|
5c3e4e3a86 | ||
|
|
c7ef7d203b | ||
|
|
a4f9d1967a | ||
|
|
bb885e3d7f | ||
|
|
43056bb5dc | ||
|
|
4c84bdc088 |
38
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
38
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
@@ -0,0 +1,38 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Describe the bug**
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
**To Reproduce**
|
||||
Steps to reproduce the behavior:
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
3. Scroll down to '....'
|
||||
4. See error
|
||||
|
||||
**Expected behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
**Screenshots**
|
||||
If applicable, add screenshots to help explain your problem.
|
||||
|
||||
**Desktop (please complete the following information):**
|
||||
- OS: [e.g. iOS]
|
||||
- Browser [e.g. chrome, safari]
|
||||
- Version [e.g. 22]
|
||||
|
||||
**Smartphone (please complete the following information):**
|
||||
- Device: [e.g. iPhone6]
|
||||
- OS: [e.g. iOS8.1]
|
||||
- Browser [e.g. stock browser, safari]
|
||||
- Version [e.g. 22]
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the problem here.
|
||||
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
@@ -0,0 +1,20 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen.
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
|
||||
**Additional context**
|
||||
Add any other context or screenshots about the feature request here.
|
||||
17
.github/workflows/build_pdf.yml
vendored
Normal file
17
.github/workflows/build_pdf.yml
vendored
Normal file
@@ -0,0 +1,17 @@
|
||||
# latex-action von Deutschsprachige Anwendervereinigung TeX e.V.
|
||||
# https://github.com/dante-ev/latex-action
|
||||
name: Build LaTeX document
|
||||
on:
|
||||
push:
|
||||
schedule:
|
||||
- cron: '0 0 2 * *'
|
||||
jobs:
|
||||
build_latex:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Set up Git repository
|
||||
uses: actions/checkout@v2
|
||||
- name: Compile LaTeX document
|
||||
uses: dante-ev/latex-action@latest
|
||||
with:
|
||||
root_file: htwsaar-i-mst-vorlage.tex
|
||||
278
.gitignore
vendored
Normal file
278
.gitignore
vendored
Normal file
@@ -0,0 +1,278 @@
|
||||
## Core latex/pdflatex auxiliary files:
|
||||
*.aux
|
||||
*.lof
|
||||
*.log
|
||||
*.lot
|
||||
*.fls
|
||||
*.out
|
||||
*.toc
|
||||
*.fmt
|
||||
*.fot
|
||||
*.cb
|
||||
*.cb2
|
||||
.*.lb
|
||||
|
||||
## Intermediate documents:
|
||||
*.dvi
|
||||
*.xdv
|
||||
*-converted-to.*
|
||||
# these rules might exclude image files for figures etc.
|
||||
# *.ps
|
||||
# *.eps
|
||||
# *.pdf
|
||||
|
||||
## Generated if empty string is given at "Please type another file name for output:"
|
||||
.pdf
|
||||
|
||||
## Bibliography auxiliary files (bibtex/biblatex/biber):
|
||||
*.bbl
|
||||
*.bcf
|
||||
*.blg
|
||||
*-blx.aux
|
||||
*-blx.bib
|
||||
*.run.xml
|
||||
|
||||
## Build tool auxiliary files:
|
||||
*.fdb_latexmk
|
||||
*.synctex
|
||||
*.synctex(busy)
|
||||
*.synctex.gz
|
||||
*.synctex.gz(busy)
|
||||
*.pdfsync
|
||||
|
||||
## Build tool directories for auxiliary files
|
||||
# latexrun
|
||||
latex.out/
|
||||
|
||||
## Auxiliary and intermediate files from other packages:
|
||||
# algorithms
|
||||
*.alg
|
||||
*.loa
|
||||
|
||||
# achemso
|
||||
acs-*.bib
|
||||
|
||||
# amsthm
|
||||
*.thm
|
||||
|
||||
# beamer
|
||||
*.nav
|
||||
*.pre
|
||||
*.snm
|
||||
*.vrb
|
||||
|
||||
# changes
|
||||
*.soc
|
||||
|
||||
# comment
|
||||
*.cut
|
||||
|
||||
# cprotect
|
||||
*.cpt
|
||||
|
||||
# elsarticle (documentclass of Elsevier journals)
|
||||
*.spl
|
||||
|
||||
# endnotes
|
||||
*.ent
|
||||
|
||||
# fixme
|
||||
*.lox
|
||||
|
||||
# feynmf/feynmp
|
||||
*.mf
|
||||
*.mp
|
||||
*.t[1-9]
|
||||
*.t[1-9][0-9]
|
||||
*.tfm
|
||||
|
||||
#(r)(e)ledmac/(r)(e)ledpar
|
||||
*.end
|
||||
*.?end
|
||||
*.[1-9]
|
||||
*.[1-9][0-9]
|
||||
*.[1-9][0-9][0-9]
|
||||
*.[1-9]R
|
||||
*.[1-9][0-9]R
|
||||
*.[1-9][0-9][0-9]R
|
||||
*.eledsec[1-9]
|
||||
*.eledsec[1-9]R
|
||||
*.eledsec[1-9][0-9]
|
||||
*.eledsec[1-9][0-9]R
|
||||
*.eledsec[1-9][0-9][0-9]
|
||||
*.eledsec[1-9][0-9][0-9]R
|
||||
|
||||
# glossaries
|
||||
*.acn
|
||||
*.acr
|
||||
*.glg
|
||||
*.glo
|
||||
*.gls
|
||||
*.glsdefs
|
||||
*.lzo
|
||||
*.lzs
|
||||
|
||||
# uncomment this for glossaries-extra (will ignore makeindex's style files!)
|
||||
# *.ist
|
||||
|
||||
# gnuplottex
|
||||
*-gnuplottex-*
|
||||
|
||||
# gregoriotex
|
||||
*.gaux
|
||||
*.gtex
|
||||
|
||||
# htlatex
|
||||
*.4ct
|
||||
*.4tc
|
||||
*.idv
|
||||
*.lg
|
||||
*.trc
|
||||
*.xref
|
||||
|
||||
# hyperref
|
||||
*.brf
|
||||
|
||||
# knitr
|
||||
*-concordance.tex
|
||||
# TODO Comment the next line if you want to keep your tikz graphics files
|
||||
# *.tikz
|
||||
*-tikzDictionary
|
||||
|
||||
# listings
|
||||
*.lol
|
||||
|
||||
# luatexja-ruby
|
||||
*.ltjruby
|
||||
|
||||
# makeidx
|
||||
*.idx
|
||||
*.ilg
|
||||
*.ind
|
||||
|
||||
# minitoc
|
||||
*.maf
|
||||
*.mlf
|
||||
*.mlt
|
||||
*.mtc[0-9]*
|
||||
*.slf[0-9]*
|
||||
*.slt[0-9]*
|
||||
*.stc[0-9]*
|
||||
|
||||
# minted
|
||||
_minted*
|
||||
*.pyg
|
||||
|
||||
# morewrites
|
||||
*.mw
|
||||
|
||||
# nomencl
|
||||
*.nlg
|
||||
*.nlo
|
||||
*.nls
|
||||
|
||||
# pax
|
||||
*.pax
|
||||
|
||||
# pdfpcnotes
|
||||
*.pdfpc
|
||||
|
||||
# sagetex
|
||||
*.sagetex.sage
|
||||
*.sagetex.py
|
||||
*.sagetex.scmd
|
||||
|
||||
# scrwfile
|
||||
*.wrt
|
||||
|
||||
# sympy
|
||||
*.sout
|
||||
*.sympy
|
||||
sympy-plots-for-*.tex/
|
||||
|
||||
# pdfcomment
|
||||
*.upa
|
||||
*.upb
|
||||
|
||||
# pythontex
|
||||
*.pytxcode
|
||||
pythontex-files-*/
|
||||
|
||||
# tcolorbox
|
||||
*.listing
|
||||
|
||||
# thmtools
|
||||
*.loe
|
||||
|
||||
# TikZ & PGF
|
||||
*.dpth
|
||||
*.md5
|
||||
*.auxlock
|
||||
|
||||
# todonotes
|
||||
*.tdo
|
||||
|
||||
# vhistory
|
||||
*.hst
|
||||
*.ver
|
||||
|
||||
# easy-todo
|
||||
*.lod
|
||||
|
||||
# xcolor
|
||||
*.xcp
|
||||
|
||||
# xmpincl
|
||||
*.xmpi
|
||||
|
||||
# xindy
|
||||
*.xdy
|
||||
|
||||
# xypic precompiled matrices and outlines
|
||||
*.xyc
|
||||
*.xyd
|
||||
|
||||
# endfloat
|
||||
*.ttt
|
||||
*.fff
|
||||
|
||||
# Latexian
|
||||
TSWLatexianTemp*
|
||||
|
||||
## Editors:
|
||||
# WinEdt
|
||||
*.bak
|
||||
*.sav
|
||||
|
||||
# Texpad
|
||||
.texpadtmp
|
||||
|
||||
# LyX
|
||||
*.lyx~
|
||||
|
||||
# Kile
|
||||
*.backup
|
||||
|
||||
# gummi
|
||||
.*.swp
|
||||
|
||||
# KBibTeX
|
||||
*~[0-9]*
|
||||
|
||||
# TeXnicCenter
|
||||
*.tps
|
||||
|
||||
# auto folder when using emacs and auctex
|
||||
./auto/*
|
||||
*.el
|
||||
|
||||
# expex forward references with \gathertags
|
||||
*-tags.tex
|
||||
|
||||
# standalone packages
|
||||
*.sta
|
||||
|
||||
# Makeindex log files
|
||||
*.lpz
|
||||
clear.bat
|
||||
htwsaar-i-mst-vorlage.tcp
|
||||
63
Bibliography.bib
Normal file
63
Bibliography.bib
Normal file
@@ -0,0 +1,63 @@
|
||||
% This file was created with JabRef 2.8.1.
|
||||
% Encoding: Cp1252
|
||||
|
||||
@BOOK{bentley:1999,
|
||||
title = {{P}rogramming {P}earls},
|
||||
publisher = {Addison--Wesley},
|
||||
year = {1999},
|
||||
author = {Jon Bentley}
|
||||
}
|
||||
|
||||
@BOOK{bringhurst:2002,
|
||||
title = {{T}he {E}lements of {T}ypographic {S}tyle},
|
||||
publisher = {Hartley \& Marks Publishers},
|
||||
year = {2008},
|
||||
author = {Robert Bringhurst}
|
||||
}
|
||||
|
||||
@BOOK{cormen:2001,
|
||||
title = {{I}ntroduction to {A}lgorithms},
|
||||
publisher = {The MIT Press},
|
||||
year = {2001},
|
||||
author = {Cormen, Thomas H. and Leiserson, Charles E. and Rivest, Ronald L.
|
||||
and Clifford Stein}
|
||||
}
|
||||
|
||||
@BOOK{dueck:trio,
|
||||
title = {{D}uecks {T}rilogie: {O}mnisophie -- {S}upramanie -- {T}opothesie},
|
||||
publisher = {Springer},
|
||||
year = {2005},
|
||||
author = {Gunter Dueck},
|
||||
note = {\url{http://www.omnisophie.com}}
|
||||
}
|
||||
|
||||
@ARTICLE{knuth:1976,
|
||||
author = {Knuth, Donald E.},
|
||||
title = {{B}ig {O}micron and {B}ig {O}mega and {B}ig {T}heta},
|
||||
journal = {SIGACT News},
|
||||
year = {1976},
|
||||
volume = {8},
|
||||
pages = {18--24},
|
||||
number = {2},
|
||||
publisher = {ACM Press}
|
||||
}
|
||||
|
||||
@ARTICLE{knuth:1974,
|
||||
author = {Knuth, Donald E.},
|
||||
title = {{C}omputer {P}rogramming as an {A}rt},
|
||||
journal = {Communications of the ACM},
|
||||
year = {1974},
|
||||
volume = {17},
|
||||
pages = {667--673},
|
||||
number = {12},
|
||||
publisher = {ACM Press}
|
||||
}
|
||||
|
||||
@BOOK{sommerville:1992,
|
||||
title = {{S}oftware {E}ngineering},
|
||||
publisher = {Addison-Wesley},
|
||||
year = {1992},
|
||||
author = {Ian Sommerville},
|
||||
address = {Boston, MA, USA}
|
||||
}
|
||||
|
||||
10
Chapters/Anhang-A.tex
Normal file
10
Chapters/Anhang-A.tex
Normal file
@@ -0,0 +1,10 @@
|
||||
%********************************************************************
|
||||
% Appendix
|
||||
%*******************************************************
|
||||
\chapter{Erster Abschnitt des Anhangs}
|
||||
In den Anhang gehören "`Hintergrundinformationen"', also weiterführende Information, ausführliche Listings, Graphen, Diagramme oder Tabellen, die den Haupttext mit detaillierten Informationen ergänzen.
|
||||
|
||||
\blindtext
|
||||
\blindtext
|
||||
\blindtext
|
||||
|
||||
15
Examples/Beispiele.tex
Normal file
15
Examples/Beispiele.tex
Normal file
@@ -0,0 +1,15 @@
|
||||
%*****************************************
|
||||
\chapter{Beispiele}\label{ch:examples}
|
||||
%*****************************************
|
||||
|
||||
\input{Examples/Beispiele/Acronyme}
|
||||
\input{Examples/Beispiele/Biblatex}
|
||||
\input{Examples/Beispiele/Referenzierung}
|
||||
\input{Examples/Beispiele/DateienEinbinden}
|
||||
\input{Examples/Beispiele/Tabellen}
|
||||
\input{Examples/Beispiele/Abbildungen}
|
||||
\input{Examples/Beispiele/Listings}
|
||||
\input{Examples/Beispiele/Formeln}
|
||||
\input{Examples/Beispiele/Todonotes}
|
||||
|
||||
|
||||
76
Examples/Beispiele/Abbildungen.tex
Normal file
76
Examples/Beispiele/Abbildungen.tex
Normal file
@@ -0,0 +1,76 @@
|
||||
\section{Abbildungen}
|
||||
%=============================
|
||||
|
||||
\textit{LaTeX} unterstützt generell die Formate \textit{*.jpeg}, \textit{*.png} und \textit{*.pdf}.
|
||||
Handelt es sich z.B. um Strichgrafiken oder skalierbare Farbflächen, sollte \textit{*.pdf} die erste Wahl sein,
|
||||
da sich in diesem Format Vektorgrafiken ohne Qualitätsverlust darstellen bzw. skalieren lassen.
|
||||
|
||||
\begin{figure}[bth]
|
||||
\centering
|
||||
\includegraphics[width=0.7\textwidth]{Examples/example_5.png}
|
||||
\caption{Erstes Bild, Völklinger Hütte}
|
||||
\label{fig:Huette}
|
||||
\end{figure}
|
||||
|
||||
|
||||
\subsection{Wrapfigure}
|
||||
Abbildung~\ref{fig:Huette} ist zwar ganz nett anzusehen, aber vielleicht sähe es eleganter aus, wenn die Abbildung
|
||||
von unserem Textabschnitt umflossen werden würde. Diese Art von Abbildungen sollte jedoch sparsam und mit großer Sorgfalt eingesetzt werden, da es zu unschönen Darstellungen kommen kann.
|
||||
\blindtext
|
||||
\begin{wrapfigure}{l}{0.4\textwidth}
|
||||
\centering
|
||||
\includegraphics[width=0.4\textwidth]{Examples/example_5.jpg}
|
||||
\caption{Völklinger Hütte, *.jpg}
|
||||
\label{fig:Huette2}
|
||||
\end{wrapfigure}
|
||||
\blindtext
|
||||
|
||||
|
||||
\subsection{Subfigures}
|
||||
Es ist ebenso möglich, mehrere Abbildungen nebeneinander zu setzen, wie in Abbildung~\ref{fig:Beide} zu sehen ist. Eine separate Referenzierung ist auch möglich: Abbildung~\ref{subfig:abbone}.
|
||||
\begin{figure}[bth]
|
||||
\subfloat[Erstes ...]{\includegraphics[width=0.49\textwidth]{Examples/example_5.png}\label{subfig:abbone}}\hfill
|
||||
\subfloat[... und zweites Bild]{\includegraphics[width=0.49\textwidth]{Examples/example_5.png}\label{subfig:abbtwo}}
|
||||
\caption{Mehrere Abbildungen nebeneinander}
|
||||
\label{fig:Beide}
|
||||
\end{figure}
|
||||
|
||||
|
||||
\subsection{Qualitätsunterschiede}
|
||||
\begin{figure}[p]
|
||||
\centering
|
||||
\subfloat[\textit{PDF}-Format]{\includegraphics[width=0.65\textwidth]{Examples/bpmn.pdf}} \\
|
||||
\subfloat[\textit{JPG}-Format]{\includegraphics[width=0.65\textwidth]{Examples/bpmn.jpg}}
|
||||
\caption{Beide Formate im Vergleich}
|
||||
\label{fig:pdfvsjpg}
|
||||
\end{figure}
|
||||
|
||||
\begin{figure}[p]
|
||||
\centering
|
||||
\includegraphics[width=0.65\textwidth]{Examples/jabref.png}
|
||||
\caption{\textit{PNG}-Format}
|
||||
\label{fig:pngvsjpg1}
|
||||
\end{figure}
|
||||
|
||||
\begin{figure}[p]
|
||||
\centering
|
||||
\includegraphics[width=0.65\textwidth]{Examples/jabref.jpg}
|
||||
\caption{\textit{JPG}-Format}
|
||||
\label{fig:pngvsjpg2}
|
||||
\end{figure}
|
||||
|
||||
Leider haben die unterschiedlichen Grafikformate bedingt durch die unterschiedlichen Kompressionsverfahren einige Schwächen, insbesondere die Umwandlung in das \textit{JPG}-Format erzeugt unangenehme Artefakte im Bild. \autoref{fig:pdfvsjpg} zeigt die Unterschiede zwischen \textit{PDF-Format} und \textit{JPG-Format} im Vergleich.
|
||||
|
||||
Wenn eine \textit{*.pdf}-Datei nicht infrage kommt, beispielsweise bei Screenshots, ist unbedingt das \textit{PNG-Format} vorzuziehen.
|
||||
Den Unterschied machen \autoref{fig:pngvsjpg1} und \autoref{fig:pngvsjpg2} deutlich.
|
||||
|
||||
"`Faustregeln"' im Umgang mit Abbildungen:
|
||||
\begin{itemize}
|
||||
\item Diagramme bzw. alles, was Linien usw. enthält: \textit{PDF} (im Vektorformat).
|
||||
\item Screenshots bzw. alles, was größere gleichfarbige Flächen enthält: \textit{PNG}.
|
||||
\item Der Rest (in der Regel Fotos): \textit{JPEG}.
|
||||
\end{itemize}
|
||||
|
||||
|
||||
|
||||
|
||||
12
Examples/Beispiele/Acronyme.tex
Normal file
12
Examples/Beispiele/Acronyme.tex
Normal file
@@ -0,0 +1,12 @@
|
||||
%************************************************
|
||||
%* Abkürzungen *********************************
|
||||
%************************************************
|
||||
|
||||
\section{Abkürzungen}
|
||||
|
||||
Um Abkürzungen zu verwenden, muss über \lstinline|\usepackage{acronym}| das benötigte Package geladen werden. Danach kann man lange Begriffe ganz bequem abkürzen:
|
||||
|
||||
So muss man nicht ständig \ac{WLAN} ausschreiben, auch \ac{TCP} lässt sich abkürzen. Würde man im Text \acs{WLAN} oft verwenden, kann man sie, wie hier, nur als
|
||||
Abkürzung anzeigen lassen - oder bei Bedarf die Erklärung mitliefern (\acf{WLAN}). Weiteres Beispiel könnte die \ac{GoF} sein.
|
||||
|
||||
Weitere Informationen sind im \href{http://www.ctan.org/tex-archive/macros/latex/contrib/acronym}{Acronym-Manual} zu finden.
|
||||
24
Examples/Beispiele/Biblatex.tex
Normal file
24
Examples/Beispiele/Biblatex.tex
Normal file
@@ -0,0 +1,24 @@
|
||||
%*********************************************
|
||||
%* Biblatex-Beispiel
|
||||
%*********************************************
|
||||
\section{Beispiel für BibLaTeX}
|
||||
|
||||
BibLaTeX ist ein Package, das einem die Arbeit mit Zitaten bzw. Quellenangaben erleichtern kann. Mit JabRef (\autoref{sec:Werkzeuge}) ist es möglich
|
||||
\textit{*.bib}-Dateien zu erstellen, in denen alle Angaben zu Autor, Buchtitel, Erscheinungsdatum usw. hinterlegt werden, welche zum passenden Zeitpunkt
|
||||
abgerufen werden können. Das Literaturverzeichnis wird mittels \lstinline{\printbibliography} ausgegeben.
|
||||
|
||||
Im Allgemeinen wird im Literaturverzeichnis auch nur jene Literatur aufgenommen, die auch in der \textit{*.tex}-Datei referenziert wird. Danach ist es wichtig
|
||||
nicht nur mit \textit{Pdf\-LaTeX}, sondern auch mit \textit{BibLaTeX} zu kompilieren, damit die zitierten Einträge in die verschiedenen Hilfsdateien aufgenommen
|
||||
werden können. %Hinweis: Pdf\-LaTeX teilt LaTeX mit, dass nur zwischen Pdf und LaTeX getrennt werden darf
|
||||
|
||||
|
||||
\subsection*{Einige Zitate}
|
||||
In diesem Satz könnten wir auf \cite{knuth:1976} verweisen, ebenso auf das wichtige Werk \cite{dueck:trio}. Wenn uns das nicht genug ist, sollten wir das anmerken,
|
||||
was in \cite{sommerville:1992} geschrieben wurde. Im Zweifelsfall verweisen wir auf eine einzelne Seite, wie in \cite[112]{bentley:1999} zu finden.
|
||||
|
||||
Üblicherweise wird auch der Name des Autors bzw. der Autoren genannt, also beispielsweise bei einem Verweis auf \citeauthor{knuth:1976} \cite{knuth:1976} oder
|
||||
auch bei mehreren Autoren \citeauthor{cormen:2001} \cite{cormen:2001}. LaTeX stellt Mechanismen zur Verfügung, auch dies automatisiert zu erledigen.
|
||||
|
||||
|
||||
|
||||
|
||||
10
Examples/Beispiele/DateienEinbinden.tex
Normal file
10
Examples/Beispiele/DateienEinbinden.tex
Normal file
@@ -0,0 +1,10 @@
|
||||
\section{Dateien einbinden}
|
||||
|
||||
Damit man nicht alle Einstellungen, Optionen, Packages und Texte, Abbildungen etc. in einer Datei unterbringen muss, werden
|
||||
zwei Befehle bereitgestellt, um externe \textit{*.tex}-Dateien einzubinden: \lstinline|\include{PFAD}| und \lstinline|\input{PFAD}|.
|
||||
Mit dem erstem Befehl wird eine neue Seite angelegt, danach kommen die Inhalte aus der angegebenen Datei; mit dem zweiten
|
||||
Befehl wird keine neue Seite angelegt -- der Inhalt der angegebenen Datei wird direkt an die betroffene Stelle eingefügt.
|
||||
|
||||
\textbf{Wichtig:} Der \textit{Pfad} wird sinnigerweise \textit{relativ} angegeben, wobei als Stammverzeichnis jenes Verzeichnis
|
||||
angesehen wird, in dem die \textit{*.tex}-Datei mit der \textit{Document}-Umgebung abgelegt ist (in diesem Fall ist es
|
||||
\textit{htwsaar-i-mst-config.tex}).
|
||||
76
Examples/Beispiele/Formeln.tex
Normal file
76
Examples/Beispiele/Formeln.tex
Normal file
@@ -0,0 +1,76 @@
|
||||
\section{Mathematische Ausdrücke}
|
||||
Mathematische Ausdrücke sind eine kleine Kunst für sich. Am allereinfachsten kann man eine Formel, wie \(a + b = c\) in den Fließtext einbinden, wobei LaTeX die Höhe der Ausdrücke der Zeile anpasst,
|
||||
wie hier zu sehen \(\sum_{y=0}^{x} a\) . In einer Umgebung sieht das schon anders aus:
|
||||
\begin{equation}
|
||||
\sum_{y=0}^{x} a
|
||||
\end{equation}
|
||||
|
||||
Griechische Buchstaben:
|
||||
\begin{equation}
|
||||
\alpha\beta\gamma\delta\epsilon\varepsilon\zeta\eta
|
||||
\theta\iota\kappa\lambda\mu\nu\xi\pi\varpi\rho\varrho
|
||||
\sigma\tau\upsilon\phi\varphi\chi\psi\omega
|
||||
\end{equation}
|
||||
|
||||
Brüche:
|
||||
\begin{equation}
|
||||
Ergebnis = \frac{a}{b}
|
||||
\end{equation}
|
||||
|
||||
\begin{equation}
|
||||
\frac{\sin{\alpha}^2 + \cos{\alpha}^2}{1} = 1
|
||||
\end{equation}
|
||||
|
||||
\begin{equation}
|
||||
\frac{-9x}{\frac{2y}{3z+2}}
|
||||
\end{equation}
|
||||
|
||||
Text innerhalb von Formeln:
|
||||
\begin{equation}
|
||||
\sum_{y=1}^{n} y = \frac{n*(n+1)}{2}
|
||||
\quad
|
||||
\text{Gaußsche Summenformel}
|
||||
\end{equation}
|
||||
|
||||
Hoch- bzw. Tiefstellungen:
|
||||
\begin{equation}
|
||||
x_{i,j}^2
|
||||
\end{equation}
|
||||
|
||||
\begin{equation}
|
||||
{x_{i,j}}^2
|
||||
\end{equation}
|
||||
|
||||
\begin{equation}
|
||||
x_{n_0}
|
||||
\end{equation}
|
||||
|
||||
|
||||
Matrizen:
|
||||
Matrizen werden innerhalb der mathematischen Umgebung als wiederum neue Umgebung eingebunden. Wie bei Tabellen auch werden Zeilen durch \lstinline{\\} und Spalten durch \lstinline{&} getrennt.
|
||||
|
||||
\begin{equation}
|
||||
\begin{pmatrix}
|
||||
a&b\\
|
||||
c&d
|
||||
\end{pmatrix}
|
||||
\end{equation}
|
||||
|
||||
\begin{equation}
|
||||
\begin{vmatrix}
|
||||
a&b\\
|
||||
c&d
|
||||
\end{vmatrix}
|
||||
\end{equation}
|
||||
|
||||
Fallunterscheidung:
|
||||
\begin{equation}
|
||||
f(x) =
|
||||
\begin{cases}
|
||||
0, &\text{falls } x < 0 \\
|
||||
1, &\text{falls } x \geq 0
|
||||
\end{cases}
|
||||
\end{equation}
|
||||
|
||||
|
||||
|
||||
25
Examples/Beispiele/Listings.tex
Normal file
25
Examples/Beispiele/Listings.tex
Normal file
@@ -0,0 +1,25 @@
|
||||
%*******************************
|
||||
% Listings *
|
||||
%*******************************
|
||||
|
||||
\section{Quellcode einbinden}
|
||||
Das Package \textit{lstlisting} ermöglicht es, Quellcode ansprechend in das Dokument einzubinden. Man kann Quellcode einzeilig einbinden
|
||||
mittels \lstinline{\lstinline|Quellcode|}. Dabei ist darauf zu achten, dass der Befehl einmal mit \{ \} und einmal mit | | aufgerufen werden kann, je nachdem,
|
||||
welche Zeichen im angegebenen Quelltext genutzt werden.
|
||||
Es ist auch möglich eine eigene Umgebung für Quelltext zu schaffen:
|
||||
|
||||
\begin{lstlisting}[caption=Erstes Listing,style=Java]
|
||||
private Umgebung(int i, int k)
|
||||
{
|
||||
System.out.println("Eine Funktion mit " + i + "und" + k ".");
|
||||
}
|
||||
\end{lstlisting}
|
||||
|
||||
Wer Quelltext aus externen Dateien einbinden möchte, geht wie folgt vor:
|
||||
|
||||
\lstinputlisting
|
||||
[caption={Externer Quellcode},style=Java]
|
||||
{Examples/Code.java}
|
||||
|
||||
Wie genau der Quellcode formatiert und gefärbt ist, ist in \textit{htwsaar.i.mst.config.tex} hinterlegt, wobei fü verschiedene Sprachen auch eigene Styles angelegt werden
|
||||
können (hier z.B. für Java).
|
||||
12
Examples/Beispiele/Referenzierung.tex
Normal file
12
Examples/Beispiele/Referenzierung.tex
Normal file
@@ -0,0 +1,12 @@
|
||||
\section{Referenzierungen}
|
||||
Mit Referenzierungen kann ich ganz bequem auf Textpassagen, Kapitel, Sections oder Abbildungen im weiteren Text verweisen.
|
||||
Dies ist ein Verweis auf \autoref{subsec:Beispieltext}, der sich auf \autoref{subsec:Beispieltext} befindet.
|
||||
|
||||
Auch ein Verweis auf \autoref{tab:beispieltabelle1} auf Seite~\pageref{tab:beispieltabelle1} ist möglich.
|
||||
|
||||
Man sollte beachten, dass man sein Dokument, wenn es Referenzierungen enthält, mehrmals kompiliert, da sonst manche
|
||||
Verweise nicht aufgelöst werden können.
|
||||
|
||||
|
||||
\subsection{Beispieltext}\label{subsec:Beispieltext}
|
||||
\blindtext
|
||||
105
Examples/Beispiele/Tabellen.tex
Normal file
105
Examples/Beispiele/Tabellen.tex
Normal file
@@ -0,0 +1,105 @@
|
||||
%************************
|
||||
%* Tabellen *
|
||||
%************************
|
||||
|
||||
\section{Tabellen}
|
||||
\label{sec:Tabellen}
|
||||
|
||||
\subsection{Einfache Tabelle}
|
||||
In LaTeX lassen sich Tabellen unterschiedlicher Ausprägung einfach erzeugen. Das allgemeine Format einer Tabelle sieht aus wie folgt:
|
||||
|
||||
\begin{lstlisting}[caption={Allgemeines Format}]
|
||||
\begin{table}
|
||||
\caption{BESCHRIFTUNG}
|
||||
\begin{tabular}{FORMATIERUNG}
|
||||
TABELLENINHALT
|
||||
\end{tabular}
|
||||
\end{table}
|
||||
\end{lstlisting}
|
||||
|
||||
Eine Beispieltabelle (Tabelle \ref{tab:beispieltabelle1}) könnte also so aussehen:
|
||||
|
||||
\begin{lstlisting}[caption={Tabelle \ref{tab:beispieltabelle1}}]
|
||||
\begin{table}
|
||||
\caption{Beispiel 1}
|
||||
\begin{tabular}{lrcr}
|
||||
\toprule
|
||||
\textbf{Name} & \textbf{Vorname} & \textbf{Matrikelnummer} & \textbf{Lieblingsspeise}\\
|
||||
\midrule
|
||||
Jackson & Michael & 123456 & Erdbeereis \\
|
||||
Springsteen & Bruce & 234567 & Schwedisches Lakritz \\
|
||||
Bach & Anna, Magdalena & 3456789 & Frankfurter Kranz \\
|
||||
Schumann & Clara & 4567890 & Bisquitt\"ortchen \\
|
||||
\bottomrule
|
||||
\end{tabular}
|
||||
\label{tab:beispieltabelle1}
|
||||
\end{table}
|
||||
\end{lstlisting}
|
||||
|
||||
Mit \lstinline|\caption{Beispiel 1}| bekommt unsere Tabelle eine Beschriftung am Tabellenkopf. \lstinline{l|r|c|r} legt die Textausrichtung der einzelnen Spalten fest: \lstinline|l| bedeutet linksausgerichtet, \lstinline|r| rechtsausgerichtet und \lstinline|c| zentriert. Durch \lstinline{|} werden Spaltenlinien gezogen. \lstinline|\toprule|, \lstinline|\midrule| und \lstinline|\bottomrule| erzeugen Kopf-, Mittel- und Abschlusslinie in der Tabelle. Als Spaltentrenner wird das \lstinline{&} genutzt, Zeilentrenner ist der doppelte Backslash (\lstinline|\\|). Am Ende kann die Tabelle auch mit einem Label versehen werden (\lstinline|\label{tab:beispieltabelle1}|), über welches diese referenziert wird.
|
||||
|
||||
%\begin{center}
|
||||
\begin{table}[b]
|
||||
|
||||
\caption{Beispiel 1}
|
||||
\begin{tabular}{lrcr}
|
||||
\toprule
|
||||
\textbf{Name} & \textbf{Vorname} & \textbf{Matrikelnummer} & \textbf{Lieblingsspeise}\\
|
||||
\midrule
|
||||
Jackson & Michael & 123456 & Erdbeereis \\
|
||||
Springsteen & Bruce & 234567 & Schwedisches Lakritz \\
|
||||
Bach & Anna, Magdalena & 3456789 & Frankfurter Kranz \\
|
||||
Schumann & Clara & 4567890 & Bisquittörtchen \\
|
||||
\bottomrule
|
||||
\end{tabular}
|
||||
\label{tab:beispieltabelle1}
|
||||
\end{table}
|
||||
%\end{center}
|
||||
|
||||
\subsection{Erweiterte Tabellenbefehle}
|
||||
Um Tabellen in LaTeX flexibler zu gestalten gibt es weitere Befehle bzw. zusätzliche Pakete, die einem das Leben leichter machen (Tabelle \ref{tab:beispieltabelle2}). Hierzu ein weiteres Beispiel:
|
||||
|
||||
\begin{lstlisting}[caption={Tabelle \ref{tab:beispieltabelle2}}]
|
||||
\begin{table}
|
||||
\centering
|
||||
\caption{Beispiel 2}
|
||||
\begin{tabular}{lll}
|
||||
\hline
|
||||
Author & Title & Year \\
|
||||
\hline
|
||||
\hline
|
||||
\multirow{3}{*}{Stanislav Lem} & Solaris & 1961 \\
|
||||
& Roboterm\"archen & 1967 \\
|
||||
& Der futurologische Kongress & 1971 \\
|
||||
\hline
|
||||
\multirow{3}{*}{Isaac Asimov} & Ich, der Robot & 1952 \\
|
||||
& Der Tausendjahresplan & 1966 \\
|
||||
& Doctor Schapirows Gehirn & 1988 \\
|
||||
\hline
|
||||
\end{tabular}
|
||||
\label{tab:beispieltabelle2}
|
||||
\end{table}
|
||||
\end{lstlisting}
|
||||
|
||||
Mit \lstinline|\centering| wird die Tabelle zentriert ausgerichtet, analoge Befehle für rechts- bzw. linksausrichtung sind z.B. \lstinline|\raggedleft| und \lstinline|\raggedright|. \\
|
||||
|
||||
Eine weitere Form der Tabellen ist das Package \textit{tabularx}, das variable Spaltenbreiten unterstützt, und \textit{booktabs}, welches mit horizontalen Linien besser arbeiten kann.
|
||||
\begin{table}
|
||||
\centering
|
||||
\caption{So sollte man es nicht machen! Beispiel für einen schlechten Tabellenstil}
|
||||
\begin{tabular}{|l|l|l|}
|
||||
\hline
|
||||
Author & Title & Year \\
|
||||
\hline
|
||||
\hline
|
||||
\multirow{3}{*}{Stanislav Lem} & Solaris & 1961 \\
|
||||
& Robotermärchen & 1967 \\
|
||||
& Der futurologische Kongress & 1971 \\
|
||||
\hline
|
||||
\multirow{3}{*}{Isaac Asimov} & Ich, der Robot & 1952 \\
|
||||
& Der Tausendjahresplan & 1966 \\
|
||||
& Doctor Schapirows Gehirn & 1988 \\
|
||||
\hline
|
||||
\end{tabular}
|
||||
\label{tab:beispieltabelle2}
|
||||
\end{table}
|
||||
51
Examples/Beispiele/Todonotes.tex
Normal file
51
Examples/Beispiele/Todonotes.tex
Normal file
@@ -0,0 +1,51 @@
|
||||
%############################################################
|
||||
\clearpage\section{To-Do-Notes}
|
||||
Um bei einer längeren Arbeit nicht den Überblick zu verlieren, an welcher Stelle es nötig ist
|
||||
weiter zu arbeiten, bietet es sich an, kleine Notizen einzufügen. Das Package \textit{todonotes}
|
||||
stellt eine elegante Lösung bereit, um differenziert und vielfarbig jene Abschnitte zu kennzeichnen,
|
||||
die einer weiteren Bearbeitung bedürfen.
|
||||
|
||||
\subsection*{Beispiel für To-Do-Notes}
|
||||
Dies hier ist ein Blindtext zum Testen von Textausgaben. Wer diesen Text liest, ist selbst
|
||||
\todo{Plain todonotes.} schuld. Der Text gibt lediglich den Grauwert der Schrift an. Ist das wirklich so? Ist es
|
||||
gleichgültig, ob ich schreibe: Dies ist ein Blindtext? oder Huardest gefburn? Kjift?
|
||||
mitnichten! Ein Blindtext bietet mir wichtige Informationen. An ihm messe ich die Les-
|
||||
barkeit einer Schrift, ihre Anmutung, \todo{Plain todonotes.}wie harmonisch die Figuren zueinander stehen
|
||||
und prüfe, wie breit oder schmal sie läuft. Ein Blindtext sollte möglichst viele verschie-
|
||||
dene Buchstaben enthalten und in der Originalsprache gesetzt sein. Er muss keinen
|
||||
Sinn ergeben, sollte aber lesbar sein.\todo[nolist]{Todonote that is only shown in the margin and not in
|
||||
the list of todos.}%
|
||||
Fremdsprachige Texte wie Lorem ipsum dienen
|
||||
nicht dem eigentlichen Zweck, da sie eine falsche Anmutung vermitteln. Dies hier ist
|
||||
ein Blindtext zum Testen von Textausgaben. Wer diesen Text liest, ist selbst schuld.
|
||||
|
||||
\todo[inline]{A very long todonote that certainly will fill more
|
||||
than a single line in the list of todos. Just to make sure let's add
|
||||
some more text \ldots}
|
||||
|
||||
Der Text gibt lediglich den Grauwert der Schrift an. Ist das wirklich so? Ist es gleichgültig,
|
||||
ob ich schreibe: Dies ist ein Blindtext? oder Huardest gefburn? Kjift? mitnichten!
|
||||
\todo[noline]{A note with no line back to the text.}
|
||||
Ein Blindtext bietet mir wichtige Informationen. An ihm messe ich die Lesbarkeit einer
|
||||
Schrift, ihre Anmutung, wie harmonisch die Figuren zueinander stehen und prüfe, wie
|
||||
\todo[caption={A short entry in the list of todos}]{A very long
|
||||
todonote that certainly will fill more than a single line in the
|
||||
list of todos \ldots}
|
||||
breit oder schmal sie läuft. Ein Blindtext sollte möglichst viele verschiedene Buchstaben
|
||||
enthalten und in der Originalsprache gesetzt sein. Er muss keinen Sinn ergeben, sollte
|
||||
aber lesbar sein. Fremdsprachige Texte wie Lorem ipsum dienen nicht dem eigentlichen Zweck,
|
||||
da sie eine falsche Anmutung vermitteln.
|
||||
\missingfigure{A figure I have to make \ldots}
|
||||
|
||||
%Nummerierte ToDo-Notes
|
||||
\todox{Erste Nummer...}
|
||||
\todox{Zweite Nummer...}
|
||||
|
||||
%Alles To-Dos als Liste ausgegeben
|
||||
Nachfolgend wird noch eine Liste aller To-Dos auf einer separaten
|
||||
Seite ausgegeben.
|
||||
%\begingroup
|
||||
%\let\clearpage\relax
|
||||
%\let\cleardoublepage\relax
|
||||
\listoftodos
|
||||
%\endgroup
|
||||
5
Examples/Code.java
Normal file
5
Examples/Code.java
Normal file
@@ -0,0 +1,5 @@
|
||||
public class HalloWelt {
|
||||
public static void main(String[] args) {
|
||||
System.out.println("Hallo Welt!");
|
||||
}
|
||||
}
|
||||
110
Examples/Einleitung.tex
Normal file
110
Examples/Einleitung.tex
Normal file
@@ -0,0 +1,110 @@
|
||||
%=========================================
|
||||
% Einleitung =
|
||||
%=========================================
|
||||
\chapter{Einleitung}
|
||||
|
||||
\section{\LaTeX\ installieren und einrichten}
|
||||
\subsection{Unter Windows}
|
||||
|
||||
Als LaTeX-Distribution unter Windows steht \href{http://www.miktex.org/}{\textit{MikTeX}} zu Verfügung, die als freie Software im Internet erhältlich ist.
|
||||
\textit{MikTeX} unterstützt Windows XP, Vista und Windows 7. Neben \textit{MikTeX} wird noch ein PostScript-Interpreter benötigt,
|
||||
z.B. GhostScript, zu finden auf \href{http://www.chip.de}{Chip.de}.
|
||||
|
||||
\textit{Wichtig:} Bei \textit{MikTeX} unbedingt Vollinstallation auswählen, sonst sind eventuell benötigte Packages nicht vorhanden.
|
||||
|
||||
\subsection{Unter Linux}
|
||||
|
||||
Unter Linux existiert die LaTeX-Distribution \textit{texlive}, die als aktuelle Version aus den Paketquellen geladen werden kann (unter Ubuntu mit
|
||||
\lstinline{apt-get install texlive-full}). Auch hier ist ganz wichtig, die volle Distribution zu laden, damit alle Packages zur Verfügung stehen.
|
||||
|
||||
\section{Entwicklungsumgebungen}
|
||||
|
||||
Hat man die passende Distribution installiert, bieten sich vielerlei Möglichkeiten an ein LaTeX-Projekt anzugehen oder einzelne Dokumente zu editieren. Unter
|
||||
Windows könnten dies folgende sein:
|
||||
|
||||
\begin{description}
|
||||
\item [TeXnicCenter] Umfangreiche Entwicklungsumgebung mit Projektorganisation und Autovervollständigung
|
||||
\item [TeXLipse] Eclipse-Plugin, das alle Vorteile der Eclipseumgebung mit LaTeX verbindet
|
||||
\item [TeXmaker] Einfacher LaTeX-Editor mit Pdf-Direktvorschau
|
||||
\end{description}
|
||||
|
||||
|
||||
Unter Linux stehen bereit:
|
||||
|
||||
\begin{description}
|
||||
\item [Gummi] Ebenfalls einfacher LaTeX-Editor mit Direktvorschau
|
||||
\item [TeXLipse] Auch für Linux erhältlich
|
||||
\item [Kile] Umfangreiche Entwicklungsumgebung, ähnlich wie TeXnicCenter
|
||||
\end{description}
|
||||
|
||||
Nach der Installation muss die Entwicklungsumgebung eingerichtet werden; dazu finden sich viele Anleitungen im Internet, die genau erklären, welche Distribution
|
||||
auf welche Weise eingerichtet wird. Insbesondere sollte der PDF-Viewer festgelegt werden, damit bei Gummi und TeXmaker die Direktvorschau funktioniert. Manchmal kommt es vor, dass die Ausgabe
|
||||
nach dem Kompilieren Umlaute und Sonderzeichen nicht richtig darstellt. Unter Linux hängt dies mit den unterschiedlichen Zeichensätzen zusammen, die unterstützt
|
||||
werden. Um diese Vorlage zu verwenden ist es notwendig, den verwendeten Zeichensatz des Editors bzw. der Entwicklungsumgebung auf den in diesem Dokument
|
||||
verwendeten Zeichensatz umzustellen: UTF-8 ohne BOM (Byte Order Mark).
|
||||
|
||||
\section{Werkzeuge}
|
||||
\label{sec:Werkzeuge}
|
||||
|
||||
\begin{description}
|
||||
\item [\href{http://jabref.sourceforge.net/}{JabRef}] Ein Literaturverwaltungsprogramm, welches das \textit{BibTeX}-Format einsetzt
|
||||
und mithilfe einer graphischen Oberfläche das Anlegen von Literaturverzeichnissen vereinfacht.
|
||||
|
||||
\end{description}
|
||||
|
||||
\section{Struktur und Gebrauch der Vorlage}
|
||||
|
||||
Die vorliegende Vorlage für Abschlussarbeiten besteht aus einer internen Struktur, die grundsätzlich nicht verändert werden sollte. % Außer, der Student weiß genau, was er tut.
|
||||
|
||||
\subsection{Struktur der Vorlage}
|
||||
\label{subsec:strukturvorlage}
|
||||
|
||||
%\begin{figure}
|
||||
%\centering
|
||||
%\includegraphics[width=0.85\textwidth]{Examples/strukturvorlage}
|
||||
%\caption{Verzeichnisbaum der Vorlage}
|
||||
%\label{fig:strukturvorlage}
|
||||
%\end{figure}
|
||||
|
||||
|
||||
\begin{description}
|
||||
\item [htw-i-mst-config.tex] Enthält alle zu ladenden Packages, Styleparameter für Hyperlinks, Codelistings und Literaturverzeichnis sowie globale Parameter
|
||||
für Tabellen und Beschriftungen. Im Besonderen befinden sich hier die Variablen für den eigenen Namen, Titel, Datum der Arbeit, den betreuenden Professor etc.
|
||||
|
||||
\item [htw-i-mst-vorlage.tex] Dies ist die Hauptdatei, in der alle notwendigen \textit{*.tex}-Dateien eingebunden werden, die zu dem Dokument gehören. Es empfiehlt sich
|
||||
die interne Struktur \textit{nicht} zu verändern. Eigene Kapitel werden an der dafür markierten Stelle eingebunden.
|
||||
|
||||
\item [Bibliography.bib] Zentrale Datei für die Literaturangaben, welche man z.B. mit JabRef verwalten kann.
|
||||
|
||||
\item [Chapters/] Ablageort für alle selbst angelegten Kapitel der Arbeit. Die Aufteilung in eigene Dateien erleichtert die Übersicht über den Quellcode.
|
||||
|
||||
\item [Graphics/] Ablageort für alle im Dokument benötigten Grafikdateien. Gerne darf man hier Unterverzeichnisse zur besseren Strukturierung anlegen.
|
||||
|
||||
\item [Examples/] Dieser Ordner enthält die in dieser Vorlage beigefügten LaTeX-Beispiele, welche vor der Abgabe der Arbeit selbstverständlich gelöscht werden sollten.
|
||||
|
||||
\item [Frontbackmatter/]
|
||||
In diesem Ordner sind all jene Dateien abgelegt, die -- außer dem Kerntext in \textit{Chapters/} -- die Gesamtheit der Abschlussarbeit ausmachen.
|
||||
\begin{description}
|
||||
\item [Titlepage.tex] Definiert die Titelseite der Abschlussarbeit. Diese Datei muss normalerweise nicht verändert werden.
|
||||
\item [Abbreviations.tex] Hier werden alle Abkürzungen hinterlegt, die im Dokument verwendet werden.
|
||||
\item [Abstract.tex] Eine kurze Zusammenfassung der Abschlussarbeit wird in diese Datei eingefügt.
|
||||
\item [Acknowledgements.tex] Dort finden Danksagungen ihren Platz.
|
||||
\item [ConfidentialityClause.tex] Beinhaltet den Sperrvermerk und ist nur zu verwenden, falls dies beispielsweise vom beteiligten Unternehmen gefordert wird.
|
||||
\item [Contents.tex] Enthält wichtige Eintragungen in die \textit{Table-of-Contents}. Diese Datei muss normalerweise nicht geändert werden.
|
||||
\item [Declaration.tex] Enthält die Selbständigkeitserklärung. Diese Datei darf nicht geändert werden.
|
||||
\item [Colophon.tex] Enthält einen Hinweis auf die Urheber dieser Vorlage. Diese Datei darf nicht geändert werden.
|
||||
\item [ListOfs.tex] Enthält die Einträge für die Tabellen- und Abbildungsverzeichnisse etc. und muss gewöhnlich nicht verändert werden.
|
||||
\end{description}
|
||||
|
||||
\end{description}
|
||||
|
||||
|
||||
\subsection{Gebrauch der Vorlage}
|
||||
|
||||
Grundsätzlich ist nicht viel zu tun, um die Vorlage für Abschlussarbeiten zu verwenden. Man entpackt den Hauptordner in das gewünschte Verzeichnis und nutzt die Dateien so, wie in
|
||||
\autoref{subsec:strukturvorlage} beschrieben. Danach werden \textit{alle} Dateien gespeichert und die Hauptdatei, \textit{htwsaar-i-mst-vorlage.tex}, mehrfach kompiliert
|
||||
(LaTeX benötigt mehrere Durchgänge um z.B. Referenzen richtig zuzuordnen).
|
||||
Hat man Änderungen in \textit{Bibliography.bib} bzw. \textit{Bibliography.tex} vorgenommen oder neue Zitate z.B. mittels \lstinline{\cite} eingefügt, muss erst mit
|
||||
\textit{BibLaTeX} und anschließend mitdem entsprechenden LaTeX-nach-PDF-Compiler übersetzt werden.
|
||||
|
||||
|
||||
BIN
Examples/bpmn.jpg
Normal file
BIN
Examples/bpmn.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 15 KiB |
BIN
Examples/bpmn.pdf
Normal file
BIN
Examples/bpmn.pdf
Normal file
Binary file not shown.
BIN
Examples/example_5.jpg
Normal file
BIN
Examples/example_5.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 474 KiB |
BIN
Examples/example_5.pdf
Normal file
BIN
Examples/example_5.pdf
Normal file
Binary file not shown.
BIN
Examples/example_5.png
Normal file
BIN
Examples/example_5.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.5 MiB |
BIN
Examples/jabref.jpg
Normal file
BIN
Examples/jabref.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 48 KiB |
BIN
Examples/jabref.png
Normal file
BIN
Examples/jabref.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 74 KiB |
14
FrontBackmatter/Abbreviations.tex
Normal file
14
FrontBackmatter/Abbreviations.tex
Normal file
@@ -0,0 +1,14 @@
|
||||
%*******************************************************
|
||||
% Abkürzungsverzeichnis
|
||||
%*******************************************************
|
||||
\chapter*{Abkürzungsverzeichnis}
|
||||
\markboth{Abkürzungsverzeichnis}{}
|
||||
\addcontentsline{toc}{chapter}{Abkürzungsverzeichnis}
|
||||
%Hier alle benötigten Abkürzungen einfügen
|
||||
\begin{acronym}[WLAN] % LONGEST ACRONYM HERE FOR CORRECT SPACING
|
||||
\acro{WLAN}{Wireless Local Area Network}
|
||||
\acro{TCP}{Transmission Control Protocol}
|
||||
\acro{GoF}{Gang of Four}
|
||||
\end{acronym}
|
||||
|
||||
|
||||
8
FrontBackmatter/Abstract.tex
Normal file
8
FrontBackmatter/Abstract.tex
Normal file
@@ -0,0 +1,8 @@
|
||||
%*******************************************************
|
||||
% Abstract
|
||||
%*******************************************************
|
||||
\pdfbookmark[0]{Zusammenfassung}{Zusammenfassung}
|
||||
\chapter*{Zusammenfassung}
|
||||
Kurze Zusammenfassung des Inhaltes in deutscher Sprache, der Umfang beträgt zwischen einer halben und einer ganzen DIN A4-Seite.
|
||||
|
||||
Orientieren Sie sich bei der Aufteilung bzw. dem Inhalt Ihrer Zusammenfassung an Kent Becks Artikel: \url{http://plg.uwaterloo.ca/~migod/research/beckOOPSLA.html}.
|
||||
28
FrontBackmatter/Acknowledgments.tex
Normal file
28
FrontBackmatter/Acknowledgments.tex
Normal file
@@ -0,0 +1,28 @@
|
||||
%*******************************************************
|
||||
% Acknowledgments
|
||||
%*******************************************************
|
||||
\pdfbookmark[0]{Danksagung}{acknowledgments}
|
||||
|
||||
% Beispiel für ein sinnvolles Zitat
|
||||
\begin{flushright}{\slshape
|
||||
We have seen that computer programming is an art, \\
|
||||
because it applies accumulated knowledge to the world, \\
|
||||
because it requires skill and ingenuity, and especially \\
|
||||
because it produces objects of beauty.} \\ \medskip
|
||||
--- Donald E. Knuth \cite{knuth:1974}
|
||||
\end{flushright}
|
||||
|
||||
\bigskip
|
||||
|
||||
\begingroup
|
||||
\let\clearpage\relax
|
||||
\let\cleardoublepage\relax
|
||||
\let\cleardoublepage\relax
|
||||
\chapter*{Danksagung}
|
||||
Hier können Sie Personen danken, die zum Erfolg der Arbeit beigetragen haben, beispielsweise Ihren Betreuern in der Firma, Ihren Professoren/Dozenten an der htw saar, Freunden, Familie usw.
|
||||
|
||||
|
||||
|
||||
|
||||
\endgroup
|
||||
|
||||
4
FrontBackmatter/Bibliography.tex
Normal file
4
FrontBackmatter/Bibliography.tex
Normal file
@@ -0,0 +1,4 @@
|
||||
%********************************************************************
|
||||
% Bibliography
|
||||
%*******************************************************
|
||||
\printbibliography
|
||||
11
FrontBackmatter/Colophon.tex
Normal file
11
FrontBackmatter/Colophon.tex
Normal file
@@ -0,0 +1,11 @@
|
||||
\pagestyle{empty}
|
||||
|
||||
\hfill
|
||||
|
||||
\vfill
|
||||
|
||||
|
||||
\pdfbookmark[0]{Kolophon}{colophon}
|
||||
\section*{Kolophon}
|
||||
Dieses Dokument wurde mit der \LaTeX-Vorlage für Abschlussarbeiten an der htw saar im Bereich Informatik/Mechatronik-Sensortechnik erstellt (\currentVersion). Die Vorlage wurde von Yves Hary und Andr\'e Miede entwickelt (mit freundlicher Unterstützung von Thomas Kretschmer, Helmut G. Folz und Martina Lehser). Daten: (F)\makeatletter\f@size\makeatother\ -- (B)\the\textwidth\ -- (H)\the\textheight\
|
||||
|
||||
12
FrontBackmatter/Colophon_en.tex
Normal file
12
FrontBackmatter/Colophon_en.tex
Normal file
@@ -0,0 +1,12 @@
|
||||
\pagestyle{empty}
|
||||
|
||||
\hfill
|
||||
|
||||
\vfill
|
||||
|
||||
|
||||
\pdfbookmark[0]{Colophon}{colophon}
|
||||
\section*{Colophon}
|
||||
%Dieses Dokument wurde mit der \LaTeX-Vorlage für Abschlussarbeiten an der htw saar im Bereich Informatik/Mechatronik-Sensortechnik erstellt (\currentVersion). Die Vorlage wurde von Yves Hary und Andr\'e Miede entwickelt (mit freundlicher Unterstützung von Thomas Kretschmer, Helmut G. Folz und Martina Lehser). Daten: (F)\makeatletter\f@size\makeatother\ -- (B)\the\textwidth\ -- (H)\the\textheight\
|
||||
|
||||
This document has been created with the theses \LaTeX template provided by htw saar, Saarland University of Applied Sciences, Informatics/Mechatronics and Sensor Technology (\currentVersion). This template has been created by Yves Hary and Andr\'e Miede (with kind support from Thomas Kretschmer, Helmut G. Folz and Martina Lehser). Data: (F)\makeatletter\f@size\makeatother\ -- (B)\the\textwidth\ -- (H)\the\textheight\
|
||||
19
FrontBackmatter/ConfidentialityClause.tex
Normal file
19
FrontBackmatter/ConfidentialityClause.tex
Normal file
@@ -0,0 +1,19 @@
|
||||
%*******************************************************
|
||||
% Sperrvermerk
|
||||
% [Nicht übersetzen,
|
||||
% weil Prüfungsleistung an dt. Hochschule]
|
||||
%*******************************************************
|
||||
% Der Sperrvermerk kann entfernt werden, wenn die Arbeit z.B. nicht im
|
||||
% Zusammenarbeit mit einem Unternehmen angefertigt wurde oder kein
|
||||
% Sperrvermerk verlangt wird.
|
||||
|
||||
\pdfbookmark[0]{Sperrvermerk}{sperrvermerk}
|
||||
\chapter*{Sperrvermerk}
|
||||
%\thispagestyle{empty}
|
||||
|
||||
Die vorliegende Arbeit mit dem Titel "`\myTitle"' enthält vertrauliche Daten des Unternehmens \myCompany.
|
||||
|
||||
Die Arbeit darf nur dem Erst- und Zweitgutachter sowie befugten Mitgliedern des Prüfungsausschusses zugänglich gemacht werden.
|
||||
Eine Veröffentlichung und Vervielfältigung der Arbeit ist -- auch in Auszügen -- nicht gestattet.
|
||||
|
||||
Eine Einsichtnahme der Arbeit durch Unbefugte bedarf einer ausdrücklichen Genehmigung des Verfassers und des Unternehmens \myCompany.
|
||||
12
FrontBackmatter/Contents.tex
Normal file
12
FrontBackmatter/Contents.tex
Normal file
@@ -0,0 +1,12 @@
|
||||
%*******************************************************
|
||||
% Table of Contents
|
||||
%*******************************************************
|
||||
\setcounter{tocdepth}{2} % <-- 2 includes up to subsections in the ToC
|
||||
\setcounter{secnumdepth}{3} % <-- 3 numbers up to subsubsections
|
||||
|
||||
\pdfbookmark[0]{\contentsname}{toc}
|
||||
\tableofcontents
|
||||
|
||||
% Die weiteren Verzeichnisse folgen am Ende des Dokuments
|
||||
|
||||
|
||||
31
FrontBackmatter/Declaration.tex
Normal file
31
FrontBackmatter/Declaration.tex
Normal file
@@ -0,0 +1,31 @@
|
||||
%*******************************************************
|
||||
% Declaration
|
||||
% [Nicht übersetzen,
|
||||
% weil Prüfungsleistung an dt. Hochschule]
|
||||
%*******************************************************
|
||||
\pdfbookmark[0]{Selbständigkeitserklärung}{declaration}
|
||||
\chapter*{Selbständigkeitserklärung}
|
||||
%\thispagestyle{empty}
|
||||
|
||||
Ich versichere, dass ich die vorliegende Arbeit (bei einer Gruppenarbeit: den entsprechend gekennzeichneten
|
||||
Anteil der Arbeit) selbständig verfasst und keine anderen als die angegebenen Quellen und
|
||||
Hilfsmittel benutzt habe.
|
||||
|
||||
Ich erkläre hiermit weiterhin, dass die vorgelegte Arbeit zuvor weder von mir noch von einer anderen Person an dieser oder einer
|
||||
anderen Hochschule eingereicht wurde.
|
||||
|
||||
Darüber hinaus ist mir bekannt, dass die Unrichtigkeit dieser Erklärung eine Benotung der
|
||||
Arbeit mit der Note "`nicht ausreichend"' zur Folge hat und einen Ausschluss von der Erbringung
|
||||
weiterer Prüfungsleistungen zur Folge haben kann.
|
||||
\bigskip
|
||||
|
||||
\noindent\textit{\myLocation, \myTime}
|
||||
|
||||
\smallskip
|
||||
|
||||
\begin{flushright}
|
||||
\begin{tabular}{m{5cm}}
|
||||
\\ \hline
|
||||
\centering\myName \\
|
||||
\end{tabular}
|
||||
\end{flushright}
|
||||
12
FrontBackmatter/ListOfs.tex
Normal file
12
FrontBackmatter/ListOfs.tex
Normal file
@@ -0,0 +1,12 @@
|
||||
%*******************************************************
|
||||
% Verzeichnisse (Abbildungen, Tabellen, Listings, etc.)
|
||||
%*******************************************************
|
||||
\cleardoublepage
|
||||
\begingroup
|
||||
\let\clearpage\relax
|
||||
\let\cleardoublepage\relax
|
||||
\listoffigures
|
||||
\listoftables
|
||||
%\addcontentsline{toc}{chapter}{\lstlistlistingname}
|
||||
\lstlistoflistings
|
||||
\endgroup
|
||||
45
FrontBackmatter/Titlepage.tex
Normal file
45
FrontBackmatter/Titlepage.tex
Normal file
@@ -0,0 +1,45 @@
|
||||
%*******************************************************
|
||||
% Titlepage
|
||||
% [Nicht zu verändern]
|
||||
%*******************************************************
|
||||
\begin{titlepage}\linespread{1.5}\selectfont
|
||||
\includegraphics[width=\linewidth]{Graphics/htwsaar_Logo_inwi_head_VF_4C_crop}
|
||||
\begin{center}
|
||||
\large
|
||||
\hfill
|
||||
\vfill
|
||||
\begingroup
|
||||
\Large\bfseries\myDegreeType-Thesis
|
||||
\endgroup
|
||||
|
||||
\bigskip
|
||||
|
||||
zur Erlangung des akademischen Grades \\
|
||||
\myDegree \\
|
||||
an der \myUni \\
|
||||
im Studiengang \myDegreeCourse \\
|
||||
der Fakultät für Ingenieurwissenschaften \\
|
||||
|
||||
\vfill
|
||||
|
||||
\begingroup
|
||||
\Large\bfseries\myTitle
|
||||
\endgroup
|
||||
|
||||
\bigskip
|
||||
|
||||
vorgelegt von \\
|
||||
\myName
|
||||
|
||||
\vfill
|
||||
|
||||
betreut und begutachtet von \\
|
||||
\myFirstProf \\
|
||||
\mySecondProf
|
||||
|
||||
\vfill
|
||||
|
||||
\myLocation, \myTime
|
||||
|
||||
\end{center}
|
||||
\end{titlepage}
|
||||
50
FrontBackmatter/Titlepage_dfhi.tex
Normal file
50
FrontBackmatter/Titlepage_dfhi.tex
Normal file
@@ -0,0 +1,50 @@
|
||||
%*******************************************************
|
||||
% Titlepage
|
||||
% [Nicht zu verändern]
|
||||
%*******************************************************
|
||||
\begin{titlepage}\linespread{1.5}\selectfont
|
||||
\noindent\includegraphics[width=3cm]{Graphics/logo-dfhi} \hfill \includegraphics[width=3cm]{Graphics/logo-uni-de-lorraine} \medskip
|
||||
|
||||
\noindent\includegraphics[width=\linewidth]{Graphics/htwsaar_Logo_inwi_head_VF_4C_crop}
|
||||
|
||||
\begin{center}
|
||||
\large
|
||||
\hfill
|
||||
\vfill
|
||||
\begingroup
|
||||
\Large\bfseries\myDegreeType-Thesis
|
||||
\endgroup
|
||||
|
||||
\bigskip
|
||||
|
||||
zur Erlangung des akademischen Grades \\
|
||||
\myDegree \\
|
||||
an der \myUni \\
|
||||
und \\
|
||||
der Université de Lorraine, Metz \\
|
||||
im Studiengang \myDegreeCourse \\
|
||||
des Deutsch-Französischen Hochschulinstituts (DFHI / ISFATES) \\
|
||||
|
||||
\vfill
|
||||
|
||||
\begingroup
|
||||
\Large\bfseries\myTitle
|
||||
\endgroup
|
||||
|
||||
\bigskip
|
||||
|
||||
vorgelegt von \\
|
||||
\myName
|
||||
|
||||
\vfill
|
||||
|
||||
betreut und begutachtet von \\
|
||||
\myFirstProf \\
|
||||
\mySecondProf
|
||||
|
||||
\vfill
|
||||
|
||||
\myLocation, \myTime
|
||||
|
||||
\end{center}
|
||||
\end{titlepage}
|
||||
BIN
Graphics/htwsaar_Logo_inwi_head_VF_4C_crop.pdf
Normal file
BIN
Graphics/htwsaar_Logo_inwi_head_VF_4C_crop.pdf
Normal file
Binary file not shown.
BIN
Graphics/logo-dfhi.pdf
Normal file
BIN
Graphics/logo-dfhi.pdf
Normal file
Binary file not shown.
BIN
Graphics/logo-uni-de-lorraine.pdf
Normal file
BIN
Graphics/logo-uni-de-lorraine.pdf
Normal file
Binary file not shown.
674
LICENSE
Normal file
674
LICENSE
Normal file
@@ -0,0 +1,674 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
19
README.md
Normal file
19
README.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# htwsaar-i-mst-vorlage [](https://github.com/systemtechniklabor/htwsaar-i-mst-vorlage/actions/workflows/build_pdf.yml)
|
||||
|
||||
Eine LaTeX-Vorlage für Abschlussarbeiten im Bereich Informatik/Mechatronik-Sensortechnik an der htw saar. Auch für die DFHI-Informatik-Studiengänge geeignet (Deckblatt).
|
||||
|
||||
Details zur Installation und Konfiguration sind in der Vorlage selbst enthalten.
|
||||
|
||||
[Das Wiki](https://github.com/systemtechniklabor/htwsaar-i-mst-vorlage/wiki) enthält Best Practices und weitere Hinweise (ist aktuell noch im Aufbau).
|
||||
|
||||
### Hinweis zum Ausdruck des Abgabeexemplars
|
||||
Bitte drucken Sie das Dokument *beidseitig* (doppelseitig) aus, weil dies Papier spart und professioneller aussieht.
|
||||
|
||||
### Hinweis zu Thesen in englischer Sprache
|
||||
Falls Sie die Thesis auf Englisch schreiben, *müssen* Sie jedoch die folgenden Teile aus juristischen Gründen in deutscher Sprache (wie in der Vorlage) belassen:
|
||||
* Titelseite
|
||||
* Selbständigkeitserklärung
|
||||
* Sperrvermerk (falls verwendet)
|
||||
|
||||
### Hinweis zu Absätzen und Zeilenumbrüchen
|
||||
Gedankengänge bitte durch Absätze trennen, das ist im LaTeX-Quelltext eine `Leerzeile`. Leerzeilen nicht in Kombination mit `\\` bzw. `\newline` verwenden. Idealerweise `\\` bzw. `\newline` gar nicht verwenden. :innocent:
|
||||
253
htwsaar-i-mst-config.tex
Normal file
253
htwsaar-i-mst-config.tex
Normal file
@@ -0,0 +1,253 @@
|
||||
% ****************************************************************************************************
|
||||
% htwsaar-i-mst-config.tex
|
||||
% ****************************************************************************************************
|
||||
\RequirePackage[utf8]{inputenc}
|
||||
\DeclareUnicodeCharacter{00A0}{~}
|
||||
\RequirePackage[T1]{fontenc}
|
||||
|
||||
% ****************************************************************************************************
|
||||
% 1. Personal data and user ad-hoc commands
|
||||
% ****************************************************************************************************
|
||||
\newcommand{\myTitle}{Eine \LaTeX-Vorlage für Abschlussarbeiten im Bereich Informatik/Mechatronik-Sensortechnik (inkl. DFHI) an der htw saar}
|
||||
\newcommand{\myDegree}{Bachelor of Science (B.\,Sc.)\xspace}
|
||||
%\newcommand{\myDegree}{Master of Science (M.\,Sc.)\xspace}
|
||||
\newcommand{\myDegreeType}{Bachelor\xspace}
|
||||
%\newcommand{\myDegreeType}{Master\xspace}
|
||||
\newcommand{\myDegreeCourse}{Praktische Informatik}
|
||||
%\newcommand{\myDegreeCourse}{Informatik und Web-Engineering}
|
||||
%\newcommand{\myDegreeCourse}{Kommunikationsinformatik}
|
||||
%\newcommand{\myDegreeCourse}{Produktionsinformatik}
|
||||
\newcommand{\myName}{Max Muster\xspace}
|
||||
\newcommand{\myUni}{Hochschule für Technik und Wirtschaft des Saarlandes\xspace}
|
||||
\newcommand{\myCompany}{SoftwareCenter Musterhausen\xspace}
|
||||
\newcommand{\myFirstProf}{Prof. Dr.-Ing. André Miede\xspace}
|
||||
\newcommand{\mySecondProf}{Prof. Dr. Thomas Kretschmer\xspace}
|
||||
\newcommand{\myLocation}{Saarbrücken\xspace}
|
||||
\newcommand{\myTime}{Tag.~Monat~Jahr\xspace}
|
||||
\newcommand{\currentVersion}{Version 2.25, August 2024\xspace} % TODO: ggf. über git Versionsinformationen automatisch bereitstellen und verwenden
|
||||
|
||||
% ********************************************************************
|
||||
% Setup, finetuning, and useful commands
|
||||
% ********************************************************************
|
||||
\newcounter{dummy} % necessary for correct hyperlinks (to index, bib, etc.)
|
||||
% ****************************************************************************************************
|
||||
|
||||
|
||||
% ****************************************************************************************************
|
||||
% 2. Loading some handy packages
|
||||
% ****************************************************************************************************
|
||||
% ********************************************************************
|
||||
% Packages with options that might require adjustments
|
||||
% ********************************************************************
|
||||
\PassOptionsToPackage{ngerman}{babel} % change this to your language(s)
|
||||
\RequirePackage{babel}
|
||||
\RequirePackage{csquotes}
|
||||
|
||||
\PassOptionsToPackage{language=auto,style=numeric-comp,backend=bibtex8,bibencoding=ascii,maxbibnames=50}{biblatex} % backend ggf. auf neueres Werkzeug (z.B. biber) anpassen
|
||||
\RequirePackage{biblatex}
|
||||
%\bibliography{Bibliography} % alter Befehl
|
||||
\addbibresource{Bibliography}
|
||||
|
||||
\PassOptionsToPackage{fleqn}{amsmath} % math environments and more by the AMS
|
||||
\RequirePackage{amsmath}
|
||||
|
||||
% ********************************************************************
|
||||
% Setting up the page and margins
|
||||
% ********************************************************************
|
||||
\usepackage{geometry}
|
||||
\geometry{a4paper,left=25mm,right=35mm,top=25mm,bottom=30mm}
|
||||
% DIESE WERTE SIND NICHT ZU VERÄNDERN -- DO NOT CHANGE THESE VALUES
|
||||
|
||||
% ********************************************************************
|
||||
% General useful packages
|
||||
% ********************************************************************
|
||||
%\usepackage[automark]{scrpage2}
|
||||
\PassOptionsToPackage{dvipsnames}{xcolor}
|
||||
\RequirePackage{xcolor} % [dvipsnames]
|
||||
\definecolor{ingwi}{cmyk}{.9,0,0,0}
|
||||
\usepackage{textcomp} % fix warning with missing font shapes
|
||||
\usepackage{scrhack} % fix warnings when using KOMA with listings package
|
||||
\usepackage{xspace} % to get the spacing after macros right
|
||||
\usepackage{mparhack} % get marginpar right
|
||||
%\usepackage{fixltx2e} % fixes some LaTeX stuff <-- ist seit 2015 nicht mehr notwendig
|
||||
\PassOptionsToPackage{printonlyused}{acronym}
|
||||
\usepackage{acronym} % nice macros for handling all acronyms in the thesis
|
||||
%\renewcommand{\bflabel}[1]{{#1}\hfill} % fix the list of acronyms
|
||||
\usepackage{booktabs}
|
||||
\usepackage{multirow}
|
||||
\usepackage{todonotes} %Settings for ToDoNotes
|
||||
% Eigene Shortcuts fuer laengere Befehle
|
||||
\newcommand{\todox}[1]{\todo[inline, size=\small]{#1}}
|
||||
%Nummerierte Anmerkungen
|
||||
\newcounter{todocounter}
|
||||
\renewcommand{\todox}[2][]{\stepcounter{todocounter}\todo[inline, size=\small,caption={\thetodocounter: #2}, #1]{\renewcommand{\baselinestretch}{0.5}\selectfont\thetodocounter: #2\par}}
|
||||
\usepackage{blindtext}
|
||||
%\usepackage{footmisc}
|
||||
% ****************************************************************************************************
|
||||
|
||||
|
||||
% ****************************************************************************************************
|
||||
% 3. Setup floats: tables, (sub)figures, and captions
|
||||
% ****************************************************************************************************
|
||||
\usepackage{tabularx} % better tables
|
||||
\setlength{\extrarowheight}{3pt} % increase table row height
|
||||
%\newcommand{\myfloatalign}{\centering} % to be used with each float for alignment
|
||||
\usepackage{caption}
|
||||
\captionsetup{format=hang,font=small}
|
||||
\usepackage{subfig}
|
||||
\usepackage{wrapfig}
|
||||
% ****************************************************************************************************
|
||||
|
||||
|
||||
% ****************************************************************************************************
|
||||
% 6. Setup code listings
|
||||
% ****************************************************************************************************
|
||||
\usepackage{listings}
|
||||
%\lstset{emph={trueIndex,root},emphstyle=\color{BlueViolet}}%\underbar} % for special keywords
|
||||
\lstset{language=[LaTeX]Tex,%C++,
|
||||
keywordstyle=\color{RoyalBlue},%\bfseries,
|
||||
basicstyle=\small\ttfamily,
|
||||
%identifierstyle=\color{NavyBlue},
|
||||
commentstyle=\color{Green}\ttfamily,
|
||||
stringstyle=\rmfamily,
|
||||
numbers=none,%left,%
|
||||
numberstyle=\scriptsize,%\tiny
|
||||
stepnumber=5,
|
||||
numbersep=8pt,
|
||||
showstringspaces=false,
|
||||
breaklines=true,
|
||||
frameround=ftff,
|
||||
frame=single,
|
||||
texcl=true,
|
||||
belowcaptionskip=.75\baselineskip
|
||||
%frame=L
|
||||
}
|
||||
%Styles für verschiedene Sprachen festlegen, z.B. Java
|
||||
\lstdefinestyle{Java}{
|
||||
belowcaptionskip=1\baselineskip,
|
||||
breaklines=true,
|
||||
xleftmargin=\parindent,
|
||||
language=Java,
|
||||
texcl=true,
|
||||
showstringspaces=false,
|
||||
basicstyle=\footnotesize\ttfamily,
|
||||
keywordstyle=\bfseries\color{green!40!black},
|
||||
commentstyle=\itshape\color{purple!40!black},
|
||||
identifierstyle=\color{blue},
|
||||
stringstyle=\color{orange}}
|
||||
% ****************************************************************************************************
|
||||
|
||||
|
||||
% ****************************************************************************************************
|
||||
% 6. PDFLaTeX, hyperreferences and citation backreferences
|
||||
% ****************************************************************************************************
|
||||
% ********************************************************************
|
||||
% Using PDFLaTeX
|
||||
% ********************************************************************
|
||||
\usepackage{xurl} % better handling of long URLs / hyphenation
|
||||
\PassOptionsToPackage{pdftex,hyperfootnotes=false,pdfpagelabels}{hyperref}
|
||||
\usepackage{hyperref} % backref linktocpage pagebackref
|
||||
\pdfcompresslevel=9
|
||||
\pdfadjustspacing=1
|
||||
\PassOptionsToPackage{pdftex}{graphicx}
|
||||
\usepackage{graphicx}
|
||||
|
||||
|
||||
% ********************************************************************
|
||||
% Hyperreferences
|
||||
% ********************************************************************
|
||||
\hypersetup{%
|
||||
%draft, % = no hyperlinking at all (useful in b/w printouts)
|
||||
pdfstartpage=1, pdfstartview=Fit,%
|
||||
colorlinks=true, linktocpage=true,
|
||||
%urlcolor=Black, linkcolor=Black, citecolor=Black, %pagecolor=Black,%
|
||||
%urlcolor=brown, linkcolor=RoyalBlue, citecolor=green, %pagecolor=RoyalBlue,%
|
||||
% uncomment the following line if you want to have black links (e.g., for printing)
|
||||
colorlinks=false, pdfborder={0 0 0},
|
||||
breaklinks=true, pdfpagemode=UseNone, pageanchor=true, pdfpagemode=UseOutlines,%
|
||||
plainpages=false, bookmarksnumbered, bookmarksopen=true, bookmarksopenlevel=1,%
|
||||
hypertexnames=true, pdfhighlight=/O,%nesting=true,%frenchlinks,%
|
||||
pdftitle={\myTitle},%
|
||||
pdfauthor={\textcopyright\ \myName, \myUni},%
|
||||
pdfsubject={},%
|
||||
pdfkeywords={},%
|
||||
pdfcreator={pdfLaTeX},%
|
||||
pdfproducer={LaTeX with hyperref}%
|
||||
}
|
||||
|
||||
% ********************************************************************
|
||||
% Setup autoreferences
|
||||
% ********************************************************************
|
||||
% There are some issues regarding autorefnames
|
||||
% http://www.ureader.de/msg/136221647.aspx
|
||||
% http://www.tex.ac.uk/cgi-bin/texfaq2html?label=latexwords
|
||||
% you have to redefine the makros for the
|
||||
% language you use, e.g., american, ngerman
|
||||
% (as chosen when loading babel/AtBeginDocument)
|
||||
% ********************************************************************
|
||||
\makeatletter
|
||||
\@ifpackageloaded{babel}%
|
||||
{%
|
||||
\addto\extrasamerican{%
|
||||
\renewcommand*{\figureautorefname}{Figure}%
|
||||
\renewcommand*{\tableautorefname}{Table}%
|
||||
\renewcommand*{\partautorefname}{Part}%
|
||||
\renewcommand*{\chapterautorefname}{Chapter}%
|
||||
\renewcommand*{\sectionautorefname}{Section}%
|
||||
\renewcommand*{\subsectionautorefname}{Section}%
|
||||
\renewcommand*{\subsubsectionautorefname}{Section}%
|
||||
}%
|
||||
\addto\extrasngerman{%
|
||||
\renewcommand*{\chapterautorefname}{Kapitel}%
|
||||
\renewcommand*{\sectionautorefname}{Abschnitt}%
|
||||
\renewcommand*{\subsectionautorefname}{Abschnitt}%
|
||||
\renewcommand*{\subsubsectionautorefname}{Abschnitt}%
|
||||
\renewcommand*{\paragraphautorefname}{Absatz}%
|
||||
\renewcommand*{\subparagraphautorefname}{Absatz}%
|
||||
\renewcommand*{\footnoteautorefname}{Fußnote}%
|
||||
\renewcommand*{\FancyVerbLineautorefname}{Zeile}%
|
||||
\renewcommand*{\theoremautorefname}{Theorem}%
|
||||
\renewcommand*{\appendixautorefname}{Anhang}%
|
||||
\renewcommand*{\equationautorefname}{Gleichung}%
|
||||
\renewcommand*{\itemautorefname}{Punkt}%
|
||||
}%
|
||||
% Fix to getting autorefs for subfigures right (thanks to Belinda Vogt for changing the definition)
|
||||
\providecommand{\subfigureautorefname}{\figureautorefname}%
|
||||
}{\relax}
|
||||
\makeatother
|
||||
|
||||
|
||||
% ****************************************************************************************************
|
||||
% 6. Last calls before the bar closes
|
||||
% ****************************************************************************************************
|
||||
% ********************************************************************
|
||||
% Development Stuff
|
||||
% ********************************************************************
|
||||
%\listfiles
|
||||
\PassOptionsToPackage{l2tabu,orthodox,abort}{nag}
|
||||
\usepackage{nag}
|
||||
%\PassOptionsToPackage{warning, all}{onlyamsmath}
|
||||
% \usepackage{onlyamsmath}
|
||||
|
||||
|
||||
% ****************************************************************************************************
|
||||
% 7. Further adjustments (experimental)
|
||||
% ****************************************************************************************************
|
||||
%\usepackage{tocbibind} %Allows us to add Bibliography to ToC
|
||||
\usepackage{enumitem}
|
||||
\setdescription{font=\normalfont\bfseries} %Changes the appearance of description items
|
||||
\usepackage[activate={true,nocompatibility},final,tracking=true,kerning=true,spacing=true,factor=1100,stretch=10,shrink=10]{microtype}
|
||||
|
||||
|
||||
% ********************************************************************
|
||||
% Using different fonts
|
||||
% ********************************************************************
|
||||
%\usepackage{lmodern} % <-- no osf support :-(
|
||||
%\usepackage[tt=false]{libertine} % [osf]
|
||||
%\usepackage{luximono}
|
||||
%\usepackage[urw-garamond]{mathdesign} <-- no osf support :-(
|
||||
\usepackage{mathpazo}
|
||||
%\usepackage{libertinus} % math? osf?
|
||||
|
||||
\setkomafont{disposition}{\bfseries}
|
||||
% ****************************************************************************************************
|
||||
BIN
htwsaar-i-mst-vorlage.pdf
Normal file
BIN
htwsaar-i-mst-vorlage.pdf
Normal file
Binary file not shown.
72
htwsaar-i-mst-vorlage.tex
Normal file
72
htwsaar-i-mst-vorlage.tex
Normal file
@@ -0,0 +1,72 @@
|
||||
% ****************************************************************** ********************************************
|
||||
%
|
||||
% **************************************************************************************************************
|
||||
\documentclass[ twoside,openright,titlepage,numbers=noenddot,%
|
||||
toc=bibliography,toc=listof,%
|
||||
footinclude=false,headinclude=false,cleardoublepage=empty,%
|
||||
BCOR=5mm,paper=a4,fontsize=11pt
|
||||
%,ngerman%
|
||||
]{scrreprt}
|
||||
%***************************************************************************************************************
|
||||
% Note: Make all your adjustments in here
|
||||
%***************************************************************************************************************
|
||||
\input{htwsaar-i-mst-config}
|
||||
|
||||
%********************************************************************
|
||||
% Hyphenation
|
||||
%*******************************************************
|
||||
%\hyphenation{put special hyphenation here}
|
||||
|
||||
% ********************************************************************
|
||||
% GO!GO!GO! MOVE IT!
|
||||
%*******************************************************
|
||||
\begin{document}
|
||||
\frenchspacing
|
||||
\raggedbottom
|
||||
\selectlanguage{ngerman} % american ngerman
|
||||
\pagenumbering{roman}
|
||||
\pagestyle{plain}
|
||||
%*******************************************************
|
||||
% Frontmatter
|
||||
%*******************************************************
|
||||
\include{FrontBackmatter/Titlepage}
|
||||
%\include{FrontBackmatter/Titlepage_dfhi} % <-- für DFHI-Studiengänge
|
||||
\cleardoublepage\include{FrontBackmatter/Declaration}
|
||||
%\cleardoublepage\include{FrontBackmatter/ConfidentialityClause} % <-- sollte in der Regel nicht notwendig sein und mit Betreuer/Unternehmen abgeklärt werden
|
||||
\cleardoublepage\include{FrontBackmatter/Abstract}
|
||||
\cleardoublepage\include{FrontBackmatter/Acknowledgments}
|
||||
\cleardoublepage\include{FrontBackmatter/Contents}
|
||||
|
||||
%*******************************************************
|
||||
% Mainmatter
|
||||
%*******************************************************
|
||||
\cleardoublepage
|
||||
\pagenumbering{arabic}
|
||||
\pagestyle{headings}
|
||||
%\pagestyle{scrheadings}
|
||||
\cleardoublepage\include{Examples/Einleitung} % Diese Einbindungen werden natürlich entfernt, wenn es an die richtige
|
||||
\cleardoublepage\include{Examples/Beispiele} % Abschlussarbeit geht!
|
||||
%\cleardoublepage\include{Chapters/KapitelBachelorarbeit} % <<< Hier alle Chapter der Abschlussarbeit (einzeln) einbinden
|
||||
|
||||
%********************************************************************
|
||||
% Bibliography/References
|
||||
%*******************************************************
|
||||
\cleardoublepage\include{FrontBackmatter/Bibliography}
|
||||
|
||||
%********************************************************************
|
||||
% List of Figures etc.
|
||||
%*******************************************************
|
||||
\cleardoublepage\include{FrontBackmatter/ListOfs}
|
||||
\include{FrontBackmatter/Abbreviations}
|
||||
|
||||
% ********************************************************************
|
||||
% Appendix/Anhang
|
||||
%***************************************************************
|
||||
\appendix
|
||||
\part*{Anhang}
|
||||
\cleardoublepage\include{Chapters/Anhang-A}
|
||||
|
||||
%*******************************************************
|
||||
\cleardoublepage\include{FrontBackmatter/Colophon}
|
||||
\end{document}
|
||||
% ********************************************************************
|
||||
Reference in New Issue
Block a user