Anfang dokumentation

This commit is contained in:
Johannes Theiner 2020-12-06 19:23:01 +01:00
parent 001628f14d
commit 4f98a982b5
Signed by: joethei
GPG Key ID: 9D2B9A00FDA85BCD
4 changed files with 308 additions and 1 deletions

13
.gitignore vendored
View File

@ -2,4 +2,15 @@
*.order *.order
*.symvers *.symvers
*.mod.c *.mod.c
*.ko *.ko
*.log
*.pdf
*.idx
*.aux
*.out
*.pytxcode
*.latex
*.txt
*.svg
*.toc
_minted-index

153
hs-el-text.sty Normal file
View File

@ -0,0 +1,153 @@
%Copyright: 2020, Johannes Theiner <kontakt@joethei.de>
\ProvidesPackage{hs-el-text}
\RequirePackage{graphicx}
\RequirePackage{textcomp}
\RequirePackage[ngerman]{babel}
\RequirePackage[iso]{isodate}
\RequirePackage{amsmath,amssymb,amstext,graphicx,float,caption,url}
\RequirePackage[automark, headsepline, footsepline, markcase=upper]{scrlayer-scrpage}
\RequirePackage[pdfusetitle,
unicode,
naturalnames,
pdfborder={0 0 0},
colorlinks,
linkcolor = black,
urlcolor = blue,
citecolor = black,
anchorcolor = black]{hyperref}
\RequirePackage{comment}
\RequirePackage{xargs} % Use more than one optional parameter in a new commands
\RequirePackage[dvipsnames]{xcolor} % Coloured text etc.
\RequirePackage{minted}
\RequirePackage{csquotes}
\RequirePackage[nolist, footnote]{acronym}
\RequirePackage{enumitem}
\RequirePackage[colorinlistoftodos,prependcaption,textsize=tiny]{todonotes}
\RequirePackage{titlesec}
\RequirePackage{tikz}
\RequirePackage[bottom=5em]{geometry}
\RequirePackage{svg}
\RequirePackage{lastpage}
\RequirePackage{lmodern, textcomp}
\RequirePackage{makecell}
\RequirePackage{plantuml}
\usetikzlibrary{positioning, shapes.geometric}
\RequirePackage[final]{draftwatermark}
%watermark
\SetWatermarkText{Preview}
\SetWatermarkColor{gray}
\SetWatermarkFontSize{35.83pt}
\titlespacing\section{0pt}{12pt}{10pt}
\titlespacing\subsection{0pt}{5pt}{5pt}
\titlespacing\subsubsection{0pt}{5pt}{5pt}
\titlespacing*{\paragraph}{0pt}{12pt}{5pt}[50pt]
\titlespacing*{\subparagraph}{0pt}{12pt}{5pt}[50pt]
\setitemize{noitemsep,topsep=0pt,parsep=0pt,partopsep=0pt}
\setlist[enumerate]{noitemsep, topsep=0pt, parsep=0pt, partopsep=0pt}
\newcommandx{\unsure}[2][1=]{\todo[linecolor=red,backgroundcolor=red!25,bordercolor=red,#1]{#2}}
\newcommandx{\change}[2][1=]{\todo[linecolor=blue,backgroundcolor=blue!25,bordercolor=blue,#1]{#2}}
\newcommandx{\info}[2][1=]{\todo[linecolor=OliveGreen,backgroundcolor=OliveGreen!25,bordercolor=OliveGreen,#1]{#2}}
\newcommandx{\improvement}[2][1=]{\todo[linecolor=Plum,backgroundcolor=Plum!25,bordercolor=Plum,#1]{#2}}
%
\newenvironment{longlisting}{\captionsetup{type=listing}}{}
\renewcommand{\listingscaption}{Auflistung}
\setminted{
frame=lines,
framesep=2mm,
baselinestretch=1.2,
bgcolor=bg,
linenos,
autogobble
}
\definecolor{bg}{rgb}{0.95,0.95,0.95}
%FIXME: this is realy hacky, change it asap
%https://tex.stackexchange.com/a/391042
\newcommand{\und}{\\ & & }
\graphicspath{{include/}}
\newcommand{\link}[1]{\footnote{\url{#1}}}
%define commands for title
\newcommand*{\modul}[1]{\gdef\modul{#1}}
\newcommand*{\thema}[1]{\gdef\thema{#1}}
\newcommand*{\semester}[1]{\gdef\semester{#1}}
\title{\modul \\ \thema}
%Header
\lohead{\modul \\ \thema}
\rohead{\includegraphics[scale=0.4]{hsel-logo.png}}
\chead{}
\ifoot{}
\cfoot{}
\ofoot{Seite \thepage \hspace{1pt} von \pageref{LastPage}}
\makeindex
\isodate
\renewcommand*{\maketitle}{%
\begin{titlepage}
\pagenumbering{Alph}
\pagestyle{empty}
\begin{center}
\begin{tabular}{p{\textwidth}}
\begin{center}
\LARGE{\textsc{\modul}}
\end{center}
\\
\begin{center}
\textbf{\LARGE{
\\
\thema
\\
}}
\end{center}
\vspace*{50pt}
\begin{center}
\includegraphics[scale=1.0]{hsel-logo}
\end{center}
\vspace*{200pt}
\begin{center}
\begin{tabular}{lll}
\textbf{Gruppenmitglieder:}
& & \@author
\\
\textbf{Semester:} & & \semester\\
\textbf{letzte Änderung:} & & \@date\\
\end{tabular}
\end{center}
\end{tabular}
\end{center}
\pagenumbering{arabic}
\pagestyle{scrheadings}
\clearpage
\setcounter{page}{1}
\end{titlepage}
}
\endinput

BIN
include/hsel-logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 144 KiB

143
index.tex Normal file
View File

@ -0,0 +1,143 @@
\documentclass[german, a4paper, headheight=36pt, parskip=true]{scrartcl}
\usepackage{hs-el-text}
\usepackage{wrapfig}
\usepackage{lipsum}
\modul{Echtzeitdatenverarbeitung}
\semester{Wintersemester 2020/21}
\thema{Dokumentation}
\author{Charlotte Friedemann \und Johannes Theiner}
\begin{document}
\maketitle
\tableofcontents
\section{Tasks}\label{sec:tasks}
\subsection{Drehteller}\label{subsec:task_turntable}
\begin{wrapfigure}{L}{0.5\textwidth}
\centering
\begin{plantuml}
@startuml
scale 150 width
!include https://raw.githubusercontent.com/bharatrajagopalan/plantuml-styles/master/activity_skin.pu
start
:Drehteller ausschalten;
repeat
:Prüfer fertig?<
:Bohrer fertig?<
:Auswerfer fertig?<
:Teil im Prüfer?<
:Teil im Bohrer?<
if(Teil auf einem Sensor ?) then (true)
:Drehteller anschalten;
if(Sensor Drehteller in Position ?) then (true)
:Drehteller auschalten;
endif
endif
:Drehteller fertig>
repeatwhile()
kill
@enduml
\end{plantuml}
\caption{SDL Diagramm Drehteller}
\label{fig:sdl-turntable}
\end{wrapfigure}
\lipsum[1-2]
\subsection{Prüfer}\label{subsec:task_tester}
\begin{wrapfigure}{R}{0.5\textwidth}
\begin{plantuml}
@startuml
!include https://raw.githubusercontent.com/bharatrajagopalan/plantuml-styles/master/activity_skin.pu
:Prüfer einfahren;
repeat
:Drehteller fertig?<
if(Werkstück vorhanden ?) then (ja)
:Prüfer ausfahren;
if(Werkstück Normallage ?) then (ja)
:Sende Bohrer(an)>
else (nein)
:Sende Bohrer(aus)>
endif
:Prüfer einfahren;
else (nein)
endif
:Prüfer fertig>
repeatwhile()
kill
@enduml
\end{plantuml}
\caption{SDL Diagramm Prüfer}
\label{fig:sdl-tester}
\end{wrapfigure}
\lipsum[2-4]
\subsection{Bohrer}\label{subsec:task_drill}
\begin{wrapfigure}{L}{0.5\textwidth}
\begin{plantuml}
@startuml
scale 150 width
!include https://raw.githubusercontent.com/bharatrajagopalan/plantuml-styles/master/activity_skin.pu
:Bohrer ausschalten;
:Bohrer hochfahren;
:Werkstück loslassen;
repeat
:Drehteller fertig?<
if(Werkstück vorhanden?) then(ja)
:Empfange Lage des Werkstücks<
:Sende Auswerfer>
if(Teil in Normallage?) then(ja)
:Werkstück festhalten;
:Bohrer anschalten;
:Bohrer herunterfahren;
:Warte bis Bohrer unten;
:Bohrer hochfahren;
:Warte bis Bohrer oben;
:Bohrer ausschalten;
:Werkstück loslassen;
else(nein)
endif
else (nein)
endif
:Bohrer fertig>
repeatwhile()
kill
@enduml
\end{plantuml}
\caption{SDL Diagramm Bohrer}
\label{fig:sdl-drill}
\end{wrapfigure}
\lipsum[2-4]
\subsection{Auswerfer}\label{subsec:output}
\begin{wrapfigure}{R}{0.5\textwidth}
\begin{plantuml}
scale 250 width
@startuml
!include https://raw.githubusercontent.com/bharatrajagopalan/plantuml-styles/master/activity_skin.pu
:Auswerfer einfahren;
repeat
:Drehteller fertig?<
:Auswerfer<
:Auswerfen;
:Auswerfer fertig>
repeatwhile()
kill
@enduml
\end{plantuml}
\caption{SDL Diagramm Auswerfer}
\label{fig:sdl-output}
\end{wrapfigure}
\lipsum[2-4]
\section{Hilfsfunktionen}\label{sec:functions}
\lipsum[2-4]
\end{document}