Abschnitt über Metadatenfiles eingefügt

README.md

@@ -120,7 +120,85 @@ Hier nochmals eine Erklärung der verschiedenen Dateien:
 * Das `/pdfs` Verzeichnis beinhaltet Dateien welche im Appendix (auszugsweise oder ganz) eingefügt werden. Damit dies geschieht müssen sie aber im `metadata.yaml` korrekt referenziert werden. Es ist keine Schande hier viele Dateien abzulegen - sofern diese einen Bezug zur Diplomarbeit haben.
 
 
-## Bauen der Diplomarbeit
+### Befüllen der speziellen Datein
+
+#### metadata.yaml
+
+In dieser Datei befinden sich alle Informationen rund um Ihre Diplomarbeit. Das Dateiformat ist [YAML](https://yaml.org/spec/1.2/spec.html) in welchem folgende Felder befüllt sein müssen:
+
+```
+---
+
+# Informationen für das Titelblatt
+da-titel: Titel lt. DA Portal
+da-jahr: 2020/21 
+
+# Schlüsselwörter werden im PDF als Schlüsselwörter hinterlegt
+da-keywords: HTLLE, Keyword1, Keyword2, Keyword3
+
+# Autoren der Diplomarbeit (=Schüler)
+# Je Autor sind alle felder asuzufüllen
+# Information wird am Titelblatt und bei der Eidesstattlichen Erklärung verwendet
+da-author:
+- vorname: Joltawan 
+  nachname: Barodscheff
+  klasse: 5IT
+  thema: Subthema des Schülers 1
+
+- vorname: Craig 
+  nachname: Tester
+  klasse: 5IT
+  thema: Subthema des Schülers 2 
+
+# Diplomarbeitsbetreuer
+# Je Betreuer sind alle Felder auszufüllen
+# Information wird am Titelblatt und bei den PDF Metadaten verwendet
+da-betreuer:
+- paraffe: hg
+  name: Ing. DI(FH) Günther Hutter, Msc.
+
+- paraffe: me
+  name: DI Dr. mont Thomas Messner
+
+# 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 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)
+# Wenn man nur einige Seiten aus einem großen PDF einfügen will dann kann man das optionale Attribut 'seiten' verwenden
+# in dem man entweder durch Beistrich getrennt szezifische Seiten aufzälen kann oder mittels Bindestrich einen Bereich.  
+
+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: Diplomatbeitsvereinbarung
+  pdf-file: HTL-DA-Vereinbarung.pdf
+---
+```
+
+#### literatur.bib
+
+Aus dieser Datei wird als Literaturverzeichnis erstellt. Wannimmer sie Informationen aus anderen Quellen beziehen oder daraus Wissen ableiten sollten sie diese Quelle zitieren. Alle Informationen zu direkten und auch indirekten Quellen sollten hier möglichst genau dokumentiert werden. Sobald die Quellenangabe dann in der DA verwendet wird, erstellt das Framework einen entsprechenden Literaturverweis.
+
+Egal ob die Quellenangabe aus einem Buch, einer Zeitschrift order irgend einer anderen wissenschaftlichen Arbeit stammt, versuchen sie immer möglichst alle Felder zu befüllen. In diesen [bibtex style examples](https://verbosus.com/bibtex-style-examples.html?lang=de) sieht man wie solch eine korrekt befüllter Quelleneintrag aussieht. 
+
+
+
+## Arbeiten im Rahmen der Diplomarbeit
+
+### Bauen der Diplomarbeit als PDF Datei
 
 Damit das PDF für die Diplomarbeit erstellt wird muss (aus Ihrem Basisverzeichnis heraus) folgender Befehl abgesetzt werden:
 
@@ -137,7 +215,7 @@ alias da="make pdf -C HTLLE-DA-Vorlage INPUTDIR=$(pwd)"
 ```
 Damit beschränkt sich Ihre eigentliche Arbeit darauf, die Markdoen Files zu editieren (nicht veressen zu speichern) und anschließend den neuen Alias `da` aufzurufen. Danach haben Sie immer die neuste Diplomarbeit gebaut.
 
-## Übertragen des aktuellen Standes nach GIT
+### Ü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.