From 1196a412b8c2de742fa10094c646204b695d4267 Mon Sep 17 00:00:00 2001
From: Isabell Pflug <isabell.pflug@floating-in.space>
Date: Fri, 29 Apr 2022 20:13:11 +0200
Subject: [PATCH] improved readability of preamble

---
 template_assignments_maths[English].tex | 62 ++++++++++++++---------
 template_assignments_maths[German].tex  | 65 +++++++++++++++----------
 2 files changed, 77 insertions(+), 50 deletions(-)

diff --git a/template_assignments_maths[English].tex b/template_assignments_maths[English].tex
index 8a0554e..397c8d7 100644
--- a/template_assignments_maths[English].tex
+++ b/template_assignments_maths[English].tex
@@ -1,57 +1,71 @@
-% TEMPLATE ********************************************************************************************************
 \documentclass[a4paper,fontsize=12pt,listof=totoc,toc=sectionentrywithdots]{scrartcl}
-%
-% style packages **************************************************************************************************
-%
+
 \usepackage[T1]{fontenc}
 \usepackage[utf8]{inputenc}
 \usepackage{lmodern}
 \usepackage[onehalfspacing]{setspace}
 \setcounter{secnumdepth}{5} % numbered paragraphs
 \usepackage{fancyhdr}
-% page settings ***************************************************************************************************
-%
-% custom commands for title, name and sectioning
-\newcommand{\Assignment}{class name - assignment no. X} % title, for both title and header
-\newcommand{\Task}[1]{ \section*{#1.)} \addcontentsline{toc}{section}{Task #1} \label{sec:task_#1}}
-\newcommand{\Subtask}[1]{ \subsection*{#1)} \addcontentsline{toc}{subsection}{#1 )}}
-\newcommand{\Authorname}{your name here} % your name here
-%
-\setlength{\headheight}{15.2pt}
-\pagestyle{fancy}
-\fancyhf{}
-%
-\fancyhead[R]{\Authorname}
-\fancyhead[L]{\Assignment}
-\fancyfoot[C]{\thepage}
-%
+    \setlength{\headheight}{15.2pt}
+    \pagestyle{fancy}
+    \fancyhf{}
+    \fancyhead[R]{\Authorname}
+    \fancyhead[L]{\Assignment}
+    \fancyfoot[C]{\thepage}
+
 %
-% math packages ***************************************************************************************************
+% math packages
 %
+
 \usepackage{mathtools}
 \usepackage{amsxtra,amssymb,amsthm,amstext,amsfonts}
 \usepackage{esint} % for circle integrals
+
 %
-% optimisation ****************************************************************************************************
+% microtype setting
 %
+
 \usepackage{float} % better control of placements
 \usepackage{microtype} % package for optimising typographic details
+
+%
+% tables
+%
+
 \usepackage{booktabs} % optimised display of tables
 \usepackage{tabularx} % more modern display of tables with \toprule,\midrule,\bottomrule
 \usepackage{multirow} % allows table cells over multiple rows within a column
+
 %
-% misc packages ***************************************************************************************************
+% misc packages
 %
+
 \usepackage[extendedchars]{grffile} % for spaces and special chars in file paths
 \usepackage{xcolor} % adds colours
 \usepackage[hyphens]{url} % adds hyperlinks
 \usepackage[]{hyperref} % adds links to toc
+
+%
+% custom commands
 %
+
+\newcommand{\Assignment}{class name - assignment no. X} % title, for both title and header
+\newcommand{\Authorname}{your name here} % your name here
+\newcommand{\Task}[1]{ \section*{#1.)} \addcontentsline{toc}{section}{Task #1} \label{sec:task_#1}}
+\newcommand{\Subtask}[1]{ \subsection*{#1)} \addcontentsline{toc}{subsection}{#1 )}}
+
+%
+% maketitle
+%
+
 \title{\Assignment}
 \author{\Authorname}
 \date{\today}
-% document ********************************************************************************************************
+
 %
+% document
+%
+
 \begin{document}
 \maketitle
 \tableofcontents
diff --git a/template_assignments_maths[German].tex b/template_assignments_maths[German].tex
index 6606bb7..ece5ae2 100644
--- a/template_assignments_maths[German].tex
+++ b/template_assignments_maths[German].tex
@@ -1,8 +1,5 @@
-% TEMPLATE ********************************************************************************************************
 \documentclass[a4paper,fontsize=12pt,listof=totoc,toc=sectionentrywithdots]{scrartcl}
-%
-% style packages **************************************************************************************************
-%
+
 \usepackage[T1]{fontenc}
 \usepackage[utf8]{inputenc}
 \usepackage[ngerman]{babel} 
@@ -10,49 +7,65 @@
 \usepackage[onehalfspacing]{setspace}
 \setcounter{secnumdepth}{5} % numbered paragraphs
 \usepackage{fancyhdr}
-% page settings ***************************************************************************************************
-%
-% custom commands for title, name and sectioning
-\newcommand{\Hausaufgabe}{Modulname - Hausaufgabe Nr. X} % title, for both title and header
-\newcommand{\Aufgabe}[1]{ \section*{#1.)} \addcontentsline{toc}{section}{Aufgabe #1} \label{sec:aufgabe_#1}}
-\newcommand{\Teilaufgabe}[1]{ \subsection*{#1)} \addcontentsline{toc}{subsection}{#1 )}}
-\newcommand{\Autor}{Max Mustermann} % your name here
-%
-\setlength{\headheight}{15.2pt}
-\pagestyle{fancy}
-\fancyhf{}
-%
-\fancyhead[R]{\Autor}
-\fancyhead[L]{\Hausaufgabe}
-\fancyfoot[C]{\thepage}
-%
+    \setlength{\headheight}{15.2pt}
+    \pagestyle{fancy}
+    \fancyhf{}
+    \fancyhead[R]{\Authorname}
+    \fancyhead[L]{\Assignment}
+    \fancyfoot[C]{\thepage}
+
 %
-% math packages ***************************************************************************************************
+% math packages
 %
+
 \usepackage{mathtools}
 \usepackage{amsxtra,amssymb,amsthm,amstext,amsfonts}
 \usepackage{esint} % for circle integrals
+
 %
-% optimisation ****************************************************************************************************
+% microtype setting
 %
+
 \usepackage{float} % better control of placements
 \usepackage{microtype} % package for optimising typographic details
+
+%
+% tables
+%
+
 \usepackage{booktabs} % optimised display of tables
 \usepackage{tabularx} % more modern display of tables with \toprule,\midrule,\bottomrule
 \usepackage{multirow} % allows table cells over multiple rows within a column
+
 %
-% misc packages ***************************************************************************************************
+% misc packages
 %
+
 \usepackage[extendedchars]{grffile} % for spaces and special chars in file paths
 \usepackage{xcolor} % adds colours
 \usepackage[hyphens]{url} % adds hyperlinks
 \usepackage[]{hyperref} % adds links to toc
+
 %
-\title{\Assignment}
-\author{\Authorname}
+% custom commands
+%
+\newcommand{\Hausaufgabe}{Modulname - Hausaufgabe Nr. X} % title, for both title and header
+\newcommand{\Aufgabe}[1]{ \section*{#1.)} \addcontentsline{toc}{section}{Aufgabe #1} \label{sec:aufgabe_#1}}
+\newcommand{\Teilaufgabe}[1]{ \subsection*{#1)} \addcontentsline{toc}{subsection}{#1 )}}
+\newcommand{\Autor}{Max Mustermann} % your name here
+
+%
+% maketitle
+%
+
+\title{\Hausaufgabe}
+\author{\Autor}
 \date{\today}
-% document ********************************************************************************************************
+
 %
+% document
+%
+
 \begin{document}
 \maketitle
 \tableofcontents