From 7d24ba5ea0b8ffdd451c2c3d4f37e8ca3cccc11c Mon Sep 17 00:00:00 2001 From: TH_General <> Date: Wed, 20 Jan 2021 12:35:53 +0000 Subject: [PATCH 1/6] 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 From 59b657134ee91a457e0d1bb8ef7384efd0804584 Mon Sep 17 00:00:00 2001 From: paul-loedige Date: Wed, 20 Jan 2021 14:21:26 +0100 Subject: [PATCH 2/6] basic refactoring --- Style.tex | 4 ++-- Template_Document.tex => Template_Summary.tex | 2 -- TitlePage.tex | 6 +----- 3 files changed, 3 insertions(+), 9 deletions(-) rename Template_Document.tex => Template_Summary.tex (88%) diff --git a/Style.tex b/Style.tex index 2cdbd7e..dfaddd6 100644 --- a/Style.tex +++ b/Style.tex @@ -7,8 +7,8 @@ %header content \pagestyle{fancy} \fancyhf{} -\rhead{\textbf{\TITLE\\\SUBTITLE}} +\rhead{\textbf{Zusammenfassung\\\MODULE}} \lhead{\large\leftmark} \chead{\includesvg[width=20mm]{./images/TH_OWL_Logo_small}} -\lfoot{\AUTHORCOMPACT~|~\MODULECOMPACT~|~\DATE} +\lfoot{\AUTHORCOMPACT~|~\DATE} \rfoot{\thepage} \ No newline at end of file diff --git a/Template_Document.tex b/Template_Summary.tex similarity index 88% rename from Template_Document.tex rename to Template_Summary.tex index 9f8eb69..3e4e0b0 100644 --- a/Template_Document.tex +++ b/Template_Summary.tex @@ -3,8 +3,6 @@ \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} diff --git a/TitlePage.tex b/TitlePage.tex index 31d2fd3..ad158f1 100644 --- a/TitlePage.tex +++ b/TitlePage.tex @@ -4,15 +4,11 @@ \vspace*{-20mm} \includesvg[width=.75\pdfpagewidth]{./images/TH_OWL_Logo}\\ \vspace{25mm} - {\fontsize{50}{600}\selectfont \textbf{\TITLE}}\\ - \vspace{5mm} \Huge - \textbf{\SUBTITLE}\\ + \textbf{Zusammenfassung \MODULECOMPACT}\\ \vspace{20mm} \Large \AUTHOR\\ \vspace{20mm} - \textbf{\MODULE}\\ - \vspace{20mm} \DATE \end{center} \ No newline at end of file From 06d7d532be2fa0f26ee29a00e35e3f6bd5aa8056 Mon Sep 17 00:00:00 2001 From: paul-loedige Date: Wed, 20 Jan 2021 15:28:46 +0100 Subject: [PATCH 3/6] changed style --- .gitignore | 4 ++-- Acronyms.tex | 6 ++++++ Addendum.tex | 17 ----------------- Bibliography.bib | 4 ---- Content.tex | 2 +- Glossary.tex | 12 ------------ Preface.tex | 11 +---------- Style.tex | 20 +++++++++++--------- Template_Summary.tex | 12 ++++++++---- appendix/ExampleAppendix.tex | 2 -- chapters/ExampleChapter.tex | 5 +++++ sections/ExampleSection.tex | 2 -- 12 files changed, 34 insertions(+), 63 deletions(-) create mode 100644 Acronyms.tex delete mode 100644 Addendum.tex delete mode 100644 Bibliography.bib delete mode 100644 Glossary.tex delete mode 100644 appendix/ExampleAppendix.tex create mode 100644 chapters/ExampleChapter.tex delete mode 100644 sections/ExampleSection.tex diff --git a/.gitignore b/.gitignore index 40ef656..945fb52 100644 --- a/.gitignore +++ b/.gitignore @@ -3,8 +3,8 @@ !*.bib !images !images/* -!sections -!sections/* +!chapters +!chapters/* !appendix !appendix/* !.gitignore diff --git a/Acronyms.tex b/Acronyms.tex new file mode 100644 index 0000000..d5ddd66 --- /dev/null +++ b/Acronyms.tex @@ -0,0 +1,6 @@ +%% +% list of acronyms +%% +\makeglossaries + +\newacronym{empl}{EXMPL}{example} \ No newline at end of file diff --git a/Addendum.tex b/Addendum.tex deleted file mode 100644 index 0d64038..0000000 --- a/Addendum.tex +++ /dev/null @@ -1,17 +0,0 @@ -\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 deleted file mode 100644 index 5a5b974..0000000 --- a/Bibliography.bib +++ /dev/null @@ -1,4 +0,0 @@ -@article{example, - author = "some author", - title = "some title" -} \ No newline at end of file diff --git a/Content.tex b/Content.tex index 1a398ba..794f959 100644 --- a/Content.tex +++ b/Content.tex @@ -1,4 +1,4 @@ %all the main content goes here \pagenumbering{arabic} -\input{sections/ExampleSection.tex} \ No newline at end of file +\input{chapters/ExampleChapter.tex} \ No newline at end of file diff --git a/Glossary.tex b/Glossary.tex deleted file mode 100644 index f3da532..0000000 --- a/Glossary.tex +++ /dev/null @@ -1,12 +0,0 @@ -%% -% 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/Preface.tex b/Preface.tex index a440148..8a3b640 100644 --- a/Preface.tex +++ b/Preface.tex @@ -1,18 +1,9 @@ %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 +\printglossaries \ No newline at end of file diff --git a/Style.tex b/Style.tex index dfaddd6..e415da3 100644 --- a/Style.tex +++ b/Style.tex @@ -1,14 +1,16 @@ -%page format -\usepackage[ - a4paper, - top=35mm,right=20mm,bottom=30mm,left=20mm, - headheight=25mm - ]{geometry} %header content +\fancypagestyle{plain}{ + \pagestyle{fancy} + \fancyhf{} + \chead{\textbf{Zusammenfassung \MODULE}} + \lfoot{\AUTHORCOMPACT~|~\DATE} + \rfoot{\thepage} +} + \pagestyle{fancy} \fancyhf{} -\rhead{\textbf{Zusammenfassung\\\MODULE}} -\lhead{\large\leftmark} -\chead{\includesvg[width=20mm]{./images/TH_OWL_Logo_small}} +\lhead{\large\rightmark} +\chead{\textbf{Zusammenfassung \MODULE \\\vspace{2mm}}} +\rhead{\leftmark} \lfoot{\AUTHORCOMPACT~|~\DATE} \rfoot{\thepage} \ No newline at end of file diff --git a/Template_Summary.tex b/Template_Summary.tex index 3e4e0b0..b887fa5 100644 --- a/Template_Summary.tex +++ b/Template_Summary.tex @@ -1,4 +1,10 @@ -\documentclass[a4paper,12pt,oneside]{scrartcl} +\documentclass[a4paper,12pt,oneside]{scrbook} +%page format +\usepackage[ + a4paper, + top=35mm,right=20mm,bottom=30mm,left=20mm, + headheight=25mm + ]{geometry} \input{Packages.tex} \input{Style.tex} @@ -9,7 +15,7 @@ \def \AUTHORCOMPACT{Example Author} \def \DATE{Example Date} -\input{Glossary.tex} +\input{Acronyms.tex} \begin{document} @@ -22,6 +28,4 @@ \input{Content.tex} \clearpage - \input{Addendum.tex} - \end{document} \ No newline at end of file diff --git a/appendix/ExampleAppendix.tex b/appendix/ExampleAppendix.tex deleted file mode 100644 index a1226ef..0000000 --- a/appendix/ExampleAppendix.tex +++ /dev/null @@ -1,2 +0,0 @@ -\subsection{Example Appendix} -Example Appendix Text. \ No newline at end of file diff --git a/chapters/ExampleChapter.tex b/chapters/ExampleChapter.tex new file mode 100644 index 0000000..2701c1f --- /dev/null +++ b/chapters/ExampleChapter.tex @@ -0,0 +1,5 @@ +\chapter{Example Chapter} +Example Text using \acrshort{empl}. +\clearpage +\section{Example Section} +Example Page 2 \ No newline at end of file diff --git a/sections/ExampleSection.tex b/sections/ExampleSection.tex deleted file mode 100644 index 34107c6..0000000 --- a/sections/ExampleSection.tex +++ /dev/null @@ -1,2 +0,0 @@ -\section{Example Section} -Example Text \gls{example} using \acrshort{empl} and also citing \cite{example} \ No newline at end of file From 3466344bb077c6f51b898e6bc231773d8de36310 Mon Sep 17 00:00:00 2001 From: paul-loedige Date: Wed, 20 Jan 2021 15:52:18 +0100 Subject: [PATCH 4/6] improved acronyms --- Acronyms.tex | 6 +++--- Packages.tex | 5 ++--- Preface.tex | 6 ++++-- Template_Summary.tex | 2 -- chapters/ExampleChapter.tex | 2 +- 5 files changed, 10 insertions(+), 11 deletions(-) diff --git a/Acronyms.tex b/Acronyms.tex index d5ddd66..e1941c4 100644 --- a/Acronyms.tex +++ b/Acronyms.tex @@ -1,6 +1,6 @@ %% % list of acronyms %% -\makeglossaries - -\newacronym{empl}{EXMPL}{example} \ No newline at end of file +\begin{acronym} + \acro{example}[EXMPL]{example of an acronym} +\end{acronym} \ No newline at end of file diff --git a/Packages.tex b/Packages.tex index d0a907e..68b1835 100644 --- a/Packages.tex +++ b/Packages.tex @@ -24,9 +24,8 @@ rightsub = \grq% %for code snippets \usepackage{xcolor} \usepackage{listings} -%glossary -\usepackage{datatool} -\usepackage[automake,acronym]{glossaries} +%acronyms +\usepackage{acronym} %header and footer \usepackage{fancyhdr} %custom font sizes diff --git a/Preface.tex b/Preface.tex index 8a3b640..633768f 100644 --- a/Preface.tex +++ b/Preface.tex @@ -5,5 +5,7 @@ \tableofcontents \clearpage -%abbreviations -\printglossaries \ No newline at end of file +\chapter*{Abkürzungsverzeichnis} +\input{Acronyms.tex} + +%acronyms \ No newline at end of file diff --git a/Template_Summary.tex b/Template_Summary.tex index b887fa5..314c8c3 100644 --- a/Template_Summary.tex +++ b/Template_Summary.tex @@ -15,10 +15,8 @@ \def \AUTHORCOMPACT{Example Author} \def \DATE{Example Date} -\input{Acronyms.tex} \begin{document} - \input{TitlePage.tex} \clearpage diff --git a/chapters/ExampleChapter.tex b/chapters/ExampleChapter.tex index 2701c1f..82f3050 100644 --- a/chapters/ExampleChapter.tex +++ b/chapters/ExampleChapter.tex @@ -1,5 +1,5 @@ \chapter{Example Chapter} -Example Text using \acrshort{empl}. +Example Text using \acs{example} \clearpage \section{Example Section} Example Page 2 \ No newline at end of file From 285c28c9a02b58baa0247a1b7188f1503a009c6a Mon Sep 17 00:00:00 2001 From: paul-loedige Date: Mon, 1 Feb 2021 12:06:22 +0100 Subject: [PATCH 5/6] changed structure --- .gitignore | 2 ++ Content.tex | 2 +- Style.tex | 5 ++--- chapters/{ => ExamplePart}/ExampleChapter.tex | 0 parts/ExamplePart.tex | 3 +++ 5 files changed, 8 insertions(+), 4 deletions(-) rename chapters/{ => ExamplePart}/ExampleChapter.tex (100%) create mode 100644 parts/ExamplePart.tex diff --git a/.gitignore b/.gitignore index 945fb52..9f182ce 100644 --- a/.gitignore +++ b/.gitignore @@ -3,6 +3,8 @@ !*.bib !images !images/* +!parts +!parts/* !chapters !chapters/* !appendix diff --git a/Content.tex b/Content.tex index 794f959..62a4a10 100644 --- a/Content.tex +++ b/Content.tex @@ -1,4 +1,4 @@ %all the main content goes here \pagenumbering{arabic} -\input{chapters/ExampleChapter.tex} \ No newline at end of file +\input{parts/ExamplePart.tex} \ No newline at end of file diff --git a/Style.tex b/Style.tex index e415da3..b6fd294 100644 --- a/Style.tex +++ b/Style.tex @@ -9,8 +9,7 @@ \pagestyle{fancy} \fancyhf{} -\lhead{\large\rightmark} -\chead{\textbf{Zusammenfassung \MODULE \\\vspace{2mm}}} -\rhead{\leftmark} +\chead{\textbf{Zusammenfassung \MODULE \\\vspace{1mm}}} +\lhead{\leftmark} \lfoot{\AUTHORCOMPACT~|~\DATE} \rfoot{\thepage} \ No newline at end of file diff --git a/chapters/ExampleChapter.tex b/chapters/ExamplePart/ExampleChapter.tex similarity index 100% rename from chapters/ExampleChapter.tex rename to chapters/ExamplePart/ExampleChapter.tex diff --git a/parts/ExamplePart.tex b/parts/ExamplePart.tex new file mode 100644 index 0000000..efc1090 --- /dev/null +++ b/parts/ExamplePart.tex @@ -0,0 +1,3 @@ +\part{Example Part} + +\input{chapters/ExamplePart/ExampleChapter.tex} \ No newline at end of file From 3eedcdc7be7abeefc8e00a2cb64aea3ee2f5c401 Mon Sep 17 00:00:00 2001 From: paul-loedige Date: Mon, 1 Feb 2021 21:27:17 +0100 Subject: [PATCH 6/6] improved default packages --- Packages.tex | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Packages.tex b/Packages.tex index 68b1835..4d31e67 100644 --- a/Packages.tex +++ b/Packages.tex @@ -6,6 +6,8 @@ %images \usepackage{graphicx} \graphicspath{ {./images/} } +\usepackage{wrapfig} +\usepackage{float} %svg images \usepackage{svg} %quotation @@ -25,7 +27,7 @@ rightsub = \grq% \usepackage{xcolor} \usepackage{listings} %acronyms -\usepackage{acronym} +\usepackage[printonlyused]{acronym} %header and footer \usepackage{fancyhdr} %custom font sizes