Skip to content

Commit dfbcc0f

Browse files
schuler-henryschuler-henry
committed
Created introduction text.
1 parent 166925d commit dfbcc0f

File tree

1 file changed

+4
-206
lines changed

1 file changed

+4
-206
lines changed

‎README.md

Lines changed: 4 additions & 206 deletions
Original file line numberDiff line numberDiff line change
@@ -1,209 +1,7 @@
1-
# dhbw-latex-template
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-
## Overview
8-
- [dhbw-latex-template](#dhbw-latex-template)
9-
- [Overview](#overview)
10-
- [How to use](#how-to-use)
11-
- [Release and Deploy](#release-and-deploy)
12-
- [Release](#release)
13-
- [Deployment](#deployment)
14-
- [Feedback/Issues](#feedbackissues)
15-
- [Author](#author)
16-
- [LICENSE](#license)
17-
18-
## How to use
19-
1. Installiere einen beliebigen Latex-Editor (getestet unter: [VS-Code-Extension](https://github.com/James-Yu/LaTeX-Workshop/wiki/Install))
20-
1. Klone das Repo auf deine Maschine
21-
```sh
22-
git clone https://github.com/schuler-henry/dhbw-latex-template.git
23-
```
24-
1. [main.tex](main.tex)
25-
1. Trage die relevanten Daten in die Variablen ein.
26-
> Somit werden sämtliche Informationen automatisch auf dem Deckblatt etc. ergänzt!
27-
```tex
28-
\def\vFirmenlogoPfad{} %% relativer Pfad Bsp.: images/Firmenlogo.png
29-
\def\vDHBWLogoPfad{images/DHBW_logo.jpg} %% relativer Pfad Bsp.: images/DHBW_logo.jpg
30-
\def\vUnterschrift{} %% Pfad zu Bild mit Unterschrift (für digitale Abgabe) Bsp.: images/Unterschrift.png
31-
32-
\def\vTitel{} %%
33-
\def\vUntertitel{} %%
34-
\def\vArbeitstyp{} %% Projektarbeit/Seminararbeit/Bachelorarbeit
35-
\def\vArbeitsbezeichnung{} %% T1000/T2000/T3000
36-
37-
\def\vAutor{} %% Vorname Nachname
38-
\def\vMatrikelnummer{} %% 7-stellige Zahl
39-
\def\vKursKuerzel{} %% Bsp.: TIT20
40-
\def\vPhasenbezeichnung{} %% Praxisphase/Theoriephase
41-
\def\vStudienJahr{} %% erste/zweite/dritte
42-
\def\vDHBWStandort{} %% Bsp.: Ravensburg
43-
\def\vDHBWCampus{} %% Bsp.: Friedrichshafen
44-
\def\vFakultaet{} %% Technik/Wirtschaft
45-
\def\vStudiengang{} %% Informationstechnik/...
46-
47-
\def\vBetrieb{} %%
48-
\def\vBearbeitungsort{} %%
49-
\def\vAbteilung{} %%
50-
\def\vBetreuer{} %% Vorname Nachname
51-
52-
\def\vAbgabedatum{\today} %% DD. MONTH YYYY
53-
\def\vBearbeitungszeitraum{} %% DD.MM.YYYY - DD.MM.YYYY
54-
```
55-
1. Hier können eigene [Befehle](https://golatex.de//wiki/%5cnewcommand) angelegt werden
56-
> Die Befehle \textXXXXX können individuell angepasst und verwendet werden, sodass Klassennamen o.ä. im Text speziell hervorgehoben werden. Verwendung im Text: \textFunktion{doSomething()}.
57-
> "#1" wird dabei durch den angegebenen Text (hier: "doSomething()") ersetzt.
58-
```tex
59-
%%%%%%%%%%%%%%%%%%%%%%%%% Eigene Kommandos %%%%%%%%%%%%%%%%%%%%%%%%%
60-
% Definition von \gqq{}: Text in Anführungszeichen
61-
\newcommand{\gqq}[1]{\glqq #1\grqq}
62-
% Spezielle Hervorhebung von Schlüsselwörtern
63-
\newcommand{\textOrdner}[1]{\texttt{#1}}
64-
\newcommand{\textVariable}[1]{\texttt{#1}}
65-
\newcommand{\textKlasse}[1]{\texttt{#1}}
66-
\newcommand{\textFunktion}[1]{\texttt{#1}}
67-
```
68-
2. Durch auskommentieren der einzelnen Zeilen können Verzeichnisse eingebunden oder ausgeschlossen werden:
69-
```tex
70-
%%%%%%%%%%%%%%%%%%% Einführung und Verzeichnisse %%%%%%%%%%%%%%%%%%%
71-
\pagenumbering{Roman}
72-
73-
\include{pages/titel}
74-
% \include{pages/sperrvermerk}
75-
\include{pages/selbststaendigkeitserklaerung}
76-
\include{pages/abstract}
77-
\include{pages/inhaltsverzeichnis}
78-
\include{pages/abkuerzungsverzeichnis}
79-
\include{pages/abbildungsverzeichnis}
80-
\include{pages/tabellenverzeichnis}
81-
\include{pages/listingsverzeichnis}
82-
% \include{pages/vorwort}
83-
```
84-
3. Weiterhin können hier eigenen Kapitel hinzugefügt werden.
85-
```tex
86-
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
87-
%%%% EIGENE KAPITEL EINFÜGEN %%%%
88-
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
89-
\include{chapter/Einleitung}
90-
```
91-
2. [/chapter](chapter)
92-
1. In diesem Ordner können neue Kapitel angelegt werden (.tex Dateien).
93-
3. [/images](images)
94-
1. Hier können sämtliche Bilder abgelegt werden.
95-
> Hier befindet sich beispielsweise auch das Logo der DHBW Friedrichshafen welches auf dem Deckblatt angezeigt wird.
96-
4. [/literatur/literatur.bib](literatur/literatur.bib)
97-
1. Die Vorlage verwendet Bibtex. Die dazugehörige .bib Datei befindet sich hier.
98-
> Nur die Datei literature.bib wird automatisch erkannt, andersnamige Dateien müssen manuell in main.tex eingebunden werden.
99-
5. [/pages](pages)
100-
1. [abkuerzungsverzeichnis.tex](pages/abkuerzungsverzeichnis.tex)
101-
1. Hier können eigene Abkürzungen (Akronyme) angelegt werden.
102-
```tex
103-
\acro{DHBW}[DHBW]{Duale Hochschule Ba\-den-\-Würt\-tem\-berg}
104-
\acroplural{DHBW}[DHBW]{Dualen Hochschule Ba\-den-\-Würt\-tem\-berg}
105-
\acro{<REFERENZ-NAME>}[<KÜRZEL>]{<AUSGESCHRIEBEN>}
106-
```
107-
2. Referenzierung im Text:
108-
```tex
109-
\ac{DHBW} % Singular
110-
\acp{DHBW} % Plural
111-
```
112-
> Bei der ersten Referenzierung wird die Langform mit Kürzel ausgegeben, für alle folgenden ausschließlich das Kürzel.
113-
2. [abstract.tex](pages/abstract.tex)
114-
1. Hier kann der Text für das Abstract sowohl in Deutsch, als auch in Englisch angegeben werden.
115-
2. Weiterhin können sowohl für die deutsch, als auch die englische Version Keywords angegeben werden.
116-
3. [anhang.tex](pages/anhang.tex)
117-
1. Hier können sämtliche Anhänge eingebunden werden.
118-
4. [vorwort.tex](pages/vorwort.tex)
119-
1. Hier kann bei Bedarf ein Vorwort formuliert werden.
120-
121-
> Nicht genannte Dateien müssen grundsätzlich nicht bearbeitet werden, da diese nur Verzeichnisse einbinden.
122-
> Auch die getroffenen Einstellungen in [main.tex](main.tex) müssen nicht bearbeitet werden.
123-
> Eigene Bibliotheken und Definitionen können hier aber eingebunden werden (Bestehende Module könnten dadurch jedoch beeinflusst werden).
124-
125-
## Release and Deploy
126-
Die folgenden Automatisierungen sind in der Datei [new_release.yml](.github/workflows/new_release.yml) definiert und beschreiben [GitHub Actions](https://github.com/features/actions).
127-
128-
Um automatisch einen Release zu erstellen, muss ein Tag im Format v\*.\*.\* erstellt und auf das Repository gepusht werden.
129-
Dies wird mit den Folgenden Befehlen erreicht:
130-
1. Tag erstellen
131-
```sh
132-
git tag v*.*.*
133-
```
134-
2. Tag pushen
135-
```sh
136-
git push origin v*.*.*
137-
```
138-
139-
### Release
140-
Die GitHub Action [xu-cheng/latex-action@v2](https://github.com/marketplace/actions/github-action-for-latex) baut zunächst die PDF aus den Latex-Dokumenten des Repository.
141-
142-
Anschließend erstellt die GitHub Action [marvinpinto/action-automatic-releases@latest](https://github.com/marvinpinto/action-automatic-releases) den Release unter Einbindung der generierten PDF-Datei.
143-
Zusätzlich wird ein Changelog generiert.
144-
145-
### Deployment
146-
Für das automatische Deployment mit [GitHub Pages](https://pages.github.com) wird die GitHub Action [crazy-max/ghaction-github-pages@v3](https://github.com/crazy-max/ghaction-github-pages/tree/dev) verwendet.
147-
148-
149-
Zunächst muss GitHub Pages in den Repository-Einstellungen konfiguriert werden.
150-
Dazu müssen die Folgenden Schritte ausgeführt werden:
151-
1. Öffne die Einstellungen des Repository
152-
2. Wähle im Optionsmenü den Punkt "Pages"
153-
3. Wähle als Quelle "Deploy from branch"
154-
4. Wähle als Branch-Namen "gh-pages" im "/root" Verzeichnis
155-
5. Aktiviere den Punkt "Enforce HTTPS"
156-
157-
Die URL des Deployments lautet: \<user\>.github.io/\<repo-name\>
158-
159-
Anschließend kann das automatische Deployment in der Datei [new_releases.yml](.github/workflows/new_release.yml) angepasst werden.
160-
1. Anpassen der anzuzeigenden HTML-Datei
161-
```yml
162-
- name: Create build destination
163-
run: |
164-
mkdir public
165-
cat > public/index.html <<EOL
166-
<!doctype html>
167-
<html>
168-
<head>
169-
<title>GitHub Pages deployed!</title>
170-
</head>
171-
<body>
172-
<div style="position: absolute; left: 0; right: 0; bottom: 0; top: 0;">
173-
<iframe src="./main.pdf" width="100%" height="100%" frameborder="0">
174-
</iframe>
175-
</div>
176-
</body>
177-
</html>
178-
EOL
179-
```
180-
> Standardmäßig zeigt GitHub Pages unter Verwendung dieses HTML-Codes die PDF-Datei "main.pdf".
181-
> Solltest du den Namen deiner [main.tex](main.tex) Datei verändert haben, musst du hier auch den Namen in den kompilierten Namen der PDF ändern.
182-
183-
> Alternativ kannst du an dieser Stelle auch deinen eigenen HTML-Code einsetzen.
184-
> Bedenke: Ohne Anpassungen des Deployments steht dir lediglich die generierte PDF-Datei im Repository zur Verfügung.
185-
2. Verbinden des Deployment mit einer eigenen Domain
186-
```yml
187-
- name: Deploy to GitHub Pages
188-
if: success()
189-
uses: crazy-max/ghaction-github-pages@v3
190-
with:
191-
target_branch: gh-pages
192-
build_dir: public
193-
env:
194-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
195-
```
196-
> Unter dem Schlüssel "with:" kann neben der target_branch auch mittels des Keywords "fqdn:" die Zieldomain angegeben werden.
197-
```yml
198-
with:
199-
fqdn: my-domain-name.de
200-
```
201-
> Weitere Informationen zum Konfigurieren einer benutzerdefinierten Domain (Pages + Provider): [GitHub Docs](https://docs.github.com/de/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site)
202-
203-
> Für weitere Personalisierungen: [crazy-max/ghaction-github-pages@v3 Dokumentation](https://github.com/crazy-max/ghaction-github-pages/tree/dev)
204-
205-
## Feedback/Issues
206-
Sollten Sie Fehler in der Latex Vorlage finden oder Anregungen zur Verbesserung haben, können Sie diese in Form eines Issue unter dem [Issue-Tab](https://github.com/schuler-henry/dhbw-latex-template/issues) einreichen.
1+
# Analysis of Audio Signals Using Linear Predictive Coding
2+
This study deals with audio signal feature extraction in order to be used for speaker authentication using a neuronal network.
3+
Specifically, the effectiveness of linear predictive coding (LPC) coefficients is examined.
4+
The goal of this study is to explain how linear predictive coefficients can be extracted and to evaluate whether they can be used to differentiate between multiple speakers.
2075

2086
## Author
2097
* [Henry Schuler](https://henryschuler.de) / [github](https://github.com/schuler-henry) / [E-Mail](mailto:contact@henryschuler.de?subject=[GitHub]%20dhbw-latex-template)

0 commit comments

Comments
 (0)