diff options
Diffstat (limited to 'Master/texmf-dist/source/latex/udesoftec/udesoftec-doc.tex')
| -rw-r--r-- | Master/texmf-dist/source/latex/udesoftec/udesoftec-doc.tex | 350 |
1 files changed, 202 insertions, 148 deletions
diff --git a/Master/texmf-dist/source/latex/udesoftec/udesoftec-doc.tex b/Master/texmf-dist/source/latex/udesoftec/udesoftec-doc.tex index 25578415ca8..df7dbb831c2 100644 --- a/Master/texmf-dist/source/latex/udesoftec/udesoftec-doc.tex +++ b/Master/texmf-dist/source/latex/udesoftec/udesoftec-doc.tex @@ -1,11 +1,28 @@ % !Mode:: "TeX:UTF-8" %% udesoftec-doc.tex -%% Copyright 2014 J. Peter M. Schuler -%% 2014/05/13 v1.3.8 udesoftec -\documentclass[omit-aen,omit-lof,omit-lot,omit-sd,final]{udesoftec} +%% Copyright 2013-2014 J. Peter M. Schuler +%% 2014/06/22 v1.4.2 udesoftec +\documentclass[omit-sd]{udesoftec} \usepackage{udesoftec-extra} -\usepackage{lipsum} +\usetikzlibrary{shadows} +\newcommand*\keystroke[1]{%from http://tex.stackexchange.com/questions/5226/keyboard-font-for-latex + \tikz[baseline=(key.base)] + \node[% + draw, + fill=white, + drop shadow={shadow xshift=0.15ex,shadow yshift=-0.15ex,fill=black,opacity=0.75}, + rectangle, + rounded corners=1pt, + inner sep=.5pt, + line width=0.5pt, + font=\scriptsize\sffamily + ](key){\strut{}#1};% +} + +\newcommand{\BibTeX}{BibTeX} + + \typeofdoc{Dokumentation zu} \title{udesoftec} @@ -27,9 +44,8 @@ \abstract{ This LaTeX package provides a documentclass for use in written theses at the University of Duisburg-Essen, Research Group for Business Informatics and Software Engineering. It is based on pdflatex and bibtex using KOMA-Script and natbib and many other popular packages. The current documentation is only available in german. However the \hyperref[sec:classoptions]{class options in section \ref*{sec:classoptions}} and \hyperref[sec:variables]{configuration variables for the titlepage in section \ref*{sec:variables}} should be quite understandable and the \hyperref[sec:paketlist]{package listing in the appendix} shows where to look for further information. A \hyperref[sec:exampleproject]{MWE and a download of an example project is also available in section \ref*{sec:exampleproject}.} - - -\section*{Installation} +} +\abstractEn{ Install with MikTeX or if using TeX Live (e.g. BasicTeX) with \lstinline!tlmgr! using the command mentioned in section \ref{sec:classinstall}. An alternative, in case you run into problems: just install the documentclass and bibstyle from ctan. Afterwards @@ -39,12 +55,10 @@ This LaTeX package provides a documentclass for use in written theses at the Uni \renewcommand{\udesoftecoverride}{ \renewcaptionname{ngerman}{\labelabstracttitle}{English summary for this document} + \renewcaptionname{english}{\labelabstracttitle}{Installation} } %%%%%%%%%%%%%%%%%%%%%%%% DOCUMENT %%%%%%%%%%%%%%%%%%%%%%%% -\begin{document} - - - +\begin{document} %%%%%%%%%%%%%%%%%%%%%%%%%%% METADATA %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \newacronym[description={User Interface, \entode{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} @@ -53,8 +67,8 @@ This LaTeX package provides a documentclass for use in written theses at the Uni %%%%%%%%%%%%%%%%%%%%%%%% 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. Dementsprechend wird über das Template hinaus eine eher spezifische Konfiguration der \LaTeX{}-Umgebung empfohlen. Ein paar Beispiele dafür: @@ -68,12 +82,12 @@ Dieses Template stellt eine professionelle Lösung für die Nutzung von \LaTeX{} \section{Beispiel-Projekt}\label{sec:exampleproject} Ein funktionierendes Dokument lässt sich durch folgendes Beispiel (MWE - minimum working example) erstellen: -\begin{lstlisting}[language={[LaTeX]TeX}] +\begin{lstlistinglatex}[label=lst:mwe,caption=Minimal Working Example für udesoftec] \documentclass{udesoftec} \begin{document} Inhalt \end{document} -\end{lstlisting} +\end{lstlistinglatex} Grundsätzlich sind kaum Einstellungen und Konfigurationen notwendig. Lediglich Dinge wie der Inhalt und die bib-Datenbank sind einzufügen. Ein Beispielprojekt mit echten Inhalten findet sich unter\newline \url{http://udue.de/udesoftecexample} @@ -91,59 +105,77 @@ Unter anderen Systemumgebungen funktioniert dieses Template natürlich genauso, Eine vollständige Konfigurationsanleitung für diese Software findet sich in \autoref{sec:software}. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\section{Klassenparameter und Konstanten} +\pagebreak\section{Klassenparameter und Konstanten} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \subsection{Optionen der Klasse}\label{sec:classoptions} -\begin{description}[leftmargin=2.5cm,style=sameline] +\begin{description}[leftmargin=2.75cm,style=sameline] + \item[proposal]{Bspw. für ein Exposé. Setzt alle omit-* Optionen.} + \item[final]{Deaktiviert einige Funktionen (bspw. TODOs) und beschleunigt einige Ausgaben.} \item[en]{Wechselt die primäre Dokumentsprache von Deutsch auf Englisch. Ändert einzelne Überschriften und andere sprachabhängige Labels.} \item[printlayout]{Wechselt auf doppelseitiges Druck-Layout ("`Buchlayout"') und Serien-Schrift. Nützlich, wenn die Arbeit ausgedruckt wird und beidseitiger Druck möglich ist. Kapitel beginnen auf rechten Seiten, dadurch werden Leerseiten eingefügt.} \item[confidential]{Erstellt einen Sperrvermerk, vgl. \autoref{sec:sperrvermerk}.} - \item[proposal]{Bspw. für ein Exposé. Setzt alle omit-* Optionen.} - \item[final]{Setzt die Standard-Werte für die omit-Optionen (nur omit-todos) und beschleunigt einige 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.} - \item[long-a]{Für deutsche Dokumente: Wenn die beiden Abstracts so lang sind, dass sie nicht auf eine Seite passen, fangen Sie jeweils auf einer neuen Seite an} - \item[omit-a]{Abstract entfernen.}s + \item[long-a]{Für deutsche Dokumente: Wenn die beiden Abstracts so lang sind, dass sie nicht auf eine Seite passen, fängt der englische auf einer neuen Seite an.} + \item[omit-a]{Abstract entfernen.} \item[omit-lot]{Tabellenverzeichnis entfernen.} \item[omit-lof]{Abbildungsverzeichnis entfernen.} \item[omit-loa]{Abkürzungsverzeichnis entfernen.} \item[omit-sd]{Eidesstattliche Versicherung entfernen.} \item[omit-toc]{Inhaltsverzeichnis entfernen.} \item[omit-todos]{TODO-Liste am Ende des Dokuments entfernen.} + \item[vawiessen]{Passt das Deckblatt an die Vorgaben von VAWi-Essen an.} + \item[vawibamberg]{Passt das Deckblatt an die Vorgaben von VAWi-Bamberg an.} \end{description} \subsection{Anpassen des Deckblatts}\label{sec:variables} -Neben den Paket-Optionen \lstinline!vawiessen! und \lstinline!vawibamberg! können die folgenden Kommandos vor dem \lstinline!\begin{document}! genutzt werden: - - \begin{multicols}{2} -\begin{itemize} - \item city -\item typeofdoc -\item academicfield -\item institution -\item semester -\item confidentialitySource -\item authorbox -\item entitle -\end{itemize} - \end{multicols} +Neben den Paket-Optionen \lstinlinelatex!vawiessen! und \lstinlinelatex!vawibamberg! können die folgenden Kommandos vor dem \lstinlinelatex!\begin{document}! genutzt werden: + +\begin{multicols}{2} + \begin{itemize} + \item \lstinlinelatex!\city! + \item \lstinlinelatex!\typeofdoc! + \item \lstinlinelatex!\academicfield! + \item \lstinlinelatex!\institution! + \item \lstinlinelatex!\semester! + \item \lstinlinelatex!\confidentialitySource! + \item \lstinlinelatex!\authorbox! + \item \lstinlinelatex!\entitle! + \end{itemize} +\end{multicols} Darüber hinaus gibt es natürlich noch die Standard-Kommandos: - \begin{multicols}{3} -\begin{itemize} -\item title -\item author -\item date -\end{itemize} - - \end{multicols} +\begin{multicols}{3} + \begin{itemize} + \item \lstinlinelatex!\title! + \item \lstinlinelatex!\author! + \item \lstinlinelatex!\date! + \end{itemize} +\end{multicols} Die Nutzung ist wie bei den Standard-LaTeX-Kommandos üblich: -\begin{lstlisting} +\begin{lstlistinglatex}[label=lst:configuration,caption=Beispiel für Konfigurations-Commandos für das Deckblatt] \title{Meine Bachelorarbeit} \entitle{My Bachelor Thesis} -\end{lstlisting} - +\author{Max Musterman} +\authorbox{ + \begin{tabularx}{.7\linewidth}{ll} + von: &Max Mustermann\\ + &Musterstrasse 123\\ + &12345 Musterstadt\\ + \\ + Gutacher: &Prof. Dr. Stefan Eicker\\ + &Prof. Dr. John Doe\\ + \\ + Betreuer: &Dipl.-Wirt.-Inf Some Body\\ + \\ + \end{tabularx} +}\end{lstlistinglatex} + +\subsection{Sperrvermerke}\label{sec:sperrvermerk} +Durch die Klassenoption \lstinlinelatex!confidential! wird der Sperrvermerk aktiviert und durch die Neudefinition des Firmennamens über den Befehl \lstinlinelatex!\confidentialitySource!, kann Sie entsprechend angepasst werden: +\begin{lstlistinglatex}[label=lst-confidentialitySource,caption=Sperrvermerke aktivieren] + \documentclass[confidential]{udesoftec} + \confidentialitySource{Name der Firma} +\end{lstlistinglatex} \chapter{Nutzung der Formatvorlage und übliche Kommandos} @@ -151,80 +183,82 @@ Die Nutzung ist wie bei den Standard-LaTeX-Kommandos üblich: Die häufigsten Zitationsarten sind hier vermerkt, eine komplette Liste der Möglichkeiten findet sich bspw. im \href{http://merkel.zoneo.net/Latex/natbib.php}{Natbib Cheat Sheet} -\subsection{Absatz-Zitate} +\subsection{Wörtliche Zitate eines Absatzes mit Quellenangabe} Zitate als Absätze machen vor allem bei vollständigen Aussagen oder umfangreichen Definitionen Sinn: - -\begin{lstlisting}[language={[LaTeX]TeX},morekeywords=citequotepar] +\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.} +\begin{lstlistinglatex}[label=lst:citequotepar,caption=Wörtliche Zitate eines vollständigen Absatzes mit Quellenangabe] \citequotepar[<Seite>]{<Quelle>}{<Text>} -\end{lstlisting} -\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.} +\end{lstlistinglatex} + +\subsection{Wörtliche Zitate im Fließtext mit Quellenangabe} + +Wörtliche Zitate im Fließtext machen vor allem bei kleineren Auszügen Sinn: +\parExample[Wörtliche Zitate im Fließtext mit Quellenangabe]{Die meisten Autoren sehen als Ausgangspunkt die Architektur: \citequote[xix]{Tidwell.2011}{The text that started it all dealt with physical buildings [\ldots]}} +\begin{lstlistinglatex}[label=lst:citequote,caption=Wörtliche Zitate im Fließtext mit Quellenangabe] +\citequote[<Seite>]{<Quelle>}{<Text>} +\end{lstlistinglatex} + \subsection{Quellenangaben im Fließtext} Für Quellenangaben im Fließtext wird folgende Variante genutzt: -\begin{lstlisting}[language={[LaTeX]TeX}] +\parExample[nicht-wörtliches Zitat]{Merkmale von Patterns sind bspw. Abstraktionsgrad, Domänenbezug und Sprache \cite[541]{Fettke.et.al.2009}.} +\begin{lstlistinglatex}[label=lst:cite,caption=Quellenangaben im Fließtext] \cite[<Seite>]{<Quelle>} -\end{lstlisting} -Merkmale von Patterns sind bspw. Abstraktionsgrad, Domänenbezug und Sprache \cite[541]{Fettke.et.al.2009}. +\end{lstlistinglatex} -\subsection{Quellenangaben und Autorennamen im Text} -\begin{lstlisting}[language={[LaTeX]TeX}] + +\subsection{Autorennamen im Text mit Quellenangabe} +Wenn der Autorenname im Text erwähnt wird, sollte dieser immer direkt auch die Jahresangabe (oder sogar Seitenzahl) für das Werk enthalten, da man in der Regel nicht wirklich den Autor erwähnt, sondern Aussagen oder Forschungsergebnisse der Person zu einem bestimmten Zeitpunkt. Theoretisch könnte man zuerst nur den Namen erwähnen und am Ende des Gedankenganges dann die Quelle, es ist aber zielführender die Quellenangabe und Autorenangabe nicht zu trennen: +\parExample[Autorennamen im Text mit Quellenangabe]{Systemakzeptanz ist nach \citet[24]{Nielsen.1993} die grundlegende Frage dahingehend, [...]. } +\begin{lstlistinglatex}[label=lst:citet,caption={Autorennamen im Text mit Quellenangabe}] \citet[<Seite>]{<Quelle>} -\end{lstlisting} -Systemakzeptanz ist nach \citet[24]{Nielsen.1993} die grundlegende Frage dahingehend, [...]. \par -\begin{lstlisting}[language={[LaTeX]TeX}] +\end{lstlistinglatex} +\parExample[Autorennamen im Text ohne Quellenangabe]{Dabei unterteilt \citeauthor{Nielsen.1993} diese Akzeptanz in verschiedene Bereiche.} +\begin{lstlistinglatex}[label=lst:citeauthor,caption={Autorennamen im Text ohne Quellenangabe}] \citeauthor{<Quelle>} -\end{lstlisting} -Dabei unterteilt \citeauthor{Nielsen.1993} diese Akzeptanz in verschiedene Bereiche. - +\end{lstlistinglatex}% \subsection{Mehrere Werke in Quellenangaben} -\begin{lstlisting}[language={[LaTeX]TeX}] -\citetext{<prefix>\citealp[<Seite1>]{<Quelle1>}...} -\end{lstlisting} -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}}. +Manchmal wird ein Gedanke durch mehrere unterschiedliche Quellen gestützt. Hier kann man folgendes Verfahren nutzen und bspw. als \lstinline!<prefix>! ein "`vgl. z.\ B."' nutzen: +\parExample[mehrere Werke in Quellenangabe]{Dementsprechend 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}}.} +\begin{lstlistinglatex}[label=lst:citealp,caption={Mehrere Werke in Quellenangaben}] +\citetext{<prefix>\citealp[<Seite>]{<Quelle>}; \citealp[<Seite2>]{<Quelle2>}...} +\end{lstlistinglatex} + \section{Abbildungen} -Abbildungen werden ausschließlkich als PDF eingefügt. Dadurch sind Sie einfacher wartbar und die Chance, dass beim Erstellen eine Vektorgrafik produziert wird steigt gegenüber anderen Vorgehensweisen. Jedes Programm kann grundsätzlich PDF exportieren (selbst MS Powerpoint) und ein PDF-Drucker wie \href{http://www.dopdf.com/de/}{doPDF} versorgt die restlichen Programme. +Abbildungen werden ausschließlich als PDF eingefügt. Dadurch sind Sie einfacher wartbar und die Chance, dass beim Erstellen eine Vektorgrafik produziert wird steigt gegenüber anderen Vorgehensweisen. Jedes Programm kann grundsätzlich PDF exportieren (selbst MS Powerpoint) und ein PDF-Drucker wie \href{http://www.dopdf.com/de/}{doPDF} versorgt die restlichen Programme. Im Gegensatz zur anderen Textprogrammen ist folgendes wichtig zu wissen: 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. - -\begin{lstlisting}[language={[LaTeX]TeX},morekeywords={\begin,\citeauthor,\autoref,\includegraphics,\imagewidth},breaklines=true] -Dabei unterteilt \citeauthor{Nielsen.1993} diese Akzeptanz in verschiedene Bereiche (vgl. \autoref{fig:Nielsen_1993_Acceptability}). - +\parExample[Abbildungen einfügen]{Dabei unterteilt \citeauthor{Nielsen.1993} die Akzeptanz in verschiedene Bereiche (vgl. \autoref{fig:Nielsen_1993_Acceptability}).} %%%%%%%%%%%%%%%%%%% FIGURE %%%%%%%%%%%%%%%%%%%%%% \begin{figure} -\centering{ - \includegraphics[width=.95\imagewidth,keepaspectratio=true]{udesoftec-doc-exampleimage} - \caption[System Akzeptanz nach \citeauthor{Nielsen.1993}]{System Akzeptanz nach \citet[25]{Nielsen.1993}}% - \label{fig:Nielsen_1993_Acceptability}% -}% + \centering{ + \includegraphics[width=.95\linewidth,keepaspectratio=true]{udesoftec-doc-exampleimage} + \caption[System Akzeptanz nach \citeauthor{Nielsen.1993}]{System Akzeptanz nach \citet[25]{Nielsen.1993}}% + \label{fig:Nielsen_1993_Acceptability}% + }% \end{figure}% %%%%%%%%%%%%%%%%%%% FIGURE %%%%%%%%%%%%%%%%%%%%%% -\end{lstlisting} -Dabei unterteilt \citeauthor{Nielsen.1993} diese Akzeptanz in verschiedene Bereiche (vgl. \autoref{fig:Nielsen_1993_Acceptability}). +\begin{lstlistinglatex}[label=lst:figure,caption={Abbildungen einfügen}] +Dabei unterteilt \citeauthor{Nielsen.1993} die Akzeptanz in verschiedene Bereiche (vgl. \autoref{fig:Nielsen_1993_Acceptability}). %%%%%%%%%%%%%%%%%%% FIGURE %%%%%%%%%%%%%%%%%%%%%% \begin{figure} - \centering{ - \includegraphics[width=.95\imagewidth,keepaspectratio=true]{udesoftec-doc-exampleimage} - \caption[System Akzeptanz nach \citeauthor{Nielsen.1993}]{System Akzeptanz nach \citet[25]{Nielsen.1993}}% - \label{fig:Nielsen_1993_Acceptability}% - }% + \centering{ + \includegraphics[width=.95\linewidth,keepaspectratio=true]{udesoftec-doc-exampleimage} + \caption[System Akzeptanz nach \citeauthor{Nielsen.1993}]{System Akzeptanz nach \citet[25]{Nielsen.1993}}% + \label{fig:Nielsen_1993_Acceptability}% + }% \end{figure}% %%%%%%%%%%%%%%%%%%% FIGURE %%%%%%%%%%%%%%%%%%%%%% +\end{lstlistinglatex} -\section{Sperrvermerke}\label{sec:sperrvermerk} -Durch die Klassenoption "`confidential"' wird der Sperrvermerk aktiviert und durch die Neudefinition des Firmennamens über den folgenden Befehl, kann Sie entsprechend angepasst werden: -\begin{lstlisting}[language={[LaTeX]TeX}] -\confidentialitySource{Name der Firma} -\end{lstlisting} -\section{Abkürzungen} +\section{Abkürzungen} Über das folgende Kommando können Abkürzungen angelegt werden: \begin{lstlisting}[language={[LaTeX]TeX},morekeywords={\newacronym}] \newacronym[<Erlaeuterung>]{<intern>}{<Abkuerzung>}{<Ausgeschrieben>} @@ -238,72 +272,83 @@ Als Wert für \lstinline!<intern>! hat sich die Kleinschreibung der Abkürzung b \acr{<intern>} oder \acrshort{<intern>} \end{lstlisting} Bspw.: Abkürzungen wie \acr{b2c} können eingeführt und danach kurz als \acr{b2c} genutzt werden, oder wie bei \acrshort{ui} trotz erstmaliger Verwendung kurzgeschrieben werden. - -\section{Aufzählungslisten unnummeriert} +\section{Aufzählungen} +\subsection{Aufzählungslisten unnummeriert} Beschreibungslisten können auch mit festem Einschub gesetzt werden: -\parExample{ +\parExample[Aufzählungslisten unummeriert]{ \begin{itemize} \item{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{Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.} \end{itemize} } -\begin{lstlisting}[language={[LaTeX]TeX}] +\begin{lstlistinglatex}[label=lst:itemize,caption={Aufzählungslisten unummeriert}] \begin{itemize}[leftmargin=3.5cm] \item{Lorem ipsum dolor...} \item{Stet clita kasd...} \end{itemize} -\end{lstlisting} +\end{lstlistinglatex} -\section{Aufzählungslisten nummeriert} +\subsection{Aufzählungslisten nummeriert} Nummerierte Aufzählungslisten sind auch möglich. +\parExample[Aufzählungslisten nummeriert]{ \begin{enumerate} \item{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{Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.} -\end{enumerate} -\begin{lstlisting}[language={[LaTeX]TeX}] +\end{enumerate}} +\begin{lstlistinglatex}[label=lst:enumerate,caption={Aufzählungslisten nummeriert}] \begin{enumerate} \item{Lorem ipsum dolor...} \item{Stet clita kasd...} \end{enumerate} -\end{lstlisting} +\end{lstlistinglatex} Für eine Anpassung der Form (beispielsweise aufzählen mit Buchstaben, Text vor den Zahlen etc.) sei auf die \lstinline!\label!-Option verwiesen, die bspw. unter \url{http://de.wikibooks.org/wiki/LaTeX-Wörterbuch:_enumitem} erklärt ists. -\section{Merkmal-Aufzählungen mit festem Einschub} +\subsection{Merkmal-Aufzählungen mit festem Einschub} Beschreibungslisten können auch mit festem Einschub gesetzt werden: +\parExample[Merkmal-Aufzählungen mit festem Einschub]{ \begin{description}[leftmargin=2.5cm,style=sameline] \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[Element]{Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.} -\end{description} -\begin{lstlisting}[language={[LaTeX]TeX}] +\end{description}} +\begin{lstlistinglatex}[label=lst:desc-sameline,caption={Merkmal-Aufzählungen mit festem Einschub}] \begin{description}[leftmargin=2.5cm,style=sameline] \item[Merkmal]{Lorem ipsum dolor...} \item[Element]{Stet clita kasd...} \end{description} -\end{lstlisting} +\end{lstlistinglatex} -\section{Merkmal-Aufzählungen mit Umbruch} +\subsection{Merkmal-Aufzählungen mit Umbruch} Beschreibungslisten können auch mit festem Umbruch gesetzt werden: +\parExample[Merkmal-Aufzählungen mit Umbruch]{ \begin{description}[style=nextline] \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[Element]{Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.} -\end{description} -\begin{lstlisting}[language={[LaTeX]TeX}] +\end{description}} +\begin{lstlistinglatex}[label=lst:desc-nextline,caption={Merkmal-Aufzählungen mit Umbruch}] \begin{description}[style=nextline] \item[Merkmal]{Lorem ipsum dolor...} \item[Element]{Stet clita kasd...} \end{description} -\end{lstlisting} +\end{lstlistinglatex} \section{TODOs} -Über \lstinline!\todo{<Text>}! und \lstinline!\inlinetodo{<Text>}! gibt es die Möglichkeit TODOs zu verwalten. \inlinetodo{Diese können innerhalb des Textes stehen wie hier.} Aber Sie können auch am Rand \todo{Absatz überarbeiten} stehen. Am Ende des Dokuments wird eine Gesamtliste angefügt, sofern ein TODO existiter und das Dokument nicht mit der Option \lstinline!final! oder \lstinline!omit-todos! kompiliert wird. +Über \lstinlinelatex!\todo{<Text>}! und \lstinlinelatex!\inlinetodo{<Text>}! gibt es die Möglichkeit TODOs zu verwalten. \inlinetodo{TODO: Diese können innerhalb des Textes stehen wie hier.} Aber Sie können auch am Rand stehen und auf eine bestimmte Stelle im Text\todo{TODO: Absatz überarbeiten} zeigen. Am Ende des Dokuments wird eine Gesamtliste angefügt, sofern ein TODO existiter und das Dokument nicht mit der Option \lstinlinelatex!final! oder \lstinlinelatex!omit-todos! kompiliert wird. \chapter{FAQ} -\section{Bei kursiver Serifenschrift ist das "`a"' und das "`\&"' komisch} -Das tritt bei Serifenschrift (also mit der Option "`printlayout"') 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{Bei kursiver Schrift ist das "`a"' komisch} +Das 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 benutzte Schriftart ist \sfdefault{} (screenlayout) sowie \rmdefault{} (printlayout). Hierbei existiert ein solcher Schriftschnitt. Da das kleine "`a"' in "`schräg"' aber sehr merkwürdig aussehen würden, sind Sie leicht anders entworfen. Bei anderen Schriften kann dies bspw. auch das \&-Zeichen betreffen. +\parExample[unterschiedliche Schriftschnitte]{ +\begin{tabularx}{\linewidth}{ll} +Screenlayout normal:& \textsf{Schriften \& anderes}\\ +Screenlayout kursiv:& \textsf{\emph{Schriften \& anderes}}\\ +Printlayout normal:& \textrm{Schriften \& anderes}\\ +Printlayout kursiv:& \textrm{\emph{Schriften \& anderes}}\\ +\end{tabularx} +} \section{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. +Das \BibTeX-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. Folglich wäre "`Aufl."' das richtige Verhalten und wenn stattdessen "`Auflage"' steht, sollte der \BibTeX{}- bzw. Citavi-Eintrag angepasst werden. \section{LaTeX Error: File `udesoftec-cover-ude-de' not found.} Anscheinend kann die \TeX{}-Distribution die Cover-Dateien nicht finden. Das lässt auf eine veraltete Version der Klasse schließen. In diesem Fall (nach einem Update der packages)einfach das passende Cover von der \href{http://mirror.ctan.org/macros/latex/contrib/udesoftec}{Paket-Seite auf CTAN} heruntergeladen und in den selben Ordner wie die Hauptdatei des Projektes (z.B. \lstinline!main.tex!) gelegt werden. @@ -329,25 +374,31 @@ vgl. \autoref{sec:classinstall} nutzen. \def\chapterAuthor{ } \chapter{Appendix} \section{Installation und Konfiguration der Software}\label{sec:software} - -\subsection{LaTeX-Umgebung: MikTeX (Windows) oder BasicTeX (OSX)}\label{sec:classinstall} +Grundsätzlich wird immer empfohlen Updates für die Software-Pakete einzuspielen. Sollte sich die Ausgabe verändern, bspw. weil udesoftec neue Features erhält finden Sie in \autoref{sec:updateinstructions} und im \hyperref[sec:changelog]{ChangeLog} entsprechende Hinweise wie das Dokument anzupassen ist. Es steht ein \href{http://pipes.yahoo.com/jpmschuler/udesoftec?_render=rss}{RSS-Feed} zur Verfügung, der auf neue Versionen hinweist. + +\subsection{LaTeX-Umgebung: MikTeX (Windows), BasicTeX (OSX)}\label{sec:classinstall} Unter Windows wird ausdrücklich \href{http://miktex.org}{MikTeX} empfohlen, da dieses selbständig und On-Demand fehlende Dinge nachinstalliert. Unter MacOS kann beispielsweise ein minimales \TeX{}-Live-System wie \href{http://tug.org/mactex/morepackages.html}{BasicTeX} genutzt werden. Die notwendigen Pakete lassen sich wie folgt installieren: -\begin{lstlisting}[language=bash,breaklines=true] -sudo tlmgr install udesoftec chngcntr hyphenat nag footmisc placeins advdate expdlist todonotes type1cm wallpaper marginnote glossaries xfor datatool substr varwidth collection-fontsrecommended tikz mdframed libertine cm-super helvetic ec bookmark -\end{lstlisting} +\begin{lstlisting}[label=lst:tlmgr,caption={Paket-Installation der Documentclass und ihrer Abhängigkeiten},language=bash,breaklines=true,morekeywords={sudo},emph={tlmgr,install,update,--self,--all}, + keywordstyle=\color{DocumentDark4}, + emphstyle=\color{DocumentDark1}] +sudo tlmgr update --self +sudo tlmgr update --all +sudo tlmgr install udesoftec nag chngcntr hyphenat libertine mweights fontaxes footmisc placeins enumitem todonotes wallpaper marginnote mdframed needspace csquotes glossaries xfor datatool substr +\end{lstlisting} + Sollte es zu Problemen kommen, sollten die Fehlermeldungen und die \hyperref[sec:paketlist]{Liste der Pakete im Anhang} genügend Informationen bieten. \subsection{Citavi} -Citavi erlaubt nur noch manuelle BibTeX-Exporte, die \href{http://support.citavi.de/forum/viewtopic.php?f=156&t=7295&p=24152}{Funktion für automatischen Export ist entfernt worden}. Der Export funktioniert einfach über das Datei Menü (\href{http://www.citavi.com/sub/manual4/de/exporting_to_bibtex.html}{Anleitung zum BibTeX-Export in der Citavi-Hilfe}). +Citavi erlaubt nur noch manuelle \BibTeX-Exporte, die \href{http://support.citavi.de/forum/viewtopic.php?f=156&t=7295&p=24152}{Funktion für automatischen Export ist entfernt worden}. Der Export funktioniert einfach über das Datei Menü (\href{http://www.citavi.com/sub/manual4/de/exporting_to_bibtex.html}{Anleitung zum \BibTeX-Export in der Citavi-Hilfe}). \subsection{Sumatra PDF} \href{http://blog.kowalczyk.info/software/sumatrapdf/download-free-pdf-viewer-de.html}{SumatraPDF} herunterladen (Portable Version genügt, am besten direkt neben die TeXnixCenter.exe legen). \subsection{TeXnicCenter} -Die aktuelle Version ist \href{http://www.texniccenter.org/}{TeXnicCenter 2.02 }. +Die aktuelle Version ist \href{http://www.texniccenter.org/}{TeXnicCenter 2.02}. Im TeXnicCenter unter Ausgabeprofile (Ausgabe -> Ausgabeprofile definieren) das vorhandene PDF-Profil (pdflatex) kopieren und die Kopie wie beschrieben anpassen um folgende Dinge zu erreichen:~\par \begin{enumerate} @@ -363,8 +414,8 @@ Im TeXnicCenter unter Ausgabeprofile (Ausgabe -> Ausgabeprofile definieren) das Im Ausgabeprofil im Karteireiter (La)TeX:~\par \begin{itemize} \item Argumente für Compiler: - \par\lstinline!-src-specials -synctex=1 -aux-directory .tmp -output-format pdf! - \par\lstinline!-interaction=nonstopmode %Wm! + \par\lstinline!-src-specials -synctex=1 -aux-directory .tmp -output-format ! + \par\lstinline!pdf -interaction=nonstopmode %Wm! \item Argumente für BibTex: \lstinline!"\%dm/.tmp/%tm"! \item Argumente für MakeIndex: \lstinline!".tmp/%tm.tex"! \end{itemize} @@ -386,7 +437,8 @@ Im Ausgabeprofil im Karteireiter Nachbearbeitung einen neuen Postprozessoren anl \begin{itemize} \item Pfad der Anwendung: \par\lstinline!<Pfad zu Sumatra>\SumatraPDF.exe -inverse-search! - \par\lstinline!"\"<Pfad zu TeXnicCenter>\TeXnicCenter.exe\" /ddecmd \"[goto('%f','%l')]\""! + \par\lstinline!"\"<Pfad zu TeXnicCenter>\TeXnicCenter.exe\"! + \par\lstinline!/ddecmd \"[goto('%f','%l')]\""! \item Projektausgabe betrachten:~\par [X] Kommandozeile, Kommando: \lstinline!"%bm.pdf"! \item Suche in Ausgabe:~\par [X] DDE-Kommando, Server: \lstinline!SUMATRA!, Thema: \lstinline!control! \par Kommando: \lstinline![ForwardSearch("\%bm.pdf","\%Wc",\%l,0,0,1)]! @@ -397,24 +449,25 @@ Im Ausgabeprofil im Karteireiter Nachbearbeitung einen neuen Postprozessoren anl Nun das \hyperref[sec:exampleproject]{Beispielprojekt oder das Minimal Working Example} öffnen und einmal rendern lassen, dadurch sollten alle benötigten Pakete automatisch installiert werden. -Im TeXnicCenter mit Strg+Alt+R die "`Erstellung Ergebnis"'-Ansicht anzeigen lassen, diese fasst die LaTeX-Kompiler-Ausgaben sinnvoll zusammen. +Im TeXnicCenter mit \keystroke{Strg}+\keystroke{Alt}+\keystroke{R} die "`Erstellung Ergebnis"'-Ansicht anzeigen lassen, diese fasst die LaTeX-Kompiler-Ausgaben sinnvoll zusammen. \unnumberedsection{Zusätzliche Dateiendungen für das Aufräumen angeben} - Im TeXnicCenter unter Optionen und Aufräumen neue Dateiendungen hinzufügen (Aktion: löschen; [X] Unterverzeichnisse einbeziehen und als Pattern jeweils)~\par + Im TeXnicCenter unter Optionen und Aufräumen neue Dateiendungen hinzufügen (Aktion: löschen):~\par \begin{multicols}{3} \begin{itemize} - \item *.synctex.gz - \item *.acn - \item *.acr - \item *.alg - \item *.glg - \item *.glo - \item *.gls - \item *.ist - \item *.pdfsync + \item \lstinline!*.synctex.gz! + \item \lstinline!*.acn! + \item \lstinline!*.acr! + \item \lstinline!*.alg! + \item \lstinline!*.glg! + \item \lstinline!*.glo! + \item \lstinline!*.gls! + \item \lstinline!*.ist! + \item \lstinline!*.pdfsync! \end{itemize} \end{multicols} + Zusätzlich für alle "`löschen"'-Aktionen "` Unterverzeichnisse einbeziehen auswählen. @@ -422,42 +475,46 @@ Im TeXnicCenter mit Strg+Alt+R die "`Erstellung Ergebnis"'-Ansicht anzeigen lass \section{Update Instructions}\label{sec:updateinstructions} This documentclass is as downwards compatible as possible. Any change in the version number according the third digit (e.g. from 1.2.1 to 1.2.8) creates no compile or display errors. Some changes however cannot be catched, so that in case of major version changes some LaTeX errors and warnings may occure. The following list shows some changes to the document one should do in order to remove the errors and warnings. + +\subsection{Update to 1.4.0} +Removed many packages and removed some deprecated commands. Might raise problems with custom loaded packages or if e.g. \ctanlink{verbatim}-commands were used instead of \ctanlink{lstlisting}-commands. + +\subsection{Update to 1.3.8} +Added abstract as default, so fill values \lstinlinelatex!\abstract! and perhabs \lstinlinelatex!\abstractEn!. + \subsection{Update to 1.3.0} \begin{description}[style=nextline] - \item[Change in document configuration sets main page to default values]{All configuration labels like \lstinline!\def \institution{University of Duisburg-Essen}! are not working anymore and need to be replaced with real commands like \lstinline!\institution{University of Duisburg-Essen}!. } - \item[Error: Undefied control sequence - Package enumitem]{Happens while using \lstinline!\begin{description}[\breaklabel]!. \newline{} Due to a new package the option is now "`style=nextline"', so use\newline{} \lstinline!\begin{description}[style=nextline]! instead. + \item[Change in document configuration sets main page to default values]{All configuration labels like \lstinlinelatex!\def \institution{Name}! are not working anymore and need to be replaced with real commands like \lstinlinelatex!\institution{Name}!. } + \item[Error: Undefied control sequence - Package enumitem]{Happens while using \lstinlinelatex!\begin{description}[\breaklabel]!. \newline{} Due to a new package the option is now \lstinlinelatex!style=nextline!, so use\newline{} \lstinlinelatex!\begin{description}[style=nextline]! instead. -Happens while using \lstinline!\begin{description}[\setleftmargin{1.5cm}]]!.\newline{} Due to a new package the option is now "`leftmargin=1,5cm"', so use\newline{} \lstinline!\begin{description}[leftmargin=1.5cm,style=sameline]! instead. +Happens while using \lstinlinelatex!\begin{description}[\setleftmargin{1.5cm}]]!.\newline{} Due to a new package the option is now \lstinlinelatex!leftmargin=1.5cm!, so use\newline{} \lstinlinelatex!\begin{description}[leftmargin=1.5cm,style=sameline]! instead. } \end{description} \subsection{Update to 1.2.1} -\lstinline!\printacronyms! not necessary any more - the documentclass takes care of this. +\lstinlinelatex!\printacronyms! not necessary any more - the documentclass takes care of this. \section{List of used packages}\label{sec:paketlist} -The base documentclass is \emph{scrbook}, which is part of KOMA-Script. Other used packages: +The base documentclass is \emph{scrbook}, which is part of \ctanlink{koma-script}. Other used packages (with link to CTAN to access documentation): \begin{multicols}{4} \begin{itemize}[labelindent=0px,itemindent=0em,leftmargin=1em] \item \ctanlink{babel} \item \ctanlink{chngcntr} \item \ctanlink{enumitem} -\item \ctanlink{fix-cm} \item \ctanlink{fixltx2e} \item \ctanlink{fontenc} \item \ctanlink{footmisc} \item \ctanlink{geometry} \item \ctanlink{glossaries} \item \ctanlink{graphicx} -\item \ctanlink{helvet} \item \ctanlink{hypcap} \item \ctanlink{hyperref} \item \ctanlink{hyphenat} \item \ctanlink{inputend} \item \ctanlink{libertine} \item \ctanlink{listings} -\item \ctanlink{lmodern} \item \ctanlink{marginnote} \item \ctanlink{mdframed} \item \ctanlink{microtype} @@ -467,22 +524,19 @@ The base documentclass is \emph{scrbook}, which is part of KOMA-Script. Other us \item \ctanlink{ragged2e} \item \ctanlink{scrhack} \item \ctanlink{scrpage2} -\item \ctanlink{setspace} \item \ctanlink{tabularx} \item \ctanlink{tikz} \item \ctanlink{todonotes} -\item \ctanlink{type1cm} -\item \ctanlink{verbatim} \item \ctanlink{wallpaper} \item \ctanlink{xcolor} \end{itemize} \end{multicols} -\section{Changelog} +\clearpage\section{Changelog}\label{sec:changelog} +An \href{http://pipes.yahoo.com/jpmschuler/udesoftec?_render=rss}{RSS feed} is available to annouce new versions of udesoftec. \begingroup - \fontsize{8pt}{10pt}\selectfont - \verbatiminput{CHANGELOG.} + \lstinputlisting[backgroundcolor={},frame=none,nolol,breaklines=true]{CHANGELOG.} \endgroup \bibliography{udesoftec-doc-examplebib} % output Literature and use this file as bibtext catalogue |