Skip to content

🌿 LaTeX Vorlage für Scientific Essays, Seminar-, Bachelor- und Masterarbeiten der FOM - Hochschule für Oekonomie und Management

License

Notifications You must be signed in to change notification settings

dhd80/FOM-TeX-Microservice

Repository files navigation

FOM TeX Template Microservice

build and test

Eine LaTeX-Vorlage für den persönlichen Gebrauch für Scientific Essays, Haus-, Seminar-, Bachelor- und Master-Arbeiten an der FOM Hochschule für Oekonomie & Management. Dieses TeX Template ist eine sehr stark angepasst Version von Andy Grunwald's wunderbarem FOM-LaTeX-Template. Die Anpassungen basieren auf den Rückmeldungen der Dozenten und dem FOM Leitfaden zur formalen Gestaltung Seminar-/Abschlussarbeiten (Stand Mai 2021).

Features

Template mit Microservice Charakter. Automatisch da während des Schreibens, die PDF kompiliert wird. Echte Einbindung von Times New Roman als Systemschrift, denn die meisten TeX-Templates nutzen nur eine ähnliche Schriftart und nicht das Original. Keine Systeminstallation von LaTeX notwendig, da LaTeX automatisch im Docker installiert wird. Platzsparend da nur die notwendigen TeX-Pakete installiert werden (~1.2GB). Prozessorientiert. Getestet unter Linux und macOS.

How it works

Dieser Microservice, soll einen Docker starten und jedesmal wenn die Datei deine_inhalte/Kapitel.tex gespeichert wird, wird diese automatisch mit arara kompiliert. Ein Kompilierungslauf dauert ~20 Sekunden, da LaTeX und BibLaTeX einen mehrmaligen Durchlauf benötigen und via arara Support-Befehle ausgeführt werden.

VsCode

Verwendung von LaTeX und des Templates

Software

Visual Studio Code - LaTeX Workshop - Spell Right

Bibliographie und Zitate

Bücher

Unter zbib.org kannst du die ISBNs deiner Bücher eingeben, die Einträge werden in einem Cookie gespeichert. Dann den Cite-Style auf Chicago stellen und eine BibLaTeX Datei downloaden, mit dem Namen citations.bib. Diese .bib kannst du einfach unter deine_inhalte/ immer wieder überschreiben und nutzen. Im selben Verzeichnis liegt citations_manual.bib diese kannst du nutzen um eigene Einträge zu setzen, bspw. wenn die auto. generierten unsauber aufbereitet sind. Es werden also beide .bib gleichzeitig von der Vorlage genutzt. Es sollten in keiner bib Datei doppelte Keywords gesetzt werden.

Artikel

Bei Springer können für jeden Artikel, unter Cite this article, Einträge für deine Biblatex citations_manual.bib geladen werden. Diese RIS-Dateien müssen vorher mit einem ris2bib Konverter in das Biblatex-Format gebracht werden bevor du sie eintragen kannst.

TeX- und andere Beispiele

In deine_inhalte/Kapitel.tex ist der von mir meistgenutzte LaTeX-Code eingetragen, Grafiken, Tabellen, Kursivschrift etc. so kannst du in diesem Git-Repository immer wieder nachschlagen. Im Kompilat elaborat.pdf sind die gebräuchlichsten LaTeX-Beispiele hinterlegt, so kannst du prüfen, wie deine Hausarbeit aussehen sollte.

Internetseiten zitieren

Mit der Chrome-Erweiterung Cite This For Me: Web Citer können Informationen, welche normalerweise auf der Internetseite zusammengesucht werden müssen, bequem in die Zwischenablage kopiert werden. Vor der Benutzung Chicago einstellen.

Flüchtige Quellen

Du kannst flüchtige Quellen mit wget von deinem Terminal aus downloaden:

$ wget \
     --recursive \
     --no-clobber \
     --page-requisites \
     --html-extension \
     --convert-links \
     --restrict-file-names=windows \
     --domains website.org \
     --no-parent \
         'www.website.org/tutorials/html/'

Quelle: linuxjournal.com

Wörter zählen

Bei jedem Lauf wird die Datei word_count.log erstellt/überschrieben, in welcher du die Anzahl deiner geschriebenen Worte ablesen kannst.

Erscheinungsbild des Templates

Zitierstile

Es können die Zitierstil-Pakete IEEE und FOM-ext-authoryear geladen werden. Letzteres ist per Default aktiviert. Um IEEE zu aktivieren muss in der Datei elaborat.tex (Zeile 51), die folgende Zeile:

\usepackage[backend=biber,style=ext-authoryear,maxcitenames=1,maxbibnames=999,mergedate=false,date=iso,seconds=true,urldate=iso,innamebeforetitle,dashed=false,autocite=footnote,doi=false,useprefix=true,mincrossrefs=1]{biblatex}\input{app/src/bib/modsBiblatex}

durch folgende Zeile ersetzt werden:

\usepackage[backend=biber,style=ieee,maxcitenames=1,maxbibnames=999,mergedate=false,date=iso,seconds=true,urldate=iso,innamebeforetitle,dashed=false,autocite=footnote,doi=false,useprefix=true,mincrossrefs=1]{biblatex}\input{app/src/bib/modsBiblatex}

Titelseite

Unter deine_inhalte/Kapitelanhang/Metainformationen.tex können die Informationen der Titelseite angepasst werden.

Ehrenwörtliche Erklärung und Unterschrift

Ersetze die Grafik deine_inhalte/Kapitelanhang/Unterschrift.png mit einer Grafik deiner Unterschrift.


Installation und Start des Dockers

Vorbereitung

Installiere Docker für dein Betriebssystem. Klone dieses Repository in deinem Terminal, mit dem Befehl:

git clone https://github.com/dhd80/FOM-TeX-Microservice.git

gehe in den Ordner dieses Repository mit:

cd FOM-TeX-Microservice

Starte via Docker Compose (Empfohlen)

Gib den folgenden Befehl in dein Terminal ein und fertig 🤓 🤓 🤓:

docker compose up

Terminal

Weitere Startbefehle (Optional), inkl. min. Fehlerhandling:

docker compose up --detach --build --remove-orphans
docker compose up --build --remove-orphans

Starte via Dockerfile

docker build --pull --rm -f "Dockerfile" -t fomtextemplate:latest "."
docker run -d --name fomtextemplate -v ${PWD}:/usr/fomtextemplate:rw fomtextemplate:latest

Starte ohne Docker

Hierbei wird natürlich eine LaTeX Installation und alle benötigten Pakete auf deinem System erwartet, sowie eine Systeminstallation von Times New Roman. Du kannst das Template kompilieren, wenn du in deinem Terminal folgenden Befehl nutzt: arara elaborat.tex Es wird eine elaborat.pdf neben der elaborat.tex erzeugt.

Aufräumen

Nach geschriebener Hausarbeit, kann das System gesäubert werden indem du den Docker stoppst mit docker compose down und folgenden Befehl ausführst um Speicher freizugeben [Achtung: dies tangiert auch andere Docker!]: docker system prune -a

Fehlerhandling

arara säubert diverse auxiliary files vor und nach dem Kompilierungslauf, was diversen Fehlern vorbeugt. Sollte ein Fehler auftreten, kompiliere mit arara -lv elaborat.tex direkt im Docker, was eine weitere Logdatei erzeugt, aber auch mehr Output auf deinem Terminal, u.a. in Form von Fehlermeldungen.

Disclaimer

Solltest du dieses Template nutzen wollen, plane genug Zeit ein und teste es vorher aus. Bespreche mit deinem Betreuer das Format, da mehrere Zitierstile im Umlauf sind und manche Betreuer speziellere Vorgaben machen. Gerne Antworte ich auf Anfragen, hier in GitHub. Ich kann jedoch keine Aussage über die Reaktionszeit treffen. Dies ist ein privates Projekt und die Nutzung auf eigene Gefahr. Diese Vorlage hat weder einen Anspruch auf Richtigkeit, noch auf Vollständigkeit. Verbesserungen sind jederzeit willkommen.

Lizenz

Dieses Projekt ist unter den Bedingungen der MIT Lizenz öffentlich verfügbar.

About

🌿 LaTeX Vorlage für Scientific Essays, Seminar-, Bachelor- und Masterarbeiten der FOM - Hochschule für Oekonomie und Management

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published