Prepare server documentation document

This commit is contained in:
Jan Philipp Timme 2018-09-12 22:19:28 +02:00
parent 585325c064
commit a9bdaf3919
4 changed files with 153 additions and 4 deletions

View File

@ -2,6 +2,7 @@
MA_NAME="MA-Master"
CA_DOC_NAME="CA-DOC-Master"
SRV_DOC_NAME="SRV-DOC-Master"
LAST_EXPORT=`cat LAST_EXPORT`
@ -19,15 +20,27 @@ render_ca_doc:
#pdflatex -output-directory build ${CA_DOC_NAME}.tex
pdflatex -output-directory build ${CA_DOC_NAME}.tex
render_srv_doc:
pdflatex -output-directory build ${SRV_DOC_NAME}.tex
#bibtex build/${SRV_DOC_NAME}
#pdflatex -output-directory build ${SRV_DOC_NAME}.tex
pdflatex -output-directory build ${SRV_DOC_NAME}.tex
clean:
cd build; rm -v *.aux *.bbl *.blg *.log *.out *.toc
cleanall:
rm -rfv build; mkdir build
viewer:
okular build/${NAME}.pdf
viewer_ma:
okular build/${MA_NAME}.pdf
show: cleanall render_ma render_ca_doc viewer
viewer_ca_doc:
okular build/${CA_DOC_NAME}.pdf
release: cleanall render_ma render_ca_doc clean
viewer_srv_doc:
okular build/${SRV_DOC_NAME}.pdf
show: cleanall render_ma render_ca_doc render_srv_doc viewer_ma viewer_ca_doc viewer_srv_doc
release: cleanall render_ma render_ca_doc render_srv_doc clean

2
SRV-DOC-Inhalt.tex Normal file
View File

@ -0,0 +1,2 @@
\chapter{Vorwort}
Diese Dokumentation enthält Installations- und Betriebsanweisungen.

115
SRV-DOC-Master.tex Normal file
View File

@ -0,0 +1,115 @@
\documentclass[12pt,a4paper,twoside,parskip=half-,headsepline,headinclude]{scrreprt} % Grundgröße 12pt, zweiseitig
% Packages from template
\usepackage[headsepline,automark]{scrlayer-scrpage} % Seitenköpfe automatisch
\KOMAoptions{headinclude} % Fix
\usepackage[german]{babel} % Sprachpaket für Deutsch (Umlaute, Trennung,deutsche Überschriften)
\usepackage{graphicx} % Graphikeinbindung
\usepackage[hidelinks]{hyperref} % Hyperref (alles klickbar, Bookmarks)
\usepackage{amssymb} % Math. Symbole aus AmsTeX
\usepackage[utf8]{inputenc} % Umlaute
% Custom packages
\usepackage[autostyle=true,german=quotes]{csquotes} % Anführungszeichen mit \enquote{}
\usepackage{textcomp} % Zusätzliches Package für °C
\usepackage{listings} % Codesnippets
\usepackage{scrhack} % Hack for lstlisting i suspect :-/
\usepackage{xcolor}
\usepackage{float}
\usepackage{soul}
\usepackage{verbatim} % für comment-environment
\usepackage{amsmath}
\usepackage{enumitem} % enumerate mit benutzerdefinierten Labels
\usepackage{caption}
\captionsetup[table]{skip=8pt}
\usepackage[numbers,round]{natbib} % Let's try alphadin bibliography style
% Setup für Codeblocks
\lstset{
% Optionen
breaklines=true,
breakatwhitespace=true,
breakautoindent=true,
frame=single,
%framexleftmargin=19pt,
inputencoding=utf8,
%language=awk,
%numbers=left,
%numbersep=8pt,
showspaces=false,
showstringspaces=false,
tabsize=1,
%xleftmargin=19pt,
captionpos=b,
% Styling
basicstyle=\footnotesize\ttfamily,
commentstyle=\footnotesize,
keywordstyle=\footnotesize\ttfamily,
numberstyle=\footnotesize,
stringstyle=\footnotesize\ttfamily,
}
% Hack für Sonderzeichen in Codeblocks
\lstset{literate=%
{Ö}{{\"O}}1
{Ä}{{\"A}}1
{Ü}{{\"U}}1
{ß}{{\ss}}1
{ü}{{\"u}}1
{ä}{{\"a}}1
{ö}{{\"o}}1
{°}{{${^\circ}$}}1
}
% Befehl für TODO-Markierungen
\newcommand{\todo}[1]{\textcolor{blue}{\emph{TODO: #1}}}
% Befehl für Entwürfe und grobe Pläne
%\newenvironment{draft}{\par\color{orange}\begin{center}Entwurf / Konzept\end{center}\hrule}{\hrule\par}
% Broken citation needs broken command
\newcommand\mathplus{+}
% Festlegung Kopf- und Fußzeile
\defpagestyle{meinstil}{%
{\headmark \hfill}
{\hfill \headmark}
{\hfill \headmark\hfill}
(\textwidth,.4pt)
}{%
(\textwidth,.4pt)
{\pagemark\hfill Jan Philipp Timme}
{Version 1.0 vom \today \hfill \pagemark}
{Version 1.0 vom \today \hfill \pagemark}
}
\pagestyle{meinstil}
\raggedbottom
\renewcommand{\topfraction}{1}
\renewcommand{\bottomfraction}{1}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Beginn des Dokuments (Titelseite und der ganze Krempel)
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{document}
\input{SRV-DOC-Titelseite.tex}
% Inhaltsverzeichnis
\pdfbookmark[0]{Inhalt}{contents}
\tableofcontents
% Abbildungsverzeichnis, falls genug vorhanden sind
%\listoffigures
% Codeverzeichnis, falls genug vorhanden ist
%\lstlistoflistings
% Tabellenverzeichnis, falls genug vorhanden sind
%\listoftables
% Sicherstellen, dass Inhalte auf der nächsten neuen Seite beginnen
\newpage
% Inhalte
\input{SRV-DOC-Inhalt.tex}
\end{document}
% Nothing beyond this line!

19
SRV-DOC-Titelseite.tex Normal file
View File

@ -0,0 +1,19 @@
% Titelseite
\thispagestyle{empty}
\includegraphics[width=0.2\textwidth]{res/Wortmarke_WI_schwarz.pdf}
{ ~ \sffamily
\vfill
{\Huge\bfseries IPv6-VPN Serverdokumentation}
\bigskip
{\Large Jan Philipp Timme
\\[2ex]
%Masterarbeit im Studiengang "`Angewandte Informatik"'
\\[5ex]
\today
}
}
\vfill
~ \hfill
\includegraphics[height=0.3\paperheight]{res/H_WI_Pantone1665.pdf}
\vspace*{-3cm}