Skip to content

Latest commit

 

History

History
224 lines (152 loc) · 11 KB

README.md

File metadata and controls

224 lines (152 loc) · 11 KB
Raw

LaTeX-Vorlage für die FOM Hochschule für Oekonomie & Management

Build Status

Eine LaTeX-Vorlage für den persönlichen Gebrauch für Haus-, Seminar-,Bachelor und Master-Arbeiten an der FOM Hochschule für Oekonomie & Management.

Wie das Ergebnis aussieht, könnt ihr euch in der Datei thesis_main.pdf ansehen.

Diese Vorlage hat weder einen Anspruch auf Richtigkeit, noch auf Vollständigkeit. Verbesserungen sind jederzeit willkommen (siehe Ich möchte mithelfen, diese Vorlage zu verbessern).

Inhaltsverzeichnis

  1. Für die eigene Arbeit nutzen
  2. Klassischer Download
  3. Fork auf Github
  4. Vorlage personalisieren
  5. Fußnoten
  6. Literaturverzeichnis
  7. Sperrvermerk
  8. Quellcode einbinden
  9. Vorraussetzungen
  10. LaTeX-Pakete
  11. LaTeX zu PDF kompilieren
    1. Docker unter Linux / Mac / Windows
    2. Image selbst bauen
  12. IDE zur Bearbeitung nutzen
  13. Texpad
  14. Ich habe eine Frage oder ein Problem
  15. Ich möchte mithelfen, diese Vorlage zu verbessern
  16. Disclaimer
  17. Lizenz

Für die eigene Arbeit nutzen

Aufgrund der gewählten Lizenz MIT Lizenz, darfst du diese Vorlage für den persönlichen oder kommerzielen Gebrauch nutzen und abändern. Um dies zu tun gibt es mehrere Möglichkeiten, die wir nachfolgend kurz vorstellen.

Generell gilt: Dieses Dokument beschreibt eine ganze Menge Details, die dir beim erstellen und bearbeiten des Dokument hilfreich sein könnten. Leider wird es unmöglich sein, jede Frage abzudecken. Solltest du uns kontaktieren wollen um eine Frage zu stellen, ein Problem mit zuteilen oder um einfach nur mal Danke sagen zu wollen, eröffne doch ein neues Issue in diesem Projekt.

Klassischer Download

Über den Clone or Download Button in der oberen rechten Ecke kannst du dir diese Vorlage herunterladen (ZIP-Archiv). Danach kannst du, wie gewohnt, die Dateien lokal bearbeiten, deine Arbeit schreiben, Drucken und abgeben.

Fork auf Github

Die bessere Alternative zum klassischen Download ist ein Fork auf Github. Wie das im Detail funktioniert beschreibt der Artikel Fork A Repo. Das ganze hat primär zwei Vorteile:

  • Du hast automatisch ein Backup deiner Arbeit auf Github
  • Andere Personen / Studenten können sich deine Arbeit ansehen, diese verbessern, diese weiter verwenden (und ggf. Zeit sparen) oder daraus lernen (bedenke, all diese Vorteile hast du auch durch dieses Projekt)
  • Wenn du es nicht mehr öffentlich zur Verfügung stellen kannst, kannst du das Projekt als privat markieren oder löschen

Vorlage personalisieren

Wenn du diese Vorlage nutzt ist der erste Einstiegspunkt die Datei skripte/meta.tex. In der Datei haben wir einige Variablen hinterlegt, die im Dokument (u.a. auf dem Deckblatt) genutzt werden.

Ersetze die Muster-Werte durch deine persönlichen Angaben und diese werden automatisch im Dokument verwendet.

Fußnoten

Einige Professoren bevorzugen ein anderes Fußnoten-Format. Das Standard-Format kann mit \footcite[Vgl. ][Seite 1]{Balzert.2008} genutzt werden und gibt folgendes aus:

Vgl. Balzert et al. (2008), Seite 1.

Es besteht auch die Möglichkeit, den Vornamen des Autors mit auszugeben. Dazu kann der Custom-Befehl \fullfootcite[Vgl. ][Seite 1]{Balzert.2008} genutzt werden, der folgendes Resultat liefert:

Vgl. Balzert, Helmut et al. (2008), Seite 1.

Literaturverzeichnis

Einige Professoren bevorzugen ein sortiertes (Webseite, Buch, Artikel...) Literaturverzeichnis. Dies kann mit folgender Änderung im Quellcode (thesis_main.tex) erreicht werden:

Zunächst diese Zeile auskommentieren:

%\printbibliography

Und die folgenden Zeilen einkommentieren und ggf. anpassen.

\printbibheading
\printbibliography[type=article,heading=subbibliography,title={Artikel}]
\printbibliography[type=book,heading=subbibliography,title={Bücher}]
\printbibliography[type=online,heading=subbibliography,title={Webseiten}]

Sperrvermerk

Sollte ein Sperrvermerk für die Arbeit notwendig sein, so kann dieser durch einkommentieren der folgenden Zeile aktiviert werden:

\input{kapitel/anhang/sperrvermerk}

Die Angaben zu Titel der Arbeit und Name der Firma werden dabei aus den Metadaten entnommen.

Quellcode einbinden

Um euren Quellcode einzubinden, wurde bereits das Packet listings in der Datei thesis_main.tex eingebunden. Dieses wird dort auch mit den Farben für Kommentare, Strings, etc konfiguriert. Folgendermaßen könnt ihr Quellcode einbauen:

\lstinputlisting[language=Java]{./Quellcode/Dateiname.js}

Für Javascript gibt es noch keine eigene Sprache, daher benutzt am besten Java. Für eine genauere Beschreibung empfehlen wir folgenden Artikel: LaTeX/Source Code Listings @ Wikibooks.

Vorraussetzungen

LaTeX-Pakete

LaTeX ist Grundvoraussetzung. Wenn Du MikTex oder MacTex verwendest, dann brauchst Du keine weiteren LaTeX-Pakete installieren.

Weiterhin wird Biblatex und Biber (>= Version 1.8) für das Literaturverzeichnisses benötigt.

LaTeX zu PDF kompilieren

Um die LaTeX-Dateien in eine PDF zu kompilieren müsst ihr unter Windows einfach die beiliegende compile.bat ausführen. Benutzer von Mac OSX und Linux verwenden bitte die compile.sh. Zum Kompilieren müssen die oben beschriebenen Vorraussetzungen erfüllt sein.

Wenn das kompilieren nicht ohne Fehler möglich ist, kontrolliert bitte ganz genau eure LaTeX-versionen. Alternativ empfehlen wir das Dokument mit Docker (siehe unten) zu kompilieren.

Docker unter Linux / Mac / Windows

Mit Docker wird das Dokument direkt in einem isolierten Container kompiliert. In diesem Container sind alle Vorraussetzungen mit der richtigen Software und den richtigen Versionen gegeben.

Voraussetzung ist eine installierte Docker engine.

Um die PDF ohne die Installation der LaTeX-Pakete zu kompilieren muss folgender Befehl in eurem Projekt-Ordner ( da wo die compile.sh bzw compile.bat liegt) ausgeführt werden:

docker run -it --rm -v ${PWD}:/data andygrunwald/fom-latex-template

Den Befehl lasst ihr einfach über eure Kommandozeile bzw. PowerShell laufen (in Windows cmd.exe bzw. powershell.exe, beim Mac ist es das Terminal). Zum Projektordner könnt ihr kommen, indem ihr über den cd Befehl dorthin navigiert oder im Windows-Explorer in diesen Ordner wechselt und dann bei gedrückter Shift-Taste die rechte Maus-Taste klickt. Dort müsst ihr dann im Menü den Eintrag : "Öffne Kommandozeile hier" auswählen.

Wird Docker unter Windows 10 verwendet, muss der Daemon wie folgt konfiguriert werden:

Docker Konfiguration unter Windows 10

Die benötigten Pakete befinden sich in dem Docker-Image, welches auf Docker Hub unter andygrunwald/fom-latex-template zur Verfügung steht. Es wird bei der Ausführung automatisch heruntergeladen.

Image selbst bauen

Wenn du das Docker Image selbst bauen möchtest, kannst du es mit dem nachfolgenden Befehl tun:

docker build -t andygrunwald/fom-latex-template .

IDE zur Bearbeitung nutzen

Prinzipiell reicht ein normaler Text-Editor zur Bearbeitung aus. Jedoch kannst du zum schreiben der Arbeit auch ein IDE verwenden. Hierzu gibt es nachfolgend einige Software:

Texpad

Für die Nutzung von Texpad unter Mac OSX müssen einige Einstellungen beachtet werden. Standardmäßig ist biber nicht aktiviert. Dies führt dazu, dass das Literaturverzeichnis einfach "verschwindet", wenn man mit Texpad kompliliert. Daher musst Du unter Preferences > Typesettings > Bibliography Compilation als Engine biber auswählen.

Ich habe eine Frage oder ein Problem

Ab und zu kommt es vor, dass es nicht klappt wie beschrieben oder man eine Frage hat. Ich würde euch bitten mir nicht persönlich eine E-Mail zu schreiben, sondern lieber ein neues Issue in diesem Projekt eröffnet. Dies hat folgende Vorteile:

  • andere Personen können zur Lösung beitragen (weil sie diese ggf. auch hatten)
  • wir haben eine Dokumentation an vorhandenen und gelösten Fehlern / Fragen
  • gelöste / wiederkehrende Probleme müssen nicht erneut beantwortet werden

Ich möchte mithelfen, diese Vorlage zu verbessern

Verbesserungen an dieser Vorlage sind stehts erwünscht und Willkommen. Github (diese Plattform) selbst ist dafür gemacht um zusammen an Open Source Projekten zu arbeiten. Deswegen werden Änderungen über Pull Requests sehr gerne entgegen genommen.

Wenn du das erste mal mit Git, Github und Pull Requests arbeitest, können dir folgende zwei Artikel weiter helfen:

Disclaimer

Diese Vorlage wurde zu meiner Studiumszeit erstellt und genutzt. Die Grundlage waren die damaligen Formatierungsregeln für Abschlussarbeiten der FOM (Standort Düsseldorf). I.d.R. sind diese jedoch für jeden Standort gültig. Ab und zu weichen einzelne Professoren davon ab.

Mein Studium habe ich inzwischen abgeschlossen und deswegen nutze ich diese Vorlage nicht mehr aktiv. Jedoch wird sie von mehreren Personen genutzt, weiter gepflegt und angepasst. Ich versuche das Projekt soweit wie zeitlich möglich weiter zu betreuen, bitte jedoch um Verständnis, wenn eine Antowrt nicht innerhalb einer Stunde vorliegt.

Lizenz

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