From 7d24ba5ea0b8ffdd451c2c3d4f37e8ca3cccc11c Mon Sep 17 00:00:00 2001 From: TH_General <> Date: Wed, 20 Jan 2021 12:35:53 +0000 Subject: [PATCH] Initial commit --- .gitignore | 11 ++++++ Addendum.tex | 17 ++++++++++ Bibliography.bib | 4 +++ Content.tex | 4 +++ Glossary.tex | 12 +++++++ Packages.tex | 35 +++++++++++++++++++ Preface.tex | 18 ++++++++++ Readme.md | 7 ++++ Style.tex | 14 ++++++++ Template_Document.tex | 29 ++++++++++++++++ TitlePage.tex | 18 ++++++++++ appendix/ExampleAppendix.tex | 2 ++ images/TH_OWL_Logo.svg | 58 +++++++++++++++++++++++++++++++ images/TH_OWL_Logo_small.svg | 66 ++++++++++++++++++++++++++++++++++++ images/TH_OWL_Logo_tiny.svg | 61 +++++++++++++++++++++++++++++++++ sections/ExampleSection.tex | 2 ++ 16 files changed, 358 insertions(+) create mode 100644 .gitignore create mode 100644 Addendum.tex create mode 100644 Bibliography.bib create mode 100644 Content.tex create mode 100644 Glossary.tex create mode 100644 Packages.tex create mode 100644 Preface.tex create mode 100644 Readme.md create mode 100644 Style.tex create mode 100644 Template_Document.tex create mode 100644 TitlePage.tex create mode 100644 appendix/ExampleAppendix.tex create mode 100644 images/TH_OWL_Logo.svg create mode 100644 images/TH_OWL_Logo_small.svg create mode 100644 images/TH_OWL_Logo_tiny.svg create mode 100644 sections/ExampleSection.tex diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..40ef656 --- /dev/null +++ b/.gitignore @@ -0,0 +1,11 @@ +* +!*.tex +!*.bib +!images +!images/* +!sections +!sections/* +!appendix +!appendix/* +!.gitignore +!Readme.md \ No newline at end of file diff --git a/Addendum.tex b/Addendum.tex new file mode 100644 index 0000000..0d64038 --- /dev/null +++ b/Addendum.tex @@ -0,0 +1,17 @@ +\pagenumbering{Roman} + +%glossary +\printglossary + +\newpage + +%bibliography +\bibliographystyle{plainnat} +\bibliography{Bibliography.bib} + +\newpage + +%appendix +\appendix +\section{Anhang} +\input{appendix/ExampleAppendix.tex} \ No newline at end of file diff --git a/Bibliography.bib b/Bibliography.bib new file mode 100644 index 0000000..5a5b974 --- /dev/null +++ b/Bibliography.bib @@ -0,0 +1,4 @@ +@article{example, + author = "some author", + title = "some title" +} \ No newline at end of file diff --git a/Content.tex b/Content.tex new file mode 100644 index 0000000..1a398ba --- /dev/null +++ b/Content.tex @@ -0,0 +1,4 @@ +%all the main content goes here +\pagenumbering{arabic} + +\input{sections/ExampleSection.tex} \ No newline at end of file diff --git a/Glossary.tex b/Glossary.tex new file mode 100644 index 0000000..f3da532 --- /dev/null +++ b/Glossary.tex @@ -0,0 +1,12 @@ +%% +% all references for the glossary as well as the abbreviation list +%% + +\makeglossaries + +\newglossaryentry{example}{ + name=example, + description={example glossary entry} + } + +\newacronym{empl}{EXMPL}{example} diff --git a/Packages.tex b/Packages.tex new file mode 100644 index 0000000..d0a907e --- /dev/null +++ b/Packages.tex @@ -0,0 +1,35 @@ +%encoding +\usepackage[utf8]{inputenc} +\usepackage[T1]{fontenc} +%language +\usepackage[ngerman]{babel} +%images +\usepackage{graphicx} +\graphicspath{ {./images/} } +%svg images +\usepackage{svg} +%quotation +\usepackage[% +left = \glqq,% +right = \grqq,% +leftsub = \glq,% +rightsub = \grq% +]{dirtytalk} +%boxes +\usepackage[framemethod=tikz]{mdframed} +%enumeration +\usepackage{enumerate} +%references +\usepackage{hyperref} +%for code snippets +\usepackage{xcolor} +\usepackage{listings} +%glossary +\usepackage{datatool} +\usepackage[automake,acronym]{glossaries} +%header and footer +\usepackage{fancyhdr} +%custom font sizes +\usepackage{anyfontsize} +%bibliography +\usepackage[square, numbers]{natbib} \ No newline at end of file diff --git a/Preface.tex b/Preface.tex new file mode 100644 index 0000000..a440148 --- /dev/null +++ b/Preface.tex @@ -0,0 +1,18 @@ +%all content that contains information about the main content (e.g. abbreviations) + +\pagenumbering{roman} + +%table of contents +\tableofcontents +\clearpage + +%list of figures +\listoffigures +\clearpage + +%list of tables +\listoftables +\clearpage + +%abbreviations +\printglossary[type=\acronymtype, title=Abkürzungsverzeichnis] \ No newline at end of file diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..4b6b3eb --- /dev/null +++ b/Readme.md @@ -0,0 +1,7 @@ +# How to use this template +1. fork +1. refactor +1. compile + +## Notice +Requires you to enable [--shell escape](https://tex.stackexchange.com/questions/516604/how-to-enable-shell-escape-or-write18-visual-studio-code-latex-workshop) \ No newline at end of file diff --git a/Style.tex b/Style.tex new file mode 100644 index 0000000..2cdbd7e --- /dev/null +++ b/Style.tex @@ -0,0 +1,14 @@ +%page format +\usepackage[ + a4paper, + top=35mm,right=20mm,bottom=30mm,left=20mm, + headheight=25mm + ]{geometry} +%header content +\pagestyle{fancy} +\fancyhf{} +\rhead{\textbf{\TITLE\\\SUBTITLE}} +\lhead{\large\leftmark} +\chead{\includesvg[width=20mm]{./images/TH_OWL_Logo_small}} +\lfoot{\AUTHORCOMPACT~|~\MODULECOMPACT~|~\DATE} +\rfoot{\thepage} \ No newline at end of file diff --git a/Template_Document.tex b/Template_Document.tex new file mode 100644 index 0000000..9f8eb69 --- /dev/null +++ b/Template_Document.tex @@ -0,0 +1,29 @@ +\documentclass[a4paper,12pt,oneside]{scrartcl} + +\input{Packages.tex} +\input{Style.tex} + +\def \TITLE{Example Title} +\def \SUBTITLE{Example Subtitle} +\def \AUTHOR{Example Author\\author@example.com} +\def \MODULE{ExampleModule} +\def \MODULECOMPACT{EM} +\def \AUTHORCOMPACT{Example Author} +\def \DATE{Example Date} + +\input{Glossary.tex} + +\begin{document} + + \input{TitlePage.tex} + \clearpage + + \input{Preface.tex} + \clearpage + + \input{Content.tex} + \clearpage + + \input{Addendum.tex} + +\end{document} \ No newline at end of file diff --git a/TitlePage.tex b/TitlePage.tex new file mode 100644 index 0000000..31d2fd3 --- /dev/null +++ b/TitlePage.tex @@ -0,0 +1,18 @@ +\thispagestyle{empty} + +\begin{center} + \vspace*{-20mm} + \includesvg[width=.75\pdfpagewidth]{./images/TH_OWL_Logo}\\ + \vspace{25mm} + {\fontsize{50}{600}\selectfont \textbf{\TITLE}}\\ + \vspace{5mm} + \Huge + \textbf{\SUBTITLE}\\ + \vspace{20mm} + \Large + \AUTHOR\\ + \vspace{20mm} + \textbf{\MODULE}\\ + \vspace{20mm} + \DATE +\end{center} \ No newline at end of file diff --git a/appendix/ExampleAppendix.tex b/appendix/ExampleAppendix.tex new file mode 100644 index 0000000..a1226ef --- /dev/null +++ b/appendix/ExampleAppendix.tex @@ -0,0 +1,2 @@ +\subsection{Example Appendix} +Example Appendix Text. \ No newline at end of file diff --git a/images/TH_OWL_Logo.svg b/images/TH_OWL_Logo.svg new file mode 100644 index 0000000..e9b0538 --- /dev/null +++ b/images/TH_OWL_Logo.svg @@ -0,0 +1,58 @@ + +image/svg+xml \ No newline at end of file diff --git a/images/TH_OWL_Logo_small.svg b/images/TH_OWL_Logo_small.svg new file mode 100644 index 0000000..ba5b034 --- /dev/null +++ b/images/TH_OWL_Logo_small.svg @@ -0,0 +1,66 @@ + +image/svg+xml diff --git a/images/TH_OWL_Logo_tiny.svg b/images/TH_OWL_Logo_tiny.svg new file mode 100644 index 0000000..0cd455d --- /dev/null +++ b/images/TH_OWL_Logo_tiny.svg @@ -0,0 +1,61 @@ + +image/svg+xml diff --git a/sections/ExampleSection.tex b/sections/ExampleSection.tex new file mode 100644 index 0000000..34107c6 --- /dev/null +++ b/sections/ExampleSection.tex @@ -0,0 +1,2 @@ +\section{Example Section} +Example Text \gls{example} using \acrshort{empl} and also citing \cite{example} \ No newline at end of file