Merge branch 'master' of lcle/HTLLE-DA-Vorlage_Jenkinsfile into master

Jenkinsfile

@@ -51,7 +51,7 @@ pipeline {
                     }
                     if(env.GIT_PATH.contains("../")) {
                         error("GIT_PATH must not contain '../'")
-                    ]
+                    }
                     
                     // be sure branch is set
                     env.GIT_BRANCH = params.GIT_BRANCH ?: '*/master'
@@ -112,7 +112,10 @@ pipeline {
             }
             steps {
                 dir(env.GIT_PATH) {
-                    sh "make pdf -C ${env.TEMPLATE_NAME} SOURCEDIR=`pwd`"
+                    sh"""#!/bin/bash
+                    make pdf -C ${env.TEMPLATE_NAME} SOURCEDIR=`pwd`
+                    hunspell -d de_AT,de_AT_frami,en_US -p ignore.dict -l -t *.md > diplomarbeit.pdf.spellcheck.txt
+                    """
                 }
             }
         }
@@ -135,6 +138,13 @@ pipeline {
                 }
             }
         }
+        stage('Create Tarball-Archive') {
+            steps {
+                dir(env.GIT_PATH) {
+                    sh "tar -czvf diplomarbeit.tar.gz diplomarbeit.pdf*"
+                }
+            }
+        }
     }
     post {
         always {
@@ -155,7 +165,7 @@ pipeline {
                 }
             }
             dir(env.GIT_PATH) {
-                emailext attachmentsPattern: "diplomarbeit.pdf*",
+                emailext attachmentsPattern: "diplomarbeit.tar.gz",
                     to: "${env.RECIPIENTS}",
                     subject: "[${currentBuild.currentResult}] Diplomarbeit Build #${env.BUILD_NUMBER}",
                     body: "Job ${env.JOB_NAME}: ${env.JOB_URL}"

README.md

@@ -142,6 +142,7 @@ $ tree ~/Diplomarbeit
 │
 ├── literatur.bib                  <= Das ist das Literaturverzeichnis
 ├── metadata.yaml                  <= Grundlegende Informationen zur Diplomarbeit
+├── ignore.dict                    <= Hier kommen Wörter rein, die beim Spellchecker ignoriert werden (Jenkins-Job)
 │
 ├── img                            <= Hier kommen alle Ihre Bilder rein
 │   ├── graph.png
@@ -253,6 +254,10 @@ Egal ob die Quellenangabe aus einem Buch, einer Zeitschrift order irgend einer a
 
 Um das Zusammensuchen der Quellenangaben für Bücher zu vereinfachen kann man in vielen Fällen den Bibliographiedienst [OttoBib](https://www.ottobib.com) verwenden, in dem alleine durch Angabe der [ISBN Nummer](https://en.wikipedia.org/wiki/International_Standard_Book_Number) eines Buches in vielen Fällen schon einen fertigen BibTex Block bekommt. Einen ähnlichen Dienst bietet die Internetseite [bibtexsearch](https://www.bibtexsearch.com/) an - wo man durch die Eingabe von Schlüsselwörtern nach BibTexeinträgen suchen kann.
 
+#### ignore.dict
+
+Während des [Build-Jobs](#remote) läuft auch eine Rechtschreibprüfung (`hunspell`) mit deutschen und englischen Wörterbuch über die Markdown Dateien. Möchten Sie dabei Wörter ignorieren (z.B.: Namen) tragen, Sie diese hier ein. Pro Begriff muss eine Zeile verwendet werden. 
+
 ## Arbeiten im Rahmen der Diplomarbeit
 
 ### Bauen der Diplomarbeit als PDF Datei
@@ -299,6 +304,7 @@ $ tree ~/Diplomarbeit
     │   └── graph.png
     ├── literatur.bib
     ├── metadata.yaml
+    ├── ignore.dict
     └── pdfs
         ├── HTL-DA-Vereinbarung.pdf
         ├── README
@@ -324,6 +330,7 @@ $ tree ~/Diplomarbeit
 │   └── graph.png
 ├── literatur.bib
 ├── metadata.yaml
+├── ignore.dict
 └── pdfs
     ├── HTL-DA-Vereinbarung.pdf
     ├── README
@@ -336,6 +343,11 @@ $ tree ~/Diplomarbeit
 
 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 `tar.gz` Datei 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
+- `diplomarbeit.pdf.spellcheck.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.
@@ -369,7 +381,7 @@ Bei speziellen Fragen zu diesem Vorgehen wenden Sie sich bitte an den Programmie
 
 ### Text
 
-* Grammatik + Rechtschreibung beachten (Markdown hat keinen Spell-checker integriert). ggf. `aspell` installieren und durch die Markdown files suchen lassen.
+* Grammatik + Rechtschreibung beachten (Markdown hat keinen Spell-checker integriert). ggf. `aspell` installieren und durch die Markdown files suchen lassen. Lassen Sie die Dateien remote bauen, so bekommen Sie den Output einer Rechtschreibprüfung mit übermittelt
 * Irgendwie sollte man ein (einheitliches) Bild vom Leser haben. Negativbeispiel:
     * Einerseits ein Dummy dem man `mdir` erklären muss
     * andererseits kann er Python-Pakete installieren

example/ignore.dict

@@ -0,0 +1,9 @@
+-
+-----
+------
+---------
+.java
+PNG
+args
+array.length.
+graph.png