Merge remote-tracking branch 'ML_Summary/master' and added improvements

This commit is contained in:
paul-loedige 2022-02-24 23:07:21 +01:00
commit 89d63ff0df
14 changed files with 498 additions and 144 deletions

318
.gitignore vendored
View File

@ -1,13 +1,305 @@
*
!*.tex
!*.bib
!images
!images/*
!parts
!parts/*
!chapters
!chapters/*
!appendix
!appendix/*
!.gitignore
!Readme.md
# ---> TeX
## Core latex/pdflatex auxiliary files:
*.aux
*.lof
*.log
*.lot
*.fls
*.out
*.toc
*.fmt
*.fot
*.cb
*.cb2
.*.lb
## Intermediate documents:
*.dvi
*.xdv
*-converted-to.*
# these rules might exclude image files for figures etc.
# *.ps
# *.eps
# *.pdf
## Generated if empty string is given at "Please type another file name for output:"
Template_Summary.pdf
## Bibliography auxiliary files (bibtex/biblatex/biber):
*.bbl
*.bcf
*.blg
*-blx.aux
*-blx.bib
*.run.xml
## Build tool auxiliary files:
*.fdb_latexmk
*.synctex
*.synctex(busy)
*.synctex.gz
*.synctex.gz(busy)
*.pdfsync
## Build tool directories for auxiliary files
# latexrun
latex.out/
## Auxiliary and intermediate files from other packages:
# algorithms
*.alg
*.loa
# achemso
acs-*.bib
# amsthm
*.thm
# beamer
*.nav
*.pre
*.snm
*.vrb
# changes
*.soc
# comment
*.cut
# cprotect
*.cpt
# elsarticle (documentclass of Elsevier journals)
*.spl
# endnotes
*.ent
# fixme
*.lox
# feynmf/feynmp
*.mf
*.mp
*.t[1-9]
*.t[1-9][0-9]
*.tfm
#(r)(e)ledmac/(r)(e)ledpar
*.end
*.?end
*.[1-9]
*.[1-9][0-9]
*.[1-9][0-9][0-9]
*.[1-9]R
*.[1-9][0-9]R
*.[1-9][0-9][0-9]R
*.eledsec[1-9]
*.eledsec[1-9]R
*.eledsec[1-9][0-9]
*.eledsec[1-9][0-9]R
*.eledsec[1-9][0-9][0-9]
*.eledsec[1-9][0-9][0-9]R
# glossaries
*.acn
*.acr
*.glg
*.glo
*.gls
*.glsdefs
*.lzo
*.lzs
*.slg
*.slo
*.sls
*.ncl
*.nom
*.ist
# uncomment this for glossaries-extra (will ignore makeindex's style files!)
# *.ist
# gnuplot
*.gnuplot
*.table
# gnuplottex
*-gnuplottex-*
# gregoriotex
*.gaux
*.glog
*.gtex
# htlatex
*.4ct
*.4tc
*.idv
*.lg
*.trc
*.xref
# hyperref
*.brf
# knitr
*-concordance.tex
# TODO Uncomment the next line if you use knitr and want to ignore its generated tikz files
# *.tikz
*-tikzDictionary
# listings
*.lol
# luatexja-ruby
*.ltjruby
# makeidx
*.idx
*.ilg
*.ind
# minitoc
*.maf
*.mlf
*.mlt
*.mtc[0-9]*
*.slf[0-9]*
*.slt[0-9]*
*.stc[0-9]*
# minted
_minted*
*.pyg
# morewrites
*.mw
# newpax
*.newpax
# nomencl
*.nlg
*.nlo
*.nls
# pax
*.pax
# pdfpcnotes
*.pdfpc
# sagetex
*.sagetex.sage
*.sagetex.py
*.sagetex.scmd
# scrwfile
*.wrt
# svg
svg-inkscape/
# sympy
*.sout
*.sympy
sympy-plots-for-*.tex/
# pdfcomment
*.upa
*.upb
# pythontex
*.pytxcode
pythontex-files-*/
# tcolorbox
*.listing
# thmtools
*.loe
# TikZ & PGF
*.dpth
*.md5
*.auxlock
# titletoc
*.ptc
# todonotes
*.tdo
# vhistory
*.hst
*.ver
# easy-todo
*.lod
# xcolor
*.xcp
# xmpincl
*.xmpi
# xindy
*.xdy
# xypic precompiled matrices and outlines
*.xyc
*.xyd
# endfloat
*.ttt
*.fff
# Latexian
TSWLatexianTemp*
## Editors:
# WinEdt
*.bak
*.sav
# Texpad
.texpadtmp
# LyX
*.lyx~
# Kile
*.backup
# gummi
.*.swp
# KBibTeX
*~[0-9]*
# TeXnicCenter
*.tps
# auto folder when using emacs and auctex
./auto/*
*.el
# expex forward references with \gathertags
*-tags.tex
# standalone packages
*.sta
# Makeindex log files
*.lpz
# xwatermark package
*.xwm
# REVTeX puts footnotes in the bibliography by default, unless the nofootinbib
# option is specified. Footnotes are the stored in a file with suffix Notes.bib.
# Uncomment the next line to have this generated file ignored.
#*Notes.bib

6
Acronyms.tex Normal file
View File

@ -0,0 +1,6 @@
\setabbreviationstyle[acronym]{long-short}
\shorthandon{"}
\newacronym{XMPL}{XMPL}{Example Acronym}
\shorthandoff{"}

View File

@ -1,19 +1,4 @@
\pagenumbering{roman}
%glossary
\printglossary[nonumberlist]
\newpage
%bibliography
\phantomsection
\addcontentsline{toc}{chapter}{Literatur}
\bibliographystyle{IEEEtran-de}
\bibliography{Bibliography.bib}
\newpage
%appendix
\appendix
\chapter{Anhang}
\label{appendix}
\label{appendix}

View File

@ -1,58 +1,10 @@
%%
% all references for the glossary as well as the abbreviation list and nomenclature
%%
% add glossary for nomenclature
\newglossary{nomenclature}{nom}{ncl}{Nomenklatur}
\shorthandon{"}
%--------------------
%main glossary
%--------------------
\newglossaryentry{example}{
name=Example,
plural=Examples,
description={This is an example for a main glossary entry}
}
%--------------------
%acronyms
%--------------------
\setabbreviationstyle[acronym]{long-short}
\newacronym{EXP}{EXP}{Example}
%--------------------
%nomenclature
%--------------------
%add new key
\glsaddstoragekey{unit}{}{\glsentryunit}
\glsnoexpandfields
\newcommand{\newnom}[5]{
\newglossaryentry{#1}{
name={#2},
symbol={#3},
description={#4},
unit={#5},
type=nomenclature,
sort={#1}
description={
Example for a Glossary entry
}
}
%use nomenclature entry (name + symbol) nomF=>First letter upper case
\newcommand{\nomf}[1]{\glsentryname{#1} \texorpdfstring{\glslink{#1}{\boldmath\ensuremath{\glsentrysymbol{#1}}}}{}\xspace}
\newcommand{\nomF}[1]{\Glsentryname{#1} \texorpdfstring{\glslink{#1}{\boldmath\ensuremath{\glsentrysymbol{#1}}}}{}\xspace}
%use nomenclature entry (name) nomS=>First letter upper case
\newcommand{\noms}[1]{\glsentryname{#1}\xspace}
\newcommand{\nomS}[1]{\Glsentryname{#1}\xspace}
%use nomenclature entry (symbol only)
\newcommand{\nomsym}[1]{\texorpdfstring{\glslink{#1}{\boldmath\ensuremath{\glsentrysymbol{#1}}}}{#1}\xspace}
%use nomenclature entry (use in equation)
\newcommand{\nomeq}[1]{\glslink{#1}{\glsentrysymbol{#1}}}
\newnom{exampl}{Example}{e_xa_mp_le}{Example for a nomenclature entry}{\si{m}}
\shorthandoff{"}
\makeglossaries

30
Makros.tex Normal file
View File

@ -0,0 +1,30 @@
%--------------------
% this file contains usefull makros for various functionalities
%--------------------
% {{{ reference makros %
% double reference (name and normal ref)
\newcommand{\dref}[1]{\nameref{#1} (\cref{#1})}
% }}} %
% {{{ math makros%
% }}} %
% {{{ acronym makros %
% texorpdfstring simplification
\newcommand{\glstopfull}[1]{\texorpdfstring{\glsxtrfull{#1}}{\glsfmtfull{#1}}}
\newcommand{\Glstopfull}[1]{\texorpdfstring{\Glsxtrfull{#1}}{\Glsfmtfull{#1}}}
\newcommand{\glstopfullpl}[1]{\texorpdfstring{\glsxtrfullpl{#1}}{\glsfmtfullpl{#1}}}
\newcommand{\Glstopfullpl}[1]{\texorpdfstring{\Glsxtrfullpl{#1}}{\Glsfmtfullpl{#1}}}
\newcommand{\glstopshort}[1]{\texorpdfstring{\glsxtrshort{#1}}{\glsfmtshort{#1}}}
\newcommand{\Glstopshort}[1]{\texorpdfstring{\Glsxtrshort{#1}}{\Glsfmtshort{#1}}}
\newcommand{\glstopshortpl}[1]{\texorpdfstring{\glsxtrshortpl{#1}}{\glsfmtshortpl{#1}}}
\newcommand{\Glstopshortpl}[1]{\texorpdfstring{\Glsxtrshortpl{#1}}{\Glsfmtshortpl{#1}}}
\newcommand{\glstoplong}[1]{\texorpdfstring{\glsxtrlong{#1}}{\glsfmtlong{#1}}}
\newcommand{\Glstoplong}[1]{\texorpdfstring{\Glsxtrlong{#1}}{\Glsfmtlong{#1}}}
\newcommand{\glstoplongpl}[1]{\texorpdfstring{\glsxtrlongpl{#1}}{\glsfmtlongpl{#1}}}
\newcommand{\Glstoplongpl}[1]{\texorpdfstring{\Glsxtrlongpl{#1}}{\Glsfmtlongpl{#1}}}
% }}} %

61
Nomenclature.tex Normal file
View File

@ -0,0 +1,61 @@
% add glossary for nomenclature
\newglossary{nomenclature}{nom}{ncl}{Nomenklatur}
\shorthandon{"}
% {{{ Nomencalture Commands %
% {{{ Nomencalture Commands %
%add new key
%\glsaddstoragekey{unit}{}{\glsentryunit}
\glsnoexpandfields
%\newcommand{\newnom}[5]{
\newcommand{\newnom}[4]{
\newglossaryentry{#1}{
name={#2},
symbol={#3},
description={#4},
%unit={#5},
type=nomenclature,
sort={#1}
}
}
%use nomenclature entry (name + symbol) nomF=>First letter upper case
\newcommand{\nomf}[1]{\glsentryname{#1} \texorpdfstring{\glslink{#1}{\ensuremath{\glsentrysymbol{#1}}}}{}\xspace}
\newcommand{\nomF}[1]{\Glsentryname{#1} \texorpdfstring{\glslink{#1}{\ensuremath{\glsentrysymbol{#1}}}}{}\xspace}
%use nomenclature entry (name) nomS=>First letter upper case
\newcommand{\noms}[1]{\glsentryname{#1}\xspace}
\newcommand{\nomS}[1]{\Glsentryname{#1}\xspace}
%use nomenclature entry (symbol only)
\newcommand{\nomsym}[1]{\texorpdfstring{\glslink{#1}{\ensuremath{\glsentrysymbol{#1}}}}{#1}\xspace}
%use nomenclature entry (use in equation)
\newcommand{\nomeq}[1]{\glslink{#1}{\glsentrysymbol{#1}}}
% }}} Nomencalture Commands %
\newnom{example_nom}{Example Nom}{e^xmpl}{Example Nomenclature Entry}
\shorthandoff{"}
%custom style
\newglossarystyle{customnomenclature}{%
\setglossarystyle{long4col}% base this style on the list style
\renewcommand{\glsgroupskip}{}%avoids grouping the elements by alphabetical order
\renewenvironment{theglossary}{% Change the table type --> 4 columns
\renewcommand*{\arraystretch}{1.5}
%\begin{longtable}{>{\centering}p{.1\textwidth} >{\arraybackslash}p{.225\textwidth} p{.475\textwidth}>{\centering\arraybackslash}p{.1\textwidth}}}%
\begin{longtable}{>{\centering}p{.1\textwidth} >{\arraybackslash}p{.225\textwidth} p{.575\textwidth}}}%
{\end{longtable}}%
%
\renewcommand*{\glossaryheader}{% Change the table header
%\bfseries\large Symbol & \bfseries\large Bezeichnung & \large\bfseries Beschreibung & \large\bfseries Einheit\\
\bfseries\large Symbol & \bfseries\large Bezeichnung & \large\bfseries Beschreibung\\
\hline\endhead}%
\renewcommand*{\glossentry}[2]{% Change the displayed items
%\boldmath\ensuremath{\glossentrysymbol{##1}}
\ensuremath{\glossentrysymbol{##1}}
& \glstarget{##1}{\hspace*{0pt}\glossentryname{##1}} %
& \glossentrydesc{##1}
%& \glsentryunit{##1}
\tabularnewline
}%
}

View File

@ -20,6 +20,12 @@
\usepackage{float}
%svg images
\usepackage{svg}
%subfigures
\usepackage{subcaption}
%borders around images
\usepackage[export]{adjustbox}
%align graphics at bottom
\usepackage{graphbox}
%--------------------
%german quotation
@ -110,8 +116,10 @@ rightsub = \grq%
%--------------------
%math symbols and more
\usepackage{amsmath}
%special symbols
\usepackage{fontawesome}
\usepackage{amssymb}
%si units
\usepackage[output-decimal-marker={,}]{siunitx}
%referencing equations
@ -145,9 +153,20 @@ rightsub = \grq%
\makeatother
%boxes
\usepackage[framemethod=tikz]{mdframed}
\newmdenv[roundcorner=2mm, linecolor=blue, backgroundcolor=blue!5]{mybox}
%--------------------
% landscape
%--------------------
\usepackage{pdflscape}
%--------------------
% algorithms
%--------------------
\usepackage{algorithm}
\usepackage{algpseudocode}
%--------------------
% quick and dirty tabstops
%--------------------
\usepackage{tabto}

View File

@ -1,42 +0,0 @@
%%
%all content that contains information about the main content (e.g. abbreviations)
%%
\pagenumbering{Roman}
%table of contents
\tableofcontents
\clearpage
%list of figures
\addcontentsline{toc}{chapter}{\listfigurename}
\listoffigures
%list of tables
\addcontentsline{toc}{chapter}{\listtablename}
\listoftables
\clearpage
%abbreviations
\printglossary[type=\acronymtype, title=Abkürzungsverzeichnis, nonumberlist]
\clearpage
%nomenclature
%custom style
\newglossarystyle{symbunitlong}{%
\setglossarystyle{long4col}% base this style on the list style
\renewcommand{\glsgroupskip}{}%avoids grouping the elements by alphabetical order
\renewenvironment{theglossary}{% Change the table type --> 4 columns
\renewcommand*{\arraystretch}{1.5}
\begin{longtable}{>{\centering}p{.1\textwidth} >{\arraybackslash}p{.225\textwidth} p{.475\textwidth}>{\centering\arraybackslash}p{.1\textwidth}}}%
{\end{longtable}}%
%
\renewcommand*{\glossaryheader}{% Change the table header
\bfseries\large Symbol & \bfseries\large Bezeichnung & \large\bfseries Beschreibung & \large\bfseries Einheit\\
\hline\endhead}%
\renewcommand*{\glossentry}[2]{% Change the displayed items
\boldmath\ensuremath{\glossentrysymbol{##1}}
& \glstarget{##1}{\hspace*{0pt}\glossentryname{##1}} %
& \glossentrydesc{##1}
& \glsentryunit{##1}\tabularnewline
}%
}
\printglossary[type=nomenclature, nonumberlist, style=symbunitlong]

View File

@ -1,7 +1,9 @@
# How to use this template
1. fork
1. compile to test
- if necessary run makeglossaries
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)
Requires you to enable [--shell escape](https://tex.stackexchange.com/questions/516604/how-to-enable-shell-escape-or-write18-visual-studio-code-latex-workshop)

View File

@ -2,14 +2,13 @@
\fancypagestyle{plain}{
\pagestyle{fancy}
\fancyhf{}
\chead{\textbf{Zusammenfassung \MODULE}}
\chead{\Large\textbf{Zusammenfassung \MODULE}}
\lfoot{\AUTHOR~|~\DATE}
\rfoot{\thepage}
}
\pagestyle{fancy}
\fancyhf{}
\chead{\textbf{Zusammenfassung \MODULE \\\vspace{1mm}}}
\lhead{\leftmark}
\chead{\textbf{\Large Zusammenfassung \MODULE}\\\vspace*{2mm}\leftmark}
\lfoot{\AUTHOR~|~\DATE}
\rfoot{\thepage}

View File

@ -1,36 +1,83 @@
\documentclass[ngerman,regno,a4paper,12pt,oneside]{scrbook}
\documentclass[ngerman,regno,a4paper,11pt,oneside,hidelinks]{scrbook}
%page format
\usepackage[
a4paper,
top=35mm,right=20mm,bottom=30mm,left=20mm,
headheight=25mm
]{geometry}
\setcounter{secnumdepth}{3}
\input{Packages.tex}
\input{Style.tex}
\input{Makros.tex}
\def \AUTHOR{Example Author}
\def \AUTHOREMAIL{author@example.com}
\def \AUTHORSTUDENTID{12345678}
\def \MODULE{ExampleModule}
\def \AUTHOREMAIL{example.author@example.com}
\def \AUTHORSTUDENTID{123456}
\def \MODULE{Example Module}
\def \MODULECOMPACT{EM}
\def \DATE{\today}
% include glossary entries, acronyms and nomenclature entries
\input{Glossary.tex}
\input{Acronyms.tex}
\input{Nomenclature.tex}
\makeglossaries
\begin{document}
% {{{ Front Matter%
\input{TitlePage.tex}
\clearpage
\input{Preface.tex}
\pagenumbering{Roman}
%table of contents
\tableofcontents
%abbreviations
\printglossary[type=\acronymtype, title=Abkürzungsverzeichnis, nonumberlist]
\clearpage
% {{{ Main Content%
\pagenumbering{arabic}
\part{Example Part}
\input{chapters/ExamplePart/ExampleChapter.tex}
%nomenclature
\printglossary[type=nomenclature, nonumberlist, style=customnomenclature]
\clearpage
% }}} %
% {{{ Body%
\pagenumbering{arabic}
\part{Example Part}
\label{part:Example Part}
\include{chapters/Example_Part/Example_Chapter.tex}
% }}} %
\input{Appendix.tex}
% {{{ Back Matter%
\pagenumbering{roman}
\part*{Anhang}
\label{part:Anhang}
%list of figures
\addcontentsline{toc}{chapter}{\listfigurename}
\listoffigures
%list of tables
\addcontentsline{toc}{chapter}{\listtablename}
\listoftables
%glossary
\printglossary[nonumberlist]
\newpage
%bibliography
\phantomsection
\addcontentsline{toc}{chapter}{Literatur}
\bibliographystyle{IEEEtran-de}
\bibliography{Bibliography.bib}
%appendix
\pagenumbering{arabic}
\renewcommand*{\thepage}{A-\arabic{page}}
\include{Appendix.tex}
% }}} %
\end{document}

0
Vorlesungen/.gitkeep Normal file
View File

View File

@ -1,8 +0,0 @@
\chapter{Example Chapter}
Example Text using \gls{example} and the acronym \gls{EXP}
\begin{equation}
\nomeq{exampl}
\end{equation}
\clearpage
\section{Example Section}
Example Page 2

View File

@ -0,0 +1,11 @@
\chapter{Example Chapter}
\label{cha:Example Chapter}
Example Text using \gls{example} and the acronym \gls{XMPL}
\begin{equation}
\nomeq{example_nom}
\end{equation}
\clearpage
\section{Example Section}
\label{sec:Example Section}
Dual Reference \dref{cha:Example Chapter} on new page.