diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/hagenberg-thesis/examples/Manual/main.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/hagenberg-thesis/examples/Manual/main.tex | 104 |
1 files changed, 80 insertions, 24 deletions
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}, |