beginn the documentation

This commit is contained in:
Andreas Zweili 2018-09-11 22:33:19 +02:00
parent d89d10c19d
commit 95b2b52121
7 changed files with 594 additions and 0 deletions

67
docs/Makefile Normal file
View File

@ -0,0 +1,67 @@
ALL=$(wildcard *.sty *.tex *.org pictures/*.svg pictures/*.eps pictures/*.dot \
pictures/*.tex pictures/*.puml)
PAPER=Normfallstudie_Andreas_Zweili.tex
SHELL=/bin/bash
FIGURES_SVG=$(wildcard pictures/*.svg)
FIGURES_EPS=$(wildcard pictures/*.eps)
FIGURES_DOT=$(wildcard pictures/*.dot)
FIGURES_TEX=$(wildcard pictures/*.tex)
FIGURES_PUML=$(wildcard pictures/*.puml)
BIBLIOGRAPHY=$(wildcard general/*.bib)
SVG_PDF=$(FIGURES_SVG:.svg=.pdf)
EPS_PDF=$(FIGURES_EPS:.eps=.pdf)
DOT_PDF=$(FIGURES_DOT:.dot=.pdf)
TEX_PDF=$(FIGURES_TEX:.tex=.pdf)
PUML_PDF=$(FIGURES_PUML:.puml=.svg)
all: Normfallstudie_Andreas_Zweili.pdf ## Build full thesis (LaTeX + figures)
Normfallstudie_Andreas_Zweili.pdf: $(SVG_PDF) $(EPS_PDF) $(DOT_PDF) $(TEX_PDF) \
$(PUML_PDF) normfallstudie.tex general/ibzlogo.pdf $(BIBLIOGRAPHY)
latexmk -quiet -pdf -pdflatex="pdflatex -interaction=nonstopmode" \
-use-make $(PAPER)
clean: ## Clean LaTeX and output figure files
latexmk -c $(PAPER)
rm -f $(SVG_PDF)
rm -f $(EPS_PDF)
rm -f $(DOT_PDF)
rm -f $(PUML_PDF)
rm -f general/ibzlogo.pdf
rm -f *.acn
rm -f *.bbl
rm -f *.glo
rm -f *.ist
rm -f *.run.xml
rm -f *-blx.bib
rm -rf auto/
rm -rf general/auto/
rm -rf general/style.aux
rm -f normfallstudie.tex
distclean: clean
rm -f Normfallstudie_Andreas_Zweili.pdf
pictures/%.pdf: pictures/%.svg ## Figures for the manuscript
inkscape -C -z --file=$< --export-pdf=$@
pictures/%.pdf: pictures/%.eps ## Figures for the manuscript
inkscape -C -z --file=$< --export-pdf=$@
general/ibzlogo.pdf: general/ibzlogo.eps
inkscape -C -z --file=$< --export-pdf=$@
pictures/%.pdf: pictures/%.dot ## Figures for the manuscript
dot -Tpdf $< -o $@
pictures/%.pdf: pictures/%.tex ## Figures for the manuscript
latexmk -quiet -pdf -outdir=pictures \
-pdflatex="pdflatex -interaction=nonstopmode" -use-make $<
pictures/%.svg: pictures/%.puml
java -jar ~/bin/plantuml.jar -tsvg $<
normfallstudie.tex: normfallstudie.org
emacs -l ~/.emacs.d/init.el --batch \
--eval="(progn (find-file \"normfallstudie.org\") (org-latex-export-to-latex nil nil nil t))"

View File

@ -0,0 +1,43 @@
\documentclass[a4paper, 11pt]{article}
\include{general/style}
\bibliography{general/bibliography}
%\include{glossary}
\begin{document}
\include{normfallstudie_titlepage}
\newpage
\microtypesetup{protrusion=false} % disables protrusion locally in the document
\tableofcontents % prints Table of Contents
\microtypesetup{protrusion=true} % enables protrusion
\newpage
\include{normfallstudie}
\newpage
%\nocite{*}
\printbibliography[heading=bibintoc]
% \newpage
% \microtypesetup{protrusion=false}
% \listoffigures
% \microtypesetup{protrusion=true}
% \
% \newpage
\microtypesetup{protrusion=false}
\listoftables
\microtypesetup{protrusion=true}
\
\newpage
%\printglossaries
\end{document}
%%% Local Variables:
%%% mode: latex
%%% TeX-master: t
%%% End:

View File

@ -0,0 +1,183 @@
@misc{git,
month = {{01}},
note = {{\url{https://git-scm.com/}}},
author = {Linus Torvalds},
title = {{Git - Version Control System}},
year = {2018},
}
@misc{ansible,
month = {{01}},
note = {{\url{https://www.ansible.com/}}},
Urldate = {{2018-01-03}},
author = {Ansible, Red Hat},
title = {{Ansible - IT Automation Software}},
year = {2018},
}
@misc{vagrant,
month = {{01}},
note = {{\url{https://www.ansible.com/}}},
author = {HashiCorp Inc.},
title = {{Vagrant - Software Development Environment}},
year = {2018},
}
@misc{latex,
month = {{01}},
note = {{\url{https://www.latex-project.org/}}},
Urldate = {{2018-01-03}},
author = {Leslie Lamport},
title = {{LaTeX - A document preparation system}},
year = {2018},
}
@misc{debian,
month = {{01}},
note = {{\url{https://www.debian.org/}}},
Urldate = {{2018-01-03}},
author = {Debian Project},
title = {{Debian The Universal Operating System}},
year = {2018},
}
@misc{gplv3,
month = {{01}},
note = {{\url{https://www.gnu.org/licenses/gpl-3.0.en.html}}},
Urldate = {{2018-01-03}},
author = {Free Software Foundation},
title = {{GPLv3}},
year = {2018},
}
@misc{usecase,
month = {{01}},
note = {{\url{https://de.wikipedia.org/wiki/Anwendungsfall}}},
Urldate = {{2018-01-04}},
author = {Wikipedia},
title = {{Anwendungsfall Wikipedia}},
year = {2018},
}
@misc{usecasediagramm,
month = {{01}},
note = {{\url{https://de.wikipedia.org/wiki/Anwendungsfalldiagramm}}},
Urldate = {{2018-01-04}},
author = {Wikipedia},
title = {{Anwendungsfalldiagramm Wikipedia}},
year = {2018},
}
@misc{django,
month = {{01}},
note = {{\url{https://www.djangoproject.com/}}},
Urldate = {{2018-01-04}},
author = {Django Project},
title = {{Django Framework}},
year = {2018},
}
@misc{apache,
month = {{01}},
note = {{\url{https://httpd.apache.org/}}},
Urldate = {{2018-01-04}},
author = {Apache Foundation},
title = {{The Apache HTTP Server Project}},
year = {2018},
}
@misc{mariadb,
month = {{01}},
note = {{\url{https://mariadb.org/}}},
Urldate = {{2018-01-04}},
author = {Mariadb Foundation},
title = {{MariaDB}},
year = {2018},
}
@misc{emacs,
month = {{01}},
note = {{\url{https://www.gnu.org/software/emacs/}}},
Urldate = {{2018-01-04}},
author = {GNU Project},
title = {{GNU Emacs}},
year = {2018},
}
@misc{atom,
month = {{01}},
note = {{\url{https://atom.io/}}},
Urldate = {{2018-01-04}},
author = {GitHub Inc.},
title = {{Atom Editor}},
year = {2018},
}
@misc{mariadbgov,
month = {{01}},
note = {{\url{https://mariadb.org/about/governance/}}},
Urldate = {{2018-01-04}},
author = {MariaDB Foundation},
title = {{Governance}},
year = {2018},
}
@misc{inkscape,
month = {{01}},
note = {{\url{https://inkscape.org/en/}}},
Urldate = {{2018-01-05}},
author = {Inkscape Developers},
title = {{Inkscape}},
year = {2018},
}
@misc{orgmode,
month = {{01}},
note = {{\url{https://orgmode.org/}}},
Urldate = {{2018-01-05}},
author = {Carsten Dominik},
title = {{Org mode for Emacs}},
year = {2018},
}
@misc{virtualbox,
month = {{01}},
note = {{\url{https://www.virtualbox.org/}}},
Urldate = {{2018-01-05}},
author = {Oracle},
title = {{Oracle VM VirtualBox}},
year = {2018},
}
@misc{dia,
month = {{02}},
note = {{\url{http://dia-installer.de/}}},
Urldate = {{2018-02-06}},
author = {Macke, Steffen},
title = {{Dia draws your structured diagrams: Free Windows, Mac OS X and Linux version of the popular open source program}},
year = {2018},
}
@misc{userstory,
month = {{02}},
note = {{\url{https://de.wikipedia.org/wiki/User-Story}}},
Urldate = {{2018-02-21}},
author = {Wikipedia},
title = {{User-Story Wikipedia}},
year = {2018},
}
@misc{borgbackup,
month = {{07}},
note = {{\url{https://www.borgbackup.org/}}},
author = {The Borg Collective},
title = {{BorgBackup Deduplicating archiver with compression and authenticated encryption}},
year = {2018},
}
@misc{jsonapi,
author = {{The Borg Collective}},
title = {{All about JSON: How to develop frontends}},
year = {{2018}},
month = {{07}},
note = {{\url{https://borgbackup.readthedocs.io/en/stable/internals/frontends.html}}},
urldate = {2018-07-21}
}

130
docs/general/ibzlogo.eps Normal file
View File

@ -0,0 +1,130 @@
%!PS-Adobe-3.0 EPSF-3.0
%%Creator: cairo 1.14.8 (http://cairographics.org)
%%CreationDate: Mon Oct 16 19:08:01 2017
%%Pages: 1
%%DocumentData: Clean7Bit
%%LanguageLevel: 2
%%BoundingBox: 228 444 346 475
%%EndComments
%%BeginProlog
save
50 dict begin
/q { gsave } bind def
/Q { grestore } bind def
/cm { 6 array astore concat } bind def
/w { setlinewidth } bind def
/J { setlinecap } bind def
/j { setlinejoin } bind def
/M { setmiterlimit } bind def
/d { setdash } bind def
/m { moveto } bind def
/l { lineto } bind def
/c { curveto } bind def
/h { closepath } bind def
/re { exch dup neg 3 1 roll 5 3 roll moveto 0 rlineto
0 exch rlineto 0 rlineto closepath } bind def
/S { stroke } bind def
/f { fill } bind def
/f* { eofill } bind def
/n { newpath } bind def
/W { clip } bind def
/W* { eoclip } bind def
/BT { } bind def
/ET { } bind def
/pdfmark where { pop globaldict /?pdfmark /exec load put }
{ globaldict begin /?pdfmark /pop load def /pdfmark
/cleartomark load def end } ifelse
/BDC { mark 3 1 roll /BDC pdfmark } bind def
/EMC { mark /EMC pdfmark } bind def
/cairo_store_point { /cairo_point_y exch def /cairo_point_x exch def } def
/Tj { show currentpoint cairo_store_point } bind def
/TJ {
{
dup
type /stringtype eq
{ show } { -0.001 mul 0 cairo_font_matrix dtransform rmoveto } ifelse
} forall
currentpoint cairo_store_point
} bind def
/cairo_selectfont { cairo_font_matrix aload pop pop pop 0 0 6 array astore
cairo_font exch selectfont cairo_point_x cairo_point_y moveto } bind def
/Tf { pop /cairo_font exch def /cairo_font_matrix where
{ pop cairo_selectfont } if } bind def
/Td { matrix translate cairo_font_matrix matrix concatmatrix dup
/cairo_font_matrix exch def dup 4 get exch 5 get cairo_store_point
/cairo_font where { pop cairo_selectfont } if } bind def
/Tm { 2 copy 8 2 roll 6 array astore /cairo_font_matrix exch def
cairo_store_point /cairo_font where { pop cairo_selectfont } if } bind def
/g { setgray } bind def
/rg { setrgbcolor } bind def
/d1 { setcachedevice } bind def
%%EndProlog
%%BeginSetup
%%EndSetup
%%Page: 1 1
%%BeginPageSetup
%%PageBoundingBox: 228 444 346 475
%%EndPageSetup
q 228 444 118 31 rectclip q
1 0 0 rg
321.008 459.671 m 319.484 459.687 318.238 459.73 318.238 459.769 c 318.238
459.901 320.012 461.796 327.516 469.675 c 331.922 474.3 l 333.477 472.702
l 334.332 471.823 336.055 469.999 337.312 468.648 c 338.566 467.296 340.953
464.737 342.617 462.964 c 344.281 461.191 345.582 459.734 345.504 459.722
c 345.266 459.691 323.875 459.648 321.008 459.671 c h
321.008 459.671 m f
0 g
228.367 447.14 m 228.367 448.98 l 228.863 449.03 l 229.137 449.058 230.129
449.097 231.07 449.12 c 232.824 449.159 233.027 449.198 233.453 449.585
c 234.078 450.155 234.141 451.226 234.141 461.175 c 234.141 469.519 l 233.777
469.761 l 233.184 470.151 232.781 470.218 230.52 470.273 c 228.367 470.327
l 228.367 473.995 l 250.336 473.995 l 250.336 470.323 l 248.039 470.284
l 245.57 470.241 245.363 470.202 245.012 469.726 c 244.703 469.312 244.66
468.046 244.656 459.835 c 244.652 451.589 244.691 450.694 245.059 449.941
c 245.406 449.237 245.641 449.171 248.047 449.085 c 249.176 449.046 250.109
449.007 250.125 449.003 c 250.137 448.995 250.148 448.163 250.148 447.148
c 250.148 445.3 l 228.367 445.3 l h
228.367 447.14 m f
256.207 446.663 m 256.207 448.331 l 257.082 448.331 l 258.461 448.335 261.09
448.507 261.566 448.628 c 262.223 448.792 262.27 448.921 262.375 450.847
c 262.508 453.171 262.426 468.581 262.281 469.206 c 262.133 469.847 261.891
470.3 261.574 470.53 c 261.324 470.718 261.16 470.73 258.758 470.757 c
256.207 470.784 l 256.207 474.015 l 267.547 473.968 l 274.387 473.937 279.508
473.878 280.453 473.812 c 285.52 473.468 288.688 472.476 290.27 470.741
c 291.191 469.734 291.625 468.499 291.625 466.89 c 291.625 465.116 291.273
464.175 290.211 463.124 c 289.117 462.038 287.941 461.472 285.547 460.874
c 284.77 460.679 284.168 460.491 284.211 460.452 c 284.254 460.413 284.691
460.288 285.188 460.171 c 290.203 458.98 292.426 457.28 292.863 454.304
c 293 453.37 292.93 451.87 292.715 451.03 c 292.254 449.241 290.879 447.675
288.926 446.718 c 287.984 446.261 286.223 445.691 285.141 445.495 c 284.113
445.312 280.609 445.214 272.781 445.163 c 268.535 445.132 263.07 445.085
260.637 445.054 c 256.207 444.999 l h
279.457 448.519 m 282.199 448.816 283.852 449.648 284.555 451.081 c 284.906
451.8 285.188 452.831 285.188 453.405 c 285.188 454.038 284.867 455.265
284.574 455.773 c 284.23 456.351 283.254 457.194 282.488 457.569 c 281.234
458.183 280 458.323 274.816 458.46 c 272.836 458.515 271.016 458.558 270.77
458.558 c 270.316 458.558 l 270.316 448.304 l 274.414 448.359 l 276.668
448.39 278.938 448.46 279.457 448.519 c h
277.043 461.87 m 278.527 461.917 279.977 462.003 280.262 462.062 c 281.02
462.226 282.102 462.784 282.684 463.316 c 283.57 464.128 283.902 465.187
283.754 466.741 c 283.586 468.53 282.402 469.788 280.426 470.296 c 279.539
470.523 277.445 470.655 273.418 470.737 c 270.316 470.8 l 270.316 461.776
l 272.332 461.784 l 273.438 461.784 275.559 461.823 277.043 461.87 c h
277.043 461.87 m f
295.129 446.401 m 295.129 447.503 l 304.859 457.292 l 310.211 462.679 315.613
468.136 316.863 469.425 c 319.137 471.761 l 318.711 471.843 l 318.156 471.948
307.43 471.847 305.652 471.718 c 303.992 471.597 303.039 471.421 302.367
471.112 c 301.766 470.839 300.941 470.089 300.527 469.448 c 299.902 468.472
299.398 466.609 299.203 464.523 c 299.145 463.925 299.078 463.296 299.051
463.128 c 299.004 462.819 l 296.078 462.819 l 296.078 473.995 l 325.727
473.995 l 325.699 472.874 l 325.672 471.757 l 313.848 459.78 l 302.023
447.808 l 304.613 447.734 l 308.484 447.62 316.309 447.718 317.199 447.89
c 318.723 448.183 320.051 448.812 320.867 449.628 c 321.902 450.663 322.613
453.019 322.887 456.312 c 323.004 457.706 l 325.723 457.706 l 325.723 445.3
l 295.133 445.3 l h
295.129 446.401 m f
Q Q
showpage
%%Trailer
end restore
%%EOF

142
docs/general/style.tex Normal file
View File

@ -0,0 +1,142 @@
%Enable URL highlighting
\usepackage{hyperref}
\usepackage{graphicx}
\usepackage[table,xcdraw]{xcolor}
\hypersetup{
colorlinks=true,
linkcolor=blue,
urlcolor=blue,
}
\urlstyle{same}
%glossary
\usepackage[acronym,toc]{glossaries}
\makeglossaries
\setglossarystyle{altlistgroup}
\usepackage{xparse}
\DeclareDocumentCommand{\newdualentry}{ O{} O{} m m m m } {
\newglossaryentry{gls-#3}{name={#5},text={#5\glsadd{#3}},
description={#6},#1
}
\makeglossaries
\newacronym[see={[Glossary:]{gls-#3}},#2]{#3}{#4}{#5\glsadd{gls-#3}}
}
\makeatletter
\renewcommand{\paragraph}{\@startsection{paragraph}{4}{0ex}%
{-3.25ex plus -1ex minus -0.2ex}%
{0.3ex plus 0.2ex}%
{\normalfont\normalsize\bfseries}}
\makeatother
%page dimensions
\usepackage[a4paper,includeheadfoot, top=2.5cm, bottom=2.5cm, left=3.5cm, right=3cm]{geometry}
%Font settings
\usepackage{tgpagella}
\usepackage[T1]{fontenc}
%Support for German
\usepackage[utf8]{inputenc}
\usepackage[ngerman]{babel}
%number everything down to paragraphs
\setcounter{secnumdepth}{5}
%Enable Microtyping which improves justification
\usepackage{microtype}
%header
\setlength{\headheight}{15pt}
\usepackage{fancyhdr}
\pagestyle{fancy}
\lhead{\nouppercase{\leftmark}}
\rhead{\includegraphics[width=1cm]{general/ibzlogo.pdf}}
\cfoot{\thepage}
%footnotes
\setlength{\skip\footins}{0.5cm}
\usepackage[bottom,hang]{footmisc}
%each section should start on a new page
\usepackage{titlesec}
\newcommand{\sectionbreak}{\clearpage}
%European style paragraphs
\setlength{\parskip}{\baselineskip}%
\setlength{\parindent}{0pt}%
%Make line spacing bigger
\linespread{1.3}
%Make whitespace in tables bigger
\renewcommand\arraystretch{1.5}
%Enable colours for tables
\usepackage[table]{xcolor}
\usepackage{longtable}
%Needed to rotate graphics and tables
\usepackage{rotating}
\usepackage{pdflscape}
%Support for images
\usepackage{graphicx}
\usepackage{float}
%Material theme colours
\definecolor{red}{HTML}{F44336}
\definecolor{pink}{HTML}{E91E63}
\definecolor{purple}{HTML}{9C27B0}
%\definecolor{blue}{HTML}{2196F3}
\definecolor{brown}{HTML}{795548}
\definecolor{cyan}{HTML}{00BCD4}
\definecolor{darkgray}{HTML}{616161}
\definecolor{gray}{HTML}{9E9E9E}
\definecolor{lightgray}{HTML}{E0E0E0}
\definecolor{lime}{HTML}{CDDC39}
\definecolor{olive}{HTML}{827717}
\definecolor{orange}{HTML}{FF9800}
\definecolor{teal}{HTML}{009688}
\definecolor{yellow}{HTML}{FFEB3B}
\definecolor{green}{HTML}{388E3C}
%Support for Code Snippets and Syntax Highlighting
\usepackage{listings}
\usepackage{color}
\usepackage{sourcecodepro}
\lstset{
basicstyle=\ttfamily,
language=bash,
breaklines,
literate={ö}{{\"o}}1
{ä}{{\"a}}1
{ü}{{\"u}}1,
captionpos=b, % sets the caption-position to bottom
commentstyle=\color{green}, % comment style
escapeinside={\%*}{*)}, % if you want to add LaTeX within your code
keywordstyle=\color{blue}, % keyword style
stringstyle=\color{purple}, % string literal style
showstringspaces=false, % Removes the strange symboles where spaces are
}
% Listing with a box around it
\usepackage[most]{tcolorbox}
\newtcblisting{sexylisting}[2][]{
sharp corners,
fonttitle=\bfseries,
colframe=gray,
listing only,
listing options={basicstyle=\ttfamily,language=bash},
title=\thetcbcounter #2, #1
}
\usepackage{tocbibind}
\usepackage[citestyle=verbose,bibstyle=numeric,sorting=none,backend=bibtex8]{biblatex}
\DefineBibliographyStrings{german}{%
references = {Referenzen},
}
%%% Local Variables:
%%% mode: latex
%%% TeX-master: "main"
%%% End:

13
docs/normfallstudie.org Normal file
View File

@ -0,0 +1,13 @@
#+title: Normfallstudie
:preamble:
#+setupfile: ~/nextcloud/03_documents/org/settings/html_theme/setup/theme-readtheorg.setup
#+author: Andreas Zweili
#+latex_header: \input{/home/andreas/git_repos/notes/settings/latex/style}
#+latex_class: article
#+latex_class_options: [a4paper,11pt]
#+latex_header: \input{general/style}
#+otions: H:5 todo:f
#+language: de
#+startup: align
#+bibliography: general/bibliography.bib
:end:

View File

@ -0,0 +1,16 @@
\begin{titlepage}
\centering
%\includegraphics[width=0.15\textwidth]{example-image-1x1}\par\vspace{1cm}
{\scshape\LARGE IBZ-Schulen AG\par}
%\vspace{0.5cm}
{\scshape\Large Aarau\par}
\vspace{1.5cm}
{\huge\bfseries Normfallstudie OOP\par}
\vspace{2cm}
{\Large\itshape Zweili Andreas, TI-AR-18S\par}
\vfill
% Bottom of the page
{\large \today\par}
\thispagestyle{empty}
\end{titlepage}