Added documentation

This commit is contained in:
2021-07-07 22:44:54 +02:00
parent 9cffe4e427
commit 45e5e759d9
15 changed files with 358 additions and 0 deletions

View File

@@ -0,0 +1,86 @@
%! Author = soeichho
%! Date = 20.11.2020
% Text style
\setmainfont{\mainFont}
\setstretch{\lineStretchValue} % Space between lines
% Chapter format
\renewcommand*{\chapterformat}{
\thechapter \hspace{10pt} \textcolor{accent-color}{|} \hspace{10pt}
}
\renewcommand*{\chapterheadstartvskip}{\vspace*{0pt}}
% Header / Footer
\clearpairofpagestyles
\KOMAoptions {
headsepline = true,
footsepline = true,
plainfootsepline = true
}
\automark[chapter]{chapter}
\ihead{\headmark}
\ifoot{\author~~|~~\kurs~~|~~\date}
\ofoot{\thepage}
\renewcommand*{\headfont}{\normalfont} % Keine kursive Schrift
\renewcommand*{\footfont}{\normalfont}
\newpairofpagestyles{chapterpage}{
\KOMAoptions {
headsepline = false,
footsepline = true,
plainfootsepline = true
}
\ihead{}
\ifoot{\author~~|~~\kurs~~|~~\date}
\ofoot{\thepage}
}
\renewcommand*{\chapterpagestyle}{chapterpage}
% Listings style
\lstset{
basicstyle=\ttfamily\small,
frame=top,
frame=bottom,
breaklines=true,
tabsize=2,
upquote = true,
numbers=left,
stepnumber=1,
numbersep=5pt,
commentstyle=\color{teal},
stringstyle=\color{magenta},
keywordstyle=\color{orange}
}
\lstdefinelanguage{JSON}{
string=[s]{"}{"},
comment=[l]{:\ "},
morecomment=[l]{:"},
}
\lstdefinelanguage{JavaScript}{
keywords={const, let, typeof, instanceof, new, true, false, catch, function, return, null, undefined, catch, switch, var, if, in, while, for, do, else, case, default, break},
ndkeywords={class, export, throw, import, this},
sensitive=false,
comment=[l]{//},
morecomment=[s]{/*}{*/},
morestring=[b]',
morestring=[b]`,
morestring=[b]"
}
% Float listings
\newfloat{lstfloat}{htbp}{lop}
\floatname{lstfloat}{Listing}
\def\lstfloatautorefname{Listing} % needed for hyperref/auroref
\usepackage{pifont}% http://ctan.org/pkg/pifont
\newcommand{\cmark}{\ding{51}}%
\newcommand{\xmark}{\ding{55}}%

View File

@@ -0,0 +1,17 @@
%! Author = flokaise
%! Date = 21.04.2021
% Text variables
\renewcommand{\author}{Florian Kaiser}
\renewcommand{\date}{\today}
\newcommand{\institutionName}{Duale Hochschule Baden-Württemberg}
\newcommand{\paperName}{Dokumentation Web Engineering Projekt}
\newcommand{\registerId}{9829423}
\newcommand{\kurs}{TINF20C}
\renewcommand{\title}{Filemanager}
% Layout variables
\newcommand{\pageMarginLeft}{40mm}
\newcommand{\pageMarginRight}{20mm}
\newcommand{\pageMarginTop}{40mm}
\newcommand{\pageMarginBottom}{20mm}

View File

@@ -0,0 +1,29 @@
%! Author = soeichho
%! Date = 19.11.2020
%! This file is dedicated to individual changes.
%! If I've done my job correctly, you only have to modify this file to your personal favour.
%! Access these variables by using \commandname within any .tex file
% Style variables
%! IMPORTANT: The font size needs to be changed after the \begin{document} block in your main.tex
% TODO
%\newcommand{\mainFont}{TeleNeo Office} % Whatever font you want to use, needs to be installed on your computer
\newcommand{\mainFont}{Ubuntu} % Whatever font you want to use, needs to be installed on your computer
\newcommand{\lineStretchValue}{1.5}
\newcommand{\coverSheetImages}{
\includegraphics[width=0.4\textwidth]{images/dhbw-stuttgart}\hspace{1 cm}
\includegraphics[width=0.4\textwidth]{images/TSY-transparent}
}
% Colors
%! You can name as many colors as you'd like.
%! The accent-color is the only one, that is actually used by the template so far
%! Here are some convenient color codes for you ;)
%! telekom magenta: E20074
%! fom: 539D90
%! fom_light: 73d9c6
%! fom_dark: 36665e
%! dhbw_red: E2001A
%! dhbw_grey: 7D8990
\definecolor{accent-color}{HTML}{E20074} % This color will be used as highlight color in the chapter name