From d2aeef8669ae52ce34ab227e2ccb56bbac5e7c0c Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Fri, 16 Aug 2013 23:06:54 +0000 Subject: udesoftec (16aug13) git-svn-id: svn://tug.org/texlive/trunk@31452 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/source/latex/udesoftec/CHANGELOG | 39 ++ Master/texmf-dist/source/latex/udesoftec/README | 34 ++ Master/texmf-dist/source/latex/udesoftec/VERSION | 1 + .../latex/udesoftec/udesoftec-doc-examplebib.bib | 119 ++++++ .../latex/udesoftec/udesoftec-doc-exampleimage.pdf | Bin 0 -> 30316 bytes .../source/latex/udesoftec/udesoftec-doc.tex | 438 +++++++++++++++++++++ 6 files changed, 631 insertions(+) create mode 100644 Master/texmf-dist/source/latex/udesoftec/CHANGELOG create mode 100644 Master/texmf-dist/source/latex/udesoftec/README create mode 100644 Master/texmf-dist/source/latex/udesoftec/VERSION create mode 100644 Master/texmf-dist/source/latex/udesoftec/udesoftec-doc-examplebib.bib create mode 100644 Master/texmf-dist/source/latex/udesoftec/udesoftec-doc-exampleimage.pdf create mode 100644 Master/texmf-dist/source/latex/udesoftec/udesoftec-doc.tex (limited to 'Master/texmf-dist/source/latex/udesoftec') diff --git a/Master/texmf-dist/source/latex/udesoftec/CHANGELOG b/Master/texmf-dist/source/latex/udesoftec/CHANGELOG new file mode 100644 index 00000000000..a9aa4bd65d8 --- /dev/null +++ b/Master/texmf-dist/source/latex/udesoftec/CHANGELOG @@ -0,0 +1,39 @@ +2013/08/14 +* fixed misconfigured line endings and zip format + +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 +* updated README and added instruction for cover files +* added packages listings, multicol and verbatim +* updated documentation + * added English abstract + * better outline to improve understanding + * included package listing + * included FAQ entry for problems with cover files + +2013/06/28 +* better filenames +* update to udesoftec-cover-uba.pdf: + smaller filesize and undamaged PDF file + +2013/06/26 +* Initial CTAN Upload \ No newline at end of file diff --git a/Master/texmf-dist/source/latex/udesoftec/README b/Master/texmf-dist/source/latex/udesoftec/README new file mode 100644 index 00000000000..71dbd1f15f5 --- /dev/null +++ b/Master/texmf-dist/source/latex/udesoftec/README @@ -0,0 +1,34 @@ +ude-softec documentclass and bibstyle + +Maintainer: J. Peter M. Schuler +Copyright: 2013 J. Peter M. Schuler +Version: 2013-08-15 v1.2.1 udesoftec +License: lppl +Topic: dissertation + +Description: + LaTeX template (full documentclass) for written theses at the University + of Duisburg-Essen, Research Group for Business Informatics and Software + Engineering. + + It is based on pdflatex and bibtex using UTF-8 encoded files. It was + thorougly tested on Windows/MikTeX and MacOS/BasicTeX, works as well + under sharelatex.com and should be plattform independent. + + For more information see the instructions in udesoftec-doc.pdf - complete + instructions are available in German, a short abstract in English should + 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. + + 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 + texmf/bibtex/bst/udesoftec/udesoftec.bst \ No newline at end of file diff --git a/Master/texmf-dist/source/latex/udesoftec/VERSION b/Master/texmf-dist/source/latex/udesoftec/VERSION new file mode 100644 index 00000000000..baafb41944a --- /dev/null +++ b/Master/texmf-dist/source/latex/udesoftec/VERSION @@ -0,0 +1 @@ +2013-08-15 v1.2.1 udesoftec \ No newline at end of file diff --git a/Master/texmf-dist/source/latex/udesoftec/udesoftec-doc-examplebib.bib b/Master/texmf-dist/source/latex/udesoftec/udesoftec-doc-examplebib.bib new file mode 100644 index 00000000000..f8c998dfa55 --- /dev/null +++ b/Master/texmf-dist/source/latex/udesoftec/udesoftec-doc-examplebib.bib @@ -0,0 +1,119 @@ +@book{Tidwell.2011, + abstract = {This text offers advice on creating user-friendly interface designs - whether they're delivered on the Web, a CD, or a 'smart' device like a cell phone. It presents solutions to common UI design problems as a collection of patterns - each containing concrete examples, recommendations, and warnings.}, + author = {Tidwell, Jenifer}, + year = {2011}, + title = {Designing interfaces}, + keywords = {Pattern Katalog}, + address = {Sebastopol and CA}, + edition = {2}, + publisher = {O'Reilly}, + isbn = {9781449379704} +} + + +@incollection{Matera.2006, + crossref = {Mendes.et.al.2006}, + author = {Matera, Maristella and Rizzo, Francesca and Carughi, Giovanni Toffetti}, + title = {Web Usability: Principles and Evaluation Methods}, + pages = {143–180}, + publisher = {Springer}, + isbn = {3-540-28196-7}, + editor = {Mendes, Emilia and Mosley, Nile}, + booktitle = {Web Engineering}, + year = {2006}, + address = {Berlin/Heidelberg}, + doi = {10.1007/3-540-28218-1_5} +} + +@incollection{Mendes.et.al.2006b, + crossref = {Mendes.et.al.2006}, + author = {Mendes, Emilia and Mosley, Nile and Counsell, Steve}, + title = {The Need for Web Engineering: An Introduction}, + pages = {1–27}, + publisher = {Springer}, + isbn = {3-540-28196-7}, + editor = {Mendes, Emilia and Mosley, Nile}, + booktitle = {Web Engineering}, + year = {2006}, + address = {Berlin/Heidelberg}, + doi = {10.1007/3-540-28218-1_1} +} + + +@book{Mendes.et.al.2006, + year = {2006}, + title = {Web Engineering}, + address = {Berlin/Heidelberg}, + publisher = {Springer}, + isbn = {3-540-28196-7}, + editor = {Mendes, Emilia and Mosley, Nile}, + doi = {10.1007/3-540-28218-1} +} +@book{Schweibenz.et.al.2003, + abstract = {Webseiten müssen absolut benutzerfreundlich sein - wie alle interaktiven Anwendungen. Allerdings wird eine sinnvolle Nutzung von Informationsangeboten im WWW häufig durch \"cooles Design\" unnötig erschwert, weil zentrale Punkte der Benutzerfreundlichkeit (Usability) vernachlässigt werden. Diesem Problem kann man durch die Evaluation von Webangeboten abhelfen. Das Buch führt praxisorientiert in die Web Usability Evaluation ein und beschreibt die Anwendung ihrer verschiedenen Methoden.}, + author = {Schweibenz, Werner and Thissen, Frank}, + year = {2003}, + title = {Qualität im Web: Benutzerfreundliche Webseiten durch usability evaluation}, + address = {Berlin}, + publisher = {Springer}, + isbn = {978-3-540-41371-4} +} + +@article{Fettke.et.al.2009, + author = {Fettke, Peter and Loos, Peter}, + year = {2009}, + 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}, + doi = {10.1007/s11576-009-0195-5} +} + +@book{Nielsen.1993, + author = {Nielsen, Jakob}, + year = {1993}, + title = {Usability engineering}, + address = {San Diego}, + edition = {Reprint 2008}, + publisher = {Kaufmann}, + isbn = {0-12-518406-9} +} + +@book{Nielsen.et.al.2006, + abstract = {Describes Web site usability through critiques of real-world sites, covering such factors as legibility, navigability, searchability, and design.}, + author = {Nielsen, Jakob and Loranger, Hoa}, + year = {2006}, + title = {Prioritizing Web usability}, + keywords = {Web sites;Graphical user interfaces (Computer systems);Sites Web;Interfaces graphiques (Informatique);World wide web;Internet}, + address = {Berkeley}, + edition = {1}, + publisher = {New Riders}, + isbn = {978-0-321-35031-2} +} + +@article{Holt.et.al.2010, + author = {Holt, Raymond and Barnes, Catherine}, + year = {2010}, + title = {Towards an integrated approach to ``Design for X"': an agenda for decision-based DFX research}, + pages = {123--136}, + volume = {21}, + number = {2}, + issn = {0934-9839}, + journal = {Research in Engineering Design}, + doi = {10.1007/s00163-009-0081-6} +} + + +@book{Eller.2009, + author = {Eller, Brigitte}, + year = {2009}, + title = {Usability-Engineering in der Anwendungsentwicklung: Systematische Integration zur Unterst{\"u}tzung einer nutzerorientierten Entwicklungsarbeit: Zugl.: Darmstadt, Techn. Univ., Diss., 2009}, + price = {kart. : EUR 49.90}, + keywords = {Anwendungssystem;Systementwicklung;Information Engineering;Benutzerfreundlichkeit;Vorgehensmodell}, + address = {Wiesbaden}, + edition = {1}, + publisher = {Gabler}, + isbn = {978-3-8349-2114-7} +} diff --git a/Master/texmf-dist/source/latex/udesoftec/udesoftec-doc-exampleimage.pdf b/Master/texmf-dist/source/latex/udesoftec/udesoftec-doc-exampleimage.pdf new file mode 100644 index 00000000000..e08260cca00 Binary files /dev/null and b/Master/texmf-dist/source/latex/udesoftec/udesoftec-doc-exampleimage.pdf differ diff --git a/Master/texmf-dist/source/latex/udesoftec/udesoftec-doc.tex b/Master/texmf-dist/source/latex/udesoftec/udesoftec-doc.tex new file mode 100644 index 00000000000..f0f2ee2960e --- /dev/null +++ b/Master/texmf-dist/source/latex/udesoftec/udesoftec-doc.tex @@ -0,0 +1,438 @@ +% !Mode:: "TeX:UTF-8" +\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{Dokumentation zur} +\def \labelPreTopic{} +\def \institution{Universität Duisburg-Essen} +\def \semester{} +\date{Version: \input{VERSION.}} +\def \authorbox{ +\begin{tabularx}{.7\linewidth}{ll} + Maintainer:&J. Peter M. Schuler\\ + &j.peter.m.schuler@uni-due.de\\ + \\ +\end{tabularx} +} + +%%%%%%%%%%%%%%%%%%%%%%%% DOCUMENT %%%%%%%%%%%%%%%%%%%%%%%% +\begin{document} +\clearpage +\chapter*{English summary for this document}\label{sec:abstract}\addcontentsline{toc}{chapter}{English summary for this document} +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 \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 + \item texmf/tex/latex/udesoftec/udesoftec-cover-uba.pdf + \item texmf/tex/latex/udesoftec/udesoftec-cover-ude-de.pdf + \item texmf/tex/latex/udesoftec/udesoftec-cover-ude-en.pdf + \item texmf/bibtex/bst/udesoftec/udesoftec.bst +\end{itemize} + + + An alternative, in case you run into problems: just install the documentclass and bibstyle from ctan. Afterwards + download the appropiate cover from \url{http://www.ctan.org/tex-archive/macros/latex/contrib/udesoftec} and place it next to + your document's \verb+main.tex+. + +%%%%%%%%%%%%%%%%%%%%%%%%%%% 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} +\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. Dementsprechend wird über das Template hinaus eine eher spezifische Konfiguration der LaTeX-Umgebung empfohlen. Ein paar Beispiele dafür: + +\begin{itemize} + \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} +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. +Ein Beispielprojekt mit echten Inhalten findet sich unter \url{http://udue.de/udesoftecmanual} + + +\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 Beta 2 + \item SumatraPDF >= 2.3.2 + \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} +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 oder TeX Live} +Unter Windows wird ausdrücklich 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 +\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{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.0 Beta 2}. + +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} +\item alle temporären Dateien in einem Unterordner .tmp/ erstellt. +\item Der Glossar und das Abkürzungsverzeichnis werden aktiviert +\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} +\end{enumerate} +\subsubsection{Ordner für temporäre Dateien nutzen} +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! + \item Argumente für BibTex: \lstinline!"\%dm/.tmp/%tm"! + \item Argumente für MakeIndex: \lstinline!".tmp/%tm.tex"! + \end{itemize} + +\subsubsection{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! + \item Argumente: \par \lstinline!-s .tmp\%tm.ist -t .tmp\%tm.alg -o .tmp\%tm.acr .tmp\%tm.acn! + \end{itemize} +Im Ausgabeprofil im Karteireiter Nachbearbeitung einen neuen Postprozessoren anlegen: "`Glossaries"': + \begin{itemize} + \item Anwendung:\par \lstinline!C:\Program Files (x86)\MiKTeX 2.9\miktex\bin\makeindex.exe! + \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} + Im Ausgabeprofil im Karteireiter Viewer:~\par + \begin{itemize} + \item Pfad der Anwendung: + \par\lstinline!C:\Program Files (x86)\TeXnicCenter\SumatraPDF.exe! + \item Projektausgabe betrachten~\par + \begin{itemize} + \item {}[X] Kommandozeile, Kommando: \lstinline!"%sbm.pdf"! + \end{itemize} + \item Suche in Ausgabe:~\par + \begin{itemize} + \item {}[X] DDE-Kommando, Server: SUMATRA, Thema: control + \item Kommando: \lstinline![ForwardSearch("\%sbm.pdf","\%Wc",\%l,0,0,1)]! + \end{itemize} + \item Vor Compilierung Ausgabe schließen~\par + \begin{itemize} + \item {}[X] nicht schließen + \end{itemize} + \end{itemize} + + +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. + + +\subsubsection{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} + \item *.synctex.gz + \item *.acn + \item *.acr + \item *.alg + \item *.glg + \item *.glo + \item *.gls + \item *.ist + \item *.pdfsync + \end{itemize} + \end{multicols} + + + + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\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.} + \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} +Neben den Paket-Optionen \lstinline!vawiessen! und \lstinline!vawibamberg! können die folgende Variablen vor dem \verb|\begin{document}| ersetzt 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} +Die Nutzung ist wie bei LaTeX üblich: +\begin{lstlisting} +\def \typeofdoc{Bachelorarbeit} +\def \typeofdoc{Masterarbeit} +\end{lstlisting} + +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} +Die Nutzung ist wie bei LaTeX üblich: +\begin{lstlisting} +\title{Meine Arbeit hat einen Titel} +\end{lstlisting} + +\chapter{Funktionen} + +\section{Beispiele für Zitationen} + +Die häufigsten Zitationsarten sind hier vermerkt, eine komplette Liste der Möglichkeiten findet sich im \href{http://merkel.zoneo.net/Latex/natbib.php}{Natbib Cheat Sheet} + +\subsection{Absatz-Zitate} + +\begin{lstlisting}[language={[LaTeX]TeX},morekeywords=citequotepar] +\citequotepar[]{}{} +\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.} + +\subsection{Zitat im Text} +\begin{lstlisting}[language={[LaTeX]TeX}] +\cite[]{} +\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}[language={[LaTeX]TeX}] +\citet[]{} +\end{lstlisting} +Systemakzeptanz ist nach \citet[24]{Nielsen.1993} die grundlegende Frage dahingehend, [...]. \par +\begin{lstlisting}[language={[LaTeX]TeX}] +\citeauthor{} +\end{lstlisting} +Dabei unterteilt \citeauthor{Nielsen.1993} diese Akzeptanz in verschiedene Bereiche. + +\subsection{Multi-Quellen-Zitate} +\begin{lstlisting}[language={[LaTeX]TeX}] +\citetext{\citealp[]{}...} +\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}}. + +\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. + +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}). + +%%%%%%%%%%%%%%%%%%% 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}% +}% +\end{figure}% +%%%%%%%%%%%%%%%%%%% FIGURE %%%%%%%%%%%%%%%%%%%%%% +\end{lstlisting} + +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]{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 %%%%%%%%%%%%%%%%%%%%%% + +\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[]{}{}{} +\end{lstlisting} +Als Wert für \lstinline!! 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{} oder \acrshort{} +\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ä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[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} + + +\section{TODOs} +Über \lstinline!\todo{}! und \lstinline!\inlinetodo{}! 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} +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{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. + +\section{LaTeX Error: File `udesoftec-cover-ude-de' not found.} +Anscheinend kann die TeX-Distribution die Cover-Dateien nicht finden. Die Dateien nach dem Schema \verb+udesoftec-cover*.*+ sollten direkt neben der Documentclass \verb+udesoftec.cls+ liegen, so dass die lokale texmf-Struktur etwa wie folgt ausieht: +\begin{itemize} + \item texmf/tex/latex/udesoftec/udesoftec.cls + \item texmf/tex/latex/udesoftec/udesoftec-cover-uba.pdf + \item texmf/tex/latex/udesoftec/udesoftec-cover-ude-de.pdf + \item texmf/tex/latex/udesoftec/udesoftec-cover-ude-en.pdf + \item texmf/bibtex/bst/udesoftec/udesoftec.bst +\end{itemize} +Falls nicht klar ist, was das vorgenannte bedeutet, oder falls es andere Probleme gibt, kann einfach das passende Cover von der \href{http://www.ctan.org/tex-archive/macros/latex/contrib/udesoftec}{Paket-Seite auf CTAN} heruntergeladen und in den selben Ordner wie die Hauptdatei des Projektes (z.B. \verb+main.tex+) gelegt werden. + +%%%%%%%%%%%%%%%%%%%%%%%% APPENDIX %%%%%%%%%%%%%%%%%%%%%%% +\appendix% \addcontentsline{toc}{chapter}{Anhang} +\def\chapterAuthor{ } +\chapter{Anhang} +\section{Liste der genutzten Pakete}\label{sec:paketlist} +Die genutzte Klasse ist \emph{scrbook}, die Bestandteil von KOMA-Script ist. Weitere Pakete im Folgenden: +\begin{multicols}{3} +\begin{itemize} + \item xcolor + \item chngcntr + \item babel + \item inputend + \item fontenc + \item hyphenat + \item helvet + \item lmodern + \item setspace + \item microtype + \item fixltx2e + \item graphicx + \item footmisc + \item placeins + \item ragged2e + \item tabularx + \item expdlist + \item natbib + \item todonotes + \item type1cm + \item fix-cm + \item scrpage2 + \item wallpaper + \item geometry + \item marginnote + \item hyperref + \item hypcap + \item glossaries + \item verbatim + \item multicol + \item listings + \item scrhack + \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 +\end{document} \ No newline at end of file -- cgit v1.2.3