Added AI specific things. Solves #28 and #29

README.md

@@ -449,7 +449,19 @@ Bei speziellen Fragen zu diesem Vorgehen wenden Sie sich bitte an den Programmie
 
 * alle Tools inkl. Versionsnummer
 * alle Zitate bzw. übernommene Meinungen
-* Datenblätter usw. können auch zitiert werden-
+* Datenblätter usw. können auch zitiert werden
+
+### Künstliche Intlligenz
+
+Es ist prinzipiell erlaubt KI im Rahmen der Diplomarbeit einzusetzen. Welche Art der KI, sowie für welchen Einsatzzweck sie diese verwendet haben halten Sie vollständig in der `metadata.yaml` fest, und diese Information unterschreiben Sie auch mit der eidesstattlichen Erklärung. Man unterscheidet dabei prinzipiell zwei Use-cases:
+
+1. **Verwendung als Werkzeug (ähnlich einer Autokorrektur)**: In diesem Fall haben Sie selbst das Wissen generiert / recherchiert und es ist nicht notwendig das speziell in der Arbeit zu erwähnen. Dieser Anwendungsfall ist vergleichbar mit der Verwendung eines Taschenrechners. Dieser wird nur als Werkzeug verwendet und trägt inhaltlich nichts zur DA bei.
+2. **Verwendung zur generierung von Wissen**: Sofern Sie irgendeine KI als Informationsquelle verwenden (also um neues Wissen zu generieren, aus Quellen zusammenzufassen o.Ä.) dann ist das in der Diplomarbeit speziell kennzuzeichnen. Dazu **müssen* sei den kompletten Chatverlauf inkl. Prompt und folgekorrespondenz als PDF an die Diplomarbeit anhängen, und diese korrekt in der `.bib` Datei als `@unpublished` referenzieren. Es ist dabei wichtig das der `short-prompt` (also eine art Kurzzusammenfassung des Prompts) in der metadata.yaml mit jenem im im finalen Literaturverzeichnis übereinstimmt. Ein Beispiel wie dabei vorzugehen ist, ist im DA Template enthalten.  
+
+
+Code-generierungstools wie z.B. _Github Copilot_ stellen hier einen Grenzfall dar. Sofern Sie Copilot dazu verwenden um z.B. Quellcode formatieren zu lassen oder kleine / lokale Anpassungen (im Sinne von Boilerplate code, oder Getter/Setter generierung) dann bedarf es zwar einer Nennung in der metadata.yaml, aber keine Nennung als Quelle. Sobald Sie mit dieser oder einer vergleichbaren KI neue Inhalte oer Ansätze generieren, ist die wie oben beschrieben zu dokumentieren.
+
+Im Zweifelsfall behandeln Sie KI generierte Inhalte immer so als ob neues Wissen damit generiert wurde.   
 
 ## Checkliste
 

example/30-ausarbeitungen.md

@@ -13,12 +13,12 @@ Eine allgemeine Aufgabenstellung
 
 ### So gehen Zitate
 
-Einzel Zitat:  
-[vgl. @leeb_einfuhrung_2016, S. 13]
+Hier ein einzel Zitat eines Buches das auf der Seite 17 zu finden ist:  
+([@hattie_lernen_2013] S. 17) 
 
 Zitatsammlung:  
 (vergleich dazu @heise oder @t3n)  
-[vgl. @hattie_lernen_2013, S. 33-35; außerdem @walker_problem_2009, S. 6 f.]
+[@hattie_lernen_2013, S. 33-35; außerdem @leeb_einfuhrung_2016, S. 6 f.]
 
 Zitat ohne Autor  
 Hattie sagte bla bla [-@hattie_lernen_2013]
@@ -28,6 +28,25 @@ Name des Autors mit Jahr in Klammern
 
 Auch Videos kann man Zitieren wi Zum Biespiel hier [@Zatko15] in dieser Referenz.
 
+Hier noch ein Zitat mit Seitenangabe [[@Zatko15] Seite 5f.]
+
+Man darf auch ChatGPT oder andere KIs befragen um Wissen zu erlangen. Dazu muss allerdings ein PDF Log des exakten Chats in die Metadata.yaml eingetragen werden und der dort eingetragene `short-prompt` auch in der bib Datei eingefügt werden. Dann könnten indirekte Zitate so aussehen [@gpt-pandoc] oder auch so [@gpt-atomaufbau].
+
+Wichtig ist es, das beim Author die verwendete KI eingetragen wird (mit Versionsnummern - so genau wie möglich), beim title eine kurze Referenz zum Prompt und beim Jahr - das Jahr in dem die Abfrage gemacht wurde. Das hat dem `short-prompt` aus der metadata.yaml zu entsprechen.
+
+~~~~~
+@unpublished{gpt-pandoc,
+  author = {{ChatGPT 4.0}},
+  title  = {Was ist Pandoc ?},
+  year   = {2024},
+  url={https://chat.openai.com/c/ef535195-0e39-4d5c-9c85-cdb7ec18ad03},
+  urldate = {2023-02-29}
+}
+~~~~~ 
+
+Oben sieht man wie ein korrekter Bibtech Eintrag für eine ChatGPT Konversation aussieht. Zusätzlich wurden hier bei URL noch die url des Chats eingetragen - was zwar praktisch ist, uns allerdings nicht von der Pflicht entbindet den Chatverlauf in der DA als PDF einzufügen.
+Anzumerkein ist ebenfalls noch das wir hier ein `unpublished` Tag verwenden weil wir hier eben Quellen verwenden die in dieser Form nicht gepublished wurden.
+
 ### Systembeschreibung Y 
 
 ### Systembeschreibung Z 

example/literatur.bib

@@ -239,3 +239,19 @@ bibtex: muller\_problem-based\_2016}
 	year = {2015},
 	urldate = {2016-07-17}
 }
+
+@unpublished{gpt-atomaufbau,
+	title = {Aufbau eines Atoms},
+	author = {ChatGPT},
+	year   = {2024},
+	url = {https://chat.openai.com/c/0484c9c2-fe7f-4922-af0b-76c3ca15fb58},
+	urldate = {2023-02-29}
+}
+
+@unpublished{gpt-pandoc,
+  author = {{ChatGPT 4.0}},
+  title  = {Was ist Pandoc ?},
+  year   = {2024},
+  url={https://chat.openai.com/c/ef535195-0e39-4d5c-9c85-cdb7ec18ad03},
+  urldate = {2023-02-29}
+}

example/metadata.yaml

@@ -14,11 +14,35 @@ da-author:
   nachname: Barodscheff
   klasse: 5AHWIN
   thema: Bauen des LaTex Templates
+  ki-tools:
+  - name: ChatGPT3.5
+    zweck: Informationsbeschaffung
+  - name: Midjourney
+    zweck: Künstlerische Illustration
 
 - vorname: Craig 
   nachname: Tester
   klasse: 5AHWIN
   thema: Entwicklung eines Prototypen
+  ki-tools:
+  - name: Github Copilot
+    zweck: Boilerplate codegenerierung, Codedokumentation
+
+- vorname: Karl 
+  nachname: Ranseier
+  klasse: 5AHWIN
+  thema: API-Mockups und Testen der Applikation
+
+- vorname: Frank 
+  nachname: Borland
+  klasse: 5AHWIN
+  thema: GUI Generierung
+  ki-tools:
+  - name: Galileo AI
+    zweck: Setendesign sowie UI/UX Design der App
+  ki-tools:
+  - name: Grammarly Go
+    zweck: Stilverbesserung sowie Rechtschreibkorrekturen
 
 da-betreuer:
 - paraffe: hg
@@ -31,6 +55,17 @@ da-kurzfassung-de: Hier kommt eine deutsche Kurzfassung hin.
 
 da-kurzfassung-en: Hier kommt eine englische Kurzfassung hin.
 
+
+da-kiquellen:
+- ki: ChatGPT4
+  short-prompt: Erklärung Pandoc
+  pdf-file: gpt-pandoc.pdf
+
+- ki: ChatGPT3.5
+  short-prompt: Aufbau eines Atoms
+  pdf-file: gpt-atom.pdf
+
+
 da-appendix:
 - abschnitt: Begleitprotokolle
   pdf-file: begleitprotokolle.pdf    
@@ -45,7 +80,4 @@ da-appendix:
 - abschnitt: Diplomatbeitsvereinbarung
   pdf-file: HTL-DA-Vereinbarung.pdf
   
-da-build-properties:
-- build-notification: MSTeams-DA_2021_Thema <test@muellmail.com>
-- build-notification: abcdefg@byom.de
 ---

style/htlle-diplomarbeit.csl

@@ -13,7 +13,7 @@
     <category citation-format="numeric"/>
     <category field="generic-base"/>
     <summary>HTL Leoben numeric style</summary>
-    <updated>2021-03-26T07:58:44+00:00</updated>
+    <updated>2024-02-29T07:18:19+00:00</updated>
     <rights license="http://creativecommons.org/licenses/by-sa/3.0/">This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 License</rights>
   </info>
   <macro name="editor">
@@ -112,6 +112,14 @@
     </sort>
     <layout prefix="[" suffix="]" delimiter=",">
       <text variable="citation-number"/>
+      <choose>
+        <if match="any" variable="page">
+          <group>
+            <label prefix=" " variable="page" form="short"/>
+            <number variable="page"/>
+          </group>
+        </if>
+      </choose>
     </layout>
   </citation>
   <bibliography et-al-min="6" et-al-use-first="4" second-field-align="flush" hanging-indent="true">

style/template.tex

@@ -504,15 +504,25 @@ $for(da-betreuer)$$da-betreuer.name$$sep$\\ $endfor$
 \end{titlepage}
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%  EIDESSTATTLICHE ERKLAERUNG
+%  EIDESSTATTLICHE ERKLAERUNGEN
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+$for(da-author)$
 \cleardoublepage{}
 \section*{\translate{authorship}}
 \translate{oath}
 
+$if(da-author.ki-tools)$
+\translate{aitools}
+
+$for(da-author.ki-tools)$
+\begin{itemize}[leftmargin=2cm]
+\item \textbf{$da-author.ki-tools.name$}: $da-author.ki-tools.zweck$ 
+\end{itemize}
+$endfor$
+$endif$
+
 \noindent
 
-$for(da-author)$
 \begin{minipage}[h]{0.4\linewidth}  \vspace*{3cm}
 \translate{signinglocation}, \translate{at} \dotfill\\
 \vspace*{2.5mm}
@@ -584,6 +594,41 @@ $body$
 % 2.) Tabellenverzeichnis
 % 3.) Literaturverzeichnis 
 
+
+$if(da-kiquellen)$
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%  KI Quellen
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+% ... besteht aus PDF Files die in der metadata.yaml Datei deklariert werden
+% und hier dann eingebunden werden. Normalerweise sind das folgende Dateien
+
+\translatelet\app{aisources}
+\section{\app}
+
+\translate{attachments}
+\begin{itemize}
+
+$for(da-kiquellen)$
+\item \textbf{$da-kiquellen.ki$: $da-kiquellen.short-prompt$}\\ $if(da-kiquellen.seiten)$\translate{pages} $da-kiquellen.seiten$ \translate{of} $endif$ Datei: \texttt{$da-kiquellen.pdf-file$}
+$endfor$
+\end{itemize}
+
+
+$for(da-kiquellen)$
+\stepcounter{subsection}
+\phantomsection
+\addcontentsline{toc}{subsection}{\protect\numberline{\thesubsection}$da-kiquellen.ki$: $da-kiquellen.short-prompt$}
+\includepdf[
+    clip=0mm 0mm 0mm 0mm,
+    pages=$if(da-kiquellen.seiten)$$da-appendix.seiten$$else$-$endif$,
+    frame,
+    scale=.73,
+    pagecommand={\begin{center}\translate{attachment}: $da-kiquellen.short-prompt$\\\begin{tiny}$da-kiquellen.pdf-file$\end{tiny}\end{center}}
+ ]{pdfs/$da-kiquellen.pdf-file$}
+%\includepdf[pages=$if(da-appendix.seiten)$$da-appendix.seiten$$else$-$endif$]{source/pdfs/$da-appendix.pdf-file$}
+$endfor$
+$endif$
+
 $if(da-appendix)$
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %  APPENDIX

style/translations-default.tex

@@ -15,15 +15,18 @@
 \providetranslation{noteofhanks}{Danksagung}
 \providetranslation{appendix}{Anhang}
 \providetranslation{attachments}{Folgende Dokumente bilden einen Bestandteil dieser Diplomarbeit und liegen der digitalen Version bei.}
-\providetranslation{oath}{Ich erkläre hiermit an Eides statt, dass ich die vorliegende Arbeit ohne Hilfe Dritter und ohne Benutzung anderer als der angegebenen Hilfsmittel angefertigt habe; die aus fremden Quellen direkt oder indirekt übernommenen Gedanken sind als solche kenntlich gemacht. Die Arbeit wurde bisher in gleicher oder ähnlicher Form in keiner anderen Prüfungsbehörde vorgelegt und auch noch nicht veröffentlicht. Ich habe keine KI-Tools verwendet, außer in den entsprechend gekennzeichneten Bereichen.}
+\providetranslation{oath}{Hiermit versichere ich, dass ich die vorliegende Arbeit selbstständig verfasst und keine anderen Hilfsmittel als die angegebenen benützt habe. Die Stellen, die anderen Werken (gilt ebenso für Werke aus elektronischen Datenbanken oder aus dem Internet) wörtlich oder sinngemäß entnommen sind, habe ich unter Angabe der Quelle und Einhaltung der Regeln wissenschaftlichen Zitierens kenntlich gemacht. Diese Versicherung umfasst auch in der Arbeit verwendete bildliche Darstellungen, Tabellen, Skizzen und Zeichnungen. }
+\providetranslation{aitools}{Für die Erstellung der Arbeit habe ich auch Hilfsmittel generativer KI-Tools zu folgendem Zweck verwendet, wobei  die verwendeten Hilfsmittel vollständig und wahrheitsgetreu inkl. Produktversion und Prompt ausgewiesen wurden: }
 \providetranslation{of}{der}
 \providetranslation{file}{Datei}
 \providetranslation{pages}{Seite(n)}
 \providetranslation{author}{Autor}
-\providetranslation{authorship}{Erklärung der Urheberschaft}
+\providetranslation{authorship}{Eidesstattliche Erklärung}
 \providetranslation{attachment}{Datei}
 \providetranslation{lstoffigures}{Abbildungsverzeichnis}
 \providetranslation{lstoftables}{Tabellenverzeichnis}
 \providetranslation{lstoflistings}{Quellcodeverzeichnis}
 \providetranslation{lstofreferences}{Literaturverzeichnis}
+\providetranslation{aisources}{KI Quellen}
+
 

style/translations-english.tex

@@ -15,15 +15,17 @@
 \providetranslation{noteofhanks}{Note of Thanks}
 \providetranslation{appendix}{Appendix}
 \providetranslation{attachments}{The following documents are part of this thesis and are included in the digital version.}
-\providetranslation {oath}{I hereby declare in lieu of oath that I have prepared this work without the help of third parties and without the use of any aids other than those specified; Thoughts taken directly or indirectly from external sources are marked as such. The thesis has not been submitted in the same or a similar form to any other examination authority and has not yet been published. I have not used any AI tools, except in the areas specifically marked.}
+\providetranslation{oath}{I hereby declare that I have written the present work independently and have not used any sources or aids other than those specified. Passages taken verbatim or in essence from other works (this also applies to works from electronic databases or from the Internet) have been identified as such with the source cited and in compliance with the rules of academic citation. This declaration also covers images, tables, sketches, and drawings used in the work.}
+\providetranslation{aitools}{For the preparation of the work, I have also used generative AI tools for the following purposes, where the tools used have been fully and truthfully disclosed, including product version and prompt:}
 \providetranslation{of}{of}
 \providetranslation{file}{File}
 \providetranslation{pages}{Page(s)}
 \providetranslation{author}{Author}
-\providetranslation{authorship}{Declaration of authorship}
+\providetranslation{authorship}{Affidavit}
 \providetranslation{attachment}{File}
 \providetranslation{lstoffigures}{List of Figures}
 \providetranslation{lstoftables}{List of Tables}
 \providetranslation{lstoflistings}{List of Listings}
 \providetranslation{lstofreferences}{List of References}
+\providetranslation{aisources}{AI Sources}