summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/udesoftec
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2013-08-14 22:34:56 +0000
committerKarl Berry <karl@freefriends.org>2013-08-14 22:34:56 +0000
commit1b49b1bc8a4f1240f4fa998121c744c22e70d65b (patch)
treecf33fe88cd31d95d77eb95fb20bd3959b1a168eb /Master/texmf-dist/doc/latex/udesoftec
parentdf137cab5b91cd4f845b6a3f27545d963298be75 (diff)
udesoftec (14aug13)
git-svn-id: svn://tug.org/texlive/trunk@31431 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/udesoftec')
-rw-r--r--Master/texmf-dist/doc/latex/udesoftec/CHANGELOG18
-rw-r--r--Master/texmf-dist/doc/latex/udesoftec/README6
-rw-r--r--Master/texmf-dist/doc/latex/udesoftec/VERSION2
-rw-r--r--Master/texmf-dist/doc/latex/udesoftec/udesoftec-doc-examplebib.bib8
-rw-r--r--Master/texmf-dist/doc/latex/udesoftec/udesoftec-doc.pdfbin228358 -> 467348 bytes
-rw-r--r--Master/texmf-dist/doc/latex/udesoftec/udesoftec-doc.tex92
-rw-r--r--Master/texmf-dist/doc/latex/udesoftec/udesoftec-extra.sty39
7 files changed, 136 insertions, 29 deletions
diff --git a/Master/texmf-dist/doc/latex/udesoftec/CHANGELOG b/Master/texmf-dist/doc/latex/udesoftec/CHANGELOG
index c51e4bfda61..e87d5111994 100644
--- a/Master/texmf-dist/doc/latex/udesoftec/CHANGELOG
+++ b/Master/texmf-dist/doc/latex/udesoftec/CHANGELOG
@@ -1,3 +1,21 @@
+2013/08/14
+* added udesoftec.tds.zip to support other TeX Collections
+* removed problem with umlauts in lstlisting-env
+* added (currently emtpy udesoftec-extra.sty, for easier
+ updating in case of changed behaviour
+* improved documentation
+* improved \parExample and \citequotepar
+* added classoption omit-loa
+* added classoption omit-todos
+* added \printglossaries, \printacronyms and \listoftodos to
+ \AtBeginDocument and \AtEndDocument for convenience (i.e.
+ they aren't necessary in the document anymore)
+* made \listoftodos conditional
+* correct bibstyle "lastaccessed" format
+* added additional sections to manual with more examples
+* english cover wasn't found due to wrong filename referenced
+* option for confidentially clause now available
+
2013/07/09
* added version number
* updated cover page line spacing
diff --git a/Master/texmf-dist/doc/latex/udesoftec/README b/Master/texmf-dist/doc/latex/udesoftec/README
index 20a6ec9f0be..8b6b70a0266 100644
--- a/Master/texmf-dist/doc/latex/udesoftec/README
+++ b/Master/texmf-dist/doc/latex/udesoftec/README
@@ -2,7 +2,7 @@ ude-softec documentclass and bibstyle
Maintainer: J. Peter M. Schuler
Copyright: 2013 J. Peter M. Schuler
-Version: 2013-07-09 v1.1 udesoftec
+Version: 2013-08-14 v1.2 udesoftec
License: lppl
Topic: dissertation
@@ -20,12 +20,14 @@ Description:
give sufficient information for everybody familiar with TeX.
Installation:
+ Use the udesoftec.tds.zip or alternatively:
udesoftec.bst and udesoftec.cls are installed as always.
The files matching udesoftec-cover*.* should be placed next to the
- documentclass udesoftec.cls
+ documentclass udesoftec.cls.
e.g.:
texmf/tex/latex/udesoftec/udesoftec.cls
+ texmf/tex/latex/udesoftec/udesoftec-extra.sty
texmf/tex/latex/udesoftec/udesoftec-cover-uba.pdf
texmf/tex/latex/udesoftec/udesoftec-cover-ude-de.pdf
texmf/tex/latex/udesoftec/udesoftec-cover-ude-en.pdf
diff --git a/Master/texmf-dist/doc/latex/udesoftec/VERSION b/Master/texmf-dist/doc/latex/udesoftec/VERSION
index 9a7a7eb84e1..75d385422b0 100644
--- a/Master/texmf-dist/doc/latex/udesoftec/VERSION
+++ b/Master/texmf-dist/doc/latex/udesoftec/VERSION
@@ -1 +1 @@
-2013-07-09 v1.1 udesoftec \ No newline at end of file
+2013-08-14 v1.2 udesoftec \ No newline at end of file
diff --git a/Master/texmf-dist/doc/latex/udesoftec/udesoftec-doc-examplebib.bib b/Master/texmf-dist/doc/latex/udesoftec/udesoftec-doc-examplebib.bib
index 921109f5516..f8c998dfa55 100644
--- a/Master/texmf-dist/doc/latex/udesoftec/udesoftec-doc-examplebib.bib
+++ b/Master/texmf-dist/doc/latex/udesoftec/udesoftec-doc-examplebib.bib
@@ -59,16 +59,16 @@
isbn = {978-3-540-41371-4}
}
-
@article{Fettke.et.al.2009,
author = {Fettke, Peter and Loos, Peter},
year = {2009},
- title = {Morgenstern, Adendstern und Venus - Zum Gebruach der Wörter Referenzmodell und Pattern},
- pages = {540–541},
+ title = {Patterns in der Wirtschaftsinformatik: Morgenstern, Adendstern und Venus - Zum Gebrauch der W{\"o}rter {\dq}Referenzmodell{\dq} und {\dq}Pattern{\dq}},
+ journal = {WIRTSCHAFTSINFORMATIK},
+ pages = {540--541},
volume = {51},
number = {6},
issn = {0937-6429},
- journal = {WIRTSCHAFTSINFORMATIK}
+ doi = {10.1007/s11576-009-0195-5}
}
@book{Nielsen.1993,
diff --git a/Master/texmf-dist/doc/latex/udesoftec/udesoftec-doc.pdf b/Master/texmf-dist/doc/latex/udesoftec/udesoftec-doc.pdf
index f1ea9f3040c..fd552fe8183 100644
--- a/Master/texmf-dist/doc/latex/udesoftec/udesoftec-doc.pdf
+++ b/Master/texmf-dist/doc/latex/udesoftec/udesoftec-doc.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/udesoftec/udesoftec-doc.tex b/Master/texmf-dist/doc/latex/udesoftec/udesoftec-doc.tex
index b4dde6830cb..f0f2ee2960e 100644
--- a/Master/texmf-dist/doc/latex/udesoftec/udesoftec-doc.tex
+++ b/Master/texmf-dist/doc/latex/udesoftec/udesoftec-doc.tex
@@ -1,12 +1,12 @@
% !Mode:: "TeX:UTF-8"
-\documentclass[screenlayout,omit-lof,omit-lot,final]{udesoftec}
+\documentclass[screenlayout,omit-lof,omit-lot]{udesoftec}
\title{Latex-Formatvorlage für Qualifikationsarbeiten}
\subtitle{am Lehrstuhl für Wirtschaftsinformatik und Softwaretechnik}
\author{Max Mustermann}
\def \entitle{[\hyperref[sec:abstract]{English summary available}]}
\def \city{Essen}
-\def \typeofdoc{}
+\def \typeofdoc{Dokumentation zur}
\def \labelPreTopic{}
\def \institution{Universität Duisburg-Essen}
\def \semester{}
@@ -26,8 +26,8 @@
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]{paket listing in the appendix} shows where to look for further information.
\section*{Installation}
- Install with MikTeX or TeX Live's \verb+tlmgr+.\par
- udesoftec.bst and udesoftec.cls are installed as always. The files matching \verb+udesoftec-cover*.*+ should be placed next to the
+ Install with MikTeX or TeX Live's \lstinline!tlmgr!.\par
+ udesoftec.bst and udesoftec.cls are installed as always. The files matching \newline\lstinline!udesoftec-cover*.*! should be placed next to the
documentclass, e.g.:
\begin{itemize}
\item texmf/tex/latex/udesoftec/udesoftec.cls
@@ -47,7 +47,7 @@ This LaTeX package provides a documentclass for use in written theses at the Uni
\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}}
-\printacronyms
+
%%%%%%%%%%%%%%%%%%%%%%%% CONTENT %%%%%%%%%%%%%%%%%%%%%%%
\mainmatter
@@ -104,9 +104,9 @@ Unter Windows wird ausdrücklich MikTeX empfohlen, da dieses selbständig und On
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
+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
\end{lstlisting}
-Sollte es zu Problemen kommen sollten die Fehlermeldungen und die \hyperref[sec:paketlist]{Liste der Pakete im Anhang} genügend Informationen bieten.
+Sollte es zu Problemen kommen, sollten die Fehlermeldungen und die \hyperref[sec:paketlist]{Liste der Pakete im Anhang} genügend Informationen bieten.
\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).
@@ -201,8 +201,12 @@ Im TeXnicCenter mit Strg+Alt+R die "`Erstellung Ergebnis"'-Ansicht anzeigen lass
\item[en]{Wechselt die 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[omit-loa]{Abkürzungsverzeichnis entfernen (für Test-Ausgaben).}
+ \item[omit-todos]{TODO-Liste am Ende des Dokuments entfernen.}
+ \item[final]{Setzt die Standard-Werte für die omit-Optionen.}
\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[confidential]{Erstellt einen Sperrvermerk, vgl. \autoref{sec:sperrvermerk}.}
\end{description}
\subsection{Anpassen des Deckblatts}\label{sec:variables}
@@ -217,7 +221,7 @@ Neben den Paket-Optionen \lstinline!vawiessen! und \lstinline!vawibamberg! könn
\item semester
\item confidentialitySource
\item authorbox
-\item enttitle
+\item entitle
\end{itemize}
\end{multicols}
Die Nutzung ist wie bei LaTeX üblich:
@@ -247,7 +251,7 @@ Die häufigsten Zitationsarten sind hier vermerkt, eine komplette Liste der Mög
\subsection{Absatz-Zitate}
-\begin{lstlisting}
+\begin{lstlisting}[language={[LaTeX]TeX},morekeywords=citequotepar]
\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
@@ -255,23 +259,23 @@ A Pattern Language and its companion book The Timeless Way of Building establish
concept of patterns and described a 250-pattern multilayered pattern language.}
\subsection{Zitat im Text}
-\begin{lstlisting}
+\begin{lstlisting}[language={[LaTeX]TeX}]
\cite[<Seite>]{<Quelle>}
\end{lstlisting}
Merkmale von Patterns sind bspw. Abstraktionsgrad, Domänenbezug und Sprache \cite[541]{Fettke.et.al.2009}.
\subsection{Zitat im Text mit Autorennamen im Text}
-\begin{lstlisting}
+\begin{lstlisting}[language={[LaTeX]TeX}]
\citet[<Seite>]{<Quelle>}
\end{lstlisting}
Systemakzeptanz ist nach \citet[24]{Nielsen.1993} die grundlegende Frage dahingehend, [...]. \par
-\begin{lstlisting}
+\begin{lstlisting}[language={[LaTeX]TeX}]
\citeauthor{<Quelle>}
\end{lstlisting}
Dabei unterteilt \citeauthor{Nielsen.1993} diese Akzeptanz in verschiedene Bereiche.
\subsection{Multi-Quellen-Zitate}
-\begin{lstlisting}
+\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}}.
@@ -282,7 +286,7 @@ Abbildungen werden ausschließlkich als PDF eingefügt. Dadurch sind Sie einfach
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=TeX,basicstyle=\scriptsize,emph={\begin,\citeauthor,\autoref},breaklines=true]
+\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}).
%%%%%%%%%%%%%%%%%%% FIGURE %%%%%%%%%%%%%%%%%%%%%%
@@ -308,18 +312,58 @@ Dabei unterteilt \citeauthor{Nielsen.1993} diese Akzeptanz in verschiedene Berei
\end{figure}%
%%%%%%%%%%%%%%%%%%% FIGURE %%%%%%%%%%%%%%%%%%%%%%
-\section{Weitere Funktionen}
+\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}]
+\def \confidentialitySource{Name der Firma}
+\end{lstlisting}
+
+\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>}
+\end{lstlisting}
+Als Wert für \lstinline!<intern>! hat sich die Kleinschreibung der Abkürzung bewährt, also bspw.:
+\begin{lstlisting}[language={[LaTeX]TeX},morekeywords={\newacronym}]
+\newacronym{din}{DIN}{Deutsches Institut für Normung}
+\end{lstlisting}
+Über die folgenden Kommandos können Abkürzungen genutzt werden, wobei \lstinline!\acr! bei erster Verwendung ausschreibt:
+\begin{lstlisting}[language={[LaTeX]TeX},morekeywords={\acr,\acrshort}]
+\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.
-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:
+\section{Aufzählungen mit festem Einschub}
+Beschreibungslisten 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[Element]{Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.}
+\end{description}
+\begin{lstlisting}[language={[LaTeX]TeX},morekeywords={\setleftmargin}]
\begin{description}[\setleftmargin{3.5cm}]
+ \item[Merkmal]{Lorem ipsum dolor...}
+ \item[Element]{Stet clita kasd...}
+\end{description}
+\end{lstlisting}
+
+\section{Aufzählungen mit Umbruch}
+Beschreibungslisten können auch mit festem Umbruch gesetzt werden:
+\begin{description}[\breaklabel]
\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.}
+ \item[Element]{Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.}
\end{description}
+\begin{lstlisting}[language={[LaTeX]TeX},morekeywords={\breaklabel}]
+\begin{description}[\breaklabel]
+ \item[Merkmal]{Lorem ipsum dolor...}
+ \item[Element]{Stet clita kasd...}
+\end{description}
+\end{lstlisting}
-Zusätzlich können natürlich Abkürzungen wie \acr{b2c} eingeführt, oder wie bei \acrshort{ui} trotz erstmaliger Verwendung kurzgeschrieben werden.
+\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.
\chapter{FAQ}
\section{Bei kursiver Serifenschrift ist das "`a"' und das "`\&"' komisch}
@@ -375,16 +419,20 @@ Die genutzte Klasse ist \emph{scrbook}, die Bestandteil von KOMA-Script ist. Wei
\item hyperref
\item hypcap
\item glossaries
+ \item verbatim
\item multicol
\item listings
\item scrhack
- \item varwidth
+ \item tikz
+ \item mdframed
+ \item libertine
\end{itemize}
\end{multicols}
\section{Changelog}
+\begingroup
+ \fontsize{8pt}{10pt}\selectfont
\verbatiminput{CHANGELOG.}
+\endgroup
\bibliography{udesoftec-doc-examplebib} % output Literature and use this file as bibtext catalogue
-\printglossary
-\listoftodos
\end{document} \ No newline at end of file
diff --git a/Master/texmf-dist/doc/latex/udesoftec/udesoftec-extra.sty b/Master/texmf-dist/doc/latex/udesoftec/udesoftec-extra.sty
new file mode 100644
index 00000000000..7ed372154cc
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/udesoftec/udesoftec-extra.sty
@@ -0,0 +1,39 @@
+% !Mode:: "TeX:UTF-8"
+%% udesoftec.cls
+% Copyright 2013 J. Peter M. Schuler
+% 2013-08-14 v1.2 udesoftec
+%
+% This work may be distributed and/or modified under the
+% conditions of the LaTeX Project Public License, either version 1.3
+% of this license or (at your option) any later version.
+% The latest version of this license is in
+% http://www.latex-project.org/lppl.txt
+% and version 1.3 or later is part of all distributions of LaTeX
+% version 2005/12/01 or later.
+%
+% This work has the LPPL maintenance status `maintained'.
+%
+% The current Maintainer of this work is J. Peter M. Schuler
+% j.peter.m.schuler@uni-due.de
+%
+% This work consists of the files udesoftec.cls and udesoftec.bst.
+%
+% As this work is based on years of mostly undocumented improvement,
+% it includes parts, for which sources can't be identified anymore. Public postings
+% in the LaTeX community were used as an input and if source is known, it is
+% mentioned below. If anybody identifies parts of his/her own code,
+% feel free to contact the maintainer in order to get listed.
+%
+% Special thanks to all contributors and for the help of the tex-live team,
+% e.g. Axel K.; Norbert P.; Rainer S.; Reinhard K.; Robin F.
+%
+% For further information refer to:
+% http://mirrors.ctan.org/macros/latex/contrib/udesoftec/README
+% and
+% http://mirrors.ctan.org/macros/latex/contrib/udesoftec/udesoftec.doc.pdf
+\NeedsTeXFormat{LaTeX2e}%
+\ProvidesPackage{udesoftec-extra}[2013/08/14 Additions for udesoftec.cls which are currently optional and may break former behaviour]%
+%%%%%%%%%%%%%%%%%%%%%%%%%
+% currently nothing here
+%%%%%%%%%%%%%%%%%%%%%%%%%
+\endinput% \ No newline at end of file