Added info about docker and github workflow

Diese sollten in der DA durch ein PDF des Formulars under doc ersetzt werden

Makefile

@@ -47,6 +47,18 @@ build-stage:
 	@echo "Merging style files into the staging directory"
 	@rsync -av $(STYLEDIR)/ $(STAGINGDIR)/style --quiet
 
+    # Prüfen auf Dateien mit Unterstrichen im Namen
+	@echo "Checking for files containing underscores in $(STAGINGDIR)..."
+	@files=$$(find $(STAGINGDIR) -type f -name '*_*'); \
+	if [ -n "$$files" ]; then \
+		echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"; \
+		echo "WARNING: Found files with underscores:"; \
+		echo " ->  $$files"; \
+		echo "These files are very likely to cause issues during the build process"; \
+		echo "Remove or rename them to build the thesis safely"; \
+		echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"; \
+	fi
+
 compile-output:
     # Bauen der Arbeit aus dem staging verzeichnis heraus
 	@echo "Compiling the thesis into: $(OUTPUTFILE)"

README.md

@@ -57,6 +57,11 @@ $ sudo apt-get install git build-essential make-guile texlive-full pandoc pandoc
 
 Bei einer englischen Diplomarbeit muss außerdem entweder das Paket `hunspell-en-gb` oder `hunspell-en-us` installiert werden.
 
+
+## Alternative platformen
+
+Sie können die Diplomarbeit auch mit Hilfe von Docker oder Github WOrkflow bauen. Nähere Details dazu finden Sie im Verzeichnis `tools`.
+
 # Grundlegende Schritte
 
 ## Manuelles erstellen einer Diplomarbeit
@@ -334,14 +339,8 @@ Bei speziellen Fragen zu diesem Vorgehen wenden Sie sich bitte an den Programmie
 
 ## Tipps & Tricks
 
-**ES WIRD DRINGEND EMPFOHLEN DAS JEDER DIPLOMAND SEINE DIPLOMARBEIT LOKAL AUF SEINEM EIGENEN RECHNER BAUEN KANN**
-
 ### Generell
 * Man kann ToDo Blöcke in die DA einfügen indem man folgenden Block verwendet `\todo{Was noch zu tun wäre}`. Diese erscheinen dann als Textblasen am Rand der Arbeit.
-* Es werden alle `*.md` Files im Diplomarbeitsverzeichnis gebuildet. Das bedeutet das etwaige Readme Dateien auch eingefügt werden.
-* Am Ende jeder `*.md` Datei muss eine Leerzeile sein - sonst wird die nächste Überschrift nich korrekt dargestellt.
-* Überschriften werden nur bis zur 3. Ebene ins Inhaltsverzeichnis übernommen, und werden nur bis zur 5. Ebene bearbeitet.
-* Achtung beim Kopieren von Dateien aus Word oder anderen Unterlagen. Zuerst am besten in ein "Notepad" einfügen um etwaige Codierungsproblemen entegenzuwirken.
 
 
 ### Versionsverwaltung

example/metadata.yaml

@@ -40,7 +40,6 @@ da-author:
   ki-tools:
   - name: Galileo AI
     zweck: Setendesign sowie UI/UX Design der App
-  ki-tools:
   - name: Grammarly Go
     zweck: Stilverbesserung sowie Rechtschreibkorrekturen
 
@@ -74,7 +73,12 @@ da-appendix:
 - abschnitt: Betreuungsprotokolle
   pdf-file: betreuungsprotokolle.pdf    
 
-- abschnitt: Diplomatbeitsvereinbarung
-  pdf-file: HTL-DA-Vereinbarung.pdf
+# Diplomarbeitsvereinbarungen müssen zum Schluss sein 
+
+- abschnitt: Diplomatbeitsvereinbarung Englisch
+  pdf-file: HTL-DA-Doku-EN.pdf
+
+- abschnitt: Diplomatbeitsvereinbarung Deutsch
+  pdf-file: HTL-DA-Doku-DE.pdf
   
 ---

tools/README.md

@@ -0,0 +1,3 @@
+# docker tools
+
+The provided Dockerfile allows one to create a docker container taht builds the diploma thesis.

tools/docker/Dockerfile

@@ -0,0 +1,33 @@
+FROM ubuntu:20.04
+
+# Set the environment variables
+ENV LANG=C.UTF-8 \
+    LC_ALL=C.UTF-8 \
+    DEBIAN_FRONTEND=noninteractive
+
+# Update the package list and install dependencies
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends \
+    git \
+    build-essential \
+    make \
+    texlive-full \
+    pandoc \
+    pandoc-citeproc \
+    tree \
+    rsync \
+    hunspell \
+    hunspell-de-at \
+    hunspell-en-us && \
+    apt-get clean && \
+    rm -rf /var/lib/apt/lists/*
+
+# Set the working directory
+WORKDIR /workspace
+
+# Copy the Diplomarbeit template repository clone command here
+# Uncomment the following line if the repository URL is provided
+# RUN git clone https://itsp.htl-leoben.at/git/Hg/HTLLE-DA-Vorlage.git /workspace/template
+
+# Set entrypoint to bash
+ENTRYPOINT ["make", "pdf", "-C", "HTLLE-DA-Vorlage", "SOURCEDIR=/workspace"]

tools/docker/README.md

@@ -0,0 +1,32 @@
+# docker container
+
+The provided `Dockerfile` can be used to cerate a dockerized build environment where all depenencies are satisfied.
+
+
+## building the environment
+
+In order to build a docker container (in this example it will be namend `diplomarbeit-env` just run the following command on a docker host (Testsd with docker 20.10.22)
+
+~~~~
+$ docker build -t htlle-da-env .
+~~~~
+
+This creates a container that contains all dependencies and expects to find your diplomathesis in mounted into the `/workspace` folder. 
+
+Alternatively the image can be pulled from dockerhub. See instructions here:  https://hub.docker.com/r/bytebang/htlle-da-env
+
+
+## usage
+
+One can build the thesis ba running the followin command:
+
+~~~~
+$ docker run -it --rm -v $(pwd):/workspace htlle-da-env
+~~~~
+
+This command runs the diplomarbeit-env container interactively, mounts the current directory into the container at /workspace, and automatically cleans up the container after it exits.
+
+Errors and log messages are shown in the console, the file will be written back to the `/workspace` folder.
+This also works with _Docker Desktop_ 
+
+![Docker Dektop settings](docker-desktop.png)

tools/github/README.md

@@ -0,0 +1,4 @@
+# Github tools
+
+The workflow `build-and-send.yaml` allows the user to build the diploma thesis via a github workflow.
+Adapt it to meet your needs.

tools/github/build-and-send.yaml

@@ -0,0 +1,41 @@
+name: Build and Send Diplomathesis
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - Diplomarbeit/**
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install git build-essential make-guile texlive-full pandoc pandoc-citeproc tree rsync hunspell hunspell-de-at
+
+          
+      - name: Build DA-Thesis
+        run: |
+          make pdf -C HTLLE-DA-Vorlage SOURCEDIR=../Diplomarbeit/
+
+
+      - name:  Send File via Email
+        uses: dawidd6/action-send-mail@v2
+        with:
+          server_address: smtp.gmail.com
+          server_port: 587
+          username: ${{ secrets.GMAIL_MAIL }}
+          password: ${{ secrets.GMAIL_APP_PASSWORD }}
+          subject: "Diploma thesis"
+          body: " "
+          to: ${{ secrets.TEAMS_MAIL }}
+          from: ${{ secrets.GMAIL_MAIL }}
+          attachments: Diplomarbeit/diplomarbeit.pdf