isw_smb_diss

KO | EN

gitlite — search

#javascript #hacktoberfest #ai #machine-learning #deep-learning #linux #docker #macos #java #windows #awesome #cli #kubernetes #pytorch

(★ 13)

LaTeX template for dissertations within the "Stuttgarter Maschinenbau"

isw_smb_diss 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# isw_smb_diss

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

- [isw\_smb\_diss](#isw_smb_diss)
  - [Anleitung zum Aufsetzen meiner Dissertation](#anleitung-zum-aufsetzen-meiner-dissertation)
    - [Weg 1: Als git submodule (ohne Overleaf)](#weg-1-als-git-submodule-ohne-overleaf)
    - [Weg 2: Mit Overleaf](#weg-2-mit-overleaf)
  - [Struktur](#struktur)
    - [Spätere Ordnersturkur des Diss-Ordners](#spätere-ordnersturkur-des-diss-ordners)
    - [Optionen zum Konfigurieren der Klasse `isw_smb_diss.cls`](#optionen-zum-konfigurieren-der-klasse-isw_smb_disscls)
  - [Roadmap](#roadmap)
  - [FAQ](#faq)
    - [Unterscheidet das Template zwischen Einreichung und Veröffentlichung beim Verlag?](#unterscheidet-das-template-zwischen-einreichung-und-veröffentlichung-beim-verlag)
    - [Wie melde ich einen Fehler?](#wie-melde-ich-einen-fehler)
    - [Wie kann ich Links schwarz färben für den Druck des Manuskripts (günstiger im Druck)?](#wie-kann-ich-links-schwarz-färben-für-den-druck-des-manuskripts-günstiger-im-druck)
    - [Kann ich herausfinden, welche (und wieviele) Seiten Farbseiten sind?](#kann-ich-herausfinden-welche-und-wieviele-seiten-farbseiten-sind)
    - [Vertikales Spacing auf der Seite ist ungleichmäßig](#vertikales-spacing-auf-der-seite-ist-ungleichmäßig)
    - [Eine Überschrift taucht nicht in der Kopfzeile auf](#eine-überschrift-taucht-nicht-in-der-kopfzeile-auf)
    - [Einträge im Literaturverzeichnis brechen auf die nächste Seite um](#einträge-im-literaturverzeichnis-brechen-auf-die-nächste-seite-um)
    - [Überschriften (Kapitel, Abschnitt, ...) sollen gemeinsamen Tabulator bekommen](#überschriften-kapitel-abschnitt--sollen-gemeinsamen-tabulator-bekommen)
    - [Ich bekomme eine Warnung `You have requested document class 'isw_smb_diss/isw_smb_diss', but the document class provides 'isw_smb_diss'.`](#ich-bekomme-eine-warnung-you-have-requested-document-class-isw_smb_dissisw_smb_diss-but-the-document-class-provides-isw_smb_diss)
    - [Nach Update auf Version \>1.5.0 kompiliert mein Dokument nicht mehr](#nach-update-auf-version-150-kompiliert-mein-dokument-nicht-mehr)

## Anleitung zum Aufsetzen meiner Dissertation

| Methode                                                            | Vorteile                                                                                                                                          | Nachteile                                                                                                                                                                          |
| ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Weg 1: Als Git submodule](#weg-1-als-git-submodule-ohne-overleaf) | - Modular eingebunden  <br /> -  Updates einfach über git                                                                                         | Geht nicht mit Overleaf (Unterstützt keine git submodules)                                                                                                                         |  |
| [Weg 2: Nur die Dateien verwenden](#weg-2-mit-overleaf))           | - Lässt sich in Overleaf nutzen <br />- 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](https://stackoverflow.com/questions/46060010/download-github-release-with-curl)) |

### Weg 1: Als git submodule (ohne Overleaf)

1. Anlegen eines Diss-Ordners als Git-Repository
2. Einbinden dieses Repositories als Git-Submodul

```sh
    # 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
    ```

3. Als Gerüst zur Strukturierung der Diss kann `diss_beispiel.tex` (deutsch) / `diss_example_en.tex` (englisch) aus dem Submodul/Unterordner `isw_smb_diss` in den eigenen Ordner kopiert werden.
4. Spätere Updates der Klasse über

```
    git submodule update --remote
    ```

### Weg 2: Mit Overleaf

1. 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
    ```
2. Als Gerüst zur Strukturierung der Diss kann `diss_beispiel.tex` (deutsch) / `diss_example_en.tex` (englisch) in den eigenen Ordner kopiert werden.
3. 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
- `diss_example_en.tex` ... Englisches Beispiel für die Dissertation
- `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

```sh
Diss/
    Diss_Name.tex # Zu Beginn kopiert aus diss_beispiel.tex/diss_example_en.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`

1. `smallfont` ... kleinere Schrift: 12pt auf A4, (entspricht ~8.5pt bei A5-Druck)
2. `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.
3. `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](https://tex.stackexchange.com/a/38700) Tipp: Messen Sie in der Bibliothek eine Dissertation des Verlags mit einer ähnlichen Seitenanzahl. Für ca. 200 Seiten waren 6mm okay.
4. `accepted` ... für die finale Druckversion (siehe auch [in den FAQs](https://github.com/iswunistuttgart/isw_smb_diss/blob/master/README.md#unterscheidet-das-template-zwischen-einreichung-und-ver%C3%B6ffentlichung-beim-verlag)). Das Deckblatt wird entsprechend der Prüfungsordnung für den finalen Druck angepasst. Um beim Druck nicht alle Verlinkungen in Uni-Stuttgart-Blau zu haben (teuer, viele Farbseiten), siehe außerdem nachfolgende Option
5. `print` ... schwarz einfärben von Links für den Druck des Manuskripts (weniger Farbseiten)
6. `a5paper` ... Das Format wird auf DIN-A5 gestellt, die Schriftgröße entsprechend skaliert (nicht empfohlen, führt wahrscheinlich zu Anpassungsbedarf durch Layoutumstellung).
7. `ingenieurin|ingenieur`... ändert den Text auf dem Deckblatt: "zur Erlangung der Würde einer Doktor-Ingenieurin/eines Doktor-Ingenieurs"

Beispiel für Einbinden der Klasse:

```tex
\documentclass[
  english, ngerman, % Sprache, die letzte ist die Hauptsprache
  %smallfont, % kleinere Schrift
  %print, % Links schwarz für den Druck
  twoside, % oneside % ein-/doppelseitiger Druck
  BCOR=6mm, % binde-korrektur: 0 für Ringbindung, Hälfte der Dicke des Buchs bei Klebebindung
  ingenieurin, % "zur Erlangung der Würde einer Doktor-Ingenieurin", switch to "ingenieur" for the male form
]{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](http://dx.doi.org/10.18419/opus-10327) 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 (anderes Deckblatt, siehe Prüfungsprdnung) muss die Klassenoption `accepted` übergeben werden, also

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

Die zusätzliche Option ändert 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, wird das Format auch bei `accepted` in A4 gelassen. Der Verlag sollte für die finale Dissertation dementsprechend die Inhalte auf A5 skalieren.

Wird tatsächlich A5-Format gefordert, kann die Umstellung mit der Klassenoption `a5paper` erfolgen.

### Wie melde ich einen Fehler?

- Als [Issue aus GitHub](https://github.com/iswunistuttgart/isw_smb_diss/issues/new)
- Noch besser: direkt auf einem Branch beheben und einen [pull request](https://github.com/iswunistuttgart/isw_smb_diss/compare) stellen
- Für Änderungen gibt es keine Merge-Garantie, daher am besten vorher besprechen

### Wie kann ich Links schwarz färben für den Druck des Manuskripts (günstiger im Druck)?

In v1.9 wurde die Klassenoption `print` eingeführt. Diese einfach einkommentieren und neu kompilieren.

### Kann ich herausfinden, welche (und wieviele) Seiten Farbseiten sind?

Ja, über [Ghostscript](https://www.ghostscript.com/) siehe [`list_color_pages.sh`](https://github.com/iswunistuttgart/isw_smb_diss/blob/master/list_color_pages.sh) (benötigt bash (Linux oder WSL auf Windows))

### Vertikales Spacing auf der Seite ist ungleichmäßig

Behoben durch `\raggedbottom` im Template (>=v1.9).

### Eine Überschrift taucht nicht in der Kopfzeile auf

1. Zu Beginn in den unnummerierten Kapiteln: Es wurde vermutlich `\chapter*{...}` für die Kapitelüberschrift verwendet. Umstellen auf `\addchap{...}` sollte helfen.
2. Ein Kapitel geht über mehrere Seiten, bevor `\section` eingeführt wird. Auf ungeraden Seiten bleibt der Header leer: **TODO**
3. 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

Behoben in v1.9 durch die Stackoverflow-Lösung

~~Der Verlag möchte das gerne, scheint aus dem Schreiben mit Word zu kommen. Eine Lösung bietet [dieser Stackexchange-Link](https://tex.stackexchange.com/a/382969). 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](https://github.com/iswunistuttgart/isw_smb_diss/pull/5)

Entsteht, indem die Latex-Klasse aus einem Unterordner eingebunden wird (z.B. als [Git Submodule](#weg-1-als-git-submodule-ohne-overleaf)). Die Klasse sollte trotzdem funktionieren. Die Warnung kann behoben werden, indem dieses Repository [installiert wird](https://tex.stackexchange.com/questions/10498/installing-a-class), oder der Pfad der Klasse in die Umgebungsvariable [`TEXINPUTS`](https://tex.stackexchange.com/questions/153135/how-to-store-the-documents-style-file-in-a-subdirectory/153138#153138) 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.:

```tex
\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}}%
	{}%
}
```

isw_smb_diss

isw_smb_diss 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

isw_smb_diss

isw_smb_diss 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README