Removed unnecessary sections and added info about metadata.yaml

README.md

@@ -199,18 +199,28 @@ da-keywords: HTLLE, Keyword1, Keyword2, Keyword3
 # lang: english
 
 # Autoren der Diplomarbeit (=Schüler)
-# Je Autor sind alle felder asuzufüllen
+# Je Autor sind die Felder vorname, nachname, klasse, und thema verpflichtend auszufüllen
+# Sofern KI Toools verwendet wurden sind diese auch auszufüllen
 # Information wird am Titelblatt und bei der Eidesstattlichen Erklärung verwendet
 da-author:
 - vorname: Joltawan 
   nachname: Barodscheff
-  klasse: 5IT
+  klasse: 5AHWIN
-  thema: Subthema des Schülers 1
+  thema: Bauen des LaTex Templates
+  ki-tools:
+  - name: ChatGPT3.5
+    zweck: Informationsbeschaffung
+  - name: Midjourney
+    zweck: Künstlerische Illustration
 
 - vorname: Craig 
   nachname: Tester
-  klasse: 5IT
+  klasse: 5AHWIN
-  thema: Subthema des Schülers 2 
+  thema: Entwicklung eines Prototypen
+  ki-tools:
+  - name: Github Copilot
+    zweck: Boilerplate codegenerierung, Codedokumentation
+
 
 # Diplomarbeitsbetreuer
 # Je Betreuer sind alle Felder auszufüllen
@@ -222,12 +232,34 @@ da-betreuer:
 - paraffe: me
   name: DI Dr. mont Thomas Messner
 
-# Eine Kurzfassung in Deutsch
+# Kurzfassungen sind in Deutsch und Englisch zu verfassen und enthalten folgende Information welche auf nicht mehr als 
+# einer A4 Seite (ohne Grafiken) dargestellt wird:
+# Einleitung und Hintergrund: Ein kurzer Überblick über das Thema der Arbeit, die Forschungsfrage(n) und die Relevanz des Forschungsvorhabens.
+# Ziele: Eine klare Darstellung der Ziele oder Hypothesen, die die Arbeit zu untersuchen oder zu beweisen beabsichtigt.
+# Methodik: Eine Zusammenfassung der angewandten Forschungsmethoden und Ansätze, inklusive der Datenerhebungs- und Analyseverfahren.
+# Ergebnisse: Die wichtigsten Ergebnisse der Forschung, präsentiert in einer knappen und prägnanten Form. Dies kann quantitative oder qualitative Daten umfassen, je nach Art der Arbeit.
+# Schlussfolgerungen: Eine Zusammenfassung der Schlussfolgerungen, die aus den Ergebnissen gezogen wurden, inklusive der Beantwortung der Forschungsfrage(n).
+
+# Eine Kurzfassung in Deutsch.
 da-kurzfassung-de: Hier kommt eine deutsche Kurzfassung hin.
 
 # Eine Kurzfassung in Englisch
 da-kurzfassung-en: Hier kommt eine englische Kurzfassung hin.
 
+
+# PDF Dateien welche die Wissensbeschaffung von generativer KI dokumentieren.
+# Je Anwendungsfall ist jeweils ein PDF einzukopieren das im Ordner pdfs abgelegt ist, und
+# den Prompt sowie die gesamte KI Antwort beinhaltet. 
+
+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
+
 # PDF Dateien die im Anhang zur Diplomarbeit entweder ganz oder nur seitenweise einkopiert werden
 # Das Pflichtattribut 'abschnitt' bezeichnet hier die Überschrift für desen Anhang
 # Das Pflichtattribut 'pdf-file' ist der Dateiname des PDFs welches im pdfs Ordner zu finden ist (ohne Pfadangabe)
@@ -237,26 +269,17 @@ da-kurzfassung-en: Hier kommt eine englische Kurzfassung hin.
 # Dateinamen ohne Sonderzeichen als Eingabedateien.
 
 da-appendix:
-- abschnitt: Begleitprotokolle
-  pdf-file: begleitprotokolle.pdf    
-
-- abschnitt: Projekthandbuch
-  pdf-file: projekthandbuch.pdf
-
 - abschnitt: Technische Dokumentation
   pdf-file: pandoc-manual.pdf
   seiten: 53-73
+  
+# Betreuungsprotokolle und organisatorische Dokumente sind verpflichtender Bestandteil des Appendix
+- abschnitt: Betreuungsprotokolle
+  pdf-file: begleitprotokolle.pdf    
 
+# Die Diplomarbeitsvereinbarung sollte als letztes Dokument aufscheinen
 - abschnitt: Diplomatbeitsvereinbarung
   pdf-file: HTL-DA-Vereinbarung.pdf
-
-# Eigenschaften für den Buildserver der HTL Leoben
-# build-notification wird dazu verwendet um eine Emailadresse zu hinterlegen wohin das fertig gebaute
-# File und alle anderen Artefakte dann versandt werden soll. Hier könnte man z.B: die eigene Emailadresse
-# oder die des Diplomarbeitenteams angeben. Damit bekommt man die neusten Versionen automatisch zugestellt.
-da-build-properties:
-- build-notification: Diplomarbeit - DA_2021_Thema <269bc6a5.O365.htl-leoben.at@emea.teams.ms>
-- build-notification: mytesms@adress.com
 ---
 ```
 
@@ -272,7 +295,6 @@ Um das Zusammensuchen der Quellenangaben für Bücher zu vereinfachen kann man i
 
 ### Bauen der Diplomarbeit als PDF Datei
 
-#### **Lokal**
 Damit das PDF für die Diplomarbeit erstellt wird muss (aus Ihrem Basisverzeichnis heraus) folgender Befehl abgesetzt werden:
 
 ```
@@ -292,77 +314,6 @@ Mit den mitgelieferten Tasks kann in VS Code das Bauen entweder über das Ausfü
 
 Noch einfacher ist das Starten der Tasks mit der Erweiterung "Task Explorer". Dort können beide Tasks in einem separaten Fenster gefunden und gestartet werden. Die Tasks funktionieren jedoch nur wenn im Lokalen wsl alle benötigten Pakete installiert sind.
 
-#### **Remote**
-Sollten Sie die notwendigen Tools (pandoc, LaTeX, etc.) nicht lokal installieren wollen und Sie haben Ihre Diplomarbeit am GIT-Server der HTL versioniert, dann können Sie Ihre PDF auch am [Jenkins](https://itsp.htl-leoben.at/ci) bauen und sich per E-Mail zuschicken lassen. Es wird dabei immer das aktuellste Template verwendet.
-
-Öffnen Sie dazu den [Jenkins-Job](https://itsp.htl-leoben.at/ci/job/HTLLE-Diplomarbeit/build?delay=0sec) und melden Sie sich ggf. mit Ihren Benutzerdaten (z.B.: `1911wit00`) an.
-
-- `REPOSITORY` Ihre Repository-URL z.B: `https://itsp.htl-leoben.at/git/1911wit00/Diplomarbeit.git`
-- `GIT_PATH` Ggf. der Unterordner in dem sich Ihre Diplomarbeit auf GIT befindet z.B.: `diplomarbeit/`
-- `GIT_BRANCH` Wenn Sie nicht wissen, was in GIT `branches` sind, brauchen Sie den Parameter nicht anpassen
-- `ARCHIVE_FORMAT` Wählen Sie aus, ob die fertige Arbeit als `.zip` oder `.tar.gz` Datei versendet wird
-
-Beispiel: `GIT_PATH` ist `"text"` 
-```
-$ tree ~/Diplomarbeit
-.
-├── source
-└── text
-    ├── 10-einleitung.md
-    ├── 20-zielsetzung.md
-    ├── 30-ausarbeitungen.md
-    ├── 31-ausarbeitung_schueler1.md
-    ├── 32-ausarbeitung_schueler2.md
-    ├── 40-zusammenfassung.md
-    ├── HTLLE-DA-Vorlage
-    │   ├──                           ... Inhalte aus der DA Vorlage
-    │   └──                           ... wurden hier ausgeblendet
-    ├── img
-    │   └── graph.png
-    ├── literatur.bib
-    ├── metadata.yaml
-    └── pdfs
-        ├── HTL-DA-Vereinbarung.pdf
-        ├── README
-        ├── begleitprotokolle.pdf
-        ├── pandoc-manual.pdf
-        └── projekthandbuch.pdf
-```
-
-Beispiel: `GIT_PATH` ist default `"./"`
-```
-$ tree ~/Diplomarbeit
-.
-├── 10-einleitung.md
-├── 20-zielsetzung.md
-├── 30-ausarbeitungen.md
-├── 31-ausarbeitung_schueler1.md
-├── 32-ausarbeitung_schueler2.md
-├── 40-zusammenfassung.md
-├── HTLLE-DA-Vorlage
-│   ├──                           ... Inhalte aus der DA Vorlage
-│   └──                           ... wurden hier ausgeblendet
-├── img
-│   └── graph.png
-├── literatur.bib
-├── metadata.yaml
-└── pdfs
-    ├── HTL-DA-Vereinbarung.pdf
-    ├── README
-    ├── begleitprotokolle.pdf
-    ├── pandoc-manual.pdf
-    └── projekthandbuch.pdf
-```
-
-**Wichtig:** Das fertige PDF wird an die E-Mail Adressen aus `metadata.yaml` verschickt! Die E-Mail Adressen müssen mit `"- build-notification"` gekennzeichnet sein ([siehe oben](#befüllen-der-speziellen-dateien)).
-
-Es muss nicht einmal die Vorlage als GIT submodule im Repository eingecheckt sein, weil hier während des Build Prozesses die aktuelle verwendet wird.
-
-**Wichtig:** Sie bekommen eine Archiv-Datei (`.zip` oder `.tar.gz`) via E-Mail zugeschickt. Dieses Archiv lässt sich mit gängigen Tools entpacken (z.B.: [7-zip](https://www.7-zip.org/)). Darin befinet sich:
-- `diplomarbeit.pdf`          Ihre fertige Diplomarbeit
-- `diplomarbeit.pdf.log`      Der Log Output von pandoc
-- `spellcheck-results.txt`    Die vermeintlich falsch geschriebenen Begriffe
-
 ### Übertragen des aktuellen Standes nach GIT
 
 Es mach Sinn, die Diplomarbeit (auch nach kleinen Änderungen) immer wieder nach GIT zu übertragen. Damit ist sie optimal gesichert und falls Ihre Teammitglieder auch an der DA Arbeiten bekommen sie auch Zugang zum aktuellsten Stand. Falls Sie noch nicht mit GIT gearbeitet haben, stellen die folgenden Absätze eine (ultra-) [Kurzeinführung](https://rogerdudler.github.io/git-guide/) dar.

example/metadata.yaml

@@ -67,16 +67,13 @@ da-kiquellen:
 
 
 da-appendix:
-- abschnitt: Begleitprotokolle
-  pdf-file: begleitprotokolle.pdf    
-
-- abschnitt: Projekthandbuch
-  pdf-file: projekthandbuch.pdf
-
 - abschnitt: Technische Dokumentation
   pdf-file: pandoc-manual.pdf
   seiten: 53-73
 
+- abschnitt: Betreuungsprotokolle
+  pdf-file: begleitprotokolle.pdf    
+
 - abschnitt: Diplomatbeitsvereinbarung
   pdf-file: HTL-DA-Vereinbarung.pdf