Initial release for 2025

.github/workflows/pipeline.yaml

@@ -12,7 +12,7 @@ jobs:
           root_file: source/CAuDri-Challenge_Regulations.tex
           work_in_root_file_dir: true
       - name: Upload PDF file
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: PDF
           path: source/CAuDri-Challenge_Regulations.pdf

README.md

@@ -0,0 +1,15 @@
+# CAuDri-Challenge Regulations
+
+This repository contains the source files for the official regulations of the CAuDri-Challenge. 
+
+You can always find the current version in the [Releases](https://github.com/CAuDri/regulations/releases) section or on our [website](https://caudri-challenge.de/regulations).
+
+## Contributing
+
+There will be a main development branch for each competition (e.g. "regulations_2025"). 
+Create a new branch from this development branch for your changes and merge them back into the development branch via a pull request.
+
+A commit to the main branch will trigger the generation of a new release, which will be published on our website. This should be thoroughly tested before merging.
+
+New features and differences to the previous competition must be highlighted in yellow.
+Differences to the initial release of the same year will be highlighted in green.

source/CAuDri-Challenge_Regulations.tex

@@ -6,98 +6,66 @@
 %% All graphics can be found on our OneDrive in CAuDri-Challenge\Regelwerk\202X\Source\graphics       %%
 %%                                                                                                    %%
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\documentclass[a4paper]{report}
-
-\title{CAuDri-Challenge Regulations \the\year{}}
-\author{Max Weißer, Yannik Süssmuth}
-\date{\today}
-
-\usepackage{geometry}   	% Used to redfine page dimensions
-\usepackage{lmodern} 		% Replaces 'computer modern' font style, better look on modern displays
-\usepackage[T1]{fontenc}	% Uses T1 font encoding
-\usepackage{fancyhdr} 		% Used for header and footer generation
-\usepackage[]{graphicx}		% Include graphics
-\usepackage{titlesec}		% Change properties of chapter/section titles
-\usepackage{etoolbox}		% Used to extend functionality/properties of commands
-\usepackage{color}			% Used for coloring letters and backgrounds
-\usepackage[table]{xcolor}  % Used for coloring tables
-\usepackage{booktabs}		% Used for booktabs style (scientific looking) tables
-\usepackage{parskip}		% Add spacing between paragraphs
-\usepackage{float}			% Honestly, that's like the most important package
-\usepackage{hyperref}		% Enables clickable links and references
-\usepackage{mdframed} 		% Used for colored boxes and multipage frames
-\usepackage{tabularx}		% Used for tables with fixed width columns
-\usepackage{tablefootnote}	% Used for footnotes in tables
-
-% Page geometry
-\geometry{hmargin=2.5cm,
-          vmargin=1cm,
-          headheight=1.5cm, 
-          includeheadfoot}
-
-% Define hyperref link colors
-\hypersetup{colorlinks  = true,
-            linkcolor   = black,
-            urlcolor    = blue,
-            citecolor   = black,
-            anchorcolor = black}
-
-% Helper dimension for colored boxes
-\newlength\colorboxwidth
-\setlength{\colorboxwidth}{\dimexpr\textwidth-2\fboxsep}
-
-% Disable chapter text and change formatting of chapter titles (titlesec package)
-\titleformat{\chapter}{\normalfont\huge\bf}{\thechapter.}{8pt}{\huge\bf}
-\titlespacing{\chapter}{0pt}{-1\baselineskip}{1.5\baselineskip}
-
-% Slightly scale the height of table rows 
-\renewcommand{\arraystretch}{1.2}
-
-% No indentation of new paragraphs
-\setlength{\parindent}{0pt}
-
-% Use Sans-Serif font as default
-\renewcommand{\familydefault}{\sfdefault} 
-
-% Use fancy headers (fancyhdr package)
-\pagestyle{fancy}
-% Enable headers on pages containing a new chapter (etoolbox package)
-\patchcmd{\chapter}{\thispagestyle{plain}}{\thispagestyle{fancy}}{}{}
-% Distance between header content and horizontal line
-\renewcommand{\headruleskip}{2mm}
-% clear existing header/footer entries
-\fancyhf{}
-
-% Header and footer definitions
-\fancyhead[L]{\large CAuDri-Challenge Regulations \the\year{}}
-\fancyhead[R]{\includegraphics[width=3cm]{graphics/caudri_logo_no_border.jpg}\hspace{-5mm}
-              \vspace{-3mm}}
-\fancyfoot[L]{Page \thepage}
-%\fancyfoot[R]{\leftmark} % Chapter name
+\documentclass{caudri_report}
+
+\usepackage[table]{xcolor}  			% Used for coloring tables
+\usepackage{booktabs}					% Used for booktabs style (scientific looking) tables
+\usepackage[framemethod=tikz]{mdframed} % Used for colored boxes and multipage frames
+\usepackage{tablefootnote}				% Used for footnotes in tables
+\usepackage{soul}						% Used for highlighting text
+\usepackage{xparse}                     % For custom environments
+\usepackage{amsmath}                    % For math environments and proper line breaks
+
+% Custom commands for highlighting text
+\newcommand{\HighlightNew}[1]{\sethlcolor{yellow}\hl{#1}}
+\newcommand{\HighlightChange}[1]{\sethlcolor{green}\hl{#1}}
+\newcommand{\HighlightFix}[1]{\sethlcolor{red}\hl{#1}}
+
+% Custom environment for paragraph highlighting
+\NewDocumentEnvironment{highlight}{O{yellow}}%
+{% \begin{highlight}[<rule colour>]
+  \allowdisplaybreaks[1]%
+  \begin{mdframed}%
+    [topline=false,rightline=false,bottomline=false,% Show only left line
+      innertopmargin=0pt,innerrightmargin=0pt,innerbottommargin=0pt,%
+      skipabove=\parskip,skipbelow=0.3\baselineskip,% Add space above and below
+      innerleftmargin=1em,outerlinewidth=5pt,linecolor=#1,% Set line colour and line width
+      leftmargin=-16pt]% Move everything to the left
+    }
+    {\end{mdframed}
+}
+
+\Title{CAuDri-Challenge Regulations 2025}
+\Subtitle{Official Rules and Regulations}
+\Author{CAuDri e.V.}
+\Date{\today}
+
+\newcommand{\yearofchallenge}{2025}
+\newcommand{\dateofchallenge}{May 17th}
 
 \begin{document}
 
-% Custom title page
+% Custom title page with CAuDri logo
 \begin{titlepage}
 	\makeatletter
 	\begin{center}
 		\vspace*{3cm}
 
-		\includegraphics[width=\textwidth]{graphics/caudri_logo_no_border.jpg}\\
+		\includegraphics[width=\textwidth - 1.2cm]{caudri_logo.png}\\
 		\vspace{1cm}
 
 		\Huge\bfseries\@title\\
 		\vspace{\baselineskip}
 
 		\Large\@date\\
-		\vspace{8cm}
+		\vfill
 
 		\large DISCLAIMER:\\
 
 		{\raggedright This document may be subject to change up until the day of the competition.\\
 		All changes will be announced on our Discord Server, in case of major changes we will inform all participants via E-Mail.
-		New features and differences to the previous competition will be highlighted in \colorbox{yellow}{yellow}.
-		Differences to the initial release for each year will be highlighted in \colorbox{green}{green}.\\}
+		New features and differences to the previous competition will be highlighted in \HighlightNew{yellow}.
+		Differences to the initial release for each year will be highlighted in \HighlightChange{green}.}
 
 	\end{center}
 	\makeatother

source/caudri_report.cls

@@ -0,0 +1,141 @@
+% CAuDri Report Document Class 
+% Based on KOMA-Script scrreprt class
+% Version: 2024/12/03
+%
+% Usage:
+% \documentclass{caudri_report}
+%
+% \Title{MyTitle}
+% \Subtitle{MySubtitle}
+% \Author{Me}
+% \Date{\today}
+
+% \begin{document}
+% \Titlepage        % Create title page
+% 
+% \useportrait      % For upright page
+% \uselandscape     % For horizontal page
+% \end{document}
+
+\NeedsTeXFormat{LaTeX2e}
+\ProvidesClass{caudri_report}[2024/12/03 v1.0 CAuDri Document Class Based on scrreprt]
+\LoadClass[11pt, parskip=half]{scrreprt}
+
+% Load additional packages
+\RequirePackage[T1]{fontenc}                    % T1 font encoding
+\RequirePackage{lmodern}                        % Latin Modern font (somehow more compatible than Computer Modern)
+\RequirePackage[headsepline]{scrlayer-scrpage}  % Header and footer management
+\RequirePackage{graphicx}                       % For including images
+\RequirePackage{hyperref}                       % For hyperlinks and text fields
+\RequirePackage{tikz}                           % For custom text fields
+\RequirePackage{tabularx}                       % For tables with fixed width
+\RequirePackage{multicol}                       % For multiple column pages
+% \RequirePackage[german]{datetime2}              % For german date formatting
+\RequirePackage{float}                          % The most important package ever
+
+% Default text in header
+\newcommand{\HeaderText}{CAuDri-Challenge 2025}
+
+\graphicspath{{./graphics/}, {../graphics/}, {./}, {../}}
+
+% Use sans-serif as default font family
+\renewcommand{\familydefault}{\sfdefault}
+
+% Configure default page layout
+\KOMAoptions{
+  headheight=3cm,
+  DIV=12 % Page division, controls general page layout and margins
+  % parskip=false % No spacing between paragraphs
+}
+
+% Add space to the top of the header
+% Needs to be defined manually, setting it via KOMA Options won't have any effect
+\setlength{\headheight}{3.8cm}
+
+% Load scrlayer-scrpage for header/footer management
+\clearpairofpagestyles % Clear default header and footer settings
+
+% Define headers and footers 
+\setkomafont{pagehead}{\normalfont}
+\ihead{\large\HeaderText\\\large\Subtitle}
+\ohead{\includegraphics[width=3.5cm]{caudri_logo.png}}
+\cfoot{\pagemark}
+
+% Enable header on chapter pages and redefine chapter spacing
+\renewcommand*\chapterpagestyle{scrheadings}
+\RedeclareSectionCommand[
+  beforeskip=.25\baselineskip,
+  afterskip=\baselineskip,
+]{chapter}
+
+% Define hyperref link colors
+\hypersetup{colorlinks  = true,
+  linkcolor   = black,
+  urlcolor    = blue,
+  citecolor   = black,
+  anchorcolor = black}
+
+% Slightly scale the height of table rows
+\renewcommand{\arraystretch}{1.2}
+
+% Custom commands for layout switching
+\newcommand*{\useportrait}{%
+  \clearpage
+  \KOMAoptions{paper=portrait,DIV=12}
+  \setlength{\headheight}{3.3cm}
+}
+
+\newcommand*{\uselandscape}{%
+  \clearpage
+  \KOMAoptions{paper=landscape,DIV=13}
+  \setlength{\headheight}{4.3cm}
+}
+
+% Custom commands for setting title, subtitle, author, and date
+\newcommand{\Title}[1]{%
+  \def\@title{#1}%
+  \gdef\Title{#1} % Global definition of \Title for use in headers/footers
+}
+\newcommand{\Subtitle}[1]{%
+  \def\@subtitle{#1}%
+  \gdef\Subtitle{#1} % Global definition of \Subtitle for use in headers/footers
+}
+\newcommand{\Author}[1]{\def\@author{#1}}
+\newcommand{\Date}[1]{\def\@date{#1}}
+
+% Create the title page using "\Titlepage"
+\makeatletter
+\newcommand{\Titlepage}{
+  \begin{center}
+    {\LARGE\bfseries\@title\\}
+    \vspace{0.5\baselineskip}
+    % {\large\@subtitle}\\
+    \@date
+    \bigskip
+  \end{center}
+}
+\makeatother
+
+% Custom commands for fillable text fields
+\renewcommand{\LayoutTextField}[2]{% label, field
+  \begin{tikzpicture}[baseline, every node/.style={inner sep=0,outer sep=0}]
+    % Align the text field with the baseline of the surrounding text
+    \node[anchor=base] (TextFieldNode) at (0cm,-2pt) {#2};
+    % Position the label below the text field, without affecting vertical alignment
+    \node[anchor=north west,font=\footnotesize] at ([yshift=-0.3ex]TextFieldNode.south west) {#1};
+  \end{tikzpicture}%
+}
+
+\newcounter{fieldcounter}
+\newcommand{\TextFieldInline}[2]{\TextField[name=\thefieldcounter,width=#2,borderstyle=U,bordercolor={0 0 0},backgroundcolor={1 1 1}]{#1}\stepcounter{fieldcounter}}
+
+
+% Custom commands for checkboxes 
+\renewcommand{\LayoutCheckField}[2]{\parbox[c][4mm]{4mm}{\centering #2}}
+\renewcommand\DefaultHeightofCheckBox{3mm}
+\renewcommand\DefaultWidthofCheckBox{3mm}
+
+\newcommand{\CheckBoxInline}{\CheckBox[bordercolor={0 0 0}]{0cm}}
+
+% End of class definition
+\endinput