Edited the readme to reflect .vscode changes
This commit is contained in:
parent
8463d2c46b
commit
9baf8c012c
17
README.md
17
README.md
@ -55,6 +55,8 @@ $ sudo apt-get update
|
||||
$ sudo apt-get install git build-essential make-guile texlive-full pandoc pandoc-citeproc tree rsync hunspell hunspell-de-at
|
||||
```
|
||||
|
||||
Bei einer englischen Diplomarbeit muss außerdem entweder das Paket `hunspell-en-gb` oder `hunspell-en-us` installiert werden.
|
||||
|
||||
# Grundlegende Schritte
|
||||
|
||||
## Automatisches erstellen einer Diplomarbeit
|
||||
@ -166,6 +168,12 @@ $ tree ~/Diplomarbeit
|
||||
├── literatur.bib <= Das ist das Literaturverzeichnis
|
||||
├── metadata.yaml <= Grundlegende Informationen zur Diplomarbeit
|
||||
│
|
||||
├── .vscode <= Einstellungen und hilfreiche Dateien für VS Code
|
||||
│ ├── bibtex.code-snippets
|
||||
│ ├── extensions.json
|
||||
│ ├── markdown.code-snippets
|
||||
│ ├── settings.json
|
||||
│ └── tasks.json
|
||||
├── img <= Hier kommen alle Ihre Bilder rein
|
||||
│ ├── graph.png
|
||||
│ └── screenshot_eclipse.png
|
||||
@ -195,6 +203,7 @@ Hier nochmals eine Erklärung der verschiedenen Dateien:
|
||||
* Achten Sie darauf dass sie dort nur `*.jpg` und `*.png` Dateien ablegen
|
||||
* Groß und Kleinschreibung müssen beachtet werden. So werden unter Linux die Datein `Hallo.jpg` und `hallo.jpg` als zwei unterschiedliche Dateien angesehen. Unter Windows hingegen nicht.
|
||||
* Das `/pdfs` Verzeichnis beinhaltet Dateien welche im Appendix (auszugsweise oder ganz) eingefügt werden. Damit dies geschieht müssen sie aber im `metadata.yaml` korrekt referenziert werden. Es ist keine Schande hier viele Dateien abzulegen - sofern diese einen Bezug zur Diplomarbeit haben.
|
||||
* Das Verzeichnisse `.vscode` enthält Einstellungen, Snippets und eine Liste von empfohlenen Erweiterungen für VS Code. VS Code sollte selbständig eine Benachrichtigung rechts unten einblenden, ob die Empfohlenen Erweiterungen installiert werden sollen. Wenn das nicht passiert kann man auch in den Tab Erweiterungen gehen und nach `@recommended:workspace` suchen. Dort kann man dann alle empfohlenen Erweiterungen installieren. Die Erweiterungen beinhalten eine simple Rechtschreibüberprüfung in Deutsch und Englisch (Code Spell Checker), einige nützliche git-Tools (Git Graph, Blame & Merge), die Möglichkeit PDFs direkt in VS Code anzuzeigen (vscode-pdf) und ein Tool womit vereinfacht Literatur Referenzen eingefügt werden können (Pandoc Citer).
|
||||
|
||||
### Befüllen der speziellen Dateien
|
||||
|
||||
@ -290,7 +299,7 @@ Um das Zusammensuchen der Quellenangaben für Bücher zu vereinfachen kann man i
|
||||
|
||||
### Bauen der Diplomarbeit als PDF Datei
|
||||
|
||||
#### Lokal
|
||||
#### **Lokal**
|
||||
Damit das PDF für die Diplomarbeit erstellt wird muss (aus Ihrem Basisverzeichnis heraus) folgender Befehl abgesetzt werden:
|
||||
|
||||
```
|
||||
@ -306,7 +315,11 @@ alias da="make pdf -C HTLLE-DA-Vorlage SOURCEDIR=$(pwd)"
|
||||
```
|
||||
Damit beschränkt sich Ihre eigentliche Arbeit darauf, die Markdown Files zu editieren (nicht veressen zu speichern) und anschließend den neuen Alias `da` aufzurufen. Danach haben Sie immer die neuste Diplomarbeit gebaut.
|
||||
|
||||
#### Remote
|
||||
Mit den mitgelieferten Tasks kann in VS Code das Bauen entweder über das Ausführen der Tasks geschehen oder mittels Hotkeys. Standardmäßig ist `Strg + Shift + B` für den Standarttask vorgesehen. Dieser ist bei den angegebenen Tasks `Build PDF`, welcher, wie der Name sagt, die PDF für die Diplomarbeit baut. Dazu gibt es auch einen Task, um die Rechtschreibprüfung zu starten.
|
||||
|
||||
Noch einfacher ist das Starten der Tasks mit der Erweiterung "Task Explorer". Dort können beide Tasks in einem separaten Fenster gefunden und gestartet werden. Die Tasks funktionieren jedoch nur wenn im Lokalen wsl alle benötigten Pakete installiert sind.
|
||||
|
||||
#### **Remote**
|
||||
Sollten Sie die notwendigen Tools (pandoc, LaTeX, etc.) nicht lokal installieren wollen und Sie haben Ihre Diplomarbeit am GIT-Server der HTL versioniert, dann können Sie Ihre PDF auch am [Jenkins](https://itsp.htl-leoben.at/ci) bauen und sich per E-Mail zuschicken lassen. Es wird dabei immer das aktuellste Template verwendet.
|
||||
|
||||
Öffnen Sie dazu den [Jenkins-Job](https://itsp.htl-leoben.at/ci/job/HTLLE-Diplomarbeit/build?delay=0sec) und melden Sie sich ggf. mit Ihren Benutzerdaten (z.B.: `1911wit00`) an.
|
||||
|
Loading…
Reference in New Issue
Block a user