HsH-classes.dtx

%^^A !TeX root = ./HsH-classes.dtx
%\iffalse meta-comment
%<*internal>
\iffalse
%</internal>
%<*readme> ^^A ---------- README -------------------------------------------------------
 HsH-classes | LaTeX for the Hochschule Hannover
 -----------:| ------------------------------------------------------------
 Author      | Jan Wille
 E-mail      | <mail@janiwlle.de>
 License     | Released under the LaTeX Project Public License v1.3c or later
 See         | <http://www.latex-project.org/lppl.txt>

This Project containes classes to create documents for the Hochschule Hannover.

To use them in you projects bring this folder on you `TEXINPUTS`.
%</readme>
%<*internal>
\fi
\def\nameofplainTeX{plain}
\ifx\fmtname\nameofplainTeX\else
  \expandafter\begingroup
\fi
%</internal>
%<*install> ^^A ---------- HsH-Classes.ins ---------------------------------------------
\input docstrip.tex
\keepsilent
\askforoverwritefalse
\preamble

Copyright (C) 2024 by Jan Wille <mail@janiwlle.de>

This work may be distributed and/or modified under the
conditions of the LaTeX Project Public License (LPPL), either
version 1.3c of this license or (at your option) any later
version.  The latest version of this license is in the file:

http://www.latex-project.org/lppl.txt

\endpreamble

\usedir{tex/latex/HsH-classes}
\generate{
  \file{HsH-article.cls}{\from{\jobname.dtx}{article,localisation}}
  \file{HsH-report.cls}{\from{\jobname.dtx}{report,localisation}}
  \file{HsH-standalone.cls}{\from{\jobname.dtx}{standalone,localisation}}
}
%</install>
%<install>\endbatchfile
%<*internal> ^^A ---------- self-extract -----------------------------------------------
\usedir{source/latex/HsH-classes}
\generate{
  \file{\jobname.ins}{\from{\jobname.dtx}{install}}
}
\nopreamble\nopostamble
\usedir{doc/latex/HsH-classes}
\generate{
  \file{README.md}{\from{\jobname.dtx}{readme}}
}
\ifx\fmtname\nameofplainTeX
  \expandafter\endbatchfile
\else
  \expandafter\endgroup
\fi
%</internal>
%\fi
%
%\iffalse
%<*driver> ^^A ---------- file headers -------------------------------------------------
\ProvidesFile{HsH-classes.dtx}
%</driver>
%<article|report|standalone>\NeedsTeXFormat{LaTeX2e}[2022-06-01]
%<article>\ProvidesClass{HsH-article}
%<report>\ProvidesClass{HsH-report}
%<standalone>\ProvidesClass{HsH-standalone}
%<*article|report|standalone>
  [2024-08-10 3.03.dev0 HsH-class based on KOMA]
%</article|report|standalone>
%<*driver> ^^A ---------- documentation driver -----------------------------------------
\documentclass{ltxdoc}
\usepackage{doc}[2022-06-01]
\usepackage[a4paper,margin=25mm,left=50mm,nohead]{geometry}
\usepackage[numbered]{hypdoc}
\usepackage[style=ddmmyyyy,datesep={.}]{datetime2}
\usepackage{scrlogo}
%
\NewDocElement[idxgroup=classes]{Class}{class}
\NewDocElement{Option}{option}
\providecommand\opt{\texttt}
\newenvironment{options}
  {\begin{list}{}{
    \renewcommand{\makelabel}[1]{\opt{##1}\hfil}
    \setlength{\itemsep}{-.5\parsep}
    \settowidth{\labelwidth}{\texttt{xxxxxxxxx\space}}
    \setlength{\leftmargin}{\labelwidth}
    \addtolength{\leftmargin}{\labelsep}
  }\raggedright}
  {\end{list}}
\newenvironment{packages}
  {\begin{list}{}{
    \renewcommand{\makelabel}[1]{\pkg{##1}\hfil}
    \setlength{\itemsep}{-.5\parsep}
    \settowidth{\labelwidth}{\texttt{xxxxxxx\space}}
    \setlength{\leftmargin}{\labelwidth}
    \addtolength{\leftmargin}{\labelsep}
  }\raggedright}
  {\end{list}}
\newenvironment{note}[1]{\begin{quote}\textbf{Note:}\;#1}{\end{quote}}
\def\paragraph#1{\bigskip\textbf{#1}\\}
\newcommand\OR{\kern1pt{|}\kern1pt}
%
\renewcommand{\familydefault}{\sfdefault}
\setlength\parindent{0pt}
\setcounter{IndexColumns}{2}
\setlength\marginparsep{2\labelsep}
%
\EnableCrossrefs
%
\GetFileInfo{\jobname.dtx}
\title{
  \textsf{HsH-Classes} --- A set of \LaTeX{} classes for use in Hochschule Hannover
  \thanks{This file describes version \fileversion, last revised \filedate.}
}
\author{Jan Wille\thanks{E-mail: mail@janwille.de}}
\MaintainedBy{Maintained on \url{https://lab.it.hs-hannover.de/qxx-tul-u1/latex-template-hsh}}
\date{Created \today}
\begin{document}
  \maketitle
  \begin{multicols}{2}
    \tableofcontents
  \end{multicols}
  \DocInput{\jobname.dtx}
\end{document}
%</driver>
%\fi
%
%
%^^A ---------- document body ----------------------------------------------------------
%
%\vspace{2\baselineskip}
%\begin{abstract}
%  The following documents a set of \LaTeX{} classes created for the Hochschule Hannover.
%  They are intended to ease the workflow when writing documents by providing a common
%  formating basis that should work for pretty much everything a studend will be expected
%  to write. This can be simple one-paged documents, excercises, lab-reports, papers or
%  bachelors and masters thesises.
%
%  The classes provide interfaces to modify commend requriements, provide commands to get
%  specifics like the logo and provide and pre-configure comonly needed packages. This
%  should get you going imidealty and reduce the setuptime significantly.
%\end{abstract}
%
%
%\clearpage
%\section{The different classes}
%
% The project classes provided by the Project all carry the |HsH-| prefix. Here is a
% list of the available classes and some expleantion on when to use which class.
% \begin{description}
%   \item\DescribeClass{HsH-article}
%         A article-class based on \KOMAScript{}s \cls{scrartcl}.
%         It is designed for quick and compact documents and is useful for writing
%         lab-protocols and alike. It does not have chapters and therefore never
%         breaks to a new page on its own.
%   \item\DescribeClass{HsH-report}
%         A report-class based on \KOMAScript{}s \cls{scrreprt}.
%         This is probably the most useful class, as it can be used for a wide
%         variety of documents (beginning with lab-reports and ending at complete
%         thesis). The line between article and report is somewhat blurry, so use
%         as you see fit.
%   \item\DescribeClass{HsH-standalone}
%         A helper class based based on the \cls{standalone}
%         class. It is designed only for creating images as separate documents to
%         keep things organized and compiler times low. It is useful for creating
%         graphs, circuit diagrams or other kind of complex sub documents.
% \end{description}
%
%\section{Document options}
% To configure the behavior and style of documents using this class, options can be
% passed via the |\documentclass|\oarg{options}\marg{document-class} command.
%
% It should be noted that all unknown keys will pe passed to the parrent class and a
% log-message issued.
%
% \subsection{Generic options share by all classes}
%   These Options are avalable regardless of documentclass and modify common things.
%
%   \DescribeOption{fontfamily} \DescribeOption{sans}\DescribeOption{roman}
%   The \opt{fontfamily=\meta{opt}} option configures which font-style is used.
%   For convenience there are also short-forms providet.
%   The avalable options are:
%   \begin{options}
%     \item[sans\OR sans-serif] A sans-serif font is used (similar to Arial)
%     \item[roman\OR serif] A serif font is udes (similar to Times-new-Roman)
%   \end{options}
%
%   \DescribeOption{language} \DescribeOption{english}\DescribeOption{german}
%   The \opt{language=\meta{opt}} option set the main language you write in. It ensures
%   texts like auto-generated headings are localised properly.
%   You can pass in any language-name understood by the \pkg{babel} package. German is