Skip to content
Snippets Groups Projects
HsH-report.cls 13.8 KiB
Newer Older
  • Learn to ignore specific revisions
  • Jan Wille's avatar
    Jan Wille committed
    \typeout{Adapted from KOMA script for use in Hochschule Hannover <2021-03-18> Jan Wille}
    
    Jan Wille's avatar
    Jan Wille committed
    \NeedsTeXFormat{LaTeX2e}
    
    
    Jan Wille's avatar
    Jan Wille committed
    \newcommand{\myClassName}{HsH-report}
    
    Jan Wille's avatar
    Jan Wille committed
    \ProvidesClass{\myClassName}[2021/03/18 HsH-Report based on KOMA]
    
    Jan Wille's avatar
    Jan Wille committed
    \newcommand{\HsHlogoPath}{HSH-Logo.pdf}
    
    Jan Wille's avatar
    Jan Wille committed
    \newcommand{\HsHlogoPage}{1}
    
    \newif\if@german%
    
    Jan Wille's avatar
    Jan Wille committed
    \DeclareOption{german}{%
    	\PassOptionsToPackage{ngerman}{babel}
    	\@germantrue
    }
    
    Jan Wille's avatar
    Jan Wille committed
    \DeclareOption{ngerman}{%
    
    Jan Wille's avatar
    Jan Wille committed
    	\PassOptionsToPackage{\CurrentOption}{babel}
    
    Jan Wille's avatar
    Jan Wille committed
    }
    \DeclareOption{english}{%
    
    	\PassOptionsToPackage{\CurrentOption}{babel}
    
    Jan Wille's avatar
    Jan Wille committed
    }
    
    \DeclareOption{f1}{% use logo of fakulty 1
    
    Jan Wille's avatar
    Jan Wille committed
    	\renewcommand{\HsHlogoPage}{2}
    
    Jan Wille's avatar
    Jan Wille committed
    }
    
    \DeclareOption{f2}{% use logo of fakulty 2
    
    Jan Wille's avatar
    Jan Wille committed
    	\renewcommand{\HsHlogoPage}{3}
    
    Jan Wille's avatar
    Jan Wille committed
    }
    
    \DeclareOption{f3}{% use logo of fakulty 3
    
    Jan Wille's avatar
    Jan Wille committed
    	\renewcommand{\HsHlogoPage}{4}
    
    Jan Wille's avatar
    Jan Wille committed
    }
    
    \DeclareOption{f4}{% use logo of fakulty 4
    
    Jan Wille's avatar
    Jan Wille committed
    	\renewcommand{\HsHlogoPage}{5}
    
    Jan Wille's avatar
    Jan Wille committed
    }
    
    \DeclareOption{f5}{% use logo of fakulty 5
    
    Jan Wille's avatar
    Jan Wille committed
    	\renewcommand{\HsHlogoPage}{6}
    
    Jan Wille's avatar
    Jan Wille committed
    }
    
    \DeclareOption{sans}{% use san serif font
    	\renewcommand{\familydefault}{\sfdefault}
    }
    \DeclareOption{roman}{% use roman/serif font
    	\renewcommand{\familydefault}{\rmdefault}
    }
    
    Jan Wille's avatar
    Jan Wille committed
    \DeclareOption*{\PassOptionsToClass{\CurrentOption}{scrreprt}}
    
    Jan Wille's avatar
    Jan Wille committed
    
    
    \ExecuteOptions{fontsize=11pt,a4paper,sans} % standart options
    
    Jan Wille's avatar
    Jan Wille committed
    \ProcessOptions\relax
    
    Jan Wille's avatar
    Jan Wille committed
    
    
    % Load KOMA class
    \LoadClass{scrreprt}
    \KOMAoption{toc}{bibliography,listof}
    
    
    Jan Wille's avatar
    Jan Wille committed
    % standart options for packages
    
    Jan Wille's avatar
    Jan Wille committed
    \PassOptionsToPackage{utf8}{inputenc}
    \PassOptionsToPackage{T1}{fontenc}
    \PassOptionsToPackage{left=3cm,right=2.5cm,top=3cm,bottom=3cm}{geometry}
    
    Jan Wille's avatar
    Jan Wille committed
    \PassOptionsToPackage{hidelinks}{hyperref}
    
    Jan Wille's avatar
    Jan Wille committed
    \PassOptionsToPackage{headsepline}{scrlayer-scrpage}
    
    \PassOptionsToPackage{babel}{csquotes}
    \if@german\PassOptionsToPackage{german=quotes}{csquotes}\fi
    
    Jan Wille's avatar
    Jan Wille committed
    
    \PassOptionsToPackage{backend=biber,style=alphabetic,sorting=nyt}{biblatex}
    
    Jan Wille's avatar
    Jan Wille committed
    \PassOptionsToPackage{free-standing-units,abbreviations}{siunitx}
    
    \PassOptionsToPackage{european,EFvoltages,straightvoltages,betterproportions}{circuitikz}
    
    Jan Wille's avatar
    Jan Wille committed
    
    
    Jan Wille's avatar
    Jan Wille committed
    % used packages:
    
    Jan Wille's avatar
    Jan Wille committed
    \RequirePackage{inputenc} % inputencoding, utf8 recomendet
    \RequirePackage{fontenc} % outputencoding, T1 recomendet
    \RequirePackage{lmodern} % font
    
    Jan Wille's avatar
    Jan Wille committed
    \RequirePackage{babel} % required for german names
    
    Jan Wille's avatar
    Jan Wille committed
    \RequirePackage{geometry} % required for changing layout
    
    Jan Wille's avatar
    Jan Wille committed
    \RequirePackage{scrlayer-scrpage} % required for header and footer
    \RequirePackage{scrhack} % compatability with listings
    \RequirePackage{pgffor} % foreach loops
    
    Jan Wille's avatar
    Jan Wille committed
    \RequirePackage{graphicx} % required for importing images
    
    Jan Wille's avatar
    Jan Wille committed
    \RequirePackage{hyperref} % references and lists are clikable
    \RequirePackage{bookmark} % generat bookmarkes
    
    \RequirePackage{amsmath} % a lot of nice Math
    
    Jan Wille's avatar
    Jan Wille committed
    \RequirePackage{csquotes} % quotations
    
    \if@german\RequirePackage{ziffer}\fi % german dezimal numbers
    
    Jan Wille's avatar
    Jan Wille committed
    
    
    
    % internal commands
    \newtoks\@tabtoks
    \newcommand\addtabtoks[1]{\global\@tabtoks\expandafter{\the\@tabtoks#1}}
    \newcommand\eaddtabtoks[1]{\edef\mytmp{#1}\expandafter\addtabtoks\expandafter{\mytmp}}
    %\newcommand*\resettabtoks{\global\@tabtoks{}}
    \newcommand*\printtabtoks{\the\@tabtoks}
    
    % config for title, header and footer
    
    \newcommand*{\@matrikelnr}{}%
    \newcommand{\matrikelnr}[1]{\gdef\@matrikelnr{#1}}%
    
    Jan Wille's avatar
    Jan Wille committed
    \newcommand*{\@professor}{}%
    \newcommand{\professor}[1]{\gdef\@professor{#1}}%
    
    \newcommand*{\@keywords}{}%
    \newcommand{\keywords}[1]{\gdef\@keywords{#1}}%
    
    Jan Wille's avatar
    Jan Wille committed
    \let\@author\@empty
    
    \let\@keywords\@empty
    
    Jan Wille's avatar
    Jan Wille committed
    \InputIfFileExists{personal.tex}{
    	\ClassInfo{\myClassName}{personal.tex was found. Using it...}
    }{
    	\ClassInfo{\myClassName}{no personal.tex! Configre the titlepage yourselfe}
    }
    
    Jan Wille's avatar
    Jan Wille committed
    \pagestyle{scrheadings}
    
    Jan Wille's avatar
    Jan Wille committed
    \clearpairofpagestyles
    
    \renewcommand*{\chapterpagestyle}{scrheadings} % Chaptertitles get same header/footer as everything
    
    Jan Wille's avatar
    Jan Wille committed
    \automark{chapter}
    
    Jan Wille's avatar
    Jan Wille committed
    \ohead{\headmark}
    \ihead{\@title}
    
    Jan Wille's avatar
    Jan Wille committed
    \ofoot*{\pagemark}
    
    Jan Wille's avatar
    Jan Wille committed
    
    
    Jan Wille's avatar
    Jan Wille committed
    % typesetting indexes upright or standart
    
    Jan Wille's avatar
    Jan Wille committed
    \def\subinrm#1{\sb{\mathrm{#1}}}
    
    Jan Wille's avatar
    Jan Wille committed
    {\catcode`\_=13 \global\let_=\subinrm}
    \mathcode`_="8000
    
    Jan Wille's avatar
    Jan Wille committed
    \newcommand\upsubscripts{\catcode`\_=12 } % the toggle for upright subscripts
    \newcommand\normalsubscripts{\catcode`\_=8 } % the toggle for italic subscripts
    \upsubscripts % setting upright as default
    
    Jan Wille's avatar
    Jan Wille committed
    
    
    Jan Wille's avatar
    Jan Wille committed
    % styling for itemize
    \renewcommand{\labelitemi}{$\bullet$}
    \renewcommand{\labelitemii}{$\circ$}
    \renewcommand{\labelitemiii}{$-$}
    \renewcommand{\labelitemiv}{$\cdot$}
    
    
    % custom commands
    \newcommand{\includeHsHlogohere}[1][5cm]{\includegraphics[width=#1,page=\HsHlogoPage]{\HsHlogoPath}}
    \newcommand{\uproman}[1]{\uppercase\expandafter{\romannumeral#1}}
    \newcommand{\lowroman}[1]{\romannumeral#1\relax}
    
    
    Jan Wille's avatar
    Jan Wille committed
    % do stuff
    
    Jan Wille's avatar
    Jan Wille committed
    \setlength\parindent{0pt} % indentation of new paragraphs
    \raggedbottom
    
    Jan Wille's avatar
    Jan Wille committed
    \renewcommand{\fps@figure}{h!t} % positioning of figures
    \renewcommand{\fps@table}{h!t} % Positonierung of tables
    
    Jan Wille's avatar
    Jan Wille committed
    \renewcommand{\layercontentsmeasure}{\empty} % rulers when using draft disabled
    
    Jan Wille's avatar
    Jan Wille committed
    \MakeOuterQuote{"} % easy quotationmarks
    
    \addtokomafont{publishers}{\normalsize}
    
    
    % load config at beginning of document
    \AtBeginDocument{
    	\makeatletter
    	% solve some common errors:
    	\@ifpackageloaded{biblatex}{
    		\renewcommand*{\mkbibacro}[1]{\MakeUppercase{#1}} % solves fontype warning in San-Serif
    	}{}%
    	\@ifpackageloaded{subfigure}{
    		\newcommand{\subfigureautorefname}{\figureautorefname}
    	}{}%
    	% input config File:
    	\InputIfFileExists{config.tex}{
    		\ClassInfo{\myClassName}{config.tex was found. Using it...}
    	}{
    		\ClassInfo{\myClassName}{no config.tex!! I hope you configered it yourself.}
    	}
    	% provide some usefull commands:
    	\providecommand{\abs}[1]{\ensuremath{\left\vert#1\right\vert}} % Makro for vertical lines around absolute values
    	\makeatother
    }
    
    % nicer abstract:
    \renewenvironment{abstract}{%
    	\chapter*{\centering\abstractname}
    	\addcontentsline{toc}{chapter}{\abstractname}
    		\small
    		\quotation
    }{%
    
    	\ifx\@keywords\@empty\else
    		\vspace{1cm}
    		\paragraph{\if@german Schlüsselwörter:\else Keywords:\fi}
    		\@keywords
    	\fi
    
    	\endquotation
    }
    
    % decloration of Authorship
    
    \newif\if@oneAuthor \@oneAuthortrue
    \if@german
    	\setlocalecaption{ngerman}{dATitle}{Selbstständigkeitserklärung}
    	\setlocalecaption{ngerman}{dAPronomen}{\if@oneAuthor ich\else wir\fi}
    	\setlocalecaption{ngerman}{dAPluralendung}{\if@oneAuthor\else n\fi}
    	\setlocalecaption{ngerman}{dAGenitiv}{\if@oneAuthor mir\else uns\fi}
    	\setlocalecaption{ngerman}{dAText}{
    			Hiermit bestätige\dAPluralendungname\space\dAPronomenname, dass die folgende Arbeit eigenständig von \dAGenitivname\space allein erstellt
    			und unter Berücksichtigung der zur Verfügung gestellten Aufgabenstellung sowie dem Arbeitsmaterial unter Angabe aller verwendeten Quellen
    			erarbeitet wurde. Die Regelungen und Konsequenzen eines Plagiats, inklusive disziplinarischer Maßnahmen, sind \dAGenitivname\space
    			bewusst. Insbesondere wurden alle Zitate und gedanklichen Übernahmen als solche kenntlich gemacht.
    	}
    \else
    	\setlocalecaption{english}{dATitle}{Declaration of Authorship}
    	\setlocalecaption{english}{dAPronomen}{\if@oneAuthor I\else we\fi}
    	\setlocalecaption{english}{dAPronomenf}{\if@oneAuthor I\else We\fi}
    	\setlocalecaption{english}{dAPronomverb}{\if@oneAuthor am\else are\fi}
    	\setlocalecaption{english}{dAGenitiv}{\if@oneAuthor my\else our\fi}
    	\setlocalecaption{english}{dAText}{
    		\dAPronomenfname\space hereby certify that the work \dAPronomenname\space\dAPronomverbname\space submitting is entirely of
    		\dAGenitivname\space own making except where otherwise indicated. \dAPronomenfname\space\dAPronomverbname\space aware of regulations
    		concerning plagiarism, including disciplinary actions that may result from it. Any use of the works of any other author, in any form, is
    		properly acknowledged at their point of use.
    	}
    \fi
    
    Jan Wille's avatar
    Jan Wille committed
    \newcommand\declarationAuthorship{
    
    	\renewcommand{\thanks}{\sbox0}
    	\foreach \x [count=\i] in \@author{\ifnum\i>1\global\@oneAuthorfalse\fi}
    %
    
    Jan Wille's avatar
    Jan Wille committed
    	\thispagestyle{plain}
    
    Jan Wille's avatar
    Jan Wille committed
    	\vspace*{\fill}
    	{\rule{\textwidth}{0.1pt}}
    
    	\vskip 3em
    	{\centering\huge\textbf{\dATitlename}\par}
    	\vskip 3em
    	{\dATextname\par}
    	{\raggedleft
    
    		\foreach \x in \@author{
    
    Jan Wille's avatar
    Jan Wille committed
    			\begin{tabular}[t]{r}
    
    				\rule{4cm}{0.4pt}\\
    
    Jan Wille's avatar
    Jan Wille committed
    				{\footnotesize\x}
    			\end{tabular}
    		}
    
    Jan Wille's avatar
    Jan Wille committed
    }
    
    
    Jan Wille's avatar
    Jan Wille committed
    % reconfig Titlepage
    
    \renewcommand\maketitle[1][l]{%
    
    Jan Wille's avatar
    Jan Wille committed
    	\expandafter\ifnum \csname scr@v@3.12\endcsname>\scr@compatibility\relax
    	\else
    		\def\and{%
    			\end{tabular}%
    			\hskip 1em \@plus.17fil%
    			\begin{tabular}[t]{c}%
    		}%
    	\fi
    
    	\begin{titlepage}
    
    		\ifx\@param\@empty\ClassError{\myClassName}{\maketitle\space with empty option}{
    				\maketitle[] has been called with an empty parameter, this doesn't work. Use \maketitle instead.
    			}
    		\fi
    		\if@titlepageiscoverpage
    			\edef\titlepage@restore{%
    				\noexpand\endgroup
    				\noexpand\global\noexpand\@colht\the\@colht
    				\noexpand\global\noexpand\@colroom\the\@colroom
    				\noexpand\global\vsize\the\vsize
    				\noexpand\global\noexpand\@titlepageiscoverpagefalse
    				\noexpand\let\noexpand\titlepage@restore\noexpand\relax
    
    Jan Wille's avatar
    Jan Wille committed
    			}%
    
    			\begingroup
    			\topmargin=\dimexpr \coverpagetopmargin-1in\relax
    			\oddsidemargin=\dimexpr \coverpageleftmargin-1in\relax
    			\evensidemargin=\dimexpr \coverpageleftmargin-1in\relax
    			\textwidth=\dimexpr
    			\paperwidth-\coverpageleftmargin-\coverpagerightmargin\relax
    			\textheight=\dimexpr
    			\paperheight-\coverpagetopmargin-\coverpagebottommargin\relax
    			\headheight=0pt
    			\headsep=0pt
    			\footskip=\baselineskip
    			\@colht=\textheight
    			\@colroom=\textheight
    			\vsize=\textheight
    			\columnwidth=\textwidth
    			\hsize=\columnwidth
    			\linewidth=\hsize
    		\else
    			\let\titlepage@restore\relax
    		\fi
    		\let\footnotesize\small
    		\let\footnoterule\relax
    		\let\footnote\thanks
    		\renewcommand*\thefootnote{\@fnsymbol\c@footnote}%
    		\let\@oldmakefnmark\@makefnmark
    		\renewcommand*{\@makefnmark}{\rlap\@oldmakefnmark}%
    		\ifx\@extratitle\@empty
    			\ifx\@frontispiece\@empty
    
    Jan Wille's avatar
    Jan Wille committed
    			\else
    
    				\if@twoside\mbox{}\next@tpage\fi
    				\noindent\@frontispiece\next@tdpage
    
    Jan Wille's avatar
    Jan Wille committed
    			\fi
    
    		\else
    			\noindent\@extratitle
    			\ifx\@frontispiece\@empty
    
    Jan Wille's avatar
    Jan Wille committed
    			\else
    
    				\next@tpage
    				\noindent\@frontispiece
    
    Jan Wille's avatar
    Jan Wille committed
    			\fi
    
    			\next@tdpage
    		\fi
    		\setparsizes{\z@}{\z@}{\z@\@plus 1fil}\par@updaterelative
    		\IfFileExists{\HsHlogoPath}{}{
    			\ClassError{\myClassName}{HsH-Logo.pdf not found!}{
    				The HsH Logo is necasary for the titlepage! Try putting it next to your source file or use \HsHlogoPath to define the file location
    
    Jan Wille's avatar
    Jan Wille committed
    			}
    
    		}
    		\vspace*{1cm}
    		\begin{minipage}[t]{\textwidth}%
    			\ifx\@titlehead\@empty \else
    				\usekomafont{titlehead}{\@titlehead}%
    			\fi
    			\hfill
    			\raisebox{0pt}[\ht\strutbox][\dp\strutbox]{\includeHsHlogohere} % image referrencepoint in lower left corner
    		\end{minipage}
    		\raisebox{10pt}{\rule{\textwidth}{0.5pt}}
    		\null\vfill
    		\if\@param c\begin{center}\fi
    		\if\@param r\begin{flushright}\fi
    			\ifx\@subject\@empty \else
    				{\usekomafont{subject}{\@subject\par}}%
    
    Jan Wille's avatar
    Jan Wille committed
    				\vskip 3em
    
    			\fi
    			{\usekomafont{title}{\huge\@title\par}}%
    			\vskip 1em
    			{\ifx\@subtitle\@empty\else\usekomafont{subtitle}{\@subtitle\par}\fi}%
    			\vskip 4em
    			{\ifx\@matrikelnr\@empty
    				\if\@author\@empty\else\usekomafont{author}{
    					\parbox{\dimexpr\linewidth}{
    						\if\@param c\centering\fi
    						\if\@param r\raggedleft\fi
    						\@author
    					}
    				}\fi
    
    Jan Wille's avatar
    Jan Wille committed
    			\else
    
    				\if\@author\@empty\else
    					% sneeky comma needed after \@matrikelnr to deal with single item list
    					\foreach \x [count=\i,evaluate=\i as \y using {{\@matrikelnr,}[\i-1]}] in \@author {\eaddtabtoks{\x & \y\protect\\}}
    					\usekomafont{author}{\def\arraystretch{1.2}
    						\if\@param l\hspace{-6pt}\begin{tabular}{l l}\printtabtoks\end{tabular}\fi
    						\if\@param c\begin{tabular}{l l}\printtabtoks\end{tabular}\fi
    						\if\@param r\begin{tabular}{r r}\printtabtoks\end{tabular}\hspace{-6pt}\fi
    					}
    
    Jan Wille's avatar
    Jan Wille committed
    				\fi
    
    			{\usekomafont{date}{\@date \par}}
    
    			\vskip \z@ \@plus3fill
    
    			{\if\@professor\@empty\else\usekomafont{publishers}{Professor\if@german(in)/Lehrbeauftragte(r)\fi: \@professor}\fi}
    
    			\vskip 3em
    		\if\@param c\end{center}\fi
    		\if\@param r\end{flushright}\fi
    		\par
    		\@thanks\global\let\@thanks\@empty
    		\vfill\null
    		\if@twoside
    			\@tempswatrue
    			\expandafter\ifnum \@nameuse{scr@v@3.12}>\scr@compatibility\relax
    
    Jan Wille's avatar
    Jan Wille committed
    			\else
    
    				\ifx\@uppertitleback\@empty\ifx\@lowertitleback\@empty
    					\@tempswafalse
    				\fi\fi
    			\fi
    			\if@tempswa
    				\next@tpage
    				\begin{minipage}[t]{\textwidth}
    					\@uppertitleback
    				\end{minipage}\par
    				\vfill
    				\begin{minipage}[b]{\textwidth}
    					\@lowertitleback
    				\end{minipage}\par
    
    Jan Wille's avatar
    Jan Wille committed
    				\@thanks\global\let\@thanks\@empty
    			\fi
    
    		\else
    			\ifx\@uppertitleback\@empty\else
    				\ClassWarning{\KOMAClassName}{%
    					non empty \string\uppertitleback\space ignored
    					by \string\maketitle\MessageBreak
    					in `twoside=false' mode%
    				}%
    
    Jan Wille's avatar
    Jan Wille committed
    			\fi
    
    			\ifx\@lowertitleback\@empty\else
    				\ClassWarning{\KOMAClassName}{%
    					non empty \string\lowertitleback\space ignored
    					by \string\maketitle\MessageBreak
    					in `twoside=false' mode%
    				}%
    			\fi
    		\fi
    		\ifx\@dedication\@empty
    		\else
    			\next@tdpage\null\vfill
    			{\centering\usekomafont{dedication}{\@dedication \par}}%
    			\vskip \z@ \@plus3fill
    
    Jan Wille's avatar
    Jan Wille committed
    			\@thanks\global\let\@thanks\@empty
    
    			\cleardoubleemptypage
    		\fi
    		\ifx\titlepage@restore\relax\else\clearpage\titlepage@restore\fi
    	\end{titlepage}
    
    Jan Wille's avatar
    Jan Wille committed
    	\setcounter{footnote}{0}%
    	\expandafter\ifnum \csname scr@v@3.12\endcsname>\scr@compatibility\relax
    		\let\thanks\relax
    		\let\maketitle\relax
    		\let\@maketitle\relax
    		\global\let\@thanks\@empty
    		\global\let\@author\@empty
    		\global\let\@date\@empty
    		\global\let\@title\@empty
    		\global\let\@subtitle\@empty
    		\global\let\@extratitle\@empty
    		\global\let\@frontispiece\@empty
    		\global\let\@titlehead\@empty
    		\global\let\@subject\@empty
    		\global\let\@publishers\@empty
    		\global\let\@uppertitleback\@empty
    		\global\let\@lowertitleback\@empty
    		\global\let\@dedication\@empty
    
    		\global\let\@matrikelnr\@empty
    
    Jan Wille's avatar
    Jan Wille committed
    		\global\let\@professor\@empty
    
    Jan Wille's avatar
    Jan Wille committed
    		\global\let\author\relax
    		\global\let\title\relax
    		\global\let\extratitle\relax
    		\global\let\titlehead\relax
    		\global\let\subject\relax
    		\global\let\publishers\relax
    		\global\let\uppertitleback\relax
    		\global\let\lowertitleback\relax
    		\global\let\dedication\relax
    		\global\let\date\relax
    
    		\global\let\matrikelnr\relax
    		\global\let\professor\relax
    
    Jan Wille's avatar
    Jan Wille committed
    	\fi
    	\global\let\and\relax