Skip to content

Commit a22a7a3

Browse files
schuler-henryschuler-henry
committed
Updated README.md
1 parent a471947 commit a22a7a3

File tree

1 file changed

+123
-1
lines changed

1 file changed

+123
-1
lines changed

‎README.md‎

Lines changed: 123 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,124 @@
11
# dhbw-latex-template
2-
This is a latex template for projects at the DHBW.
2+
Dieses Repository enthält eine Latex-Vorlage welche für sämtliche Arbeiten an der DHBW eingesetzt werden kann. Die Vorlage garantiert keine vollständige Einhaltung der Anforderungen für Format und Layout nach den [Richtlinien der DHBW](https://www.ravensburg.dhbw.de/fileadmin/user_upload/Dokumente/Dokumente_fuer_Studierende/191212_Leitlinien_Praxismodule_Studien_Bachelorarbeiten.pdf).
3+
Die Vorlage orientiert sich aber an den Vorschriften der Fakultät Technik an der DHBW Ravensburg Campus Friedrichshafen und versucht diese bestmöglich einzuhalten (Stand 22.04.2022).
4+
5+
Die Vorlage ist universal einsetzbar für T1000, T2000, T3000, die Studienarbeit, die Bachelorarbeit, sowie sonstige Projekte während der Theorie-Semester.
6+
7+
## How to use
8+
1. Installiere einen beliebigen Latex-Editor (getestet unter: [VS-Code-Extension](https://github.com/James-Yu/LaTeX-Workshop/wiki/Install))
9+
1. Klone das Repo auf deine Maschine
10+
```sh
11+
git clone https://github.com/schuler-henry/dhbw-latex-template.git
12+
```
13+
1. [main.tex](main.tex)
14+
1. Trage die relevanten Daten in die Variablen ein.
15+
> Somit werden sämtliche Informationen automatisch auf dem Deckblatt etc. ergänzt!
16+
```tex
17+
\def\vFirmenlogoPfad{} %% relativer Pfad Bsp.: images/Firmenlogo.png
18+
\def\vDHBWLogoPfad{images/DHBW_logo.jpg} %% relativer Pfad Bsp.: images/DHBW_logo.jpg
19+
20+
\def\vTitel{} %%
21+
\def\vUntertitel{} %%
22+
\def\vArbeitstyp{} %% Projektarbeit/Seminararbeit/Bachelorarbeit
23+
\def\vArbeitsbezeichnung{} %% T1000/T2000/T3000
24+
25+
\def\vAutor{} %% Vorname Nachname
26+
\def\vMatrikelnummer{} %% 7-stellige Zahl
27+
\def\vKursKuerzel{} %% Bsp.: TIT20
28+
\def\vPhasenbezeichnung{} %% Praxisphase/Theoriephase
29+
\def\vStudienJahr{} %% erste/zweite/dritte
30+
\def\vDHBWStandort{} %% Bsp.: Ravensburg
31+
\def\vDHBWCampus{} %% Bsp.: Friedrichshafen
32+
\def\vFakultaet{} %% Technik/Wirtschaft
33+
\def\vStudiengang{} %% Informationstechnik/...
34+
35+
\def\vBetrieb{} %%
36+
\def\vBearbeitungsort{} %%
37+
\def\vAbteilung{} %%
38+
\def\vBetreuer{} %% Vorname Nachname
39+
40+
\def\vAbgabedatum{\today} %% DD. MONTH YYYY
41+
\def\vBearbeitungszeitraum{} %% DD.MM.YYYY - DD.MM.YYYY
42+
```
43+
1. Durch auskommentieren der einzelnen Zeilen können Verzeichnisse eingebunden oder ausgeschlossen werden:
44+
```tex
45+
%%%%%%%%%%%%%%%%%%% Einführung und Verzeichnisse %%%%%%%%%%%%%%%%%%%
46+
\pagenumbering{Roman}
47+
48+
\include{pages/titel}
49+
\include{pages/selbststaendigkeitserklaerung}
50+
\include{pages/abstract}
51+
\include{pages/inhaltsverzeichnis}
52+
\include{pages/abkuerzungsverzeichnis}
53+
\include{pages/abbildungsverzeichnis}
54+
\include{pages/tabellenverzeichnis}
55+
% \include{pages/vorwort}
56+
```
57+
2. Weiterhin können hier eigenen Kapitel hinzugefügt werden.
58+
```tex
59+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
60+
%%%% EIGENE KAPITEL EINFÜGEN %%%%
61+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
62+
\include{chapter/Einleitung}
63+
```
64+
2. [/chapter](chapter)
65+
1. In diesem Ordner können neue Kapitel angelegt werden (.tex Dateien).
66+
3. [/images](images)
67+
1. Hier können sämtliche Bilder abgelegt werden.
68+
> Hier befindet sich beispielsweise auch das Logo der DHBW Friedrichshafen welches auf dem Deckblatt angezeigt wird.
69+
4. [/literatur/literatur.bib](literatur/literatur.bib)
70+
1. Die Vorlage verwendet Bibtex. Die dazugehörige .bib Datei befindet sich hier.
71+
> Nur die Datei literature.bib wird automatisch erkannt, andersnamige Dateien müssen manuell in main.tex eingebunden werden.
72+
5. [/pages](pages)
73+
1. [abkuerzungsverzeichnis.tex](pages/abkuerzungsverzeichnis.tex)
74+
1. Hier können eigene Abkürzungen (Akronyme) angelegt werden.
75+
```tex
76+
\acro{DHBW}[DHBW]{Duale Hochschule Ba\-den-\-Würt\-tem\-berg}
77+
\acroplural{DHBW}[DHBW]{Dualen Hochschule Ba\-den-\-Würt\-tem\-berg}
78+
\acro{<REFERENZ-NAME>}[<KÜRZEL>]{<AUSGESCHRIEBEN>}
79+
```
80+
2. Referenzierung im Text:
81+
```tex
82+
\ac{DHBW} % Singular
83+
\acp{DHBW} % Plural
84+
```
85+
> Bei der ersten Referenzierung wird die Langform mit Kürzel ausgegeben, für alle folgenden ausschließlich das Kürzel.
86+
2. [abstract.tex](pages/abstract.tex)
87+
1. Hier kann der Text für das Abstract sowohl in Deutsch, als auch in Englisch angegeben werden.
88+
2. Weiterhin können sowohl für die deutsch, als auch die englische Version Keywords angegeben werden.
89+
3. [anhang.tex](pages/anhang.tex)
90+
1. Hier können sämtliche Anhänge eingebunden werden.
91+
4. [vorwort.tex](pages/vorwort.tex)
92+
1. Hier kann bei Bedarf ein Vorwort formuliert werden.
93+
94+
> Nicht genannte Dateien müssen grundsätzlich nicht bearbeitet werden, da diese nur Verzeichnisse einbinden.
95+
> Auch die getroffenen Einstellungen in [main.tex](main.tex) müssen nicht bearbeitet werden.
96+
> Eigene Bibliotheken und Definitionen können hier aber eingebunden werden (Bestehende Module könnten dadurch jedoch beeinflusst werden).
97+
98+
## Kontakt
99+
Bei Fehlern in den Dateien oder fehlenden Funktionalitäten wenden Sie sich bitte an [contact@henryschuler.de](mailto:contact@henryschuler.de?subject=[GitHub]%20dhbw-latex-template).
100+
101+
102+
## Autoren
103+
* [Henry Schuler](https://henryschuler.de) / [github](https://github.com/schuler-henry) / [E-Mail](mailto:contact@henryschuler.de?subject=[GitHub]%20dhbw-latex-template)
104+
105+
## [LICENSE](LICENSE)
106+
Copyright (c) 2022 Henry Schuler
107+
108+
Permission is hereby granted, free of charge, to any person obtaining a copy
109+
of this software and associated documentation files (the "Software"), to deal
110+
in the Software without restriction, including without limitation the rights
111+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
112+
copies of the Software, and to permit persons to whom the Software is
113+
furnished to do so, subject to the following conditions:
114+
115+
The above copyright notice and this permission notice shall be included in all
116+
copies or substantial portions of the Software.
117+
118+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
119+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
120+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
121+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
122+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
123+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
124+
SOFTWARE.

0 commit comments

Comments
 (0)