Skip to content

Commit 9bb8478

Browse files
committed
update teltowPack.sty and documentation example
1 parent 0402ab6 commit 9bb8478

File tree

5 files changed

+97
-96
lines changed

5 files changed

+97
-96
lines changed

example/assets/Projektantrag.pdf

18.4 KB
Binary file not shown.
-18.3 KB
Binary file not shown.

example/documentation/project-documentation.tex

Lines changed: 91 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77
\usepackage{graphicx}
88
\usepackage{lmodern}
99
\usepackage{url}
10-
\usepackage{subfiles}
11-
\usepackage{pdfpages}
12-
\usepackage{wrapfig}
10+
\usepackage{subfiles} % enables including TeX files
11+
\usepackage{pdfpages} % enables including pdf files
12+
\usepackage{wrapfig} % inline images
1313
\usepackage{lipsum} % Adds Lorem Ipsum placeholder
1414

1515
% = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
@@ -38,6 +38,8 @@
3838
\begin{document}
3939
\makeIHKTitlePage%
4040

41+
\includepdf[pages=-]{../assets/Projektantrag.pdf}
42+
4143
% \subfile{../pages/test/test.tex} compile all .tex subpages with PowerShell Script: /helper/compile-all.ps1
4244
% OR
4345
\makeTimeNotesPage{
@@ -70,10 +72,21 @@
7072
\entry{13.02.2069}{... usw.}{2}
7173
}
7274
\tableofcontents
75+
76+
\newpage
77+
\section*{Abkürzungsgsverzeichnis}
78+
\addcontentsline{toc}{section}{Abkürzungsgsverzeichnis}
79+
\begin{tabularx}{\linewidth}{lX}
80+
DB & Database, zu Deutsch Datenbank \\
81+
SQL & \textbf{S}tructured \textbf{Q}uery \textbf{L}anguage \\
82+
IDE & \textbf{I}ntegrated \textbf{D}evelopment \textbf{E}nvironment, Entwicklungsumgebung \\
83+
\end{tabularx}
84+
7385
\newpage
7486
\listoffigures
7587
\addcontentsline{toc}{section}{Abbildungsverzeichnis} % add page to toc
76-
\clearpage
88+
89+
\newpage
7790
% \listoftables
7891
% \addcontentsline{toc}{section}{Tabellenverzeichnis} % add page to toc
7992
% \clearpage
@@ -86,56 +99,96 @@ \section{Einleitung}
8699
\caption[Beispiel Bild]{Beispiel Bild\footnotemark.}
87100
\end{figure}
88101
\footnotetext{Beispiel Bild. verfügbar unter \url{www.nowhere.de}, aufgerufen am: garnicht.2024 um 00:00Uhr}
89-
\lipsum\
102+
\lipsum[1]
90103
\subsection{Projektziel}
91-
\lipsum[1-3]
104+
\lipsum[1-2]
92105
\begin{wrapfigure}{l}{.3\textwidth}
93106
\centering
94107
\includegraphics[width=.3\textwidth]{example-image-a}
95108
\caption[Klickibunti Mockup]{Klickibunti Mockup\footnotemark.}
96109
\end{wrapfigure}
97-
\lipsum[3-6]
110+
\lipsum[2-3]
98111
\footnotetext{Klickibunti mockups. verfügbar unter \url{www.nowhere.de}, aufgerufen am: 100 v. Chr. um 07:00Uhr}
99112
\subsection{Projektumfeld}
100-
\lipsum\
101-
\subsection{Projektschnittstellen}
102-
\lipsum\
113+
\lipsum[1]
114+
115+
\newpage
103116
\section{Projektplannung}
104-
\subsection{Projektphasen}
105-
\lipsum\
106-
\subsection{Ressourcenplannung}
107-
\lipsum\
117+
\subsection{Lorem Ipsum}
118+
\lipsum[1]
119+
\begin{table}[!htb]
120+
\centering
121+
\caption{Projektphasen}
122+
\begin{tabular}{|lr|}
123+
\hline
124+
\textbf{Projektphasen} & \textbf{Geplante Zeit} \\
125+
\hline
126+
Phase1 & 42h \\
127+
Phase2 & 42h \\
128+
Phase3 & 42h \\
129+
Phase4 & 42h \\
130+
Phase5 & 42h \\
131+
Phase6 & 42h \\
132+
\hline
133+
Gesamt & 42h \\
134+
\hline
135+
\end{tabular}
136+
\end{table}
137+
108138
\section{Anlysephase}
109-
\subsection{Anwendungsfälle}
110-
\lipsum\
139+
\subsection{Lorem Ipsum}
140+
\lipsum[1-2]
141+
\subsection{\glqq{}Make or Buy\grqq{}- Entscheidung}
142+
\lipsum[1]
143+
\subsection{Projektkosten}
144+
\begin{table}[h]
145+
\centering
146+
\caption{Projektkosten}
147+
\begin{tabularx}{\linewidth}{|lXrrrr|}
148+
\hline
149+
\textbf{Vorgang} & \textbf{Mitarbeiter} & \textbf{Zeit} & \textbf{Personalkosten} & \textbf{Ressourcen} & \textbf{Gesamt}\\
150+
\hline
151+
Plannung & 1x Auszubildender & 42h & 42,00€ & 2,00€ & 44,00€ \\
152+
Entwicklung & 1x Auszubildender & 42h & 42,00€ & 2,00€ & 44,00€ \\
153+
Code Review & 1x Mitarbeiter & 42h & 1,00€ & 2,00€ & 3,00€ \\
154+
Abnahme & 1x Mitarbeiter & 42h & 1,00€ & 2,00€ & 3,00€ \\
155+
\hline
156+
& & & & & 2920,00€ \\
157+
\hline
158+
\end{tabularx}
159+
\end{table}
160+
111161
\section{Entwurfsphase}
112-
\subsection{Zielplattform}
113-
\lipsum\
114-
\subsection{Architekturdesign}
115-
\lipsum\
116-
\subsection{Entwurf der Benutzeroberfläche}
117-
\lipsum\
118-
\subsection{Datenmodell}
119-
\lipsum\
120-
\subsection{Geschäftslogik}
121-
\lipsum\
162+
\subsection{Lorem Ipsum}
163+
\lipsum[2-3]
164+
122165
\section{Implementierungsphase}
123-
\newpage
166+
\subsection{Lorem Ipsum}
167+
\lipsum[3-4]
168+
124169
\section{Dokumentation}
125-
\newpage
170+
\subsection{Entwicklerdokumentation}
171+
Im \fullref{anhang:Anhang1} ist die Dokumentation für Entwickler zu finden.
172+
126173
\section{Fazit}
127174

128-
\newpage
129-
\begin{alphasection}
175+
\clearpage
176+
\appendix
130177
\section{Anhang}
131-
\end{alphasection}
132178

133-
%
134-
% Stats
135-
%
136-
% \newpage
137-
% {\Large Statistics \par}
138-
% \vspace{.5cm}
139-
% \verb|Total Reports:|\arabic{reportID}
179+
\subsection{Anhang 1}\label{anhang:Anhang1}
180+
\begin{figure}[htb]
181+
\centering
182+
\includegraphics[width=.95\textwidth]{example-image}
183+
\caption{Beispiel Anhang1}
184+
\end{figure}
140185

186+
\clearpage
187+
\subsection{Anhang 2}\label{anhang:Anhang2}
188+
\begin{figure}[htb]
189+
\centering
190+
\includegraphics[width=.95\textwidth]{example-image}
191+
\caption{Beispiel Anhang2}
192+
\end{figure}
193+
141194
\end{document}

example/packages/teltowPack.sty

Lines changed: 3 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
%%
88
%% History: 2024-03-19 mewesm Created
99
%% 2024-03-21 mewesm Refactoring
10+
%% 2024-04-25 mewesm Removed AlphaSection
1011
%%
1112
%%
1213
% ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -25,6 +26,7 @@
2526
\usepackage{graphicx}
2627
\usepackage{setspace}
2728
\usepackage{tabularray}
29+
\usepackage{tabularx}
2830
\usepackage{verbatim}
2931
\usepackage{hyperref}
3032
\usepackage{fancyhdr}
@@ -356,35 +358,7 @@
356358
% = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
357359
% | HELPER COMMANDS AND DEFINITIONS
358360
% = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
359-
\newcounter{alphasect}
360-
\def\alphainsection{0}
361-
362-
\let\oldsection=\section
363-
\def\section{
364-
\ifnum\alphainsection=1
365-
\addtocounter{alphasect}{1}
366-
\fi
367-
\oldsection}
368-
369-
\renewcommand\thesection{
370-
\ifnum\alphainsection=1
371-
\Alph{alphasect}
372-
\else
373-
\arabic{section}
374-
\fi
375-
}
376-
377-
\newenvironment{alphasection}{
378-
\ifnum\alphainsection=1
379-
\errhelp={Let other blocks end at the beginning of the next block.}
380-
\errmessage{Nested Alpha section not allowed}
381-
\fi
382-
\setcounter{alphasect}{0}
383-
\def\alphainsection{1}
384-
}{
385-
\setcounter{alphasect}{0}
386-
\def\alphainsection{0}
387-
}
361+
\newcommand*{\fullref}[1]{\hyperref[{#1}]{\autoref*{#1} \nameref*{#1}}}
388362

389363
% handle unkown package options
390364
\DeclareOption*{

teltowPack.sty

Lines changed: 3 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
%%
88
%% History: 2024-03-19 mewesm Created
99
%% 2024-03-21 mewesm Refactoring
10+
%% 2024-04-25 mewesm Removed AlphaSection
1011
%%
1112
%%
1213
% ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -25,6 +26,7 @@
2526
\usepackage{graphicx}
2627
\usepackage{setspace}
2728
\usepackage{tabularray}
29+
\usepackage{tabularx}
2830
\usepackage{verbatim}
2931
\usepackage{hyperref}
3032
\usepackage{fancyhdr}
@@ -356,35 +358,7 @@
356358
% = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
357359
% | HELPER COMMANDS AND DEFINITIONS
358360
% = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
359-
\newcounter{alphasect}
360-
\def\alphainsection{0}
361-
362-
\let\oldsection=\section
363-
\def\section{
364-
\ifnum\alphainsection=1
365-
\addtocounter{alphasect}{1}
366-
\fi
367-
\oldsection}
368-
369-
\renewcommand\thesection{
370-
\ifnum\alphainsection=1
371-
\Alph{alphasect}
372-
\else
373-
\arabic{section}
374-
\fi
375-
}
376-
377-
\newenvironment{alphasection}{
378-
\ifnum\alphainsection=1
379-
\errhelp={Let other blocks end at the beginning of the next block.}
380-
\errmessage{Nested Alpha section not allowed}
381-
\fi
382-
\setcounter{alphasect}{0}
383-
\def\alphainsection{1}
384-
}{
385-
\setcounter{alphasect}{0}
386-
\def\alphainsection{0}
387-
}
361+
\newcommand*{\fullref}[1]{\hyperref[{#1}]{\autoref*{#1} \nameref*{#1}}}
388362

389363
% handle unkown package options
390364
\DeclareOption*{

0 commit comments

Comments
 (0)