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 | 104 |
1 files changed, 49 insertions, 55 deletions
diff --git a/Master/texmf-dist/source/latex/udesoftec/udesoftec-doc.tex b/Master/texmf-dist/source/latex/udesoftec/udesoftec-doc.tex index 0b567c79e1f..dacbf56ce23 100644 --- a/Master/texmf-dist/source/latex/udesoftec/udesoftec-doc.tex +++ b/Master/texmf-dist/source/latex/udesoftec/udesoftec-doc.tex @@ -1,7 +1,7 @@ % !Mode:: "TeX:UTF-8" -%% udesoftec-doc.texs +%% udesoftec-doc.tex % Copyright 2014 J. Peter M. Schuler -% 2014-03-31 v1.3.4 udesoftec +% 2014/04/07 v1.3.5 udesoftec \documentclass[screenlayout,omit-lof,omit-lot,omit-sd]{udesoftec} \usepackage{udesoftec-extra} @@ -61,12 +61,12 @@ Dieses Template stellt eine professionelle Lösung für die Nutzung von LaTeX be \section{Beispiel-Projekt}\label{sec:exampleproject} Ein funktionierendes Dokument lässt sich durch folgendes Beispiel (MWE - minimum working example) erstellen: -\begin{verbatim} +\begin{lstlisting} \documentclass[screenlayout]{udesoftec} \begin{document} Inhalt \end{document} -\end{verbatim} +\end{lstlisting} 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 \url{http://udue.de/udesoftecexample} @@ -87,16 +87,17 @@ Eine vollständige Konfigurationsanleitung für diese Software findet sich in \a \section{Klassenparameter und Konstanten} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \subsection{Optionen der Klasse}\label{sec:classoptions} -\begin{description} - \item[printlayout]{Sollte pauschal genutzt werden wenn die Arbeit ausgedruckt wird und beidseitiger Druck möglich ist. 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.} +\begin{description}[leftmargin=2.5cm,style=sameline] + \item[printlayout]{Wechselt auf doppelseitiges Druck-Layout ("`Buchlayout"'). Nützlich, wenn die Arbeit ausgedruckt wird und beidseitiger Druck möglich ist. 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 (Standard-Einstellung).} \item[en]{Wechselt die primäre Dokumentsprache von Deutsch auf Englisch. Ändert einzelne Überschriften und andere sprachabhängige Labels.} \item[omit-lot]{Tabellenverzeichnis entfernen (für Exposés, wenn keine Tabellen in der Arbeit vorkommen oder für Test-Ausgaben).} \item[omit-lof]{Abbildungsverzeichnis entfernen (für Exposés, wenn keine Tabellen in der Arbeit vorkommen oder für Test-Ausgaben).} - \item[omit-loa]{Abkürzungsverzeichnis entfernen (für Exposés oder für Test-Ausgaben).} - \item[omit-toc]{Abkürzungsverzeichnis entfernen (für Exposés oder für Test-Ausgaben).} + \item[omit-loa]{Abkürzungsverzeichnis entfernen (für Test-Ausgaben).} + \item[omit-toc]{Abkürzungsverzeichnis entfernen (für Test-Ausgaben).} \item[omit-sd]{Eidesstattliche Versicherung entfernen (falls keine Abschlussarbeit o. ä.).} \item[omit-todos]{TODO-Liste am Ende des Dokuments entfernen.} + \item[proposal]{Bspw. für ein Exposé. Setzt alle omit-* Optionen.} \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.} @@ -118,12 +119,8 @@ Neben den Paket-Optionen \lstinline!vawiessen! und \lstinline!vawibamberg! könn \item entitle \end{itemize} \end{multicols} -Die Nutzung ist wie bei den Standard-LaTeX-Kommandos üblich: -\begin{lstlisting} -\title{Meine Bachelorarbeit} -\entitle{My Bachelor Thesis} -\end{lstlisting} - + + Darüber hinaus gibt es natürlich noch die Standard-Kommandos: \begin{multicols}{3} \begin{itemize} @@ -131,12 +128,15 @@ Darüber hinaus gibt es natürlich noch die Standard-Kommandos: \item author \item date \end{itemize} + \end{multicols} -Die Nutzung ist wie bei LaTeX üblich: +Die Nutzung ist wie bei den Standard-LaTeX-Kommandos üblich: \begin{lstlisting} -\title{Meine Arbeit hat einen Titel} +\title{Meine Bachelorarbeit} +\entitle{My Bachelor Thesis} \end{lstlisting} + \chapter{Nutzung der Formatvorlage und übliche Kommandos} \section{Beispiele für Zitationen} @@ -287,23 +287,9 @@ vgl. \autoref{sec:updateinstructions} \def\chapterAuthor{ } \chapter{Appendix} \section{Installation und Konfiguration der Software}\label{sec:software} - -\subsection{Citavi} -In Citavi kann wie folgt ein automatischen BibTeX-Export beim Speichern eingerichtet werden:~\par - \begin{itemize} - \item Datei->Exportieren->Exportieren... - \item Alle n Titel - \item "Dokumenttypen zuordnen": Weiter - \item "Felder zuordnen": Weiter (eigentlich: bei allen Dokumenttypen die DOI nach doi mappen (mit Kringel), aber das sollte inzwischen von vorneherein eingestellt sein) - \item "{}Optionen": 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 wird die .bib-Datei immer automatisch aktualisiert bei jeder Änderung (Citavi speichert meistens automatisch). TeXnicCenter cached diese Datei, daher erscheinen einige Einträge in der Literaturliste teilweise nicht ohne Neustart, das Kompilieren geht aber. - -\subsection{MikTeX (Windows) und BasicTeX (OSX)}\label{sec:classinstall} -Unter Windows wird ausdrücklich MikTeX empfohlen, da dieses selbständig und On-Demand fehlende Dinge nachinstalliert. + +\subsection{LaTeX-Umgebung: MikTeX (Windows) oder 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] @@ -311,6 +297,10 @@ sudo tlmgr install udesoftec chngcntr hyphenat nag footmisc placeins advdate exp \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 Exporte, die \href{http://support.citavi.de/forum/viewtopic.php?f=156&t=7295&p=24152}{Funktion für automatischen Export ist entfernt worden.} + + \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). @@ -327,7 +317,7 @@ Im TeXnicCenter unter Ausgabeprofile (Ausgabe -> Ausgabeprofile definieren) das \item Rückwärtssuche: Doppelklick im PDF öffnet die Textstelle im TeXnicCenter \end{itemize} \end{enumerate} -\subsubsection{Ordner für temporäre Dateien nutzen} +\unnumberedsection{Ordner für temporäre Dateien nutzen} Im Ausgabeprofil im Karteireiter (La)TeX:~\par \begin{itemize} \item Argumente für Compiler: @@ -337,7 +327,7 @@ Im Ausgabeprofil im Karteireiter (La)TeX:~\par \item Argumente für MakeIndex: \lstinline!".tmp/%tm.tex"! \end{itemize} -\subsubsection{Abkürzungen und Glossare einbeziehen} +\unnumberedsection{Abkürzungen und Glossare einbeziehen} Im Ausgabeprofil im Karteireiter Nachbearbeitung einen neuen Postprozessoren anlegen: "`Acronyms"': \begin{itemize} \item Anwendung:\par \lstinline!C:\Program Files (x86)\MiKTeX 2.9\miktex\bin\makeindex.exe! @@ -349,7 +339,7 @@ Im Ausgabeprofil im Karteireiter Nachbearbeitung einen neuen Postprozessoren anl \item Argumente:\par \lstinline!-s .tmp\%tm.ist -t .tmp\%tm.glg -o .tmp\%tm.gls .tmp\%tm.glo! \end{itemize} -\subsubsection{Sumatra PDF mit Vorwärts- und Rückwärtssuche} +\unnumberedsection{Sumatra PDF mit Vorwärts- und Rückwärtssuche} Im Ausgabeprofil im Karteireiter Viewer:~\par \begin{itemize} \item Pfad der Anwendung: @@ -374,7 +364,7 @@ Nun das \hyperref[sec:exampleproject]{Beispielprojekt oder das Minimal Working E Im TeXnicCenter mit Strg+Alt+R die "`Erstellung Ergebnis"'-Ansicht anzeigen lassen, diese fasst die LaTeX-Kompiler-Ausgaben sinnvoll zusammen. -\subsubsection{Zusätzliche Dateiendungen für das Aufräumen angeben} +\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 \begin{multicols}{3} \begin{itemize} @@ -390,7 +380,26 @@ Im TeXnicCenter mit Strg+Alt+R die "`Erstellung Ergebnis"'-Ansicht anzeigen lass \end{itemize} \end{multicols} -\pagebreak + + + +\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.3.0} +\begin{description}[style=nextline] + \item[Change in document configuration sets main page to default values]{All options 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. + +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. +} + +\end{description} +\subsection{Update to 1.2.1} +\lstinline!\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: \begin{multicols}{3} @@ -432,21 +441,6 @@ The base documentclass is \emph{scrbook}, which is part of KOMA-Script. Other us \item libertine \end{itemize} \end{multicols} -\pagebreak -\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.3.0} -\begin{description}[style=nextline] - \item[Change in document configuration sets main page to default values]{All options 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. - -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,5cms]! instead. -} - -\end{description} -\subsection{Update to 1.2.1} -\lstinline!\printacronyms! not necessary any more - the documentclass takes care of this. \section{Changelog} @@ -456,4 +450,4 @@ Happens while using \lstinline!\begin{description}[\setleftmargin{1.5cm}]]!.\new \endgroup \bibliography{udesoftec-doc-examplebib} % output Literature and use this file as bibtext catalogue -\end{document} +\end{document}
\ No newline at end of file |