Add ai notice feature

.gitattributes

@@ -0,0 +1,20 @@
+# git files
+**/.gitignore text eol=lf
+.gitattributes text eol=lf
+
+# text files
+docs/* text eol=lf
+*.md text eol=lf
+LICENSE text eol=lf
+
+# text files
+*.bbx text eol=lf
+*.bib text eol=lf
+*.cbx text eol=lf
+*.cls text eol=lf
+*.dbx text eol=lf
+*.tex text eol=lf
+*.theme text eol=lf
+
+# images
+images/* binary

baarticle.cls

@@ -206,7 +206,7 @@
 % \renewcommand{\footrulewidth}{0.4pt}
 
 % helper macro to print the list of correctors comma seperated
-\newcommand{\printcorrectors}[1]{
+\newcommand{\printcorrectors}[1]{%
     \@for\next:=#1\do
     {Gutachter: \next\\}%
 }
@@ -321,6 +321,49 @@
     \clearpage
 }
 
+% Define keys for the artificial intelligence usage notice
+% models used
+\define@key[BA]{ai}{model}{\edef\@baaimodel{#1}}
+
+\newcommand{\printaimodels}[1]{%
+    \ifdefempty{#1}{%
+        % Do nothing if the list is empty
+    }{%
+        \begingroup
+        \def\modellist{}%
+        \@for\next:=#1\do{%
+            \ifx\modellist\empty
+                \edef\modellist{\next}%
+            \else
+                \edef\modellist{\modellist, \next}%
+            \fi
+        }
+        \newcount\modelcount
+        \modelcount=0
+        \@for\next:=#1\do{\advance\modelcount by 1}%
+        \ifnum\modelcount=1
+            Als Modell wurde \modellist{} verwendet.%
+        \else
+            Als Modelle wurden \modellist{} verwendet.%
+        \fi
+        \endgroup%
+    }%
+}
+
+% artificial intelligence usage notice
+\newcommand{\mkainotice}[1]{
+    \setkeys[BA]{ai}{#1}
+    % do not print page number on AI notice
+    \thispagestyle{empty}
+    \subsection*{Hinweis zur Nutzung Generativer Künstlicher Intelligenz}
+    Die vorliegende wissenschaftliche Arbeit wurde mit Unterstützung einer generativen KI erstellt.%
+    \printaimodels{\@baaimodel}
+    Die Inhalte wurden auf Basis der Ausgabe der Künstlichen Intelligenz erstellt, wobei eine eigenständige Überprüfung und wissenschaftliche Validierung durch die Autorin bzw. den Autor erfolgte.
+    Die Verantwortung für die Richtigkeit, Vollständigkeit und wissenschaftliche Relevanz der Arbeit liegt bei der Autorin bzw. dem Autor.
+    Die Nutzung der KI erfolgte ausschließlich zur Unterstützung der Erstellung und Analyse von Textinhalten im Rahmen der wissenschaftlichen Arbeit.
+    \clearpage
+}
+
 % Define keys for the affirmation
 % signature of the author
 \define@key[BA]{affirmation}{signature}{\def\@baaffirsignature{#1}}
@@ -417,8 +460,12 @@
     \define@key[BA]{simple}{assignment}{\def\@basimpleassignment{#1}}
     % whether to include the blocknotice or not
     \define@boolkey[BA]{simple}{blocknotice}[true]{}
+    % whether to include the artificial intelligence usage notice or not
+    \define@boolkey[BA]{simple}{ainotice}[false]{}
+    % artificial intelligence models used
+    \define@key[BA]{simple}{aimodel}{\def\@basimpleaimodel{#1}}
 
-    \presetkeys[BA]{simple}{type=undefined,degreetype=undefined,blocknotice=true}{}
+    \presetkeys[BA]{simple}{corrector={},type=undefined,degreetype=undefined,blocknotice=true,ainotice=false,aimodel={}}{}
 
     % adjust glossary styling
     \renewcommand{\glossarypreamble}{\glsfindwidesttoplevelname[\currentglossary]}
@@ -462,6 +509,11 @@
                 location=\@basimplelocation
             }
         \fi
+        \ifBA@simple@ainotice
+            \mkainotice{
+                model=\@basimpleaimodel
+            }
+        \fi
         \ifdefvoid{\basimpleabstract}{}{
             \section*{Abstract}
             \basimpleabstract

docs/Gemfile

@@ -1,41 +1,41 @@
-source "https://rubygems.org"
-
-# Hello! This is where you manage which Jekyll version is used to run.
-# When you want to use a different version, change it below, save the
-# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
-#
-#     bundle exec jekyll serve
-#
-# This will help ensure the proper Jekyll version is running.
-# Happy Jekylling!
-gem "jekyll", "~> 3.10.0"
-
-# This is the default theme for new Jekyll sites. You may change this to anything you like.
-gem "minima", "~> 2.0"
-
-# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
-# uncomment the line below. To upgrade, run `bundle update github-pages`.
-# gem "github-pages", group: :jekyll_plugins
-
-# If you have any plugins, put them here!
-group :jekyll_plugins do
-  gem "jekyll-feed", "~> 0.6"
-end
-
-# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
-# and associated library.
-install_if -> { RUBY_PLATFORM =~ %r!mingw|mswin|java! } do
-  gem "tzinfo", "~> 1.2"
-  gem "tzinfo-data"
-end
-
-# Performance-booster for watching directories on Windows
-gem "wdm", "~> 0.1.0", :install_if => Gem.win_platform?
-
-# kramdown v2 ships without the gfm parser by default. If you're using
-# kramdown v1, comment out this line.
-gem "kramdown-parser-gfm"
-
-gem "github-pages", "~> 232", group: :jekyll_plugins
-
-gem "webrick", "~> 1.7"
+source "https://rubygems.org"
+
+# Hello! This is where you manage which Jekyll version is used to run.
+# When you want to use a different version, change it below, save the
+# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
+#
+#     bundle exec jekyll serve
+#
+# This will help ensure the proper Jekyll version is running.
+# Happy Jekylling!
+gem "jekyll", "~> 3.10.0"
+
+# This is the default theme for new Jekyll sites. You may change this to anything you like.
+gem "minima", "~> 2.0"
+
+# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
+# uncomment the line below. To upgrade, run `bundle update github-pages`.
+# gem "github-pages", group: :jekyll_plugins
+
+# If you have any plugins, put them here!
+group :jekyll_plugins do
+  gem "jekyll-feed", "~> 0.6"
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+# and associated library.
+install_if -> { RUBY_PLATFORM =~ %r!mingw|mswin|java! } do
+  gem "tzinfo", "~> 1.2"
+  gem "tzinfo-data"
+end
+
+# Performance-booster for watching directories on Windows
+gem "wdm", "~> 0.1.0", :install_if => Gem.win_platform?
+
+# kramdown v2 ships without the gfm parser by default. If you're using
+# kramdown v1, comment out this line.
+gem "kramdown-parser-gfm"
+
+gem "github-pages", "~> 232", group: :jekyll_plugins
+
+gem "webrick", "~> 1.7"

docs/quickstart.md

@@ -1,93 +1,93 @@
----
-title: Quick Start
-sort: 1
----
-
-# Quick Start
-
-This quick start will outline a simple way to get started with this template and LaTeX.
-For the most steps described below exist alternative solution.
-You can check the other articles in this documentation for the alternatives.
-This guide will also assume that the operating system used is Windows.
-
-## Install LaTeX and Perl
-
-Install [TexLive](https://www.tug.org/texlive/acquire-netinstall.html), a TeX distributions, which bundles compilers and packages the template needs, and [StrawberryPerl](http://strawberryperl.com/), which a tool you will use requires.
-It might be a good idea to restart the computer.
-
-## Download the template
-
-The latest version of the template can be found on the [Releases](https://github.com/Nuckal777/ba-latex-template/releases) page.
-Download it.
-Create a directory, which will hold all the files required for your paper.
-Put the content of template into that directory.
-Create a file called `document.tex`. The directory structure should now look like the following.
-
-```text
-somedirectory
-|-baarticle.bbx
-|-baarticle.cbx
-|-baarticle.cls
-|-baarticle.dtx
-|-document.tex
-|-ngerman-ba.lbx
-```
-
-## Get the required images
-
-You need an image of your signature.
-Put it into the subfolder 'images' and call it `signature.png`.
-
-```note
- If the image of your signature as an other file extension than png, use that one.
-```
-
-The directory should now look like this.
-
-```text
-somedirectory
-|-baarticle.bbx
-|-baarticle.cbx
-|-baarticle.cls
-|-baarticle.dtx
-|-document.tex
-|-ngerman-ba.lbx
-|-images|-signature.png
-|-images|-logo.png
-```
-
-## Build your first paper
-
-Open the document.tex file in your favourite editor and copy the following code block.
-
-```latex
-\documentclass[first=firstname,last=lastname,company=comp,location=Dresden,simple]{baarticle}
-
-\begin{document}
-    \begin{basimple}[
-        img=./images/logo.png,
-        course=thecourse,
-        title=The title,
-        number=1234567,
-        corrector={corrector1,corrector2},
-        themedate=\today,
-        returndate=\today,
-        signature=./images/signature.png,
-        location=Dresden
-    ]
-        \section{Caption}
-        Here is the content of paper.
-        \clearpage
-    \end{basimple}
-\end{document}
-```
-
-The only task left is to compile the document.
-Open a command line in the working directory and execute `latexmk --pdf --interaction=nonstopmode document.tex`.
-After running that command `document.pdf` is created along with a bunch of other files.
-You can view the PDF-file in your favourite viewer.
-Now you probably want inform yourself about the [simple mode](./usage/simple).
-
-```tip
- Some PDF-viewers, like Adobe Reader, hold file locks. You need to close these before invoking latexmk. Otherwise compilation will fail.
-```
+---
+title: Quick Start
+sort: 1
+---
+
+# Quick Start
+
+This quick start will outline a simple way to get started with this template and LaTeX.
+For the most steps described below exist alternative solution.
+You can check the other articles in this documentation for the alternatives.
+This guide will also assume that the operating system used is Windows.
+
+## Install LaTeX and Perl
+
+Install [TexLive](https://www.tug.org/texlive/acquire-netinstall.html), a TeX distributions, which bundles compilers and packages the template needs, and [StrawberryPerl](http://strawberryperl.com/), which a tool you will use requires.
+It might be a good idea to restart the computer.
+
+## Download the template
+
+The latest version of the template can be found on the [Releases](https://github.com/Nuckal777/ba-latex-template/releases) page.
+Download it.
+Create a directory, which will hold all the files required for your paper.
+Put the content of template into that directory.
+Create a file called `document.tex`. The directory structure should now look like the following.
+
+```text
+somedirectory
+|-baarticle.bbx
+|-baarticle.cbx
+|-baarticle.cls
+|-baarticle.dtx
+|-document.tex
+|-ngerman-ba.lbx
+```
+
+## Get the required images
+
+You need an image of your signature.
+Put it into the subfolder 'images' and call it `signature.png`.
+
+```note
+ If the image of your signature as an other file extension than png, use that one.
+```
+
+The directory should now look like this.
+
+```text
+somedirectory
+|-baarticle.bbx
+|-baarticle.cbx
+|-baarticle.cls
+|-baarticle.dtx
+|-document.tex
+|-ngerman-ba.lbx
+|-images|-signature.png
+|-images|-logo.png
+```
+
+## Build your first paper
+
+Open the document.tex file in your favourite editor and copy the following code block.
+
+```latex
+\documentclass[first=firstname,last=lastname,company=comp,location=Dresden,simple]{baarticle}
+
+\begin{document}
+    \begin{basimple}[
+        img=./images/logo.png,
+        course=thecourse,
+        title=The title,
+        number=1234567,
+        corrector={corrector1,corrector2},
+        themedate=\today,
+        returndate=\today,
+        signature=./images/signature.png,
+        location=Dresden
+    ]
+        \section{Caption}
+        Here is the content of paper.
+        \clearpage
+    \end{basimple}
+\end{document}
+```
+
+The only task left is to compile the document.
+Open a command line in the working directory and execute `latexmk --pdf --interaction=nonstopmode document.tex`.
+After running that command `document.pdf` is created along with a bunch of other files.
+You can view the PDF-file in your favourite viewer.
+Now you probably want inform yourself about the [simple mode](./usage/simple).
+
+```tip
+ Some PDF-viewers, like Adobe Reader, hold file locks. You need to close these before invoking latexmk. Otherwise compilation will fail.
+```

docs/setup/README.md

@@ -1,7 +1,7 @@
----
-sort: 4
----
-
-# Setup
-
-{% include list.liquid %}
+---
+sort: 4
+---
+
+# Setup
+
+{% include list.liquid %}