summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/udesoftec/udesoftec-doc.tex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2014-08-24 21:18:53 +0000
committerKarl Berry <karl@freefriends.org>2014-08-24 21:18:53 +0000
commit9913fb8461243c1606b55dabd26ad4871aac1929 (patch)
tree1655970e12b0c09e3d0a8ea939925543b1a5f5ec /Master/texmf-dist/source/latex/udesoftec/udesoftec-doc.tex
parenta90a70397dcc0fe65403afb486646af6f48d5669 (diff)
udesoftec (24aug14)
git-svn-id: svn://tug.org/texlive/trunk@35033 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex/udesoftec/udesoftec-doc.tex')
-rw-r--r--Master/texmf-dist/source/latex/udesoftec/udesoftec-doc.tex39
1 files changed, 19 insertions, 20 deletions
diff --git a/Master/texmf-dist/source/latex/udesoftec/udesoftec-doc.tex b/Master/texmf-dist/source/latex/udesoftec/udesoftec-doc.tex
index df7dbb831c2..fe55d8485c6 100644
--- a/Master/texmf-dist/source/latex/udesoftec/udesoftec-doc.tex
+++ b/Master/texmf-dist/source/latex/udesoftec/udesoftec-doc.tex
@@ -1,8 +1,8 @@
% !Mode:: "TeX:UTF-8"
%% udesoftec-doc.tex
%% Copyright 2013-2014 J. Peter M. Schuler
-%% 2014/06/22 v1.4.2 udesoftec
-\documentclass[omit-sd]{udesoftec}
+%% 2014/08/23 v1.4.4 udesoftec
+\documentclass[omit-sd,omit-lol,en]{udesoftec}
\usepackage{udesoftec-extra}
\usetikzlibrary{shadows}
@@ -33,7 +33,7 @@
\labelPreTopic{}
\institution{Universität Duisburg-Essen}
\semester{}
-\date{Version: \input{VERSION.}}
+%%\date{Version: \input{VERSION.}}
\authorbox{
\begin{tabularx}{.7\linewidth}{ll}
Maintainer:&J. Peter M. Schuler\\
@@ -41,6 +41,7 @@
\\
\end{tabularx}
}
+\date{\udesoftecversion}
\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}.}
@@ -76,8 +77,6 @@ Dieses Template stellt eine professionelle Lösung für die Nutzung von \LaTeX{}
\item es werden direkt und ausschließlich PDF-Dokumente generiert und kein DVI oder PS als Ergebnis.
\item durchgehende UTF-8-Nutzung (trotz \LaTeX{} statt XeLaTeX)
\item eingebettete Grafiken liegen ausschließlich im PDF-Format vor
- \item alle temporär generierten Dateien liegen so gut es geht in einem Unterordner, um die Übersichtlichkeit zu erhöhen
- \item es wird keine Acrobat-Lösung für die PDFs benutzt, da diese für den Anwendungsfall \LaTeX{} nicht geeignet ist
\end{itemize}
\section{Beispiel-Projekt}\label{sec:exampleproject}
@@ -92,18 +91,6 @@ Grundsätzlich sind kaum Einstellungen und Konfigurationen notwendig. Lediglich
Ein Beispielprojekt mit echten Inhalten findet sich unter\newline \url{http://udue.de/udesoftecexample}
-\section{Software-Empfehlungen}
-Diese Dokumentation gibt Hinweise für eine \LaTeX{}-Konfiguration unter Windows mit
-\begin{itemize}
- \item MikTeX >= 2.9
- \item TeXnicCenter >= 2.0.2
- \item SumatraPDF >= 2.4
- \item Citavi >= 4.1
-\end{itemize}
-Unter anderen Systemumgebungen funktioniert dieses Template natürlich genauso, hier müssen Sie lediglich die zusätzlichen Compile-Aufrufe für das Paket "`glossaries"' selbst konfigurieren.
-
-Eine vollständige Konfigurationsanleitung für diese Software findet sich in \autoref{sec:software}.
-
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\pagebreak\section{Klassenparameter und Konstanten}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -336,6 +323,9 @@ Beschreibungslisten können auch mit festem Umbruch gesetzt werden:
Ü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{Der Hinweis mit der Templateversion auf dem Deckblatt soll verschwinden}
+Vor der Abgabe sollte mit dem Kommando \lstinlinelatex!\date{}! das Datum des Dokuments entfernt werden. Dadurch wird auch der Hinweis auf die Templateversion entfernt. Während der Bearbeitung können beide Hinweise aber beim Feedback hilfreich sein.
+
\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]{
@@ -372,9 +362,9 @@ vgl. \autoref{sec:classinstall} nutzen.
%%%%%%%%%%%%%%%%%%%%%%%% APPENDIX %%%%%%%%%%%%%%%%%%%%%%%
\appendix% \addcontentsline{toc}{chapter}{Anhang}
\def\chapterAuthor{ }
-\chapter{Appendix}
+\chapter{Anhang}
\section{Installation und Konfiguration der Software}\label{sec:software}
-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.
+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.
@@ -385,11 +375,20 @@ Unter MacOS kann beispielsweise ein minimales \TeX{}-Live-System wie \href{http:
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
+sudo tlmgr install udesoftec nag chngcntr hyphenat libertine mweights fontaxes footmisc placeins enumitem todonotes wallpaper marginnote mdframed needspace csquotes glossaries xfor datatool substr xstring
\end{lstlisting}
Sollte es zu Problemen kommen, sollten die Fehlermeldungen und die \hyperref[sec:paketlist]{Liste der Pakete im Anhang} genügend Informationen bieten.
+Diese Dokumentation gibt im Folgenden Hinweise für eine \LaTeX{}-Konfiguration unter Windows mit
+\begin{itemize}
+ \item MikTeX >= 2.9
+ \item TeXnicCenter >= 2.0.2
+ \item SumatraPDF >= 2.4
+ \item Citavi >= 4.1
+\end{itemize}
+Unter anderen Systemumgebungen funktioniert dieses Template natürlich genauso, hier müssen Sie lediglich die zusätzlichen Compile-Aufrufe für das Paket "`glossaries"' selbst konfigurieren.
+
\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}).