diff options
author | Karl Berry <karl@freefriends.org> | 2018-11-30 21:48:50 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2018-11-30 21:48:50 +0000 |
commit | aac57f0cd7aea0d101e3240a12321b2cba46fb28 (patch) | |
tree | a68f3192bcc516dcf226c98fc7297ea504066432 /Master/texmf-dist | |
parent | 10b8702e8b19735324a53494aa3f9312147bf1e7 (diff) |
hagenberg-thesis (30nov18)
git-svn-id: svn://tug.org/texlive/trunk@49284 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist')
44 files changed, 856 insertions, 210 deletions
diff --git a/Master/texmf-dist/doc/latex/hagenberg-thesis/README.md b/Master/texmf-dist/doc/latex/hagenberg-thesis/README.md index 141dc83882b..e4e95d8aa11 100644 --- a/Master/texmf-dist/doc/latex/hagenberg-thesis/README.md +++ b/Master/texmf-dist/doc/latex/hagenberg-thesis/README.md @@ -1,11 +1,11 @@ # The `hagenberg-thesis` Package -A collection of modern LaTeX classes, style files and example documents for authoring Bachelor, Master or Diploma theses and related academic manuscripts in English and German. This includes a comprehensive tutorial with detailed instructions and authoring guidelines. +A collection of modern LaTeX classes, style files and example documents for authoring Bachelor, Master or Diploma theses and related academic manuscripts in English and German. Includes a comprehensive tutorial (in German) with detailed instructions and authoring guidelines. ## Package information -### Version: 2017/10/28 +### Version: 2018/11/24 ### Authors: W. Burger, W. Hochleitner diff --git a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbArticle/main.pdf b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbArticle/main.pdf Binary files differindex cecdddeb362..2e3ae4ee7fa 100644 --- a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbArticle/main.pdf +++ b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbArticle/main.pdf diff --git a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbArticle/references.bib b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbArticle/references.bib index c0f9515705b..571825792b5 100644 --- a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbArticle/references.bib +++ b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbArticle/references.bib @@ -450,3 +450,22 @@ hyphenation={english} } +@patent{Pike2008, + author={Pike, Dion}, + title={Master-slave communications system and method for a network element}, + type={US Patent}, + holder={Alcatel-Lucent SAS}, + number={7,460,482}, + year={2008}, + month={12}, + url={https://patents.google.com/patent/US7460482} +} + +@misc{Hough62, + author={Hough, Paul V. C.}, + title={Method and means for recognizing complex patterns}, + howpublished={US Patent 3,069,654}, + year={1962}, + month={12}, + url={https://patents.google.com/patent/US3069654} +} diff --git a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbInternshipReport/main.pdf b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbInternshipReport/main.pdf Binary files differindex c2bd5d4a74e..ab890dbf26b 100644 --- a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbInternshipReport/main.pdf +++ b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbInternshipReport/main.pdf diff --git a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbInternshipReport/references.bib b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbInternshipReport/references.bib index c0f9515705b..571825792b5 100644 --- a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbInternshipReport/references.bib +++ b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbInternshipReport/references.bib @@ -450,3 +450,22 @@ hyphenation={english} } +@patent{Pike2008, + author={Pike, Dion}, + title={Master-slave communications system and method for a network element}, + type={US Patent}, + holder={Alcatel-Lucent SAS}, + number={7,460,482}, + year={2008}, + month={12}, + url={https://patents.google.com/patent/US7460482} +} + +@misc{Hough62, + author={Hough, Paul V. C.}, + title={Method and means for recognizing complex patterns}, + howpublished={US Patent 3,069,654}, + year={1962}, + month={12}, + url={https://patents.google.com/patent/US3069654} +} diff --git a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbLabReportDE/main.pdf b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbLabReportDE/main.pdf Binary files differindex 2af9677104f..d7a4da8b247 100644 --- a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbLabReportDE/main.pdf +++ b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbLabReportDE/main.pdf diff --git a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbLabReportDE/references.bib b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbLabReportDE/references.bib index c0f9515705b..571825792b5 100644 --- a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbLabReportDE/references.bib +++ b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbLabReportDE/references.bib @@ -450,3 +450,22 @@ hyphenation={english} } +@patent{Pike2008, + author={Pike, Dion}, + title={Master-slave communications system and method for a network element}, + type={US Patent}, + holder={Alcatel-Lucent SAS}, + number={7,460,482}, + year={2008}, + month={12}, + url={https://patents.google.com/patent/US7460482} +} + +@misc{Hough62, + author={Hough, Paul V. C.}, + title={Method and means for recognizing complex patterns}, + howpublished={US Patent 3,069,654}, + year={1962}, + month={12}, + url={https://patents.google.com/patent/US3069654} +} diff --git a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbLabReportEN/main.pdf b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbLabReportEN/main.pdf Binary files differindex 184ddecf05f..8a67c75b7d6 100644 --- a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbLabReportEN/main.pdf +++ b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbLabReportEN/main.pdf diff --git a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbLabReportEN/main.tex b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbLabReportEN/main.tex Binary files differindex f1e83b6f657..77ec0fcf6cb 100644 --- a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbLabReportEN/main.tex +++ b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbLabReportEN/main.tex diff --git a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbLabReportEN/references.bib b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbLabReportEN/references.bib index c0f9515705b..571825792b5 100644 --- a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbLabReportEN/references.bib +++ b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbLabReportEN/references.bib @@ -450,3 +450,22 @@ hyphenation={english} } +@patent{Pike2008, + author={Pike, Dion}, + title={Master-slave communications system and method for a network element}, + type={US Patent}, + holder={Alcatel-Lucent SAS}, + number={7,460,482}, + year={2008}, + month={12}, + url={https://patents.google.com/patent/US7460482} +} + +@misc{Hough62, + author={Hough, Paul V. C.}, + title={Method and means for recognizing complex patterns}, + howpublished={US Patent 3,069,654}, + year={1962}, + month={12}, + url={https://patents.google.com/patent/US3069654} +} diff --git a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbTermReport/main.pdf b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbTermReport/main.pdf Binary files differindex 7800328a662..aa376e5e307 100644 --- a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbTermReport/main.pdf +++ b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbTermReport/main.pdf diff --git a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbTermReport/main.tex b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbTermReport/main.tex index dbaafd4717f..9fa2d554862 100644 --- a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbTermReport/main.tex +++ b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbTermReport/main.tex @@ -16,9 +16,9 @@ \bibliography{references} % requires file 'references.bib' %%%---------------------------------------------------------- -\author{Peter A.\ Wiseguy} -\title{CS799 Ridiculously Advanced Systems\\ % the name of the course or project - Project Report} % or "Term Report" +\author{Peter A.\ Wiseguy} % your name +\title{CS799 Ridiculously Advanced Systems\\ % the name of the course or project + Term Report} % or "Project Report" \date{\today} %%%---------------------------------------------------------- @@ -32,7 +32,8 @@ \begin{abstract}\noindent This document is a simple template for a typical term or semester paper (lab/course report, ``Übungsbericht'', \etc) based on the \textsf{HagenbergThesis} \latex package.% -\footnote{See \url{https://github.com/Digital-Media/HagenbergThesis} for the most current version. +\footnote{See \url{https://github.com/Digital-Media/HagenbergThesis} for the most current version +and additional examples. This repository also provides a good introduction and useful hints for authoring academic texts with LaTeX.} The structure and chapter titles have been formulated to provide a good starting point for a typical \emph{project report}. @@ -40,11 +41,15 @@ This document uses the custom class \textsf{hgbreport} which is based on \latex' document class with \texttt{chapter} as the top structuring element. If you wish to write this report in German you should substitute the line \begin{quote} - \verb!\documentclass[english]{hgbreport}! + \verb!\documentclass[english]{hgbreport}! \end{quote} at the top of this document by \begin{quote} - \verb!\documentclass[german]{hgbreport}!. + \verb!\documentclass[german]{hgbreport}!. +\end{quote} +To omit the default \textbf{title page} (as in this document) use the \texttt{notitlepage} option, \eg, +\begin{quote} + \verb!\documentclass[notitlepage,english]{hgbreport}!. \end{quote} Also, you may want to place the text of the individual chapters in separate files and include them using \verb!\include{..}!. @@ -66,7 +71,7 @@ Use the abstract to provide a short summary of the contents in the document. %%%---------------------------------------------------------- Describe the initial goals and situation that lead to this project, requirements, as well as -references to related work (e.g., \cite{Higham1998}). +references to related work (\eg, \cite{Higham1998}). @@ -74,13 +79,11 @@ references to related work (e.g., \cite{Higham1998}). \chapter{Project Details} %%%---------------------------------------------------------- -Describe important project steps, e.g., rationale of the chosen architecture or technology stack, +Describe important project steps, \eg, the rationale of the chosen architecture or technology stack, design decisions, algorithms used, interesting challenges faced on the way, lessons learned \etc - - %%%---------------------------------------------------------- \chapter{System Documentation} %%%---------------------------------------------------------- diff --git a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbTermReport/references.bib b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbTermReport/references.bib index c0f9515705b..571825792b5 100644 --- a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbTermReport/references.bib +++ b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbTermReport/references.bib @@ -450,3 +450,22 @@ hyphenation={english} } +@patent{Pike2008, + author={Pike, Dion}, + title={Master-slave communications system and method for a network element}, + type={US Patent}, + holder={Alcatel-Lucent SAS}, + number={7,460,482}, + year={2008}, + month={12}, + url={https://patents.google.com/patent/US7460482} +} + +@misc{Hough62, + author={Hough, Paul V. C.}, + title={Method and means for recognizing complex patterns}, + howpublished={US Patent 3,069,654}, + year={1962}, + month={12}, + url={https://patents.google.com/patent/US3069654} +} diff --git a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisDE/main.pdf b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisDE/main.pdf Binary files differindex 990bf4f1742..949c0094917 100644 --- a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisDE/main.pdf +++ b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisDE/main.pdf diff --git a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisDE/main.tex b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisDE/main.tex index 93eb6cdcd09..532b281fe56 100644 --- a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisDE/main.tex +++ b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisDE/main.tex @@ -7,7 +7,7 @@ % !TeX spellcheck = de_DE % !BIB program = biber -\documentclass[master,german]{hgbthesis} +\documentclass[bachelor,german]{hgbthesis} % Zulässige Optionen in [..]: % Typ der Arbeit: diploma, master (default), bachelor, internship % Hauptsprache: german (default), english diff --git a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisDE/references.bib b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisDE/references.bib index c0f9515705b..571825792b5 100644 --- a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisDE/references.bib +++ b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisDE/references.bib @@ -450,3 +450,22 @@ hyphenation={english} } +@patent{Pike2008, + author={Pike, Dion}, + title={Master-slave communications system and method for a network element}, + type={US Patent}, + holder={Alcatel-Lucent SAS}, + number={7,460,482}, + year={2008}, + month={12}, + url={https://patents.google.com/patent/US7460482} +} + +@misc{Hough62, + author={Hough, Paul V. C.}, + title={Method and means for recognizing complex patterns}, + howpublished={US Patent 3,069,654}, + year={1962}, + month={12}, + url={https://patents.google.com/patent/US3069654} +} diff --git a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisEN/main.pdf b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisEN/main.pdf Binary files differindex f2492491c3a..f4ca660aba8 100644 --- a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisEN/main.pdf +++ b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisEN/main.pdf diff --git a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisEN/references.bib b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisEN/references.bib index c0f9515705b..571825792b5 100644 --- a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisEN/references.bib +++ b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisEN/references.bib @@ -450,3 +450,22 @@ hyphenation={english} } +@patent{Pike2008, + author={Pike, Dion}, + title={Master-slave communications system and method for a network element}, + type={US Patent}, + holder={Alcatel-Lucent SAS}, + number={7,460,482}, + year={2008}, + month={12}, + url={https://patents.google.com/patent/US7460482} +} + +@misc{Hough62, + author={Hough, Paul V. C.}, + title={Method and means for recognizing complex patterns}, + howpublished={US Patent 3,069,654}, + year={1962}, + month={12}, + url={https://patents.google.com/patent/US3069654} +} diff --git a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/back/anhang_a.tex b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/back/anhang_a.tex index 47c6521f565..708235b8a76 100644 --- a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/back/anhang_a.tex +++ b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/back/anhang_a.tex @@ -17,8 +17,6 @@ Datum & Datei \\ \end{center} - - \section{Details zur aktuellen Version} diff --git a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/back/anhang_d.tex b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/back/anhang_d.tex index 64465cf711a..dda220cc94c 100644 --- a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/back/anhang_d.tex +++ b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/back/anhang_d.tex @@ -1,16 +1,24 @@ \chapter{\latex-Quellkode} \label{app:latex} -\section*{Hauptdatei \texttt{\_thesis\_DE.tex}} +\section*{Hauptdatei \texttt{main.tex}} \paragraph{Anmerkung:} Das sollte nur ein \emph{Beispiel} für die Einbindung von Quellcode -in einem Anhang sein. Der \latex-Quellkode der eigenen -Abschlussarbeit ist meist \emph{nicht} interessant genug, um ihn hier +in einem Anhang sein. Die dazu verwendeten Anweisungen sind folgende: +% +\begin{LaTeXCode}[numbers=none] +\begin{footnotesize} +\verbatiminput{main.tex} +\end{footnotesize} +\end{LaTeXCode} +% +Natürlich ist der \latex-Quellkode der eigenen +Abschlussarbeit meist \emph{nicht} interessant genug, um ihn hier wiederzugeben! \begin{footnotesize} -\verbatiminput{_thesis_DE.tex} +\verbatiminput{main.tex} \end{footnotesize} diff --git a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/chapters/abbildungen.tex b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/chapters/abbildungen.tex index 2ee82edea58..8930b7b45e3 100644 --- a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/chapters/abbildungen.tex +++ b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/chapters/abbildungen.tex @@ -17,7 +17,6 @@ sollte erst \emph{nach} dem ersten Verweis platziert werden. \end{figure} - \section{\emph{Let Them Float!}} Das Platzieren von Abbildungen und Tabellen gehört zu den @@ -217,11 +216,9 @@ unter\-zogen, obwohl deren verheerende Folgen für jeden Laien sichtbar sein sol \begin{figure} \centering\small -\begin{tabular}{cc} -%\FramePic{\includegraphics[width=0.45\textwidth]{screenshot-dirty}} & % JPEG file -%\FramePic{\includegraphics[width=0.45\textwidth]{screenshot-clean}} \\ % PNG file -\fbox{\includegraphics[width=0.45\textwidth]{screenshot-dirty}} & % JPEG file -\fbox{\includegraphics[width=0.45\textwidth]{screenshot-clean}} \\ % PNG file +\begin{tabular}{@{}cc@{}} +\fbox{\includegraphics[width=0.475\textwidth]{screenshot-dirty}} & % JPEG file +\fbox{\includegraphics[width=0.475\textwidth]{screenshot-clean}} \\ % PNG file (a) & (b) \end{tabular} \caption{Typischer JPEG-Pfusch. Screenshots und ähnliche im Original @@ -470,8 +467,7 @@ Kap.\ \ref{cha:Literatur} (insbes.\ Abschnitt \ref{sec:KategorieOnline}). \begin{figure} \centering\small -\setlength{\tabcolsep}{0mm} % alle Spaltenränder auf 0mm -\begin{tabular}{c@{\hspace{12mm}}c} % mittlerer Abstand = 12mm +\begin{tabular}{@{}c@{\hspace{12mm}}c@{}} % mittlerer Abstand = 12mm \includegraphics[width=.45\textwidth]{overhang-mounting} & \includegraphics[width=.45\textwidth]{straddle-mounting} \\ diff --git a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/chapters/latex.tex b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/chapters/latex.tex index 0826c269a55..d9d5c17236d 100644 --- a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/chapters/latex.tex +++ b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/chapters/latex.tex @@ -732,12 +732,15 @@ zum Erstellen dieses Dokuments erforderlich sind: \item \nolinkurl{hgb.sty} (Style-Datei): enthält zentrale Definitionen und Einstellungen. Diese Datei wird von \nolinkurl{hgbthesis.cls} automatisch geladen, kann aber grundsätzlich auch für andere Dokumente verwendet werden. -\item Weitere Style-Dateien: - \nolinkurl{hgbabbrev.sty} (div.\ Abkürzungen), - \nolinkurl{hgbbib.sty} (Literaturverwaltung), - \nolinkurl{hgbheadings.sty} (Seiten-Header), - \nolinkurl{hgblistings.sty} (Code-Listings). - Diese Dateien werden von \nolinkurl{hgbthesis.cls} verwendet. +\item Weitere Style-Dateien, die von \nolinkurl{hgbthesis.cls} importiert werden: + \begin{itemize} + \item[] \nolinkurl{hgbabbrev.sty} (div.\ Abkürzungen), + \item[] \nolinkurl{hgbalgo.sty} (Algorithmen), + \item[] \nolinkurl{hgbbib.sty} (Literaturverwaltung), + \item[] \nolinkurl{hgbheadings.sty} (Seiten-Header), + \item[] \nolinkurl{hgblistings.sty} (Code-Listings), + \item[] \nolinkurl{hgbmath.sty} (Mathematisches). + \end{itemize} \end{itemize} diff --git a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/chapters/literatur.tex b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/chapters/literatur.tex index 4c4e3d6a5ed..6568683e4e1 100644 --- a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/chapters/literatur.tex +++ b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/chapters/literatur.tex @@ -47,39 +47,101 @@ Um einen Eintrag im Quellenverzeichnis zu erstellen und im Text darauf zu verwei Für Quellenverweise im laufenden Text verwendet man die Anweisung \begin{itemize} -\item[] \verb!\cite{!\textit{Verweise}\verb!}! +\item[] \verb!\cite{!\textit{keys}\verb!}! \quad oder \quad - \verb!\cite[!\textit{Zusatztext}\verb!]{!\textit{Verweise}\verb!}!. + \verb!\cite[!\textit{text}\verb!]{!\textit{keys}\verb!}!. \end{itemize} \noindent% -\textit{Verweise} ist eine durch Kommas getrennte Auflistung von $1$--$n$ Quellen-\emph{Schlüsseln} +\textit{keys} ist eine durch Kommas getrennte Auflistung von $1$--$n$ Quellen-\emph{Schlüsseln} zur Identifikation der entsprechenden Einträge im Quellenverzeichnis. -Mit \textit{Zusatztext} können Ergänzungstexte zum aktuellen Quellenverweis angegeben +Mit \textit{text} können Ergänzungstexte zum aktuellen Quellenverweis angegeben werden, wie \zB Kapitel- oder Seitenangaben bei Büchern. -Einige Beispiele dazu: - +Nachfolgend einige Beispiele dazu: +% +\begin{itemize} +\item +%$\rightarrow$ +Mehr dazu findet sich in \cite{Kopka2003}. %\newline \begin{LaTeXCode}[numbers=none] Mehr dazu findet sich in \cite{Kopka2003}. \end{LaTeXCode} -$\rightarrow$ Mehr dazu findet sich in \cite{Kopka2003}. +\item +Mehr zu diesem Thema in \cite[Kap.~3]{Kopka2003}. \begin{LaTeXCode}[numbers=none] -Mehr über \emph{Styles} in \cite[Kap.\ 3]{Kopka2003}. +Mehr zu diesem Thema in \cite[Kap.~3]{Kopka2003}. \end{LaTeXCode} -$\rightarrow$ Mehr über \emph{Styles} in \cite[Kap.\ 3]{Kopka2003}. +\item +Die Angaben in \cite[S.\ 274--277]{BurgeBurger1999} erscheinen überholt. \begin{LaTeXCode}[numbers=none] -Die Angaben in \cite[S.\ 274--277]{BurgeBurger1999} sind falsch. +Die Angaben in \cite[S.\ 274--277]{BurgeBurger1999} erscheinen überholt. \end{LaTeXCode} -$\rightarrow$ Die Angaben in \cite[S.\ 274--277]{BurgeBurger1999} sind falsch. +\item +Interessant sind auch \cite{BurgeBurger1999,Patashnik1988,Duden1997}. +\begin{LaTeXCode}[numbers=none] +Interessant sind auch \cite{BurgeBurger1999,Patashnik1988,Duden1997}. +\end{LaTeXCode} +In diesem Beispiel sind mehrere Quellen in einem einzigen +\texttt{\textbackslash cite}-Befehl angeführt. +Man beachte, dass dabei die Einträge automatisch (numerisch \bzw\ +alphabetisch) sortiert werden. +Mehrere aufeinanderfolgende \texttt{\textbackslash cite}-Befehle sollte man +dafür nicht verwenden. +\end{itemize} + +\subsection{Mehrfache Quellenangaben mit Zusatztexten} + +Nicht ganz so einfach ist es, wenn man bei mehreren Quellenangaben gleichzeitig +auch Texte anbringen möchte, etwa zur Angabe der jeweiligen Seitennummern. +Dafür bietet das \texttt{hagenberg}-Paket das zusätzliche Makro% +\footnote{\texttt{\textbackslash mcite} funktioniert ähnlich dem \texttt{{\bs}cites}-Kommando +von \texttt{biblatex} +(s.\ \url{http://mirrors.ctan.org/info/translations/biblatex/de/biblatex-de-Benutzerhandbuch.pdf}) +und ist in \texttt{hgbbib.sty} definiert.} +% +\begin{itemize} +\item[] +\verb!\mcite[!\textit{text1}\verb!]{!\textit{key1}\verb!}!% + \verb![!\textit{text2}\verb!]{!\textit{key2}\verb!}!\ldots% + \verb![!\textit{textN}\verb!]{!\textit{keyN}\verb!}!, +\end{itemize} +bei dem man zu jedem angeführten Quellenschlüssel (\textit{key}) auch einen zugehörigen \textit{text} +angeben kann, zum Beispiel: +% +\begin{itemize} +\item +Ähnliches findet sich auch in +\mcite[Kap.~2]{Artner2007}[Abschn.~3.6]{Drake1948}[S.~5--7]{Eberl1987}. +% \begin{LaTeXCode}[numbers=none] -Überholt sind auch \cite{BurgeBurger1999, Patashnik1988, Duden1997}. +Ähnliches findet sich auch in +\mcite[Kap.~2]{Artner2007}[Abschn.~3.6]{Drake1948}[S.~5--7]{Eberl1987}. \end{LaTeXCode} -$\rightarrow$ Überholt sind auch \cite{BurgeBurger1999, Patashnik1988, Duden1997}. +\end{itemize} +% +Zur besseren Lesbarkeit wird hier -- anders als beim gewöhnlichen \texttt{\textbackslash cite} -- +ein \emph{Strichpunkt} (;) als Trennzeichen zwischen den Einträgen eingefügt. +Bei der Verwendung von \texttt{\textbackslash mcite} muss man sich allerdings (sofern gewünscht) selbst +um die Sortierung der Einträge kümmern, sie erfolgt nicht automatisch. -Die Sortierung der Angaben im letzten Beispiel erfolgt automatisch. + + +\subsection{Unterdrückung der Rückverweise mit \texttt{\textbackslash citenobr}} + +Mit dem vorliegenden Setup wird zu jedem Eintrag im Quellenverzeichnis automatisch +eine Liste der Textseiten angefügt, auf denen die Quelle zitiert wurde. +In seltenen Fällen (\zB\ bei der Auflistung der auf die CD/DVD kopierten Quellen im Anhang) +ist es sinnvoll, diese \texttt{backref}-Verweise wegzulassen. Dazu ist das spezielle Makro +\texttt{\textbackslash citenobr}% +\footnote{\emph{Cite with no back reference} (definiert in \texttt{hgbbib.sty}).} +vorgesehen: +% +\begin{itemize} +\item[] \verb!\citenobr{!\textit{keys}\verb!}! +\end{itemize} @@ -91,8 +153,8 @@ dem Punkt) stehen, nicht \emph{außerhalb}: % \begin{center} \begin{tabular}{rl} - \textbf{Falsch:} & \ldots hier ist der Satz aus. \cite{Oetiker2015} Und jetzt geht es weiter \ldots \\ - \textbf{Richtig:} & \ldots hier ist der Satz aus \cite{Oetiker2015}. Und jetzt geht es weiter \ldots + \textbf{Falsch:} & \ldots hier ist der Satz zu Ende. \cite{Oetiker2015} Und jetzt geht es weiter \ldots \\ + \textbf{Richtig:} & \ldots hier ist der Satz zu Ende \cite{Oetiker2015}. Und jetzt geht es weiter \ldots \end{tabular} \end{center} @@ -112,26 +174,29 @@ Falls ein ganzer Absatz (oder mehr) aus einer Quelle zitiert wird, sollte der Verweis im vorlaufenden Text und nicht \emph{innerhalb} des Zitats selbst platziert werden. Als Beispiel die folgende Passage aus \cite{Oetiker2015}: -\begin{quote} +% +\begin{quote}\begin{english} Typographical design is a craft. Unskilled authors often commit serious formatting errors by assuming that book design is mostly a question of aesthetics---``If a document looks good artistically, it is well designed.'' But as a document has to be read and not hung up in a picture gallery, the readability and understandability is of much greater importance than the beautiful -look of it.% -\footnote{Man beachte die Verwendung von englischen Hochkommas innerhalb dieses -Zitats.} -\end{quote} -Für das Zitat selbst sollte übrigens die dafür vorgesehene Umgebung -% -\begin{itemize} - \item[] \verb!\begin{quote}! \emph{Zitierter Text ...} \verb!\end{quote}! -\end{itemize} +look of it. +\end{english}\end{quote} % +Für das Zitat selbst sollte übrigens die dafür vorgesehene \texttt{quote}-Umgebung verwendet werden, die durch beidseitige Einrückungen das Zitat vom eigenen Text klar abgrenzt und damit die Gefahr von Unklarheiten (wo ist das Ende des Zitats?) mindert. +In obigem Beispiel wird zudem auch auf Englisch umgeschalten +(siehe Abschn.\ \ref{sec:sprachumschaltung}):% +\footnote{Man beachte auch die Verwendung von englischen Hochkommas innerhalb des Zitats.} +% +\begin{itemize} + \item[] \verb!\begin{quote}\begin{english}! \emph{Zitierter Text} \verb!\end{english}\end{quote}! +\end{itemize} +% Wenn gewünscht, kann das Innere des Zitats auch in Hochkommas verpackt \emph{oder} kursiv gesetzt werden -- aber nicht beides! @@ -618,17 +683,47 @@ unterstützt. Hier ein typisches Beispiel: \end{itemize} % +%%------------------------------------------------------ + +\subsubsection{\texttt{@patent}} +\label{sec:@patent} +Für Patente gibt es den speziellen Eintragstyp \texttt{@patent}, +wie das nachfolgende Beispiel zeigt. +\texttt{year} und \texttt{month} beziehen sich dabei auf das Datum der +Patenterteilung, die Angabe von \texttt{holder} ist optional: +% +\begin{itemize} +\item[] +\begin{GenericCode}[numbers=none] +@patent{Pike2008, + author={Pike, Dion}, + title={Master-slave communications system and method for a network element}, + type={US Patent}, + holder={Alcatel-Lucent SAS}, + number={7,460,482}, + year={2008}, + month={12}, + url={https://patents.google.com/patent/US7460482} +} +\end{GenericCode} +\item[\cite{Pike2008}] \fullcite{Pike2008} +\end{itemize} +% +\texttt{@patent} ist allerdings kein Standardtyp und daher wird nicht +von allen BibTex-Imple\-mentier\-ungen unterstützt. +Alternativ kann man für Patente auch den \texttt{@misc}-Typ verwenden, +wie im nächsten Abschnitt gezeigt \cite{Hough62}. %%------------------------------------------------------ \subsubsection{\texttt{@misc}} \label{sec:@misc} + Sollte mit den bisher angeführten Eintragungstypen für gedruckte Publikationen nicht das Auslangen gefunden werden, sollte man sich zunächst die weiteren (hier nicht näher beschriebenen) Typen im \texttt{biblatex}-Handbuch \cite{Lehman2016} ansehen, beispielsweise -\texttt{@collection} für einen Sammelband als Ganzes (also nicht nur ein Beitrag darin) -oder \texttt{@patent} für ein Patent oder eine Patentanmeldung. +\texttt{@collection} für einen Sammelband als Ganzes (also nicht nur ein Beitrag darin). Wenn nichts davon passt, dann kann auf den Typ \texttt{@misc} zurückgegriffen werden, der ein Textfeld \texttt{howpublished} vorsieht, in dem die Art der Publikation individuell @@ -647,6 +742,26 @@ angegeben werden kann. Das folgende Beispiel zeigt die Anwendung für einen Gese \end{GenericCode} \item[\cite{OoeRaumordnungsgesetz1994}] \fullcite{OoeRaumordnungsgesetz1994} \end{itemize} +% +Hier ist ein weiteres Beispiel zur Verwendung von \texttt{@misc} für ein Patent (als Alternative zu \texttt{@patent}, \so): +% +\begin{itemize} +\item[] +\begin{GenericCode}[numbers=none] +@misc{Hough62, + author={Hough, Paul V. C.}, + title={Method and means for recognizing complex patterns}, + howpublished={US Patent 3,069,654}, + year={1962}, + month={12}, + url={https://patents.google.com/patent/US3069654} +} +\end{GenericCode} +\item[\cite{Hough62}] \fullcite{Hough62} +\end{itemize} + + + \subsection{Filme und audio-visuelle Medien (\textsf{avmedia})} diff --git a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/chapters/mathematik.tex b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/chapters/mathematik.tex index 61c566ce3b7..b5c1a3903a7 100644 --- a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/chapters/mathematik.tex +++ b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/chapters/mathematik.tex @@ -85,7 +85,9 @@ Dieselbe Gleichung \emph{ohne} Nummerierung kann übrigens mit der \texttt{equat \setlength{\fboxsep}{2mm} \fbox{% \begin{minipage}{0.9\textwidth} -Man beachte, dass \textbf{Gleichungen} inhaltlich ein \textbf{Teil des Texts} sind und daher neben der sprachliche \textbf{Überleitung} auch die \textbf{Interpunktion} (wie in Gl.\ \ref{eq:MyFirstEquation} gezeigt) beachtet werden muss. Bei Unsicherheiten sollte man sich passende Beispiele in einem guten Mathematik\-buch ansehen. +Man beachte, dass \textbf{Gleichungen} inhaltlich ein \textbf{Teil des Texts} sind und daher neben der sprachlichen +\textbf{Überleitung} auch die \textbf{Interpunktion} (wie in Gl.\ \ref{eq:MyFirstEquation} gezeigt) beachtet werden muss. +Bei Unsicherheiten sollte man sich passende Beispiele in einem guten Mathematik\-buch ansehen. \end{minipage}} \end{center} % @@ -355,92 +357,167 @@ manueller Nacharbeit) in das eigene \latex-Dokument übernommen werden. \section{Algorithmen} -Für die Beschreibung von Algorithmen in mathematischer Form oder auch für +Die algorithmische Darstellung ist ein wichtiges Mittel zur präzisen Beschreibung von +Berechnungsabläufen. Durch die Verwendung von \emph{mathematischer Notation} (Symbolen und Operatoren) +einerseits und den aus der Programmierung gewohnten \emph{Ablaufstrukturen} (Entscheidungen, Schleifen, +Prozeduren \etc) sind Algorithmen ein bewährtes Bindeglied zwischen der mathematischen Formulierung +und dem zugehörigen Programmcode. + +Ein wesentlicher Aspekt der algorithmischen Beschreibung -- die idealerweise der Implementierung +zumindest strukturell möglichst ähnlich sein sollte -- ist die weitgehende +\emph{Unabhängigkeit} von einer spezifischen Programmiersprache. +Dadurch ergibt sich eine bessere Lesbarkeit, breitere Anwendbarkeit und erhöhte Nachhaltigkeit +(möglicherweise über die Lebensdauer einer Programmiersprache hinaus). +Bei der Formulierung von Algorithmen sollte man \ua\ folgendes beachten:% +\footnote{Siehe auch \url{http://mirror.easyname.at/ctan/macros/latex/contrib/algorithms/algorithms.pdf} +(Abschnitt~7).} +%% +\begin{itemize} +\item +Verwende in Algorithmen die gleichen kurze Symbole (wie $a, i, x, S, \alpha \ldots$), wie man sie auch in mathematischen Definitionen und Gleichungen verwendet. +\item +Verwende nach Möglichkeit mathematische Operatoren, wie \zB\ +$=$ (\verb!$=$!) statt \texttt{==}, +$\leq$ (\verb!$\leq$!) statt \texttt{<=}, +$\cdot$ (\verb!$\cdot$!) statt \texttt{*}, +$\wedge$ (\verb!$\wedge$!) statt \texttt{\&\&}, +\usw +\item +Verwende keine Elemente oder Syntax einer spezifischen Programmiersprache +(\zB\ ist ein "`\texttt{;}"' am Ende einer Anweisung unnötig). +\item +Wenn ein Algorithmus für eine Seite zu lang wird, überlege, wie man ihn +sinnvoll auf kleinere Module aufteilen kann (meist ist dann auch die zugehörige +Programmstruktur nicht optimal). +\end{itemize} + + +Für die Notation von Algorithmen in mathematischer Form oder auch für Pseudo\-code ist in \latex selbst keine spezielle Unterstützung vorgesehen. -Dazu gibt es jedoch eine Reihe von \latex-Paketen (\zB\ \texttt{algorithms}, -\texttt{algorithmicx}, \texttt{algorithm2e}). +Dazu gibt es jedoch eine Reihe von \latex-Paketen, \zB\ \texttt{algorithms}, +\texttt{algorithm2e} und \texttt{algorithmicx}. +Letzteres wird wegen seiner einfachen Syntax auch in dieser Vorlage verwendet, +allerdings mit einigen Erweiterungen.% +\footnote{Die Datei \nolinkurl{hgbalgo.sty} des Hagenberg-Pakets erweitert die Pakete +\texttt{algorithmicx} und \texttt{algpseudocode} (s.\ \url{https://ctan.org/pkg/algorithmicx}) +durch verbesserte Einrückung, Farben \etc Weitere Details finden sich in +\url{http://mirrors.ctan.org/macros/latex/contrib/hagenberg-thesis/doc/hagenberg-thesis.pdf}.} Das Beispiel in Alg.~\ref{alg:Example} wurde mit der Float-Umgebung \texttt{algorithm} -und dem \texttt{algorithmicx}-Paket ausgeführt -(Quellcode in Prog.~\ref{prog:AlgExample}). - +und dem \texttt{algpseudocode}-Paket ausgeführt (s.\ Quellcode in Prog.\ \ref{prog:AlgExample}). +Umfangreichere Beispiele für Algorithmen mit einem ähnlichen Setup finden sich \zB\ in +\cite{BurgerBurge2015}. %%-------------------------------------------------------------------- -\begin{algorithm}[tbp] -\caption{Bikubische Interpolation in 2D. - $w_{\mathrm{cub}}()$ in Zeile \ref{alg:wcub} bezeichnet die - eindimensionale kubische Interpolationsfunktion.} +\begin{algorithm} +\caption{Beispiel für einen mit \texttt{algorithmicx} (\texttt{algpseudocode} + \texttt{hgbalgo}) +gesetzten Algorithmus zur bikubischen Interpolation in 2D. Die in den Zeilen \ref{alg:wcub1} und +\ref{alg:wcub2} verwendete Funktion $\Call{Cubic1D}{x}$ berechnet die Gewichtung +des Werts für die eindimensionale Position $x$.} \label{alg:Example} \begin{algorithmic}[1] % [1] = all lines are numbered -\Procedure{BicubicInterpolation}{$I, x, y$} \Comment{$x,y \in \R$} - \Statex Returns the interpolated value of the image $I$ - at the continuous position $(x, y)$. +\Procedure{BicubicInterpolation}{$I, x, y$} \Comment{two-dimensional interpolation} + \Input{$I$, original image; $x,y \in \R$, continuous position; $a$, control para\-meter.} + \Returns{the interpolated pixel value at the continuous position $(x,y)$.} + \smallskip \State $\mathit{val} \gets 0$ \For{$j \gets 0, \ldots, 3$} \Comment{iterate over 4 lines} \State $v \gets \lfloor y \rfloor - 1 + j$ \State $p \gets 0$ - \For{$i \gets 0, \ldots, 3$} \Comment{iterate over 4 columns} \State $u \gets \lfloor x \rfloor - 1 + i$ - \State $p \gets p + I(u,v) \cdot w_{\mathrm{cub}}(x - u )$ - \label{alg:wcub} - \EndFor + \State $p \gets p + I(u,v) \cdot \Call{Cubic1D}{x - u}$ % w_{\mathrm{cub}}(x - u )$ + \label{alg:wcub1} + \EndFor + \StateNN[2]{Sometimes it is useful to insert a longer, \emph{unnumbered} explanation extending + over multiple lines with proper indentation. This can be done with the (non-standard) command + \texttt{{\bs}StateNN[]\{..\}}. There is also a \texttt{{\bs}StateL\{..\}} command for long + \emph{numbered} (multi-line) statements.} - \State $\mathit{val} \gets \mathit{val} + p \cdot w_{\mathrm{cub}}(y - v)$ + \State $\mathit{val} \gets \mathit{val} + p \cdot \Call{Cubic1D}{y - v}$ + \label{alg:wcub2} \EndFor - \State\Return $\mathit{val}$ - \EndProcedure + +\medskip +\hrule +\medskip + +\Function{Cubic1D}{$x$} \Comment{piecewise cubic polynomial (1D)} + \State $z \gets 0$ + \If{$|x| < 1$} + \State $z \gets |x|^3 - 2 \cdot |x|^2 + 1$ + \ElsIf{$|x| < 2$} + \State $z \gets -|x|^3 + 5 \cdot |x|^2 - 8 \cdot |x| + 4$ + \EndIf + \State\Return{$z$} +\EndFunction + \end{algorithmic} \end{algorithm} %%-------------------------------------------------------------------- -Weitere Details finden sich im Quelltext und natürlich in der Dokumentation der verwendeten Pakete. -Umfangreichere Beispiele für Algorithmen mit diesem Setup finden sich \ua\ in \cite{BurgerBurge2015}. - \begin{program} -\caption{Quellcode zu Algorithmus \ref{alg:Example} (mit \texttt{algorithmicx}). +\caption{Quellcode zu Algorithmus \ref{alg:Example}. Wie ersichtlich, können hier auch beliebig Leerzeilen verwendet werden, was die Lesbarkeit deutlich verbessert.} \label{prog:AlgExample} \begin{LaTeXCode}[numbers=none] \begin{algorithm} -\caption{Bikubische Interpolation in 2D. - $w_{\mathrm{cub}}()$ in Zeile \ref{alg:wcub} bezeichnet die - eindimensionale kubische Interpolationsfunktion.} +\caption{Beispiel für einen mit \texttt{algorithmicx} ... } \label{alg:Example} \begin{algorithmic}[1] % [1] = all lines are numbered -\Procedure{BicubicInterpolation}{$I, x, y$} \Comment{$x,y \in \R$} - \Statex Returns the interpolated value of the image $I$ - at the continuous position $(x, y)$. +\Procedure{BicubicInterpolation}{$I, x, y$} + \Comment{two-dimensional interpolation} + \Input{$I$, original image; $x,y \in \R$, continuous position; + $a$, control para\-meter.} + \Returns{the interpolated pixel value at the continuous position $(x,y)$.} + \smallskip \State $\mathit{val} \gets 0$ - \For{$j \gets 0, \ldots, 3$} \Comment{iterate over 4 lines} \State $v \gets \lfloor y \rfloor - 1 + j$ \State $p \gets 0$ - \For{$i \gets 0, \ldots, 3$} \Comment{iterate over 4 columns} \State $u \gets \lfloor x \rfloor - 1 + i$ - \State $p \gets p + I(u,v) \cdot w_{\mathrm{cub}}(x - u )$ - \label{alg:wcub} + \State $p \gets p + I(u,v) \cdot \Call{Cubic1D}{x - u}$ + \label{alg:wcub1} \EndFor - \State $\mathit{val} \gets - \mathit{val} + p \cdot w_{\mathrm{cub}}(y - v)$ + \StateNN[2]{Sometimes it is useful to insert a longer, ...} + + \State $\mathit{val} \gets \mathit{val} + p \cdot \Call{Cubic1D}{y - v}$ + \label{alg:wcub2} \EndFor - \State\Return $\mathit{val}$ - \EndProcedure + +\medskip\hrule\medskip + +\Function{Cubic1D}{$x$} \Comment{piecewise cubic polynomial (1D)} + \State $z \gets 0$ + \If{$|x| < 1$} + \State $z \gets |x|^3 - 2 \cdot |x|^2 + 1$ + \ElsIf{$|x| < 2$} + \State $z \gets -|x|^3 + 5 \cdot |x|^2 - 8 \cdot |x| + 4$ + \EndIf + \State\Return{$z$} +\EndFunction + \end{algorithmic} \end{algorithm} \end{LaTeXCode} \end{program} +%%-------------------------------------------------------------------- + + + + + diff --git a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/main.pdf b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/main.pdf Binary files differindex b7585cc942f..6927a4f2d40 100644 --- a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/main.pdf +++ b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/main.pdf diff --git a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/main.tcp b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/main.tcp index 122500dfb2f..fbb8f2a3429 100644 --- a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/main.tcp +++ b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/main.tcp @@ -7,6 +7,6 @@ MainFile=main.tex UseBibTeX=1 UseMakeIndex=0 ActiveProfile=LaTeX(utf8) ⇨ PDF(Sumatra) -ProjectLanguage=en -ProjectDialect=US +ProjectLanguage=de +ProjectDialect=DE diff --git a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/main.tex b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/main.tex index 93eb6cdcd09..2dfb462a8fd 100644 --- a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/main.tex +++ b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/main.tex @@ -28,7 +28,7 @@ \author{Peter A.\ Schlaumeier} \programname{Universal Computing} \placeofstudy{Hagenberg} -\dateofsubmission{2017}{02}{28} % {YYYY}{MM}{DD} +\dateofsubmission{2018}{07}{10} % {YYYY}{MM}{DD} %%% Zusätzlich für eine Bachelorarbeit: --------------------- \thesisnumber{XXXXXXXXXX-A} % Stud-ID, z.B. 1310238045-A diff --git a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/references.bib b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/references.bib index c0f9515705b..571825792b5 100644 --- a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/references.bib +++ b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/HgbThesisTutorial/references.bib @@ -450,3 +450,22 @@ hyphenation={english} } +@patent{Pike2008, + author={Pike, Dion}, + title={Master-slave communications system and method for a network element}, + type={US Patent}, + holder={Alcatel-Lucent SAS}, + number={7,460,482}, + year={2008}, + month={12}, + url={https://patents.google.com/patent/US7460482} +} + +@misc{Hough62, + author={Hough, Paul V. C.}, + title={Method and means for recognizing complex patterns}, + howpublished={US Patent 3,069,654}, + year={1962}, + month={12}, + url={https://patents.google.com/patent/US3069654} +} diff --git a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/Manual/main.pdf b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/Manual/main.pdf Binary files differindex f904cc02c54..573732f9f11 100644 --- a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/Manual/main.pdf +++ b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/Manual/main.pdf diff --git a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/Manual/main.tex b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/Manual/main.tex index 2b8091f5c97..b22974f11c6 100644 --- a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/Manual/main.tex +++ b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/Manual/main.tex @@ -3,13 +3,12 @@ \RequirePackage[utf8]{inputenc} % remove when using lualatex oder xelatex! -\title{The \texttt{hagenberg-thesis} Bundle} +\title{The \textsf{hagenberg-thesis} Package} \date{\hgbDate} \author{W.\ Burger and W.\ Hochleitner\\[10pt] University of Applied Sciences Upper Austria\\ -Department of Digital Media\\ -Hagenberg, Austria} +Department of Digital Media, Hagenberg (Austria)} %\author{ %Wilhelm Burger, Wolfgang Hochleitner\\ @@ -26,7 +25,7 @@ Hagenberg, Austria} %%%---------------------------------------------------------- \begin{abstract}\noindent -The \texttt{hagenberg-thesis} bundle is a collection of modern LaTeX templates for university theses (bachelor, +The \textsf{hagenberg-thesis} package is a collection of modern LaTeX templates for university theses (bachelor, master or diploma programs) and related documents. This manual describes the main features of this package. Pre-configured document templates for English and German manuscripts and a complete @@ -37,14 +36,11 @@ tutorial are available on the package's home repository. \section{Introduction} -The complete source of this package and additional materials are hosted in this -repository: -% -\begin{center} -\url{https://github.com/Digital-Media/HagenbergThesis} -\end{center} -This package is made available under the terms of the -\emph{Creative Commons Attribution 4.0 International Public License}.% +The complete source of this package and auxiliary materials are available on +CTAN\footnote{\url{https://ctan.org/pkg/hagenberg-thesis}} +and its development repository.\footnote{\url{https://github.com/Digital-Media/HagenbergThesis}} +The package is made available under the terms of the +Creative Commons Attribution 4.0 International Public License.% \footnote{\url{https://creativecommons.org/licenses/by/4.0/legalcode}} @@ -116,7 +112,7 @@ The following parameters must be specified for \emph{all} types: \section{Style files and user commands} -The \texttt{hgb} package comes with a set of style (\texttt{*.sty}) files that can be used +The package comes with a set of style (\texttt{*.sty}) files that can be used independently of the document classes listed above: \texttt{hgb.sty}, \texttt{hgbabbrev.sty}, @@ -130,7 +126,7 @@ independently of the document classes listed above: \begin{itemize} -\item \textbf{\texttt{{\bs}hgbDate}}: Outputs the \texttt{hgb} package version, +\item \textbf{\texttt{{\bs}hgbDate}}: Outputs the package version date, \eg, ``\texttt{\hgbDate}''. \item \textbf{\texttt{{\bs}calibrationbox}}: Inserts a test box for checking the final print size. \end{itemize} @@ -191,12 +187,17 @@ independently of the document classes listed above: \begin{itemize} -\item \textbf{\texttt{{\bs}AddBibFile}}: A wrapper to \texttt{biblatex}'s \verb!\addbibresource! macro +\item +\textbf{\texttt{{\bs}AddBibFile}}: A wrapper to \texttt{biblatex}'s \verb!\addbibresource! macro (for backward compatibility only). -\item \textbf{\texttt{{\bs}MakeBibliography[\emph{options}]}}: Inserts the reference section or chapter. +\item +\textbf{\texttt{{\bs}MakeBibliography[\emph{options}]}}: Inserts the reference section or chapter. By default, references are automatically split into category subsections.% -\footnote{Predefined reference categories are \texttt{literature}, \texttt{avmedia}, \texttt{online} and \texttt{software}.} +\footnote{Predefined reference categories are \texttt{literature}, \texttt{avmedia}, \texttt{online} +and \texttt{software}.} Use the option \texttt{nosplit} to produce a traditional (\ie, contiguous) list of references. +\item +\textbf{\texttt{{\bs}citenobr\{\emph{keys}\}}}: Analogous to the standard \texttt{{\bs}cite\{\emph{keys}\}} command, but inserts no ``backref'' page numbers in the bibliography. \end{itemize} % \MakeBibliography ... creates a reference section split subsections (default) @@ -223,8 +224,11 @@ The following types of code environments are defined:% \item \textbf{\texttt{XmlCode}}: for XML. \end{itemize} % -\texttt{hgblistings} is based on the \texttt{listingsutf8} package, -thus any valid \texttt{listings} option may be used; for example, +\texttt{hgblistings} is based on the \texttt{listingsutf8}% +\footnote{\url{https://ctan.org/pkg/listingsutf8}} +package, thus any valid \texttt{listings}% +\footnote{\url{https://ctan.org/pkg/listings}} +option may be used; for example, the option \texttt{numbers=none} to suppress line numbers: \begin{LaTeXCode}[numbers=none] \begin{JavaCode}[numbers=none] @@ -236,7 +240,9 @@ the option \texttt{numbers=none} to suppress line numbers: \subsection{Mathematical commands (\texttt{hgbmath.sty})} -\texttt{hgbmath} requires (and automatically loads) the \texttt{amsmath} package, thus all +\texttt{hgbmath} requires (and automatically loads) the \texttt{amsmath}% +\footnote{\url{https://ctan.org/pkg/amsmath}} +package, thus all commands and symbols of \texttt{amsmath} are available by default. The following \emph{additional} commands can only be used in math mode: % @@ -249,10 +255,60 @@ The following \emph{additional} commands can only be used in math mode: \end{itemize} -\section{Package dependencies} +\subsection{Algorithms (\texttt{hgbalgo.sty})} + +\texttt{hgbalgo} is a stand-alone package that is based on -- and extends -- the \texttt{algorithmicx} and +\texttt{algpseudocode} packages.% +\footnote{\url{https://ctan.org/pkg/algorithmicx}} +It fixes some (mostly indentation-related) problems, adds color and provides some additional +commands. It also loads the \texttt{algorithm}% +\footnote{\url{https://ctan.org/pkg/algorithms}} +package which defines a compatible float container for algorithms: +\verb!\begin{algorithm}! \verb!...! \verb!\end{algorithm}!. + + +\paragraph{Additional user commands:} +\begin{itemize} +\item +\textbf{\texttt{{\bs}StateL\{<text>\}}}: Creates a \emph{numbered} statement like \texttt{algorithmicx}'s +\verb!\State! command but provides consistent indentation on multi-line statements. +Note that the statement \texttt{<text>} must be passed as a single argument in \verb!{...}! brackets. +\item +\textbf{\texttt{{\bs}StateNN[<nesting>]\{<text>\}}}: +Creates a \emph{non-numbered} statement like \texttt{algorith\-micx}'s \verb!\State! +command but provides consistent indentation inside nested constructs and over multiple lines. +The optional integer argument \verb!<nesting>! can be used to specify the \emph{nesting depth} +to compensate for a bug in \texttt{algorithmicx} (the nesting level inside a block is not set properly before +the first \verb!\State!). Omitting the optional argument should give correct indentation in most +cases. +\item +\textbf{\texttt{{\bs}Input\{<text>\}}}: +For describing the input parameters in a procedure's preamble. %Usage: \verb!\Input{<description>}! +\item +\textbf{\texttt{{\bs}Output\{<text>\}}}: +For describing the output values in a procedure's preamble. %Usage: \verb!\Output{<description>}! +\item +\textbf{\texttt{{\bs}Returns\{<text>\}}}: +For describing the return values in a procedure's preamble. %Usage: \verb!\Returns{<description>}! +\end{itemize} + +\paragraph{Defined algorithm colors:} +\begin{itemize} +\item[] \textbf{\texttt{AlgKeywordColor}} (for algorithm keywords), +\item[] \textbf{\texttt{AlgProcedureColor}} (for procedure and function names), +\item[] \textbf{\texttt{AlgCommentColor}} (for comments). +\end{itemize} +The above colors can be redefined at any time (see the \texttt{xcolor}% +\footnote{\url{https://ctan.org/pkg/xcolor}} package), \eg, by +\begin{LaTeXCode}[numbers=none] + \definecolor{AlgKeywordColor}{named}{black} + \definecolor{AlgProcedureColor}{rgb}{0.0, 0.5, 0.0} % dark green +\end{LaTeXCode} + + +\section{Package dependencies} -% \begin{sloppypar} The \texttt{hagenberg-thesis} package builds on the following \latex\ packages:\newline \texttt{abstract}, @@ -292,8 +348,8 @@ The \texttt{hagenberg-thesis} package builds on the following \latex\ packages:\ \texttt{pict2e}, \texttt{subdepth}, \texttt{titlesec}, -\texttt{titling}, -\texttt{tocloft}, +\texttt{titling}, +\texttt{tocbasic}, \texttt{url}, \texttt{upquote}, \texttt{verbatim}, diff --git a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/Manual/references.bib b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/Manual/references.bib index c0f9515705b..571825792b5 100644 --- a/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/Manual/references.bib +++ b/Master/texmf-dist/doc/latex/hagenberg-thesis/examples/Manual/references.bib @@ -450,3 +450,22 @@ hyphenation={english} } +@patent{Pike2008, + author={Pike, Dion}, + title={Master-slave communications system and method for a network element}, + type={US Patent}, + holder={Alcatel-Lucent SAS}, + number={7,460,482}, + year={2008}, + month={12}, + url={https://patents.google.com/patent/US7460482} +} + +@misc{Hough62, + author={Hough, Paul V. C.}, + title={Method and means for recognizing complex patterns}, + howpublished={US Patent 3,069,654}, + year={1962}, + month={12}, + url={https://patents.google.com/patent/US3069654} +} diff --git a/Master/texmf-dist/doc/latex/hagenberg-thesis/hagenberg-thesis-tutorial.pdf b/Master/texmf-dist/doc/latex/hagenberg-thesis/hagenberg-thesis-tutorial.pdf Binary files differnew file mode 100644 index 00000000000..6927a4f2d40 --- /dev/null +++ b/Master/texmf-dist/doc/latex/hagenberg-thesis/hagenberg-thesis-tutorial.pdf diff --git a/Master/texmf-dist/doc/latex/hagenberg-thesis/hagenberg-thesis.pdf b/Master/texmf-dist/doc/latex/hagenberg-thesis/hagenberg-thesis.pdf Binary files differindex f904cc02c54..573732f9f11 100644 --- a/Master/texmf-dist/doc/latex/hagenberg-thesis/hagenberg-thesis.pdf +++ b/Master/texmf-dist/doc/latex/hagenberg-thesis/hagenberg-thesis.pdf diff --git a/Master/texmf-dist/doc/latex/hagenberg-thesis/hagenberg-thesis.tex b/Master/texmf-dist/doc/latex/hagenberg-thesis/hagenberg-thesis.tex index 2b8091f5c97..b22974f11c6 100644 --- a/Master/texmf-dist/doc/latex/hagenberg-thesis/hagenberg-thesis.tex +++ b/Master/texmf-dist/doc/latex/hagenberg-thesis/hagenberg-thesis.tex @@ -3,13 +3,12 @@ \RequirePackage[utf8]{inputenc} % remove when using lualatex oder xelatex! -\title{The \texttt{hagenberg-thesis} Bundle} +\title{The \textsf{hagenberg-thesis} Package} \date{\hgbDate} \author{W.\ Burger and W.\ Hochleitner\\[10pt] University of Applied Sciences Upper Austria\\ -Department of Digital Media\\ -Hagenberg, Austria} +Department of Digital Media, Hagenberg (Austria)} %\author{ %Wilhelm Burger, Wolfgang Hochleitner\\ @@ -26,7 +25,7 @@ Hagenberg, Austria} %%%---------------------------------------------------------- \begin{abstract}\noindent -The \texttt{hagenberg-thesis} bundle is a collection of modern LaTeX templates for university theses (bachelor, +The \textsf{hagenberg-thesis} package is a collection of modern LaTeX templates for university theses (bachelor, master or diploma programs) and related documents. This manual describes the main features of this package. Pre-configured document templates for English and German manuscripts and a complete @@ -37,14 +36,11 @@ tutorial are available on the package's home repository. \section{Introduction} -The complete source of this package and additional materials are hosted in this -repository: -% -\begin{center} -\url{https://github.com/Digital-Media/HagenbergThesis} -\end{center} -This package is made available under the terms of the -\emph{Creative Commons Attribution 4.0 International Public License}.% +The complete source of this package and auxiliary materials are available on +CTAN\footnote{\url{https://ctan.org/pkg/hagenberg-thesis}} +and its development repository.\footnote{\url{https://github.com/Digital-Media/HagenbergThesis}} +The package is made available under the terms of the +Creative Commons Attribution 4.0 International Public License.% \footnote{\url{https://creativecommons.org/licenses/by/4.0/legalcode}} @@ -116,7 +112,7 @@ The following parameters must be specified for \emph{all} types: \section{Style files and user commands} -The \texttt{hgb} package comes with a set of style (\texttt{*.sty}) files that can be used +The package comes with a set of style (\texttt{*.sty}) files that can be used independently of the document classes listed above: \texttt{hgb.sty}, \texttt{hgbabbrev.sty}, @@ -130,7 +126,7 @@ independently of the document classes listed above: \begin{itemize} -\item \textbf{\texttt{{\bs}hgbDate}}: Outputs the \texttt{hgb} package version, +\item \textbf{\texttt{{\bs}hgbDate}}: Outputs the package version date, \eg, ``\texttt{\hgbDate}''. \item \textbf{\texttt{{\bs}calibrationbox}}: Inserts a test box for checking the final print size. \end{itemize} @@ -191,12 +187,17 @@ independently of the document classes listed above: \begin{itemize} -\item \textbf{\texttt{{\bs}AddBibFile}}: A wrapper to \texttt{biblatex}'s \verb!\addbibresource! macro +\item +\textbf{\texttt{{\bs}AddBibFile}}: A wrapper to \texttt{biblatex}'s \verb!\addbibresource! macro (for backward compatibility only). -\item \textbf{\texttt{{\bs}MakeBibliography[\emph{options}]}}: Inserts the reference section or chapter. +\item +\textbf{\texttt{{\bs}MakeBibliography[\emph{options}]}}: Inserts the reference section or chapter. By default, references are automatically split into category subsections.% -\footnote{Predefined reference categories are \texttt{literature}, \texttt{avmedia}, \texttt{online} and \texttt{software}.} +\footnote{Predefined reference categories are \texttt{literature}, \texttt{avmedia}, \texttt{online} +and \texttt{software}.} Use the option \texttt{nosplit} to produce a traditional (\ie, contiguous) list of references. +\item +\textbf{\texttt{{\bs}citenobr\{\emph{keys}\}}}: Analogous to the standard \texttt{{\bs}cite\{\emph{keys}\}} command, but inserts no ``backref'' page numbers in the bibliography. \end{itemize} % \MakeBibliography ... creates a reference section split subsections (default) @@ -223,8 +224,11 @@ The following types of code environments are defined:% \item \textbf{\texttt{XmlCode}}: for XML. \end{itemize} % -\texttt{hgblistings} is based on the \texttt{listingsutf8} package, -thus any valid \texttt{listings} option may be used; for example, +\texttt{hgblistings} is based on the \texttt{listingsutf8}% +\footnote{\url{https://ctan.org/pkg/listingsutf8}} +package, thus any valid \texttt{listings}% +\footnote{\url{https://ctan.org/pkg/listings}} +option may be used; for example, the option \texttt{numbers=none} to suppress line numbers: \begin{LaTeXCode}[numbers=none] \begin{JavaCode}[numbers=none] @@ -236,7 +240,9 @@ the option \texttt{numbers=none} to suppress line numbers: \subsection{Mathematical commands (\texttt{hgbmath.sty})} -\texttt{hgbmath} requires (and automatically loads) the \texttt{amsmath} package, thus all +\texttt{hgbmath} requires (and automatically loads) the \texttt{amsmath}% +\footnote{\url{https://ctan.org/pkg/amsmath}} +package, thus all commands and symbols of \texttt{amsmath} are available by default. The following \emph{additional} commands can only be used in math mode: % @@ -249,10 +255,60 @@ The following \emph{additional} commands can only be used in math mode: \end{itemize} -\section{Package dependencies} +\subsection{Algorithms (\texttt{hgbalgo.sty})} + +\texttt{hgbalgo} is a stand-alone package that is based on -- and extends -- the \texttt{algorithmicx} and +\texttt{algpseudocode} packages.% +\footnote{\url{https://ctan.org/pkg/algorithmicx}} +It fixes some (mostly indentation-related) problems, adds color and provides some additional +commands. It also loads the \texttt{algorithm}% +\footnote{\url{https://ctan.org/pkg/algorithms}} +package which defines a compatible float container for algorithms: +\verb!\begin{algorithm}! \verb!...! \verb!\end{algorithm}!. + + +\paragraph{Additional user commands:} +\begin{itemize} +\item +\textbf{\texttt{{\bs}StateL\{<text>\}}}: Creates a \emph{numbered} statement like \texttt{algorithmicx}'s +\verb!\State! command but provides consistent indentation on multi-line statements. +Note that the statement \texttt{<text>} must be passed as a single argument in \verb!{...}! brackets. +\item +\textbf{\texttt{{\bs}StateNN[<nesting>]\{<text>\}}}: +Creates a \emph{non-numbered} statement like \texttt{algorith\-micx}'s \verb!\State! +command but provides consistent indentation inside nested constructs and over multiple lines. +The optional integer argument \verb!<nesting>! can be used to specify the \emph{nesting depth} +to compensate for a bug in \texttt{algorithmicx} (the nesting level inside a block is not set properly before +the first \verb!\State!). Omitting the optional argument should give correct indentation in most +cases. +\item +\textbf{\texttt{{\bs}Input\{<text>\}}}: +For describing the input parameters in a procedure's preamble. %Usage: \verb!\Input{<description>}! +\item +\textbf{\texttt{{\bs}Output\{<text>\}}}: +For describing the output values in a procedure's preamble. %Usage: \verb!\Output{<description>}! +\item +\textbf{\texttt{{\bs}Returns\{<text>\}}}: +For describing the return values in a procedure's preamble. %Usage: \verb!\Returns{<description>}! +\end{itemize} + +\paragraph{Defined algorithm colors:} +\begin{itemize} +\item[] \textbf{\texttt{AlgKeywordColor}} (for algorithm keywords), +\item[] \textbf{\texttt{AlgProcedureColor}} (for procedure and function names), +\item[] \textbf{\texttt{AlgCommentColor}} (for comments). +\end{itemize} +The above colors can be redefined at any time (see the \texttt{xcolor}% +\footnote{\url{https://ctan.org/pkg/xcolor}} package), \eg, by +\begin{LaTeXCode}[numbers=none] + \definecolor{AlgKeywordColor}{named}{black} + \definecolor{AlgProcedureColor}{rgb}{0.0, 0.5, 0.0} % dark green +\end{LaTeXCode} + + +\section{Package dependencies} -% \begin{sloppypar} The \texttt{hagenberg-thesis} package builds on the following \latex\ packages:\newline \texttt{abstract}, @@ -292,8 +348,8 @@ The \texttt{hagenberg-thesis} package builds on the following \latex\ packages:\ \texttt{pict2e}, \texttt{subdepth}, \texttt{titlesec}, -\texttt{titling}, -\texttt{tocloft}, +\texttt{titling}, +\texttt{tocbasic}, \texttt{url}, \texttt{upquote}, \texttt{verbatim}, diff --git a/Master/texmf-dist/tex/latex/hagenberg-thesis/hgb.sty b/Master/texmf-dist/tex/latex/hagenberg-thesis/hgb.sty index 41af43020dd..0522897796f 100644 --- a/Master/texmf-dist/tex/latex/hagenberg-thesis/hgb.sty +++ b/Master/texmf-dist/tex/latex/hagenberg-thesis/hgb.sty @@ -5,7 +5,7 @@ %% File encoding: ASCII \NeedsTeXFormat{LaTeX2e} -\newcommand{\hgbDate}{2017/10/28} % version string +\newcommand{\hgbDate}{2018/11/24} % version string \ProvidesPackage{hgb}[\hgbDate] % Create a default/fallback main language so it is set no matter what @@ -141,10 +141,20 @@ % Captions with font size "small" and additional margin spacing \RequirePackage[small,bf]{caption} +\DeclareCaptionStyle{ruled}{labelfont=bf,labelsep=colon} \setlength{\captionmargin}{5mm} \setlength{\abovecaptionskip}{10pt} \setlength{\belowcaptionskip}{10pt} +%% Disable \footnote in captions: +\newcommand{\@WarnFootnoteInCaption}{% +\GenericError{}{Package hgb Error: footnotes in captions are disabled}% +{How to fix: do not place footnotes in captions!}{}}% +\DeclareCaptionTextFormat{nofootnotes}{% + \renewcommand{\footnote}[1]{\@WarnFootnoteInCaption\relax}#1} +\captionsetup{textformat=nofootnotes} + + % Make float placement easier \renewcommand{\floatpagefraction}{.9} % previously: .5 \renewcommand{\textfraction}{.1} % previously: .2 @@ -173,23 +183,15 @@ % \end{nowidows} -%% Definitions for Algorithms ------------------------------------------------- - -% 'algorithm' creates a floating environment for algorithms (\begin{algorithm}...) -\@ifundefined{chapter}% - {\RequirePackage[ruled]{algorithm}}% - {\RequirePackage[ruled,chapter]{algorithm}} - -\DeclareCaptionStyle{ruled}{labelfont=bf,labelsep=colon} +% Setup for Table of Contents (ToC) -% 'algorithmicx' returns the inner content of algorithms (\begin{algorithmic}[1]...) -\RequirePackage{algorithmicx} -\RequirePackage{algpseudocode} -\algsetlanguage{pseudocode} -\renewcommand{\algorithmicprocedure}{} % use no 'Procedure' keyword +%\RequirePackage[tocgraduated,tocbreaksstrict]{tocstyle}% %% Note: tocstyle is unsupported! +%\usetocstyle{classic}% +\RequirePackage{tocbasic}% %% tocbasic is part of koma script +\DeclareTOCStyleEntry[entryformat=\bfseries\textsf]{tocline}{chapter}% -%% Program and Algorithm Environments ---------------------------------------- +%% Program environments ---------------------------------------- % Define the program float environment: \@ifundefined{chapter}% @@ -200,14 +202,10 @@ \restylefloat*{program} \ifthenelse{\equal{\bbl@main@language}{german} \or \equal{\bbl@main@language}{ngerman}}% -{ \floatname{program}{Programm} - \floatname{algorithm}{Algorithmus} -}{} + {\floatname{program}{Programm}}{}% \ifthenelse{\equal{\bbl@main@language}{english}}% -{ \floatname{program}{Program} - \floatname{algorithm}{Algorithm} -}{} + {\floatname{program}{Program}}{}% %% Date-related commands ------------------------------------------------------ @@ -277,6 +275,16 @@ \RequirePackage{pdfpages} +%% Prevent subfigure package from being loaded ------------------------------- + +% The subfigure package is DEPRECATED (see https://ctan.org/pkg/subfigure)! +% We strongly advise against its use since it creates poor output which is not +% compatible with our quality standards. Loading this package is therefore blocked +% by default. We recommend to use the 'tabular' environment instead. + +\newcommand{\subfigure}{% +\PackageError{hgb}{Use of the 'subfigure' package is not supported in this setup, because it is obsolete}{}} + %% ---------------------------------------------------------------------------- \setlength{\fboxsep}{0mm} %globally zero fbox separator diff --git a/Master/texmf-dist/tex/latex/hagenberg-thesis/hgbabbrev.sty b/Master/texmf-dist/tex/latex/hagenberg-thesis/hgbabbrev.sty index 01e7f6f9838..89215160845 100644 --- a/Master/texmf-dist/tex/latex/hagenberg-thesis/hgbabbrev.sty +++ b/Master/texmf-dist/tex/latex/hagenberg-thesis/hgbabbrev.sty @@ -4,7 +4,7 @@ %% GitHub: https://github.com/Digital-Media/HagenbergThesis %% File encoding: ASCII -\ProvidesPackage{hgbabbrev}[2017/10/28] +\ProvidesPackage{hgbabbrev}[2018/11/24] \newcommand{\latex}{La\-TeX\xspace} % no ornamental LaTeX anymore \newcommand{\tex}{TeX\xspace} % no ornamental LaTeX anymore diff --git a/Master/texmf-dist/tex/latex/hagenberg-thesis/hgbalgo.sty b/Master/texmf-dist/tex/latex/hagenberg-thesis/hgbalgo.sty new file mode 100644 index 00000000000..f7f0f8c2e50 --- /dev/null +++ b/Master/texmf-dist/tex/latex/hagenberg-thesis/hgbalgo.sty @@ -0,0 +1,109 @@ +%% hgbalgo.sty + +%% Toward better looking algorithms ... +%% This package imports and pre-configures the 'algorithmicx'/'algorithmicpseudocode' packages +%% (see https://ctan.org/pkg/algorithmicx), fixes some problems and adds new functionality +%% and colors. It relies on the 'algorithm' package for typesetting float-type algorithms +%% with captions. + +%% This file is part of the Hagenberg Thesis package for creating bachelors's and masters's theses +%% Author: Wilhelm Burger (wilhelm.burger@fh-hagenberg.at) +%% GitHub: https://github.com/Digital-Media/HagenbergThesis +%% File encoding: ASCII + +\ProvidesPackage{hgbalgo}[2018/11/24] + +\RequirePackage[]{algpseudocode} % imports algpseudocode + algorithmicx (use 'noend' to turn off 'end') +\RequirePackage{calc} % for numeric calculations +\RequirePackage{xcolor} + +% Colors to be used in algorithms (can be redefined locally if desired) +%\definecolor{AlgKeywordColor}{named}{black} +%\definecolor{AlgProcedureColor}{named}{black} +%\definecolor{AlgCommentColor}{named}{black} + +\definecolor{AlgKeywordColor}{rgb}{0.00, 0.00, 0.666} % = Dark Blue +\definecolor{AlgProcedureColor}{rgb}{0.00, 0.5, 0.20} % = Dark Green +\definecolor{AlgCommentColor}{gray}{0.40} % = Gray (40% black) + +\algrenewcommand\algorithmicend{\textbf{\color{AlgKeywordColor}end}} +\algrenewcommand\algorithmicdo{\textbf{\color{AlgKeywordColor}do}} +\algrenewcommand\algorithmicwhile{\textbf{\color{AlgKeywordColor}while}} +\algrenewcommand\algorithmicfor{\textbf{\color{AlgKeywordColor}for}} +\algrenewcommand\algorithmicforall{\textbf{\color{AlgKeywordColor}for all}} +\algrenewcommand\algorithmicloop{\textbf{\color{AlgKeywordColor}loop}} +\algrenewcommand\algorithmicrepeat{\textbf{\color{AlgKeywordColor}repeat}} +\algrenewcommand\algorithmicuntil{\textbf{\color{AlgKeywordColor}until}} +\algrenewcommand\algorithmicprocedure{\textbf{\color{AlgKeywordColor}procedure}} +\algrenewcommand\algorithmicfunction{\textbf{\color{AlgKeywordColor}function}} +\algrenewcommand\algorithmicif{\textbf{\color{AlgKeywordColor}if}} +\algrenewcommand\algorithmicthen{\textbf{\color{AlgKeywordColor}then}} +\algrenewcommand\algorithmicelse{\textbf{\color{AlgKeywordColor}else}} +\algrenewcommand\algorithmicrequire{\textbf{\color{AlgKeywordColor}Require:}} +\algrenewcommand\algorithmicensure{\textbf{\color{AlgKeywordColor}Ensure:}} +\algrenewcommand\algorithmicreturn{\textbf{\color{AlgKeywordColor}return}} + +\algrenewcommand\algorithmiccomment[1]{\hfill{\color{AlgCommentColor}\(\triangleright\) #1}}% + +%% algpseudocode assumes that these keywords are non-empty: +%\algrenewcommand\algorithmicprocedure{} % no 'procedure' keyword +%\algrenewcommand\algorithmicfunction{} % no 'function' keyword + +% Use SF font and color for procedure and function names: +\newcommand{\@AlgTextProc}[1]{\textcolor{AlgProcedureColor}{\textsf{#1}}} +\algrenewcommand\textproc{\@AlgTextProc} + +% Redefinitions to remove wrong space when \algorithmicprocedure is empty. +% Inserts an empty () parameter list when no parameters are supplied: +\algdef{SE}[PROCEDURE]{Procedure}{EndProcedure}[2]{% + \ifthenelse{\equal{\algorithmicprocedure}{}}% + {}{\algorithmicprocedure\ }% + \textproc{#1}\hskip0.75pt(#2)}% + {\algorithmicend\ \algorithmicprocedure}% + +\algdef{SE}[FUNCTION]{Function}{EndFunction}[2]{% + \ifthenelse{\equal{\algorithmicfunction}{}}% + {}{\algorithmicfunction\ }% + \textproc{#1}\hskip0.75pt(#2)}% + {\algorithmicend\ \algorithmicfunction}% + +%\algrenewcommand\Call[2]{\textproc{#1}\ifthenelse{\equal{#2}{}}{}{(#2)}}% +\algrenewcommand\Call[2]{\textproc{#1}\hskip0.75pt(#2)}% + +%% ----------------------------------------------------------------- + +\newlength{\@AlgTmpIndent} + +%% New public macros: + +% \StateLong{<text>} creates numbered statements like algorithmicx's \State command but +% provides consistent indentation on multi-line statements. +% Note that the statement text must be passed as an argument in {...} brackets +\newcommand*{\StateL}[1]{\State \parbox[t]{\linewidth-\ALG@thistlm}{#1\strut}}% + +% \StateNN[<nesting>]{<text>} creates non-numbered statements like algorithmicx's \Statex +% command but provides consistent indentation inside nested constructs and over multiple lines. +% The optional integer argument [<nesting>] can be used to specify the nesting depth +% to counteract a bug in algorithmicx (nesting level is not set properly before the first \State +% command inside a nested construct. +\newcommand{\StateNN}[2][\numexpr\theALG@nested-1]{% default indentation = nesting - 1 + \setlength\@AlgTmpIndent{\algorithmicindent*#1}% requires calc package + \Statex\hskip\@AlgTmpIndent\parbox[t]{\linewidth-\@AlgTmpIndent}{#2\strut}% +}% + +% Macros for describing input and output of procedures and functions: +\algnewcommand\Input[1]{\StateNN[1]{\textbf{Input:} #1}}% use to describe input parameters: \Input{<description>} +\algnewcommand\Output[1]{\StateNN[1]{\textbf{Output:} #1}}% use to describe output values: \Output{<description>} +\algnewcommand\Returns[1]{\StateNN[1]{\textbf{Returns} #1}}% use to describe what a procedure/function returns: \Returns{<description} + + +% 'algorithm' creates a floating environment for algorithms: \begin{algorithm}...\end{algorithm} +\@ifundefined{chapter}% + {\RequirePackage[ruled]{algorithm}}% + {\RequirePackage[ruled,chapter]{algorithm}} + +\ifthenelse{\equal{\bbl@main@language}{german} \or \equal{\bbl@main@language}{ngerman}}% + {\floatname{algorithm}{Algorithmus}}{}% + +\ifthenelse{\equal{\bbl@main@language}{english}}% + {\floatname{algorithm}{Algorithm}}{}% diff --git a/Master/texmf-dist/tex/latex/hagenberg-thesis/hgbarticle.cls b/Master/texmf-dist/tex/latex/hagenberg-thesis/hgbarticle.cls index fc861b52c73..e135f741035 100644 --- a/Master/texmf-dist/tex/latex/hagenberg-thesis/hgbarticle.cls +++ b/Master/texmf-dist/tex/latex/hagenberg-thesis/hgbarticle.cls @@ -8,7 +8,7 @@ %% Package Information -------------------------------------------------------- \NeedsTeXFormat{LaTeX2e} -\ProvidesClass{hgbarticle}[2017/10/28] +\ProvidesClass{hgbarticle}[2018/11/24] \RequirePackage{xifthen} @@ -57,6 +57,17 @@ \RequirePackage{hgb} % load associated style file hgb.sty +%% Set title font to SF +\RequirePackage{titling} +\renewcommand{\maketitlehooka}{\sffamily} + +%% Set abstract name to bold (single column format only) +\if@twocolumn% +\else% +\RequirePackage{abstract} +\renewcommand{\abstractnamefont}{\sffamily\small\bfseries} +\fi% + % Add PDF meta data \AtBeginDocument{% @@ -74,6 +85,7 @@ %% Additional Hagenberg packages ---------------------------------------------- \RequirePackage{hgbmath} +\RequirePackage{hgbalgo} \RequirePackage{hgbheadings} \RequirePackage{hgbabbrev} \RequirePackage{hgblistings} diff --git a/Master/texmf-dist/tex/latex/hagenberg-thesis/hgbbib.sty b/Master/texmf-dist/tex/latex/hagenberg-thesis/hgbbib.sty index 4903e98de15..4427cde4804 100644 --- a/Master/texmf-dist/tex/latex/hagenberg-thesis/hgbbib.sty +++ b/Master/texmf-dist/tex/latex/hagenberg-thesis/hgbbib.sty @@ -5,14 +5,20 @@ %% GitHub: https://github.com/Digital-Media/HagenbergThesis %% File encoding: ASCII -\ProvidesPackage{hgbbib}[2017/10/28] +\ProvidesPackage{hgbbib}[2018/11/24] \usepackage{csquotes} % recommended for biblatex %Note: biblatex with bibtex backend is frozen at version 1.7. \usepackage[style=numeric-comp,backend=biber,bibencoding=auto]{biblatex} - -\ExecuteBibliographyOptions{bibwarn=true,sortcites=true,defernumbers=true,isbn=false,doi=false,backref=true} +\ExecuteBibliographyOptions{ + bibwarn=true, + sortcites=true, + defernumbers=true, + isbn=false, + doi=false, + backref=true, + backrefstyle=three} %% titles of reference section + 3 categories of references: \newcommand{\@bibtitle}{Quellenverzeichnis} @@ -144,3 +150,28 @@ \DeclareBibliographyAlias{electronic}{misc} \DeclareBibliographyAlias{image}{misc} \DeclareBibliographyAlias{standard}{misc} + + +% Use a semicolon between multiple entries in \cites +%\renewcommand*{\multicitedelim}{\addsemicolon\space} %% abandoned, affects regular \cite{a,b,c,..} entries too + +% New command for multiple citations with supplementary texts +% usage: \mcite[text1]{key1}[text2]{key2}...[textN]{keyN} +% see https://tex.stackexchange.com/a/132981 +\DeclareMultiCiteCommand{\mcite}[\mkbibbrackets]{\cite}{\addsemicolon\space} + + +% Macro to produce cites with no backref entries +% Modified from http://mirrors.ibiblio.org/CTAN/macros/latex/contrib/biblatex-contrib/biblatex-ieee/ieee.cbx +% See also https://tex.stackexchange.com/questions/344861/biblatex-backref-option-per-entry +\DeclareCiteCommand{\citenobr}% + {\usebibmacro{cite:init}% + \bibopenbracket + \backtrackerfalse\usebibmacro{prenote}} + {\usebibmacro{citeindex}% + \usebibmacro{cite:comp}} + {} + {\usebibmacro{cite:dump}% + \usebibmacro{postnote}% + \bibclosebracket + } diff --git a/Master/texmf-dist/tex/latex/hagenberg-thesis/hgbheadings.sty b/Master/texmf-dist/tex/latex/hagenberg-thesis/hgbheadings.sty index b55a3fc561d..d17c94438a9 100644 --- a/Master/texmf-dist/tex/latex/hagenberg-thesis/hgbheadings.sty +++ b/Master/texmf-dist/tex/latex/hagenberg-thesis/hgbheadings.sty @@ -5,7 +5,7 @@ %% GitHub: https://github.com/Digital-Media/HagenbergThesis %% File encoding: ASCII -\ProvidesPackage{hgbheadings}[2017/10/28] +\ProvidesPackage{hgbheadings}[2018/11/24] \RequirePackage{fancyhdr} \pagestyle{fancy} @@ -34,28 +34,3 @@ \renewcommand{\footrulewidth}{0pt} } -%% Setup for headings (title, toc, abstract) for hgb* classes only ------------ - -\makeatletter% -\@ifclassloaded{hgbthesis}{% - \RequirePackage[titles]{tocloft}% - \renewcommand{\cftchapfont}{\bfseries\sffamily} -}{}% -\@ifclassloaded{hgbreport}{% - \RequirePackage{titling} - \renewcommand{\maketitlehooka}{\sffamily} - \RequirePackage[titles]{tocloft}% - \renewcommand{\cftchapfont}{\bfseries\sffamily} - \RequirePackage{abstract}% - \renewcommand{\abstractnamefont}{\sffamily\small\bfseries} -}{}% -\@ifclassloaded{hgbarticle}{% - \RequirePackage{titling} - \renewcommand{\maketitlehooka}{\sffamily} - \if@twocolumn% - \else% - \RequirePackage{abstract} - \renewcommand{\abstractnamefont}{\sffamily\small\bfseries} - \fi% -}{}% -\makeatother% diff --git a/Master/texmf-dist/tex/latex/hagenberg-thesis/hgblistings.sty b/Master/texmf-dist/tex/latex/hagenberg-thesis/hgblistings.sty index 32511342267..b15b87b74ac 100644 --- a/Master/texmf-dist/tex/latex/hagenberg-thesis/hgblistings.sty +++ b/Master/texmf-dist/tex/latex/hagenberg-thesis/hgblistings.sty @@ -4,9 +4,10 @@ %% GitHub: https://github.com/Digital-Media/HagenbergThesis %% File encoding: UTF-8 -\ProvidesPackage{hgblistings}[2017/10/28] +\ProvidesPackage{hgblistings}[2018/11/24] \RequirePackage{ifthen} +\RequirePackage{textcomp} %% required for upquote option \RequirePackage{xcolor} \definecolor{ListingsBackgroundColor}{gray}{0.95} @@ -201,3 +202,19 @@ keepspaces=true,% escapeinside={/+}{+/}, % makes "/+" and "+/" available for Latex escapes (labels etc.) #1}}% {} + + +% Disable the lstlisting environment (due to popular abuse) +\newcommand{\@WarnLstlisting}{ +\GenericError{}{Package hgblistings Error: The 'lstlisting' environment is disabled}% +{See the error note inserted in the document output for details.}{}% +\begin{quote} +\color{red}\textbf{NOTE:} The \texttt{lstlisting} environment has been deliberately disabled in this setup. +Use \emph{inline code} (breakable and \emph{without} a caption) or create a \emph{float container} with +\texttt{{\textbackslash}begin\{program\} \ldots {\textbackslash}end\{program\}} instead! +See the \texttt{hgbthesis} tutorial for examples. +\end{quote}% +} +\renewenvironment{lstlisting}[0]% +{\@WarnLstlisting\expandafter\comment}% +{\expandafter\endcomment}% diff --git a/Master/texmf-dist/tex/latex/hagenberg-thesis/hgbmath.sty b/Master/texmf-dist/tex/latex/hagenberg-thesis/hgbmath.sty index c73aa717231..33604df889d 100644 --- a/Master/texmf-dist/tex/latex/hagenberg-thesis/hgbmath.sty +++ b/Master/texmf-dist/tex/latex/hagenberg-thesis/hgbmath.sty @@ -5,7 +5,7 @@ %% File encoding: ASCII \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{hgbmath}[2017/10/28] +\ProvidesPackage{hgbmath}[2018/11/24] \RequirePackage{amsmath,amsfonts,amssymb,amsbsy} \RequirePackage{subdepth} % for positioning of sub and super scripts diff --git a/Master/texmf-dist/tex/latex/hagenberg-thesis/hgbreport.cls b/Master/texmf-dist/tex/latex/hagenberg-thesis/hgbreport.cls index 6dff1a37e61..6d7a923e7bf 100644 --- a/Master/texmf-dist/tex/latex/hagenberg-thesis/hgbreport.cls +++ b/Master/texmf-dist/tex/latex/hagenberg-thesis/hgbreport.cls @@ -8,7 +8,7 @@ %% Package Information -------------------------------------------------------- \NeedsTeXFormat{LaTeX2e} -\ProvidesClass{hgbreport}[2017/10/28] +\ProvidesClass{hgbreport}[2018/11/24] \RequirePackage{xifthen} @@ -52,6 +52,15 @@ \RequirePackage{hgb} % load associated style file hgb.sty +%% Set title font to SF +\RequirePackage{titling} +\renewcommand{\maketitlehooka}{\sffamily} + +%% Set abstract name to bold +\RequirePackage{abstract}% +\renewcommand{\abstractnamefont}{\sffamily\small\bfseries} + + % Add PDF meta data \AtBeginDocument{% @@ -69,6 +78,7 @@ %% Additional Hagenberg packages ---------------------------------------------- \RequirePackage{hgbmath} +\RequirePackage{hgbalgo} \RequirePackage{hgbheadings} \RequirePackage{hgbabbrev} \RequirePackage{hgblistings} diff --git a/Master/texmf-dist/tex/latex/hagenberg-thesis/hgbthesis.cls b/Master/texmf-dist/tex/latex/hagenberg-thesis/hgbthesis.cls index fbe1a6b2998..ba16c467923 100644 --- a/Master/texmf-dist/tex/latex/hagenberg-thesis/hgbthesis.cls +++ b/Master/texmf-dist/tex/latex/hagenberg-thesis/hgbthesis.cls @@ -8,7 +8,7 @@ %% Package Information -------------------------------------------------------- \NeedsTeXFormat{LaTeX2e} -\ProvidesClass{hgbthesis}[2017/10/28] +\ProvidesClass{hgbthesis}[2018/11/24] \RequirePackage{xifthen} @@ -587,7 +587,6 @@ This work is published under the conditions of the \@declarationpage } - % Add PDF meta data and create title pages \renewcommand{\maketitle}{ %replace standard LaTeX-command @@ -597,15 +596,17 @@ This work is published under the conditions of the pdfsubject={\@programname, \@placeofstudy}, pdfcreator={LaTeX using class hgbthesis [\hgbDate]}, pdfproducer={pdflatex}, - pdfkeywords={} + pdfkeywords={}, + pageanchor=false % disable hyperref page anchors in frontmatter pages }% - \@maketitlepages + \hypersetup{pageanchor=true} % enable hyperref page anchors in the main document } %% Additional Hagenberg packages ---------------------------------------------- \RequirePackage{hgbmath} +\RequirePackage{hgbalgo} \RequirePackage{hgbheadings} \RequirePackage{hgbabbrev} \RequirePackage{hgblistings} |