Skip to content
Snippets Groups Projects
HsH-article.cls 13.8 KiB
Newer Older
  • Learn to ignore specific revisions
  • %%
    %% This is file `HsH-article.cls',
    %% generated with the docstrip utility.
    %%
    %% The original source files were:
    %%
    %% HsH-classes.dtx  (with options: `article')
    
    Jan Wille's avatar
    Jan Wille committed
    %% 
    
    %% This is a generated file.
    
    Jan Wille's avatar
    Jan Wille committed
    %% 
    
    %% Copyright (C) 2021 by Jan Wille <mail@janwille.de>
    
    Jan Wille's avatar
    Jan Wille committed
    %% 
    
    %% This file may be distributed and/or modified under the conditions of
    %% the LaTeX Project Public License, either version 1.3 of this license
    %% or (at your option) any later version.  The latest version of this
    %% license is in:
    
    Jan Wille's avatar
    Jan Wille committed
    %% 
    
    %%    http://www.latex-project.org/lppl.txt
    
    Jan Wille's avatar
    Jan Wille committed
    %% 
    
    %% and version 1.3 or later is part of all distributions of LaTeX version
    %% 2021/01/01 or later.
    
    Jan Wille's avatar
    Jan Wille committed
    %% 
    
    \typeout{Adapted from KOMA script for use in Hochschule Hannover <2023-08-11> Jan Wille}
    
    Jan Wille's avatar
    Jan Wille committed
    \NeedsTeXFormat{LaTeX2e}
    \newcommand{\myClassName}{HsH-article}
    
    \ProvidesClass{\myClassName}[2023/08/11 v2.0 HsH-Class based on KOMA]
    
    Jan Wille's avatar
    Jan Wille committed
    
    
    %% commands for HsH-logo
    
    Jan Wille's avatar
    Jan Wille committed
    \newcommand{\HsHlogoPath}{HSH-Logo.pdf}
    \newcommand{\HsHlogoPage}{1}
    
    \newcommand{\includeHsHlogohere}[1][5cm]{
      \IfFileExists{\HsHlogoPath}{}{
        \ClassError{\myClassName}{HsH-Logo.pdf not found!}{
    
    Jan Wille's avatar
    Jan Wille committed
          The HsH Logo is necasary for the titlepage! Try putting it next to your source file or use \HsHlogoPath to define the file location
        }
      }
    
      \includegraphics[width=#1,page=\HsHlogoPage]{\HsHlogoPath}
    }
    
    Jan Wille's avatar
    Jan Wille committed
    \newif\if@german%
    
    Jan Wille's avatar
    Jan Wille committed
    \newif\if@todos\@todosfalse%
    
    Jan Wille's avatar
    Jan Wille committed
    
    
    %% document options -------------------------------------------------------------------------------
    
    \DeclareOption{german}{
    
      \@germantrue
    
    Jan Wille's avatar
    Jan Wille committed
    }
    
    \DeclareOption{ngerman}{
    
      \@germantrue
    
    Jan Wille's avatar
    Jan Wille committed
    }
    
    \DeclareOption{english}{
    
      \@germanfalse
    
    Jan Wille's avatar
    Jan Wille committed
    }
    
    \DeclareOption{f1}{
    
      \renewcommand{\HsHlogoPage}{2}
    
    Jan Wille's avatar
    Jan Wille committed
    }
    
    \DeclareOption{f2}{
    
      \renewcommand{\HsHlogoPage}{3}
    
    Jan Wille's avatar
    Jan Wille committed
    }
    
    \DeclareOption{f3}{
    
      \renewcommand{\HsHlogoPage}{4}
    
    Jan Wille's avatar
    Jan Wille committed
    }
    
    \DeclareOption{f4}{
    
      \renewcommand{\HsHlogoPage}{5}
    
    Jan Wille's avatar
    Jan Wille committed
    }
    
    \DeclareOption{f5}{
    
      \renewcommand{\HsHlogoPage}{6}
    
    Jan Wille's avatar
    Jan Wille committed
    }
    
    \DeclareOption{sans}{
    
      \renewcommand{\familydefault}{\sfdefault}
    
    \DeclareOption{roman}{
    
      \renewcommand{\familydefault}{\rmdefault}
    
    Jan Wille's avatar
    Jan Wille committed
    \DeclareOption{todos}{
      \@todostrue
    }
    
    %% defere all other options to the base class
    
    Jan Wille's avatar
    Jan Wille committed
    \DeclareOption*{\expandafter\PassOptionsToClass\expandafter{\CurrentOption}{scrartcl}}
    
    \ExecuteOptions{fontsize=11pt,a4paper,ngerman,sans} % default options
    
    Jan Wille's avatar
    Jan Wille committed
    \ProcessOptions\relax
    
    %% Load KOMA class
    
    Jan Wille's avatar
    Jan Wille committed
    \LoadClass{scrartcl}
    \KOMAoption{toc}{bibliography,listof}
    
    
    %% package loading and config ---------------------------------------------------------------------
    
    Jan Wille's avatar
    Jan Wille committed
    \PassOptionsToPackage{utf8}{inputenc}
    
    \RequirePackage{inputenc}
    
    Jan Wille's avatar
    Jan Wille committed
    \PassOptionsToPackage{T1}{fontenc}
    
    \RequirePackage{fontenc}
    
    \RequirePackage{lmodern}
    
    \RequirePackage{graphicx}
    \RequirePackage{amsmath}
    
    \PassOptionsToPackage{vmargin=5\baselineskip,bindingoffset=0.08\paperwidth,textwidth=0.75\paperwidth}{geometry}
    
    Jan Wille's avatar
    Jan Wille committed
    \if@todos
    
    Jan Wille's avatar
    Jan Wille committed
      \setlength{\marginparwidth}{6cm}
      \PassOptionsToPackage{paperwidth=\dimexpr +0.915\paperwidth+\marginparsep+\marginparwidth+0.25cm, right=\dimexpr +\marginparsep+\marginparwidth+0.25cm}{geometry}
    
    Jan Wille's avatar
    Jan Wille committed
    \else
    
      \PassOptionsToPackage{nomarginpar}{geometry}
    
    Jan Wille's avatar
    Jan Wille committed
    \fi
    
    Jan Wille's avatar
    Jan Wille committed
    \RequirePackage{geometry}
    
    \if@german
      \PassOptionsToPackage{ngerman}{babel}
    \else
      \PassOptionsToPackage{english}{babel}
    \fi
    
    \RequirePackage{babel}
    
    Jan Wille's avatar
    Jan Wille committed
    \iflanguage{ngerman}{\RequirePackage{ziffer}}{}%
    
    Jan Wille's avatar
    Jan Wille committed
    \PassOptionsToPackage{headsepline}{scrlayer-scrpage}
    
    \RequirePackage{scrlayer-scrpage}
    \RequirePackage{scrhack}
    \PassOptionsToPackage{hidelinks}{hyperref}
    \RequirePackage{hyperref}
    
    \PassOptionsToPackage{hypcap=true}{caption}
    \RequirePackage{caption}
    
    \RequirePackage{bookmark}
    
    Jan Wille's avatar
    Jan Wille committed
    \PassOptionsToPackage{babel}{csquotes}
    
    Jan Wille's avatar
    Jan Wille committed
    \iflanguage{ngerman}{\PassOptionsToPackage{german=quotes}{csquotes}}{}%
    
    \RequirePackage{csquotes}
    \MakeOuterQuote{"}
    
    Jan Wille's avatar
    Jan Wille committed
    \if@todos
      \PassOptionsToPackage{svgnames}{xcolor}
      \PassOptionsToPackage{
        textsize=small,
        figwidth=.6\textwidth
      }{todonotes}
      \RequirePackage{todonotes}
      \setlength{\marginparwidth}{5.2cm}
    \else
    
    Jan Wille's avatar
    Jan Wille committed
        \newcommand{\listoftodos}[1]{}
        \newcommand{\todo}[2]{}
        \newcommand{\missingfigure}[2]{}
    
    Jan Wille's avatar
    Jan Wille committed
    \fi
    
    \RequirePackage{pgffor}
    %% options for not loaded packages ----------------------------------------------------------------
    
    Jan Wille's avatar
    Jan Wille committed
    \PassOptionsToPackage{backend=biber,style=alphabetic,sorting=nyt}{biblatex}
    
    \PassOptionsToPackage{free-standing-units}{siunitx}
    
    \PassOptionsToPackage{european,EFvoltages,straightvoltages,betterproportions}{circuitikz}
    
    Jan Wille's avatar
    Jan Wille committed
    
    
    %% title matters ----------------------------------------------------------------------------------
    
    \newcommand*{\@shorttitle}{\@empty}
    \renewcommand{\title}[2][]{
      \gdef\@title{#2}
      \gdef\@shorttitle{#1}
    }
    
    \newcommand*{\@matrikelnr}{}
    \newcommand{\matrikelnr}[1]{\gdef\@matrikelnr{#1}}
    \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
    
    
    %% typesetting indexes upright or standart
    \def\subinrm#1{\sb{\mathrm{#1}}}
    {\catcode`\_=13 \global\let_=\subinrm}
    \newcommand\upsubscripts{\catcode`\_=12 }
    \newcommand\normalsubscripts{\catcode`\_=8 }
    \upsubscripts
    
    %% header and footer
    
    Jan Wille's avatar
    Jan Wille committed
    \clearpairofpagestyles
    
    \newpagestyle{HsHheadings}{
      {
    
        \parbox[b]{\sls@headwidth}{
          \LaTeXraggedright
          \ifx\@shorttitle\@empty\@title\else\@shorttitle\fi
        }%
      }
    
    Jan Wille's avatar
    Jan Wille committed
      {
        \parbox[b]{\sls@headwidth}{
          \LaTeXraggedleft
          \leftmark
        }%
      }
    
      {
        \parbox[b]{.45\sls@headwidth}{
          \LaTeXraggedright
          \ifx\@shorttitle\@empty\@title\else\@shorttitle\fi
        }%
    
    Jan Wille's avatar
    Jan Wille committed
        \parbox[b]{.45\sls@headwidth}{
          \LaTeXraggedleft
          \headmark
        }%
    
      }
      (\textwidth,.1pt)
    }{
      {\pagemark}
      {\hfill\pagemark}
      {\hfill\pagemark}
    }
    \pagestyle{HsHheadings}
    
    Jan Wille's avatar
    Jan Wille committed
    \automark{section}
    
    
    %% floats
    \renewcommand{\fps@figure}{h!t}
    \renewcommand{\fps@table}{h!t}
    \ifx\KOMAScriptVersion\undefined\else
      \g@addto@macro\@floatboxreset\centering
    
      \setcapwidth{0.8\textwidth}
    
    Jan Wille's avatar
    Jan Wille committed
    \iflanguage{english}{
      \renewcaptionname{english}{\figurename}{Fig.}
      \renewcaptionname{english}{\tablename}{Tab.}
    }{}%
    \iflanguage{ngerman}{
    
      \renewcaptionname{ngerman}{\figurename}{Abb.}
      \renewcaptionname{ngerman}{\tablename}{Tab.}
      \renewcaptionname{ngerman}{\abstractname}{Abstract}
    
    Jan Wille's avatar
    Jan Wille committed
    }{}%
    
    Jan Wille's avatar
    Jan Wille committed
    
    
    %% styling for itemize
    
    Jan Wille's avatar
    Jan Wille committed
    \renewcommand{\labelitemi}{$\bullet$}
    \renewcommand{\labelitemii}{$\circ$}
    \renewcommand{\labelitemiii}{$-$}
    \renewcommand{\labelitemiv}{$\cdot$}
    
    
    %% do stuff
    
    \setlength\parindent{0pt}
    
    Jan Wille's avatar
    Jan Wille committed
    \raggedbottom
    
    Jan Wille's avatar
    Jan Wille committed
    \let\layercontentsmeasure\relax
    
    %% custom commands
    \newcommand{\uproman}[1]{\uppercase\expandafter{\romannumeral#1}}
    \newcommand{\lowroman}[1]{\romannumeral#1\relax}
    
    %% load config at beginning of document
    
    \AtBeginDocument{
    
      \makeatletter
      \@ifpackageloaded{biblatex}{
        \renewcommand*{\mkbibacro}[1]{\MakeUppercase{#1}}
      }{}
      \@ifpackageloaded{subfigure}{
        \newcommand{\subfigureautorefname}{\figureautorefname}
      }{}
      \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}}
      \makeatother
    
    Jan Wille's avatar
    Jan Wille committed
    %% declaration of Authorship ----------------------------------------------------------------------
    \iflanguage{english}{
      \setlocalecaption{english}{authorshipdeclaration}{Declaration of Authorship}
    }{}%
    \iflanguage{ngerman}{
      \setlocalecaption{ngerman}{authorshipdeclaration}{Selbstst\"andigkeitserkl\"arung}
    }{}%
    
    \newif\if@oneAuthor \@oneAuthortrue
    
    Jan Wille's avatar
    Jan Wille committed
    \newcommand{\declarationofauthorship}[1][b]{
    
      \renewcommand{\thanks}{\sbox0}
      \foreach \x [count=\i] in \@author{\ifnum\i>1\global\@oneAuthorfalse\fi}
      \thispagestyle{plain}
    
      \if\@param b\vspace*{\fill}\fi
    
      {\rule{\textwidth}{0.1pt}}
      \vskip 3em
    
    Jan Wille's avatar
    Jan Wille committed
      {\centering\huge\bfseries\authorshipdeclarationname\par}
    
      \vskip 3em
    
    Jan Wille's avatar
    Jan Wille committed
      \iflanguage{english}{
        \if@oneAuthor I\else We\fi\space hereby certify that the work \if@oneAuthor I\else we\fi\space \if@oneAuthor am\else are\fi\space submitting
        is entirely of \if@oneAuthor my\else our\fi own making except where otherwise indicated. \if@oneAuthor I\else We\fi\space
        \if@oneAuthor am\else are\fi\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. \par
      }{}%
      \iflanguage{ngerman}{
        Hiermit best{\"a}tige\if@oneAuthor\else n\fi\space \if@oneAuthor ich\else wir\fi, dass die folgende Arbeit eigenst{\"a}ndig von
        \if@oneAuthor mir\else uns\fi\space allein erstellt und unter Ber{\"u}cksichtigung der zur Verf{\"u}gung gestellten Aufgabenstellung sowie dem
        Arbeitsmaterial unter Angabe aller verwendeten Quellen erarbeitet wurde. Die Regelungen und Konsequenzen eines Plagiats, inklusive
        disziplinarischer Ma{\ss}nahmen, sind \if@oneAuthor mir\else uns\fi\space bewusst. Insbesondere wurden alle Zitate und gedanklichen {\"U}bernahmen
        als solche kenntlich gemacht. \par
      }{}%
    
      {\raggedleft
        \foreach \x in \@author{
          \begin{tabular}[t]{r}
            \\[3em]
            \rule{4cm}{0.4pt}\\
            {\footnotesize\x}
          \end{tabular}
        }
      \par}
    
      \if\@param t\vspace*{\fill}\fi
    
    Jan Wille's avatar
    Jan Wille committed
    }
    
    Jan Wille's avatar
    Jan Wille committed
    \let\declarationAuthorship\declarationofauthorship
    
    
    %% reconfig Titlepage -----------------------------------------------------------------------------
    \newtoks\@tabtoks
    \newcommand\addtabtoks[1]{\global\@tabtoks\expandafter{\the\@tabtoks#1}}
    \newcommand\eaddtabtoks[1]{\edef\mytmp{#1}\expandafter\addtabtoks\expandafter{\mytmp}}
    \newcommand*\printtabtoks{\the\@tabtoks}
    \addtokomafont{publishers}{\normalsize}
    \renewcommand\maketitle[1][c]{
      \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
      \par
      \ifx\@uppertitleback\@empty\else
        \ClassWarning{\KOMAClassName}{%
          non empty \string\uppertitleback\space ignored
          by \string\maketitle\MessageBreak
          in `titlepage=false' mode%
        }
      \fi
      \ifx\@lowertitleback\@empty\else
        \ClassWarning{\KOMAClassName}{%
          non empty \string\lowertitleback\space ignored
          by \string\maketitle\MessageBreak
          in `titlepage=false' mode%
        }
      \fi
      \begingroup
        \let\@param#1
        \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
        \let\titlepage@restore\relax
        \renewcommand*\thefootnote{\@fnsymbol\c@footnote}%
        \let\@oldmakefnmark\@makefnmark
        \renewcommand*{\@makefnmark}{\rlap\@oldmakefnmark}%
        \next@tdpage
        \ifx\@extratitle\@empty
          \ifx\@frontispiece\@empty\else \mbox{}\fi
        \else
          \@makeextratitle
        \fi
        \ifx\@frontispiece\@empty
          \ifx\@extratitle\@empty\else\next@tdpage\fi
        \else
          \next@tpage
          \@makefrontispiece
          \next@tdpage
        \fi
        \global\@topnum=\z@
        \setparsizes{\z@}{\z@}{\z@\@plus 1fil}\par@updaterelative
        \vspace*{1cm}
        \begin{minipage}[t]{\textwidth}%
          \ifx\@titlehead\@empty \else
            \usekomafont{titlehead}{\@titlehead}%
          \fi
          \hfill
          \raisebox{0pt}[\ht\strutbox][\dp\strutbox]{\includeHsHlogohere}
        \end{minipage}
        \raisebox{10pt}{\rule{\textwidth}{0.5pt}}
        \null
        \vskip 2em
        \begingroup
          \if\@param c\centering\fi
          \if\@param r\raggedleft\fi
          \ifx\@subject\@empty\else
            {\usekomafont{subject}{\@subject\par}}
            \vskip 1.5em
          \fi
          {\usekomafont{title}{\huge\@title\par}}
          \vskip .5em
          {\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
          \else
            \if\@author\@empty\else
              % sneeky comma needed after \@matrikelnr to deal with single item lists
              \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\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}\fi
    
            \fi
          \fi}
          \vskip 1em
          {\usekomafont{date}{\@date\par}}
          \vskip 1em
    
    Jan Wille's avatar
    Jan Wille committed
         {\if\@professor\@empty\else\usekomafont{publishers}{Professor\iflanguage{ngerman}{(in)/Lehrbeauftragte(r)}{}: \@professor}\fi}
    
          \ifx\@dedication\@empty\else
            \vskip 2em
            {\usekomafont{dedication}{\@dedication \par}}%
          \fi
          \par
        \endgroup
        \vskip 2em
        \ifx\titlepagestyle\@empty\else\thispagestyle{\titlepagestyle}\fi
        \@thanks\global\let\@thanks\@empty
      \endgroup
      \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
        \global\let\@prof\@empty
        \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
      \fi
      \global\let\and\relax
    }
    \endinput
    %%
    %% End of file `HsH-article.cls'.