summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/udesoftec/udesoftec-doc.tex
blob: 877e3493f169112252ae1df5efa701dcc2e40260 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
% !Mode:: "TeX:UTF-8"
\documentclass[screenlayout,omit-lof,omit-lot,final]{udesoftec} 
			

\title{Latex-Formatvorlage für Qualifikationsarbeiten}
\subtitle{Lehrstuhl für Wirtschaftsinformatik und Softwaretechnik}
\author{Max Mustermann}
\def \entitle{}
\def \city{Essen}
\def \typeofdoc{Handbuch}
\def \labelPreTopic{zur}
\def \institution{Universit\"at Duisburg-Essen}
\def \semester{}                                                                               
\date{Version: \today}
\def \authorbox{}
									
%%%%%%%%%%%%%%%%%%%%%%%% DOCUMENT %%%%%%%%%%%%%%%%%%%%%%%%
\begin{document}
%%%%%%%%%%%%%%%%%%%%%%%%%%% METADATA %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\newacronym[description={Die Benutzeroberfläche}]{ui}{UI}{User Interface}
\newacronym[description={Business-to-Customer, \entode{Unternehmen-zu-Kunde}, beschreibt den Zielmarkt für Transaktionen}]{b2c}{B2C}{Business-to-Customer}
\newglossaryentry{Pattern}{name=Pattern, description={TODO:Pattern Definition}}
\newglossaryentry{Pattern-Kategorie}{name=Pattern-Kategorie, description={Die Einteilung eines \gls{Pattern} in einem Pattern-Katalog.}}

%%%%%%%%%%%%%%%%%%%%%%%% CONTENT %%%%%%%%%%%%%%%%%%%%%%%
\mainmatter
\chapter{Einführung}
\section{Grundidee}
Dieses Template stellt eine professionelle Lösung für die Nutzung von LaTeX bereit, die an einigen Stellen von den Quick'and'Dirty und den Plattformübergreifenden Lösungen aus gutem Grund abweicht. Ein paar Beispiele dafür:
* es werden direkt und ausschließlich PDF-Dokumente generiert und kein DVI oder PS als Ergebnis.
* es wird keine Acrobat-Lösung für die PDFs benutzt, SumatraPDF ermöglicht die invers-Suche, sperrt die Dokumente nicht und ist schneller
* eingebettete Grafiken liegen ausschließlich im PDF-Format vor (da jedes bessere Programm in PDF exportieren kann und ein PDF-Drucker wie doPDF die restlichen versorgt).
* alle temporär generierten Dateien liegen so gut es geht in einem Unterordner, um die Übersichtlichkeit zu erhöhen
* durchgehende UTF-8-Nutzung (trotz LaTeX statt XeLaTeX)
\section{Minimal Working Example}
Ein funktionierendes Dokument lässt sich durch folgendes Beispiel erstellen:
\begin{verbatim}
\documentclass[screenlayout]{udesoftec}
\begin{document}
Inhalt
\end{document}
\end{verbatim}
Grundsätzlich sind kaum Einstellungen und Konfigurationen notwendig. Lediglich Dinge wie der Inhalt und die bib-Datenbank sind einzufügen.
Dieses Dokument als Beispieldokument finden sie unter \url{http://udue.de/udesoftecmanual}
\section{Software-Empfehlungen}
Diese LaTex-Klasse ist erstellt für die Nutzung unter Windows mit
\begin{itemize}
	\item MikTeX >= 2.9
	\item TeXnicCenter >= 2.0B1
	\item SumatraPDF >= 2.0
	\item Citavi >= 4.0
\end{itemize}
Unter anderen Systemumgebungen funktioniert es natürlich auch, dort sollte dann aber auch genügend Kompetenz vorliegen.

\begin{enumerate}
	\item Citavi installieren und nutzen. ~\par
		\begin{itemize}
			\item In Citavi wie folgt einen automatischen BibTex export einrichten beim Speichern:~\par
				\begin{itemize}
					\item Datei->Exportieren->Exportieren...
					\item Alle n Titel
					\item "Dokumenttypen zuordnen": Weiter
					\item "Felder zuordnen": Weiter (eigentlich: bei allen Dokumenttypen Doi nach doi mappen (mit Kringel), aber das sollte inzwischen von vorneherein eingestellt sein)
					\item "Ootionen": deaktivieren von [ ] Formatierungen aus Titelfelden übernehmen
					\item "BibTex-Exportdefinition speichern": ja 
					\item "Bestimmen ...Exportdatei": [X] Eine Textdatei erstellen: (hier innerhalb des Projektes eine Datei anlegen mit der Endung .bib
					\item "Export-Vorlage speichern":	[X] Ja [X] Automatisch exportieren beim Speichern
				\end{itemize}
				Dadurch bleibt die .bib-Datei immer up-to-date (TeXnicCenter cached die, daher erscheinen einige Einträge dort teilweise nicht ohne Neustart, das kompilieren geht aber)
		\end{itemize}
	\item MikTeX installieren 
	\item TeXnicCenter installieren
	\item TeXnicCenter automatisch für MikTex konfigurieren
	\item SumatraPDF herunterladen (Portable Version, direkt neben die TexNixCenter.exe legen): \url{http://blog.kowalczyk.info/software/sumatrapdf/download-free-pdf-viewer-de.html}
	\item Im TeXnicCenter unter Ausgabeprofile: Kopieren des vorhandenen PDF-Profils (pdflatex) und das wie folgt anpassen und zum normalen Profil machen:~\par
		\begin{itemize}
			\item Im Karteireiter (La)TeX:~\par
				\begin{itemize}
					\item Argumente für Compiler: -src-specials -synctex=1 -aux-directory .tmp -output-format pdf -interaction=nonstopmode %Wm
					\item Argumente für BibTex: "\%dm/.tmp/\%tm"
					\item Argumente für MakeIndex: ".tmp/\%tm.tex"
				\end{itemize}
			\item Im Karteireiter Viewer:~\par
				\begin{itemize}
					\item Pfad der Anwendung (Pfade zu beiden Tools anpassen): 
					\item C:\textbackslash Program Files (x86)\textbackslash TeXnicCenter\textbackslash SumatraPDF.exe -inverse-search "\textbackslash "C:\textbackslash Program Files (x86)\textbackslash TeXnicCenter\textbackslash TeXnicCenter.exe\textbackslash " /ddecmd \textbackslash "[goto('\%f','\%l')]\textbackslash ""
					\item Projektausgabe betrachten~\par
						\begin{itemize}
							\item [X] Kommandozeile
							\item Kommando: "\%bm.pdf"	
						\end{itemize}
					\item Suche in Ausgabe:~\par
						\begin{itemize}
							\item [X] DDE-Kommando
							\item Kommando: [ForwardSearch("\%bm.pdf","\%Wc",\%l,0,0,1)]
							\item Server: SUMATRA
							\item Thema: control
					\end{itemize}
					\item Vor Compilierung Ausgabe schließen~\par
						\begin{itemize}
							\item [X] nicht schließen
						\end{itemize}
				\end{itemize}
			\item Im Karteireiter Nachbearbeitung:~\par
				\begin{itemize}
					\item PFADE ANPASSEN!
					\item Neuen Postprozessoren anlegen: "Acronyms"
					\item Anwendung: C:\\Program Files (x86)\\MiKTeX 2.9\\miktex\\bin\\makeindex.exe
					\item Argumente: -s .tmp\\\%tm.ist -t .tmp\\\%tm.alg -o .tmp\\\%tm.acr .tmp\\\%tm.acn
					\item Neuen Postprozessoren anlegen: "Glossaries"
					\item Anwendung: C:\\Program Files (x86)\\MiKTeX 2.9\\miktex\\bin\\makeindex.exe
					\item Argumente: -s .tmp\\\%tm.ist -t .tmp\\\%tm.glg -o .tmp\\\%tm.gls .tmp\\\%tm.glo
				\end{itemize}
		\end{itemize}
	\item Im TeXnicCenter unter Optionen und Aufräumen neue Dateiendungen hinzufügen (Aktion: löschen; [X] Unterverzeichnisse einbeziehen und als Pattern jeweils)~\par
		\begin{itemize}
	\item *.synctex.gz
	\item *.acn
	\item *.acr
	\item *.alg
	\item *.glg
	\item *.glo
	\item *.gls
	\item *.ist
			\item *.pdfsync
		\end{itemize}


\item Nun das Beispielprojekt oder das Minimal Working Example öffnen und einmal rendern lassen, dadurch sollten alle benötigten Pakete automatisch installiert werden.
\item Im TeXnicCenter mit Strg+Alt+R die "Erstellung Ergebnis" Ansicht anzeigen lassen, diese fasst die LaTeX-Ausgaben sinnvoll zusammen.

\end{enumerate}

Dadurch werden 
\begin{enumerate}
\item alle temporären Dateien in einem Unterordner .tmp/ erstellt.
\item Die Vorwärtssuche und die Rückwärtssuche im PDF ermöglicht.~\par
	\begin{itemize}
					\item Vorwärtssuche: das PDF öffnet sich an der Textstelle an der man im TeXnicCenter den Cursor hatte
	\item Rückwärtssuche: Doppelklick im PDF öffnet die Textstelle im TeXnicCenter
	\end{itemize}
\item Die Glossar und Abkürzungsverzeichnisoption aktiviert
\end{enumerate}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Klassenparameter und Konstanten}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{Optionen der Klasse}
\begin{description}
	\item[printlayout]{Sollte pauschal genutzt werden: nutzt doppelseitigem Druck-Layout ("`Buchlayout"'). Kapitel beginnen auf rechten Seiten, dadurch werden Leerseiten eingefügt.}
	\item[screenlayout]{Wechselt von doppelseitigem Druck-Layout ("`Buchlayout"') auf einseitiges Layout. Dadurch ist Innenrand=Außenrand und zusätzliche Leerseiten fehlen, die Kapitel sonst auf rechter Seite starten lassen}
	\item[en]{Wechselt primäre Dokumentsprache von Deutsch auf Englisch. Ändert einzelne Überschriften und andere sprachabhängige Labels.}
	\item[omit-lot]{Tabellenverzeichnis entfernen (wenn keine Tabellen in der Arbeit vorkommen, oder für Test-Ausgaben)}
	\item[omit-lof]{Abbildungsverzeichnis entfernen (wenn keine Tabellen in der Arbeit vorkommen, oder für Test-Ausgaben)}
	\item[vawiessen]{Passt einzelne Ausgaben an die Vorgaben von VAWi (Standort Essen) an.}
	\item[vawibamberg]{Passt einzelne Ausgaben an die Vorgaben von VAWi (Standort Bamberg) an.}
\end{description}

\subsection{Anpassen des Deckblatts}
Die folgende Variablen lassen sich ersetzen vor dem \verb|\begin{document}|:
\begin{itemize}
	\item city
\item typeofdoc
\item academicfield
\item institution
\item semester
\item confidentialitySource
\item authorbox
\item enttitle
\end{itemize}
Die Nutzung ist wie bei LaTeX üblich:
\begin{verbatim}\def \typeofdoc{Bachelorarbeit}
\def \typeofdoc{Masterarbeit}
\end{verbatim}

Darüber hinaus gibt es natürlich noch die Standard-Kommandos:
\begin{itemize}
\item title
\item author
\item date
\end{itemize}
Die Nutzung ist wie bei LaTeX üblich:
\begin{verbatim}\def \typeofdoc{Bachelorarbeit}
\title{Meine Arbeit hat einen Titel}
\end{verbatim}

\chapter{Funktionen}

\section{Beispiele für Zitationen}

\subsection{Absatz-Zitate}

\citequotepar[xix]{Tidwell.2011}{The text that started it all dealt with physical buildings, not software. Christopher Alexander’s
A Pattern Language and its companion book The Timeless Way of Building established the
concept of patterns and described a 250-pattern multilayered pattern language.}

\subsection{Zitat im Text}
Merkmale von Patterns sind bspw. \cite[541]{Fettke.et.al.2009}:

\begin{itemize}
	\item Abstraktionsgrad
	\item Domänenbezug
	\item Sprache
\end{itemize}


\subsection{Zitat im Text mit Autorennamen im Text}

Hierbei wird bei der ersten Namensnennung der Quellenbezug hergestellt (also Jahr und Seite ausgegeben). Systemakzeptanz ist nach \citet[24]{Nielsen.1993} die grundlegende Frage dahingehend, ob ein System gut genug ist, um jeden erwarteten Nutzen und alle Anforderungen des Benutzers (und darüber hinaus gehender Stakeholder) zu befriedigen. Dabei unterteilt \citeauthor{Nielsen.1993} diese Akzeptanz in verschiedene Bereiche.

\subsection{Multi-Quellen-Zitate}

Dementsprechen wird für die Usability mit dem Fokus auf das Web, in der Literatur entsprechend der Begriff der Web Usability verwendet \citetext{vgl. z.~B. \citealp[146]{Matera.2006}; \citealp[xix]{Nielsen.et.al.2006}; \citealp[11]{Schweibenz.et.al.2003}}.

\subsection{Weiterführende Informationen}
Das Natbib Cheat Sheet findet sich bspw. unter \url{http://merkel.zoneo.net/Latex/natbib.php}.

\section{Abbildungen}

Abbildungen werden als PDF eingefügt. Dadurch sind Sie einfacher wartbar und die Chance, dass beim Export eine Vektorgrafik erstellt wird steigt gegenüber anderen Möglichkeiten. Jedes bessere Programm kann PDF exportieren (selbst MS Powerpoint) und ein PDF-Drucker wie doPDF versorgt die restlichen Programme. Die Position der Abbildung bestimmt LaTeX, nicht der Autor. Daher sollten Abbildungen so im Text genutzt werden, dass es egal ist, ob Sie an der geplanten Stelle, auf der selben Seite darüber, oder erst einzelne Seiten später plaziert wird.

Beispiel: Systemakzeptanz ist nach \citet[24]{Nielsen.1993} die grundlegende Frage dahingehend, ob ein System gut genug ist, um jeden erwarteten Nutzen und alle Anforderungen des Benutzers (und darüber hinaus gehender Stakeholder) zu befriedigen.  Dabei unterteilt \citeauthor{Nielsen.1993} diese Akzeptanz in verschiedene Bereiche (vgl. \autoref{fig:Nielsen_1993_Acceptability}).

%%%%%%%%%%%%%%%%%%% FIGURE %%%%%%%%%%%%%%%%%%%%%%
\begin{figure}
  	\centering{
			\includegraphics[width=.95\imagewidth,keepaspectratio=true]{zzz_exampleimage}
			\caption[System Akzeptanz nach \citeauthor{Nielsen.1993}]{System Akzeptanz nach \citet[25]{Nielsen.1993}}%
			\label{fig:Nielsen_1993_Acceptability}%
		}%
\end{figure}%
%%%%%%%%%%%%%%%%%%% FIGURE %%%%%%%%%%%%%%%%%%%%%%

\section{Weitere Funktionen}

Durch einen Glossar können Begriffe wie \gls{Pattern-Kategorie} referenziert werden. Und falls noch etwas zu tun ist, helfen die TODOs\todo{Hierfür noch eine Quelle}.

Listen wie zum Beginn können auch mit festem Einschub gesetzt werden:
\begin{description}[\setleftmargin{3.5cm}]
	\item[Merkmal]{Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.}
	\item[Ausprägung]{Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.}
\end{description}

Zusätzlich können natürlich Abkürzungen wie \acr{ui} eingeführt, oder wie bei \acrshort{b2c} trotz erstmaliger Verwendung kurzgeschrieben werden.

\chapter{FAQ}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{FAQ Design}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\subsection{Bei kursiver Schrift ist das "`a"' und das "`\&"' komisch}
\parExample{Normal: Systemakzeptanz \& Anwenderfreundlichkeit\par
Kursiv: \emph{Systemakzeptanz \& Anwenderfreundlichkeit}}
\textbf{Erläuterung:} Das tritt bei Serifenschrift auf und ist korrekt. Bei kursiver Schrift wird bspw. in MS Word oftmals einfach der normale Font schräg gestellt. In professionellen Systemen werden extra \emph{Schriftschnitte} erstellt. Die in dieser Vorlage bei Serifenschrift benutzte Schriftart ist "`Latin Modern"'. Hierbei existiert ein solcher Schriftschnitt. Da das kleine "`a"' und das Und-Zeichen "`\&"' in "`schräg"' aber sehr merkwürdig aussehen würden, sind Sie leicht anders entworfen.

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{FAQ Zitation}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\subsection{Im Literaturverzeichnis steht manchmal "`Auflage"' statt "`Aufl."'}
Das Literaturverzeichnis-Feld Auflage (bzw. Edition) sollte als Wert in aller Regel nur eine Zahl enthalten, bspw. "`3"'. Dann erstellt der Zitierstil je nach Sprache automatisch ein "`3. Aufl."' oder "`3\textsuperscript{rd} edn."'. In seltenen Fällen kann es sein, dass eine Zahl nicht korrekt ist (bspw. "`Reprint 2008"'). Sollte der Zitierstil keine Zahl finden, wird einfach der gesamte Inhalte des Feldes genutzt.


%%%%%%%%%%%%%%%%%%%%%%%% APPENDIX %%%%%%%%%%%%%%%%%%%%%%%
\appendix
\bibliography{zzz_example} % output Literature and use this file as bibtext catalogue
\printglossary
%\listoftodos
\end{document}