isw_smb_diss

LaTeX Style für Dissertationen der Schriftenreihe Stuttgarter Maschinenbau (SMB).

isw_smb_diss

Anleitung zum Aufsetzen meiner Dissertation

Methode	Vorteile	Nachteile
Weg 1: Als Git submodule	- Modular eingebunden - Updates einfach über git	Geht nicht mit Overleaf (Unterstützt keine git submodules)
Weg 2: Nur die Dateien verwenden)	- Lässt sich in Overleaf nutzen - Das Diss-Verzeichnis kann trotzdem in Git eingecheckt werden, nur die Verbindung zur Klasse geht verloren	Updates in der Klasse müssen von Hand heruntergeladen werden (oder über die Github API mit curl)

Weg 1: Als git submodule (ohne Overleaf)

Anlegen eines Diss-Ordners als Git-Repository

Einbinden dieses Repositories als Git-Submodul

# git Kommandozeile
# über https (meistens einfacher)
git submodule add https://github.com/iswunistuttgart/isw_smb_diss.git
# oder über ssh (SSH-Key muss eingerichtet sein)
git submodule add git@github.com:iswunistuttgart/isw_smb_diss.git

Als Gerüst zur Strukturierung der Diss kann diss_beispiel.tex aus dem Submodul/Unterordner isw_smb_diss in den eigenen Ordner kopiert werden.
Spätere Updates der Klasse über
```
git submodule update --remote
```

Weg 2: Mit Overleaf

Repository auschecken oder downloaden und folgende Dateien in den Ordner isw_smb_diss/ im eigenen Dissertationsverzeichnis kopieren:
```
isw_smb_diss.cls  isw_smb_gloss.sty
```
Als Gerüst zur Strukturierung der Diss kann diss_beispiel.tex in den eigenen Ordner kopiert werden.
Spätere Updates müssen wie in Schritt 1. erfolgen

Struktur

isw_smb_diss.cls ... Klasse, die das generelle Styling festlegt und das Deckblatt generiert
isw_smb_gloss.sty ... Styling für Glossar und Abkürzungsverzeichnis mit dem Paket glossaries (falls benötigt)
diss_beispiel.tex ... Beispielgerüst für die Diss. Eine Ordnerhierarchie nach oben kopieren
settings_example/*.tex ... Beispiele von Settings-Dateien für Command definitions und TikZ-Code
.gitignore ... Gitignore-Datei für LaTeX, kann gerne auch in den eigenen Diss-Ordner übernommen werden

Spätere Ordnersturkur des Diss-Ordners

Diss/
    Diss_Name.tex # Zu Beginn kopiert aus diss_beispiel.tex
    isw_smb_diss/ # Git submodule
        isw_smb_diss.cls
        isw_smb_gloss.sty
    
    # optional für aufgeräumte Struktur
    settings/ # Einstellungen
    kapitel/ # Hier der eigentliche Inhalt
    img/ # Fotos
    figures/ # Grafiken
    bibliography/ # bib-Datei (z.B. als git submodule)

Optionen zum Konfigurieren der Klasse `isw_smb_diss.cls`

smallfont ... kleinere Schrift: 12pt auf A4, 8pt auf A5
onside|twoside ... einseitiger/doppelseitiger Druck. oneside ist für das Drucken des Manuskripts gedacht und nimmt an, dass alle Seiten rechte Seiten sind (Kopf und Seitenzahlen immer rechts). Die finale Veröffentlichung mit dem Verlag sollte mit twoside erfolgen.
BCOR=XYmm ... Bindungskorrektur. Der Textblock wird nach außen gerückt, um die Lesbarkeit bei Klebebindung zu verbessern. Methoden zur Ermittlung des Wertes finden Sie hier Tipp: Messen Sie in der Bibliothek eine Dissertation des Verlags mit einer ähnlichen Seitenanzahl. Für ca. 200 Seiten waren 6mm okay.
accepted ... für die finale Druckversion (siehe auch in den FAQs). Das Format wird auf Din-A5 gestellt, die Schriftgröße entsprechend skaliert. Das Deckblatt wird entsprechend der Prüfungsordnung angepasst.

Beispiel für Einbinden der Klasse:

\documentclass[
  english, ngerman, % Sprache, die letzte ist die Hauptsprache
  %smallfont, % kleinere Schrift
  twoside, % oneside % ein-/doppelseitiger Druck
  BCOR=6mm,
]{isw_smb_diss}

Roadmap

Ausbau des Templates für englischsprachige Dissertationen (Titelblatt und Dokumentation anpassen)

FAQ

Unterscheidet das Template zwischen Einreichung und Veröffentlichung beim Verlag?

Ja, nach den Vorgaben der Uni soll das Manuskript in A4-Format eingereicht werden, das Format für den Druck ist aber "in der Regel DIN A5". Für die Umschaltung in das Druckformat muss die Klassenoption accepted übergeben werden, also

\documentclass[accepted, english, ngerman]{isw_smb_diss/isw_smb_diss}

Diese ändert auch die Link-Farben in schwarz um die Druckkosten zu reduzieren (weniger Farbseiten).

Um die Komplikationen (und den Anpassungsbedarf) der Änderung im Papierformat möglichst gering zu halten, werden Schriftgröße und Seitenränder so angepasst, dass das Format möglichst gleich bleibt.

Um Probleme bei der Umstellung zu vermeiden, sollten in Abbildungen und Tabellen relative Maßeinheiten verwendet werden, z.B:

%for tables
\begin{tabular}{p{4em} p{5em} c c}
% ...
\end{tabular}

% graphics
\includegraphics[width=0.8\textwidth]{path/to/my_picture}

% TikZ pictures: https://tex.stackexchange.com/questions/4338/correctly-scaling-a-tikzpicture

Wie melde ich einen Fehler?

Als Issue aus GitHub
Noch besser: direkt auf einem Branch beheben und einen pull request stellen
Für Änderungen gibt es keine Merge-Garantie, daher am besten vorher besprechen

Vertikales Spacing auf der Seite ist ungleichmäßig

Dieses "Problem" entsteht vermutlich beim Umsteigen aufs geforderte A5-Format. LaTeX versucht den Satzspiegel unten bündig zu setzen, indem der Inhalt minimal gestreckt wird. Bei A5 ist weniger Seitenlänge, auf die das Strecken des Inhalts verteilt werden kann. Einzelne Vorkommen können durch manuelles Umbrechen mit dem Befehl \newpage behoben werden. Global kann durch Aufrufen des Befehls \raggedbottom das Strecken des Inhalts unterbunden werden (siehe Beispieldokument), dadurch ist der untere Satzspiegel dann unterschiedlich hoch.

Eine Überschrift taucht nicht in der Kopfzeile auf

Zu Beginn in den unnummerierten Kapiteln: Es wurde vermutlich \chapter*{...} für die Kapitelüberschrift verwendet. Umstellen auf \addchap{...} sollte helfen.
Ein Kapitel geht über mehrere Seiten, bevor \section eingeführt wird. Auf ungeraden Seiten bleibt der Header leer: TODO
In der Bibliogaphie: Behoben in der Vorlage durch Einbinden über \printbibliography[title={Literatur}]

Einträge im Literaturverzeichnis brechen auf die nächste Seite um

Behoben durch \patchcmd{\bibsetup}{\interlinepenalty=5000}{\interlinepenalty=10000}{}{} vor \printbibliography

Überschriften (Kapitel, Abschnitt, ...) sollen gemeinsamen Tabulator bekommen

Der Verlag möchte das gerne, scheint aus dem Schreiben mit Word zu kommen. Eine Lösung bietet dieser Stackexchange-Link. Bringt aber viel Whitespace und ist deswegen nicht im Template.

Ich bekomme eine Warnung `You have requested document class 'isw_smb_diss/isw_smb_diss', but the document class provides 'isw_smb_diss'.`

Siehe auch PR: Fix wrong ProvidesClass entry #5

Entsteht, indem die Latex-Klasse aus einem Unterordner eingebunden wird (z.B. als Git Submodule). Die Klasse sollte trotzdem funktionieren. Die Warnung kann behoben werden, indem dieses Repository installiert wird, oder der Pfad der Klasse in die Umgebungsvariable TEXINPUTS aufgenommen wird. (Danach \documentclass[...]]{isw_smb_diss/isw_smb_diss} ändern zu \documentclass[...]]{isw_smb_diss})

Nach Update auf Version >1.5.0 kompiliert mein Dokument nicht mehr

Fehlermeldung z.B. Undefined control sequence. \addbibresource oder Undefined control sequence. \printbibliography.

Zu Version 1.5.0 wurde der Style der Bibliographie von der Klasse getrennt. Dies ermöglicht, institutseigene Zitierstile zu verwenden, ohne die Klasse ändern zu müssen.

Definieren Sie zum Beheben des Fehlers den Zitierstil in Ihrer Präambel (vor \begin{document}), z.B.:

\usepackage[style=numeric, % see https://www.overleaf.com/learn/latex/Biblatex_citation_styles for a list of predefined styles
sorting=none,
maxcitenames=2,
maxbibnames=99,
giveninits=true,
uniquelist=false,
backend=biber,
bibwarn=true,
sortcites=true, % sort citations when multiple are cited, e.g. \cite{A,B,C} -> [1,2,3] instead of [3,1,2]
isbn=true]{biblatex}

% Optional Hack: print url only if no doi is present, credits to samcarter_is_at_topanswers.xyz on https://tex.stackexchange.com/a/424775
\renewbibmacro*{doi+eprint+url}{%
	\printfield{doi}%
	\newunit\newblock%
	\iftoggle{bbx:eprint}{%
		\usebibmacro{eprint}%
	}{}%
	\newunit\newblock%
	\iffieldundef{doi}{%
		\usebibmacro{url+urldate}}%
	{}%
}

iswunistuttgart/isw_smb_diss