diff options
author | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
commit | e0c6872cf40896c7be36b11dcc744620f10adf1d (patch) | |
tree | 60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/latex/contrib/etdipa |
Initial commit
Diffstat (limited to 'macros/latex/contrib/etdipa')
23 files changed, 3201 insertions, 0 deletions
diff --git a/macros/latex/contrib/etdipa/Data/folder_description.txt b/macros/latex/contrib/etdipa/Data/folder_description.txt new file mode 100644 index 0000000000..9dcbee2f50 --- /dev/null +++ b/macros/latex/contrib/etdipa/Data/folder_description.txt @@ -0,0 +1,2 @@ +The folder "Data" should be used to store all +the data of your project that isn't used for the documentation. diff --git a/macros/latex/contrib/etdipa/Help/etdipa_doc_DE.pdf b/macros/latex/contrib/etdipa/Help/etdipa_doc_DE.pdf Binary files differnew file mode 100644 index 0000000000..f4fe391fad --- /dev/null +++ b/macros/latex/contrib/etdipa/Help/etdipa_doc_DE.pdf diff --git a/macros/latex/contrib/etdipa/Help/etdipa_doc_DE.tex b/macros/latex/contrib/etdipa/Help/etdipa_doc_DE.tex new file mode 100644 index 0000000000..7fd0fc34d3 --- /dev/null +++ b/macros/latex/contrib/etdipa/Help/etdipa_doc_DE.tex @@ -0,0 +1,1061 @@ + %% da_manual_DE.tex + %% Copyright 2015 Simon M. Laube + % + % 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 `author maintained'. + % + % The Current Maintainer of this work is S. M. Laube + % + % This work consists of the files listed in ./Help/files.txt + +%%~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~%% +%% Documentation of the etdipa-template %% +%%~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~%% +\PassOptionsToPackage{xcolor}{dvipsnames} +\documentclass[12pt,paper=a4]{scrartcl} +\usepackage[utf8]{inputenc} +\usepackage[naustrian]{babel} +\usepackage[scale=0.7]{geometry} +\usepackage{graphicx} +\usepackage{float} +\usepackage{circuitikz} +\usepackage{listings} +\usepackage{array} + + + + +\lstset{language=[LaTeX]TeX, + texcsstyle=*\ttfamily\color{red!80!black}, + literate={{ß}{{\ss}}2}, + basicstyle={\ttfamily\color{black}}, + commentstyle=\color{green!60!black}, + keywordstyle=\ttfamily\color{red!80!black}, + numberstyle=\tiny\color{red}, + numbers=left, + captionpos=b, + %otherkeywords={}, + basicstyle=\footnotesize, + morekeywords={\diplomand ,\breite ,\@width@dpl ,\@sep@dpl,\ifundefined, + \@breite,\@default@breite,\setlength,\providecommand,{\ },{\\},\includegraphics, + \responsible,\hypersetup,\tikz,\",\href,\node,\dipalistoffigures,$, \{, \}, \[, \],\includepdf,\frontmatter,\appendix,\mainmatter,\schuljahr,\professor,\maketitle,\addchap,\acro,\unterschrift,\usetikzlibrary,\includepdf, \schule,\firma, \Masse,\TikZ,\S,\D,\DS,\SD,\dipacolor,\@@eid@text,\definecolor +\dipalistoffigures,\dipalistoftables,\dplversion,\ETdipaversion,\manversion,\dokumenttyp,\dipvorname,\eidname,\dankname, +\definecolor,\place,\setmyheadings} + } + + \usepackage{etdipa} + \clearscrheadfoot\relax + \pagestyle{empty} + \pagestyle{scrheadings} + + +\setfootsepline{.5pt} +\setheadsepline{.5pt} +\ohead{\today} +\ihead{Simon~Michael~Laube} +\ifoot{{\ttfamily etdipa} -- Manual} +\ofoot{\pagemark} + + +\title{Verwendung des Diplomarbeits-Templates \ETdipaversion} +\author{Simon~Michael~Laube\\5BHET~2014/15} +\date{\today} +\def\TikZ{Ti\textit{k}Z} +\def\addtoc#1#2{\addcontentsline{toc}{#1}{#2}} +\def\nsec#1{\section*{#1}\addtoc{section}{#1}} +\def\nsubsec#1{\subsection*{#1}\addtoc{subsection}{#1}} +\def\nsubsubsec#1{\subsubsection*{#1}\addtoc{subsubsection}{#1}} +\setlength{\parindent}{0pt} + +%% DIRTY TRICK :) +\makeatletter +\def\maketitle{% +\thispagestyle{empty} +\begin{figure}[H] +\includegraphics[scale=1]{Images/ET_logo.jpg} +\centering +\end{figure} +\begin{center} + \Huge \bfseries\sffamily\@title\\ + \vskip 1em + \Large\mdseries\rmfamily\@author\\ + \vskip .5em + \large\mdseries\@date\\ + \normalsize \rmfamily +\end{center} + }% +\makeatother + +\usepackage[colorlinks=true, + linkcolor=black, + citecolor=green, + urlcolor=blue, + bookmarks=true, + bookmarksopen=true]{hyperref} + +\begin{document} + +\maketitle +\tableofcontents\newpage + + +\addtocontents{toc}{\protect \large {\bfseries Teil~I: Konventionen \& Struktur}\protect\vspace{1mm}\hrule\normalsize} + +\nsec{Vorwort}\vspace{-1mm} +Dieses Template mit den beiliegenden Dateien dient der Erstellung +einer Diplom\-arbeits\-dokumentation, oder einem ähnlich anspruchsvollen +Dokument\footnote{Bitte beachten Sie, dass das Template +für die {\ttfamily scrreprt} Klasse geschrieben wurde.}, mit dem \TeX{} Makropaket \LaTeX{}. +Der Aufbau des Templates ist dabei so einfach wie möglich um jede +Könnerstufe von \LaTeX{}-Benutzern dazu anzuregen, ihre Diplomarbeit +mit \LaTeX{} zu verfassen. Gewisse Befehle +gehören jedoch zum Mindestmaß an Syntax und werden daher ohne +jede Erklärung verwendet.\par\medskip + +Diese Vorlage soll eine Richtlinie und Hilfe für die Erstellung +der Diplomarbeitsdokumentation sein. Sie ersetzt nicht die +Gestaltung von typografisch und sprachlich richtigen Texten und Strukturen. +\par\medskip + +Seit der vorliegenden Version \ETdipaversion{} ist das Template so +modifizierbar, dass es auch für Vor\-wiss\-en\-schaft\-liche Arbeiten (VWA) +verwendbar ist. Für weiterführende Informationen +lesen Sie bitte die \href{http://www.ctan.org/pkg/etdipa}{README} am CTAN-Server oder die +komplette \href{https://medium.com/@simon_m_laube/etdipa-offical-release-details-by-the-author-59b6d9ad104b}{Projekthistorie}.\par \medskip + + + Weiters sind Verbesserungsvorschläge oder Anregungen durchaus erwünscht. Sie können mich über +\href{mailto:simon.laube@gmx.at}{simon.laube@gmx.at} erreichen. Für Erklärungen zum +Template steht diese Adresse jedoch nicht zur Verfügung, dafür ist die vorliegende +Dokumentation gedacht. \par\vspace{-2mm} + +\nsubsec{Danksagungen} +Ich möchte mich hiermit bei allen Personen bedanken, die zur Verbesserung des Templates beigetragen haben. +Ein besonderer Dank geht an Prof. Mag Dipl.-Ing. Dr.~Daniel~Asch und Prof. Dipl.-Ing. Dr. Wilhelm Haager +für die Betreuung des Projektes und der Unterstützung bei \TeX nischen Fragen.\par\medskip + + + +\null\hfill -- Simon Michael Laube, \today{} -- + +\section{Konventionen} +In diesem Abschnitt sollen kurz die festgelegten Darstellungskonventionen +für \\dieses Dokument erläutert werden. \par\medskip +\begin{tabular}{>{\bfseries}c l} +Befehle & werden im Folgenden immer in {\ttfamily Typewriter}-Schriftart,\\ + & sowie in einer \textit{Listings-} oder + \textit{Verbatim}umgebung dargestellt. \\ +&\\ +Begriffe& aus der \LaTeX{}-Welt und Hervorhebungen werden \textit{kursiv} gesetzt. +\end{tabular}\par\bigskip + +Eine Übersicht über alle Templatebefehle befindet sich in Anhang~\ref{sec:befehle}.\par + + + + +\section{Strukturierung} + +%% ==== Ordner ==== %% +\subsection{Ordnerstruktur} +\begin{figure}[H] +\centering +\includegraphics[width=0.7\textwidth]{Images/Ordnerstruktur.pdf} +\caption{Vorgegebene Ordnerstruktur im Diplomarbeitsordner\newline + \protect\tikz{\protect\node[rectangle,fill=blue!50!white]{};} \dots\dots Stammordner\newline + \protect\tikz{\protect\node[rectangle,fill=yellow!70!red]{};} \dots\dots Unterverzeichnisse\newline + \protect\tikz{\protect\node[rectangle,fill=red!80!blue]{};} \dots\dots Erklärung} +\label{pic:ordnerstruktur} +\end{figure} + +Abbildung~\ref{pic:ordnerstruktur} zeigt die festgelegte Ordnerstruktur im Diplomarbeitsordner. Für +den Benutzer sind im Wesentlichen nur die Ordner \textit{Data, Images} und \textit{Textparts} von Bedeutung. +Im \textit{Help} Ordner befindet sich die Dokumentation zum Diplomarbeitstemplate, also diese Datei.\par\bigskip + +Die vorgegebene Struktur soll nicht verändert werden um eine gewisse Einheitlichkeit der Diplomarbeitsordner +für betreuende Lehrer und die eventuelle spätere Verwendung zu schaffen. Es dürfen -- und sollen -- +Unterordner angelegt werden um die Übersicht zu verbessern. Ein Beispiel für solch eine Unterteilung ist in +Abbildung~\ref{pic:unterordner} zu sehen. Mehr zum Thema "`{Arbeiten mit +mehreren \LaTeX{}-Dateien}"' kann in Abschnitt~\ref{sec:master} nachgelesen werden.\par\vspace{1mm} +\begin{figure}[H] +\centering +\includegraphics[width=0.4\textwidth]{Images/subordner.pdf} +\caption{Beispielhafte Unterteilung der vorgegebenen Ordner in Abbildung~\ref{pic:ordnerstruktur}} +\label{pic:unterordner} +\end{figure} + +\def\labelitemi{$>$} +\begin{itemize} + + +\item Der \textit{Data} Ordner ist der Hauptordner der Diplomarbeit außerhalb der Dokumentation. +Er ist gedacht für Simulationdateien (z.B.: Proteus, {\scshape Spice}), technische Zeichnungen und +Diagramme (z.B.: AutoCAD, \TikZ), Stromlaufpläne (EPlan,\dots) und dergleichen. Bei Bedarf kann +auch die Diplomarbeitspräsentation (PowerPoint, Beamer-\LaTeX{}, Prezi) in diesem Ordner +abgelegt werden. + +\item Der \textit{Textparts} Ordner ist das zentrale Element der Dokumentation. In ihm werden sämtliche +Subfiles der Doku abgelegt und verwaltet. In Abschnitt~\ref{sec:master} wird das Arbeiten mit +mehreren Dateien erläutert. In diesem Ordner werden auch sämtliche Hilfsdateien abgelegt, welche +in \LaTeX{} eingebunden werden (PDFs, eventuell externe Literaturverzeichnisse,\dots). + +\item Der \textit{Images} Ordner dient dem/den Benutzer(n) als Ablage für alle Fotos und Bilder. +Zum einen sind das Fotos, welche in die Dokumentation eingebunden werden; zum anderen alle sonstigen Fotos +(Testversuche, usw.). + +\end{itemize}\bigskip + +Das Masterfile der Dokumentation liegt im Stammordner (vgl. Abbildung~\ref{pic:ordnerstruktur}) +der Diplomarbeit und greift von dort aus auf die benötigten Daten in Unterordnern zu.\par\newpage + +%% ==== Mastefile ==== %% +\subsection{Arbeiten mit Masterfile}\label{sec:master} +Im Folgenden wird das Arbeiten mit mehreren \LaTeX{}-Dateien erläutert. Für die +meisten Benutzer dieses Templates wird die erklärte Arbeitsweise neu sein; das Prinzip +ist unter \LaTeX{} Benutzern jedoch weit verbreitet.\par\bigskip + +Im Grunde kann man zwischen zwei Fällen unterscheiden: +\begin{itemize} +\item[$-$] Das \LaTeX{}-File\footnote{Gilt für \LaTeXe{}. Da es sich um \TeX{}-Befehle handelt\\ aber analog in anderen Versionen +verwendbar.} hat eine angenehme Größe um die Übersicht nicht zu \\verlieren. +\item[$-$] Die Datei ist sehr groß und man verliert leicht die Übersicht über einzelne Dokumentteile. +\end{itemize} + +Bei dem Ausmaß einer Diplomarbeitsdokumentation ist ohne Zweifel der zweite Fall gegeben. +Das dargestellte Problem lässt sich durch eine Umstellung der Arbeitsweise +mit \LaTeX{} vereinfachen. Nachfolgend dienen sogenannte \textit{Minimal\-beispiele} als +Vorzeigeobjekte um Strukturen zu erklären.\par\bigskip + +\subsubsection{Einzeldokument} +Bei kleineren Dokumenten arbeitet man mit einem \LaTeX{}-File, welches beispielsweise +so aussieht, wie in Listing~\ref{lst:normalesarbeiten} dargestellt. + +\lstset{caption=Ein normales \LaTeX{} Dokument,label=lst:normalesarbeiten} +\begin{lstlisting}[ xleftmargin=.14\textwidth, xrightmargin=.14\textwidth] +%Dokumentklasse +\documentclass{article} +%UTF8 Encoding +\usepackage[utf8]{inputenc} +\begin{document} + \section{Titel} + Hier steht ein Text. + \par %Absatzende +\end{document} +\end{lstlisting} + +Beginnt die Dateigröße zu wachsen und wird die Übersicht trotz der Hilfe professioneller +Editoren immer schlechter, so kommt ein neues (und in \LaTeX{} durchaus übliches) System +zum Einsatz.\par \bigskip\bigskip + +\subsubsection{Master- und Subfile} +Für sehr große Dokumente wird im ersten Schritt ein \textit{Masterfile} angelegt. +Meist enthält dieses die sogenannte Präambel (Usepackages usw.).\par Danach folgt +der Dokumentbeginn mit \verb|\begin{document}| und das Dokumentende mit +\verb|\end{document}|. Listing~\ref{lst:masterfile} zeigt eine Möglichkeit +eines Masterfiles.\par + +\lstset{caption=Ein \LaTeX{} Masterfile,label=lst:masterfile} +\begin{lstlisting}[ xleftmargin=.1\textwidth, xrightmargin=.1\textwidth] +%Praeambel +\documentclass{article} +\usepackage[utf8]{inputenc} +%Dokument Beginn +\begin{document} + %vorerst noch leer +\end{document} +%Dokument Ende +\end{lstlisting} + +Im zweiten Schritt erfolgt das Erstellen eines Textteils des Dokumentes +in einer zweiten Datei (zum Beispiel \verb|meintext.tex|). Diese Datei +enthält \textit{nur Text} und keine Präambel (siehe Listing~\ref{lst:subfile}). +Aus diesem Grund kann sie auch nicht als eigenständige Datei kompiliert, +sondern nur gespeichert werden!\par +\lstset{caption=Ein \LaTeX{} Subfile,label=lst:subfile} +\begin{lstlisting}[ xleftmargin=.1\textwidth, xrightmargin=.1\textwidth] +%% file: meintext.tex +\section{Mein Textteil} + Das ist ein Teil meines + riesigen Dokumentes.\par +\end{lstlisting}\par\vspace{20mm} + +Um das Hauptdokument mit Leben zu erfüllen wird der \TeX{} Befehl \verb|\input| +verwendet. Dafür muss der relative Dateipfad zur Masterdatei angegeben werden. +Für PDF-Dokumente kann der Befehl +\verb|\includepdf[<options>]{<name>}| verwendet werden. Dazu ist das Package {\ttfamily pdfpages} notwendig. +Im Allgemeinen soll das Einbinden von Dokumentteilen (ausgenommen Datenblätter oder ähnliches) als PDF +jedoch vermieden werden, da für Kopf- und Fußzeilen sonst zusätzliche Einstellungen notwendig werden. +Weiters kann eine PDF Datei nicht in voller Größe eingebunden werden, da Rücksicht auf die Seitenränder +genommen werden muss.\par + +\lstset{caption=\LaTeX{} Masterfile mit eingebundenen Subfiles,label=lst:fullmaster} +\begin{lstlisting}[ xleftmargin=.1\textwidth, xrightmargin=.1\textwidth] +%Praeamble +\documentclass{article} +\usepackage[utf8]{inputenc} +\usepackage{pdfpages} +%Dokument Beginn +\begin{document} + % Mein erster Teil % + \input{meintext.tex} + % Mein zweiter Teil% PDFs eher nicht + \includepdf[pages=3-5]{meinepdf.pdf} +\end{document} +%Dokument Ende +\end{lstlisting} + +\addtocontents{toc}{\protect\large\protect\newpage{\bfseries Teil~II: Verwendung des Templates} +\protect \vspace{1mm}\hrule\normalsize} + +\section{Verwendung der Makros}\label{sec:macros} +In diesem Abschnitt werden die Funktionen des Templatepackages vorgestellt. +Die enthaltenen Makros wurden selbst definiert und gehören nicht zum +\LaTeX{}-Standard. Wichtig +dabei ist, dass der Benutzer nur das \verb|etdipa.sty| Package +einbinden muss. \par + +\subsection{Titelseite -- {\ttfamily maketitle}} +Der \LaTeX{} Standardbefehl \verb|\maketitle| dient zur Erzeugung +von Titelseiten. Für die Verwendung in der Diplomarbeit wurde +der Befehl umdefiniert und kann daher normal benutzt werden. +Wie in Standard \LaTeX{} müssen zur Erzeugung der Titelseite +die notwendigen Informationen vom Benutzer in der Präambel\footnote{oder +später, aber jedenfalls vor der Verwendung des maketitle-Befehls} +angegeben werden. +Listing~\ref{lst:maketitle_info} zeigt die benötigten Angaben: + +\lstset{caption=Informationen für die Titelseite,label=lst:maketitle_info} +\begin{lstlisting}[xleftmargin=.14\textwidth, xrightmargin=.14\textwidth] +%%==== Definitionen fuer die Diplomarbeit ====%% +\dokumenttyp{DIPLOMARBEIT} +\title{<Titel der Diplomarbeit>} +\author{Schueler 1 \and Schueler 2} +\place{<Ort>} +\date{<Datum>} +\schuljahr{<Schuljahr>} +\professor{Professor 1 \and Professor 2} +\dipacolor{ETred} +%%============================================%% +\end{lstlisting} + +Zu Beginn der Diplomarbeit wird die Titelseite erzeugt +und daraufhin gleich die Verfasser gesetzt.\par\newpage +\lstset{caption=Beispielhafter Beginn der Diplomarbeit,label=lst:maketitle} +\begin{lstlisting}[xleftmargin=.15\textwidth, xrightmargin=.15\textwidth] +\begin{document} +\frontmatter +%%============ Titelseite ============%% +\maketitle +% Verantwortliche/Verfasser +\responsible{Schueler 1, Schueler 2} +%%====================================%% + . . . + . . . + . . . +\end{lstlisting} + + +\subsection{Eidesstattliche Erklärung} +Die Eidesstattliche Erklärung wird über eine Umgebung hinzugefügt (siehe Listing~\ref{lst:eid}). +In dieser Umgebung müssen die Unterschriftenlinien für jeden Diplomanden gesetzt werden. +Die Eidesstattliche Erklärung benötigt eine ganze Seite und teilt sich die vertikalen Abstände +je nach Anzahl der Unterschriften selbst ein.\par +\lstset{caption=Hinzufügen der Eidesstattlichen Erklärung,label=lst:eid} +\begin{lstlisting}[xleftmargin=.15\textwidth, xrightmargin=.15\textwidth] +%%===== Eidesstattliche Erklaerung ======%% +\begin{Eid} +%Unterschrift der Diplomanden hinzufuegen! +\unterschrift{Schueler 1} +\unterschrift{Schueler 2} +\end{Eid}\newpage +%%=======================================%% +\end{lstlisting} + + +\subsection{Danksagungen} +Der Text der Danksagungen wird in einer externen Datei verfasst +und dann im Masterfile eingebunden (vgl. Abschnitt~\ref{sec:master}). +Der Text selbst wird in einer Umgebung geschrieben:\par +\lstset{caption=Hinzufügen der Danksagungen,label=lst:dank} +\begin{lstlisting}[xleftmargin=.15\textwidth, xrightmargin=.15\textwidth] +%% Danksagungen: +\begin{Danksagung} + +%Wir bedanken uns bei \dots + +\end{Danksagung} +\end{lstlisting} + +\subsection{Literaturverzeichnis} +Literaturverzeichnisse zählen zu den wichtigsten Teilen eines technischen Dokumentes und sollen einheitlich gestaltet werden. +In \LaTeX{} gibt es die Möglichkeit externer Literaturdateien. Diese Methode erfordert jedoch ein großes Verständnis der +Prozesse und ist daher nicht gut für schnelles Arbeiten geeignet.\par + +\LaTeX{} bietet eine Umgebung für Literaturverzeichnisse an. Für das Template wurde diese Umgebung leicht +angepasst und trägt daher auch einen anderen Namen. Die Verwendung erfolgt jedoch analog. +Ein Beispiel für einen Literatureintrag ist in Listing~\ref{lst:literatur} zu sehen.\par + +\lstset{caption=Literaturverzeichnis,label=lst:literatur} +\begin{lstlisting}[xleftmargin=.15\textwidth, xrightmargin=.15\textwidth] +%% Literaturverzeichnis: +\begin{Literatur} + +\bibitem[1] % Nummer optional + {TeXbook}% cite-key + % TEXT: + {\textbf{Donald~E.~Knuth:} + \emph{The \TeX{}book}. + 1986, {\scshape Addison--Wesley} Verlag, + ISBN-13: 978-0-201-13447-6} + +\end{Literatur} +\end{lstlisting} +Der Literatureintrag in Listing~\ref{lst:literatur} ergibt Eintrag~\cite{TeXbook}. +Mit Hilfe des \verb|\cite| Makros kann im Text auf Quellen verwiesen werden. +Alle Stellen aus anderen Quellen müssen im Text kenntlich gemacht werden! + +\lstset{caption=Zitieren der Literaturquellen,label=lst:zitate} +\begin{lstlisting}[xleftmargin=.15\textwidth, xrightmargin=.15\textwidth] +%Zitieren im Text +Text~\cite{<cite-key>} +%z.B.: +Text~\cite{TeXbook} +\end{lstlisting} + +\subsection{Abkürzungsverzeichnis} +Das Abkürzungsverzeichnis wird über das \textit{acronym}-Package von Tobias~Oetiker~\cite{acronym} gelöst. +Für die Diplomarbeit ist das Abkürzungsverzeichnis nur optional, da es nicht verwendet werden muss. +Listing~\ref{lst:abkuerz} zeigt ein Beispiel für das Erstellen eines Eintrags. Die Umgebung +funktioniert ähnlich dem Literaturverzeichnis. \par +\newpage +\lstset{caption=Abkürzungsverzeichnis,label=lst:abkuerz} +\begin{lstlisting}[xleftmargin=.1\textwidth, xrightmargin=.1\textwidth] +% Abkuerzungsverzeichnis +%Kapitel ins Inhaltsverzeichnis einfuegen +\addchap{Abkuerzungsverzeichnis} +%Beginn ..... Einrueckung (optional) +\begin{acronym}[ACRONYM] +%ein Eintrag: +%{Abkz. einfach}[Abkz. komplett]{Komplettes Wort} +\acro{ugs}[ugs.]{umgangssprachlich} +%Ende +\end{acronym}\newpage +\end{lstlisting} + +Da dieses Verzeichnis nur optional ist wurde keine Anpassung +wie beim Literaturverzeichnis vorgenommen. +Das Abkürzungsverzeichnis wird jedoch über \verb|\addchap| zum +Inhaltsverzeichnis hinzugefügt. Mittels \verb|\ac{<Abkz. einfach>}| kann +die Ab\-kürzung im Text verwendet werden.\par + + +\subsection{Diplomandenvorstellung}\label{subsec:diplomand} +\begin{figure}[H] +\centering +\diplomand{Max~Mustermann} + {12.12.2012 in St.P\"olten} + {Langestra\ss e 13} + {3100 St.Pölten} + {\schule{2010--2015}{HTBLuVA St.Pölten, Abteilung für Elektrotechnik} + \schule{2006--2010}{Gymnasium XY}} + {max.muster@xy.at} + {Images/bild} +\caption{Ergebnis des Diplomandenvorstellungs-Makros} +\label{pic:diplomandenvorstellung} +\end{figure}\newpage + +In der Diplomandenvorstellung werden die, im Projekt involvierten Schüler, + nacheinander +vorgestellt. Die Vorstellung enthält einen kurzen Lebenslauf +der von den Schülern auszufüllen ist. Die Optik wurde +der \LaTeX{} Dokumentklasse {\ttfamily moderncv}\footnote{Dient +zur Erstellung hochwertiger Lebensläufe in verschiedenen +Farben und Designs.} nachempfunden und über \TikZ{} realisiert.\par + + +\lstset{caption=Diplomandeneintrag erzeugen,label=lst:diplomandeneintrag} +\begin{lstlisting}[ xleftmargin=.15\textwidth, xrightmargin=.15\textwidth] +\begin{Diplomandenvorstellung} + % Neuen Diplomandeneintrag erzeugen + \diplomand + {<Name>} + {<Geburtsdaten>} + {<Strasse>} + {<PLZ Ort>} + {<Schulen und Anstellungen>} + {<Email>} + {<Dateiname_Bild>} +\end{Diplomandenvorstellung} +\end{lstlisting} +Listing~\ref{lst:diplomandeneintrag} zeigt den {\verb|\diplomand|}-Befehl. +Dieses Makro erzeugt mit den eingegebenen Daten (Makro-Argumente in $<\,>$) +eine Diplomandenvorstellung \textit{eines} Diplomanden +(vgl. Abbildung~\ref{pic:diplomandenvorstellung}) und setzt dabei automatisch über \verb|\responsible| seinen Namen +als Verfasser in die Fußzeile.\par Die Argumente sind in der folgenden +Tabelle~\ref{tab:diplomand_arg} erklärt.\par +\medskip +Die Diplomandenvorstellungen müssen in der passenden Umgebung eingebunden werden. +Diese Umgebung setzt die Überschrift und stellt die Ausrichtung ein. +Einzelne Diplomandenvorstellungen können durch \verb|\newpage| getrennt werden.\par +\begin{table}[H] +\centering +\begin{tabular}{l l} +\textbf{Argument} & \textbf{Bedeutung}\\ +\hline +$<$Name$>$ & Vor- und Familienname\\ +$<$Geburtsdaten$>$ & Geburtsdaten in der Form \\ + & $<${\scshape Datum} in {\scshape Ort}$>$\\ +$<$Straße$>$ & Straße und Hausnummer \\ +$<$PLZ Ort$>$ & Postleitzahl und Wohnort\\ +$<$Schulen und Anstellungen$>$& Schulen und Firmen\\ +$<$Email$>$ & Email-Adresse\\ +$<$Dateiname\underline{\ }Bild$>$& Dateipfad und Name des Bildes +\end{tabular} +\caption{Argumente des \textbackslash{\ttfamily diplomand}-Befehls} +\label{tab:diplomand_arg} +\end{table}\newpage + + +Die Breite des Schülerbildes kann dynamisch über den \verb|\breite|-Befehl +verändert werden. Es wird empfohlen den Wert nicht zu verändern, da +der Standardwert von $3\,\mathrm{cm}$ optimal erscheint.\par + +\lstset{caption=Breite des Diplomandenbildes einstellen,label=lst:breite} +\begin{lstlisting}[ xleftmargin=.2\textwidth, xrightmargin=.2\textwidth] +\breite{<Wert>} +\end{lstlisting} + +\subsubsection{Einfügen der Schulen und Firmen} +Um in der Diplomandenvorstellung die Schulen und Firmen +im beruflichen Werdegang einzufügen gibt es seit Version v2.4 die +zwei Makros: +\lstset{caption=Firmen und Schulen einfügen,label=lst:firma_schule} +\begin{lstlisting}[ xleftmargin=.2\textwidth, xrightmargin=.2\textwidth] +\firma{<Zeitraum>}{<Firmenname>} +\schule{<Zeitraum>}{<Schulname>} +\end{lstlisting} +Die Befehle fügen lediglich die gewünschte Stelle im Werdegang +ein; die chronologische Ordnung muss vom Benutzer selbst vorgenommen werden. +Das folgende Listing~\ref{lst:diplomandenvorstellung} zeigt den +Sourcecode zu Abbildung~\ref{pic:diplomandenvorstellung}.\par + +\lstset{caption=Beispiel einer Diplomandenvorstellung,label=lst:diplomandenvorstellung} +\begin{lstlisting}[ xleftmargin=.15\textwidth, xrightmargin=.15\textwidth] +\begin{Diplomandenvorstellung} + \diplomand{Max~Mustermann} + {12.12.2012 in St.P\"olten} + {Langestra\ss e 13} + {3100 St.P\"olten} + {\schule{2010--2015}{HTBLuVA St.P\"olten, + Abteilung f\"ur Elektrotechnik} + \schule{2006--2010}{Gymnasium XY}} + {max.muster@xy.at} + {Images/bild} +\end{Diplomandenvorstellung} +\end{lstlisting} + +\subsection{Kopf- und Fußzeilen} +Die Kopf- und Fußzeilen sind über das \verb|scrpage2.sty| Package realisiert. +Die vorgegebene Formatierung wird im \verb|etdipa|-Package festgelegt und +soll nicht verändert werden. +Zur Veränderung der Namen in der Fußzeile gibt es das \verb|\responsible| Makro +(vgl. Listing~\ref{lst:responsible}). Die Umstellung gilt ab der Seite auf +der diese vorgenommen wird. Bei zwei Definitionen auf einer Seite gilt +daher nur die letzte für die Fußzeile.\par\medskip + +Sollten die Kopf- und Fußzeilen nicht im Dokument erscheinen, wurde +vermutlich weder \verb|\frontmatter|, noch \verb|\mainmatter| verwendet. +Das Templatesetup kann in diesem Fall auch über \verb|\setmyheadings| am Beginn +des Dokuments eingestellt werden.\par\medskip + +Jede Stelle im Text muss eindeutig einem Schüler zuzuordnen sein. Dazu wird +\verb|\responsible| verwendet.\par + +\lstset{caption=Namen in der Fußzeile ändern,label=lst:responsible} +\begin{lstlisting}[ xleftmargin=.2\textwidth, xrightmargin=.2\textwidth] +\responsible{<Name1>, <Name2>} +\end{lstlisting}\vspace{5mm} + +\textit{Hinweis:} Die Verwendung anderer Packages (z.B.: \verb|fancyhdr|) oder +Einstellungen (z.B.: \verb|\pagestyle{empty}|) verändert das Aussehen der Kopf- und +Fußzeilen und kann zu \textit{Warnings} oder \textit{Errors} führen.\par + + +\subsection{Seiten- und Kapitelnummerierung} +Die Diplomarbeitsdokumentation besteht aus drei Teilen. Jeder +Teil hat eine spezifische Seiten- bzw. Kapitelnummerierung. +Die Nummerierung kann über Befehle umgeschaltet werden.\par\bigskip + +\begin{enumerate} +\item Frontmatter $=$ "`Vorspann"' (Danksagungen, Abstract,\dots) +\item Mainmatter $=$ Hauptteil (Texte) +\item Appendix $=$ Anhang (Datenblätter,\dots) +\end{enumerate}\bigskip + +\def\labelitemi{$>$} +\begin{itemize} + \item \textit{Frontmatter} beinhaltet alle Teile, welche nicht zum Text der Diplomarbeit +gehören. Dazu gehören die Eidesstattliche Erklärung, Danksagungen, +die Diplomandenvorstellung, das Inhaltsverzeichnis, Abstract und Zusammenfassung. + + \item \textit{Mainmatter} bezeichnet den Hauptteil der Diplomarbeit und +enthält alle Texte der Dokumentation. + +\item Der Anhang (\textit{Appendix}) dient +z.B. dem Anhängen von Datenblättern. + +\end{itemize}\medskip + + +Auf den Anhang folgen verschiedene Verzeichnisse: Abbildungsverzeichnis, +Tabellenverzeichnis, Literaturverzeichnis und optional ein Abkürzungsverzeichnis.\par + +Die Befehle zum Umschalten lauten: +\lstset{caption=Nummerierungen umschalten,label=lst:nummerierung} +\begin{lstlisting}[xleftmargin=.15\textwidth, xrightmargin=.15\textwidth] +\frontmatter % +\mainmatter % ab hier Hauptteil +\appendix % ab hier Anhang +\end{lstlisting}\par\newpage + + + + +\section{Allgemeine Richtlinien} + +In jeder Art von Dokument gilt das Prinzip "`weniger ist mehr"' (Richtlinien laut Till~Tantau:~\cite[S48--52]{TikZ}). +Der Leser soll auf den Text aufmerksam gemacht und nicht von verschiedenen Schriftgrößen, Farben +Linienstärken abgelenkt werden. Darüber hinaus soll der Text ein Mindestmaß an typographischen Konventionen +einhalten~\cite{LaTeX}:\par + +\begin{enumerate} +\item Worttrennungen mit - \hfill( in \LaTeX{} \verb|-|)\\ + Bereiche z.B. Seitenummern mit S40--50\hfill(in \LaTeX{} \verb|--|)\\ + gedankliche Trennungen mit -- und Abstand davor und danach + \footnote{Diese Methode ist in Zentraleuropa und UK gebräuchlich. + Laut US-Standard~\cite{TeXbook, LaTeX} wird---ohne Abstand zum Text + verwendet} + \hfill (in \LaTeX{} \verb|--|)\\ + +\item Abstände zwischen Zahlen und Einheiten, Einheiten nicht kursiv\\ + z.B.: $I= 12\,\mathrm{A}$\quad\quad (\verb|$I = 12\,\mathrm{A}$|) + +\item Verwendung von Abkürzungen nur wenn nötig und wenn der Leser nicht verwirrt wird. + +\item Verwendung von abgesetzten Formeln für Gleichungen oder Berechnungen + (in \LaTeX{} mit den Umgebungen \textit{displaymath, align, gather,\dots}) + +\item Geschützte Leerzeichen damit Namen nicht getrennt werden. z.B.: \verb|S.~Laube| + +\item Abstände für bessere Lesbarkeit von Zahlen (mit \verb|\,|)\\ +z.B.: $1.782\,135\,567$ \quad\quad(\verb|$1.782\,135\,567$|) +\end{enumerate}\bigskip + +\subsection{Querverweise in \LaTeX{}} +Querverweise sind in \LaTeX{} wie viele anderen Größen dynamisch. +Man schreibt daher auf keinen Fall Verweise wie: "`{\verb|In Abbildung 1 sieht man|\dots}"'. +Dieser Satz enthält zwei Fehler. Zum einen werden Verweise in \LaTeX{} über sogennante \textit{Labels} gelöst, +zum anderen werden Verweise mit geschützten Leerzeichen ausgeführt.\par + +Ein richtiger Verweis beginnt beim Einbinden der Grafik, Tabelle oder Datei. Es wird ein eindeutiges +Label festgelegt (siehe Listing~\ref{lst:label}). Dieses enthält die Nummer des zu referenzierenden Objekts +(z.B.: 1 bei "`{Abbildung 1}"').\newpage +\lstset{caption=Anlegen von Labels,label=lst:label} +\begin{lstlisting}[xleftmargin=.2\textwidth, xrightmargin=.2\textwidth] +%Abschnitte +\section{Test}\label{sec:test} + +%Bilder +\label{pic:test} +%Grafiken +\label{fig:test} + +%Tabellen +\label{tab:test} +\end{lstlisting} + +Die erzeugten Labels ändern ihre Nummer entsprechend der Reihenfolge im Text und können im Text referenziert werden +(siehe Listing~\ref{lst:referenz}).\par \medskip + +\lstset{caption=Richtiges Referenzieren im Text,label=lst:referenz} +\begin{lstlisting}[xleftmargin=.2\textwidth, xrightmargin=.2\textwidth] +%Richtiges Referenzieren: +In Abbildung~\ref{pic:test} sieht man... +\end{lstlisting} + + +\newpage +\appendix +\section{Packages} +Diese Seite zeigt alle Packages die vom Diplomarbeitspackage oder der Templatedatei geladen werden. +Sie müssen daher nicht noch einmal vom Benutzer geladen werden! + +\lstset{caption=Standardmäßig inkludierte Usepackages,label=lst:packages} +\begin{lstlisting}[xleftmargin=.15\textwidth, xrightmargin=.15\textwidth] +%Format +\usepackage[scale=0.75]{geometry} +\usepackage[automark]{scrpage2} +%Encoding+Fonts +\usepackage[utf8]{inputenc} +\usepackage[T1]{fontenc} +\usepackage{textcomp} +%Sprache +\usepackage[english, naustrian]{babel} +%Farbe +\usepackage[dvipsnames]{xcolor} +%Floats +\usepackage{graphicx} +\usepackage{tabularx} +\usepackage{listings,scrhack} +\usepackage[printonlyused,withpage]{acronym} +\usepackage{array} +\usepackage{float} +%TikZ +\usepackage[europeanresistors, + europeaninductors]{circuitikz} +\usetikzlibrary{arrows,automata,positioning} +\usepackage{pgfgantt} +%Mathematik +\usepackage{amsmath,amssymb} +%Andere +\usepackage{pdfpages} +\usepackage{etdipa} +\usepackage{todonotes} +% Hyperlinks im Dokument +\usepackage[colorlinks=true, + linkcolor=black, + citecolor=green, + bookmarks=true, + urlcolor=blue, + bookmarksopen=true]{hyperref} +\end{lstlisting}\newpage + +\section{Templatespezifische Befehle}\label{sec:befehle} +\lstset{caption=Liste aller templatespezifischen Befehle,label=lst:commands} +\begin{lstlisting}[xleftmargin=.08\textwidth, xrightmargin=.08\textwidth] +%Versionsnummern +\ETdipaversion % DA-Template +%Namen in der Fusszeile +\responsible{#1} +% Kopf- und Fusszeile +\setmyheadings +%Titelseite +\dokumenttyp{#1} +\and +\professor{#1} +\schuljahr{#1} +\place{#1} +%Eid +\unterschrift{#1} +%Diplomandenvorstellung +\firma{#1}{#2} +\schule{#1}{#2} +\diplomand{#1}{#2}{#3}{#4}{#5}{#6}{#7} +\breite{#1} +%Farbe +\dipacolor{#1} +ETred +IForange +ELyellow +MBblue +WIgreen +%Namenskonventionen +\dipvorname +\dankname +\eidname +%Eidestext +\@@eid@text +%Umgebungen +\begin{Diplomandenvorstellung} +\end{Diplomandenvorstellung} +\begin{Eid} +\end{Eid} +\begin{Danksagung} +\end{Danksagung} +\begin{Literatur} +\end{Literatur} +%Zero-Umgebungen; Prof. Haager +\begin{zeroitemize} % auch mit description und enumerate +\end{zeroitemize} +%Listen +\dipalistoffigures +\dipalistoftables +%Extra Makros +\TikZ +\Masse % Massesymbol (TikZ) +\S % Sternschaltung +\D % Dreieckschaltung +\DS % Dreieck-Stern +\SD % Stern-Dreieck +% TabularX-Erweiterung; Prof. Haager +L / C / R % als Spaltentyp +\end{lstlisting} + +\section{Ergänzungen für Lehrpersonen} +Dieser Abschnitt behandelt die allgemeinen Konventionen die +von Ihnen -- den Lehrpersonen -- festgelegt werden müssen, +bevor den Schülern das Template zur Verfügung gestellt wird.\par\medskip + +Die Vorbereitung ist essenziell, damit die Arbeiten +Ihrer Schule ein einheitliches Aussehen mit typographisch +korrektem Textsatzt vereinen.\par + +\subsection{Setup des Diplomarbeits-/VWA-Designs} +Sie sollten sich vor der Verwendung des Templates +das gewünschte Aussehen Ihrer fertigen Arbeiten +vorstellen und demnach die folgenden Einstellungen festlegen. +Diese müssen nicht immer gelten, es ist beispielsweise auch möglich +das Design jährlich oder zweijährlich +zu ändern.\par \medskip + +Optional können Sie die getroffenen Einstellungen auch +in einer \TeX{}-Datei zusammenfassen und die Schüler binden +diese dann nur noch ein -- vgl. Abschnitt~\ref{sec:master}. +Einfacher ist es jedoch, das Design festzulegen und den Schülern +dann beim Ausfüllen der notwendigen Makros zu helfen.\par + + \subsubsection{Dokumenttyp} + Ganz zu Beginn muss der Typ der Arbeit festgelegt werden. An HTLs + sind zum Beispiel Diplomarbeiten, Projektarbeiten und Abschlussarbeiten + vorgeschrieben, während an AHS durchwegs Vorwissenschaftliche Arbeiten + geschrieben werden.\par \medskip + + Der Standard-Dokumenttyp ist \textit{DIPLOMARBEIT}, er kann jedoch + verändert werden -- siehe Listing~\ref{lst:doctype}, vgl. Listing~\ref{lst:maketitle_info}.\par \newpage + + \lstset{caption=Dokumenttyp einstellen,label=lst:doctype} +\begin{lstlisting}[xleftmargin=.15\textwidth, xrightmargin=.15\textwidth] +%% Dokumenttyp einstellen +\dokumenttyp{DIPLOMARBEIT} +% oder +\dokumenttyp{VORWISSENSCHAFTLICHE\\ARBEIT} +% oder +\dokumenttyp{ABSCHLUSSARBEIT} +% usw. +\end{lstlisting} + \subsubsection{Titelseite} + Ein sehr kritischer Punkt bei der Designerstellung ist die Titelseite. + In der aktuellen Version \ETdipaversion{} wird lediglich der Austausch + des Titelbildes auf der ersten Seite der Arbeit unterstützt.Falls eine + komplett eigene Titelseite gewünscht ist, müssen Sie sich zwangsweise + mit der \LaTeX{}-Umgebung \textit{titlepage}, dem \verb|\maketitle|-Befehl + und meinem Templatepackage {\ttfamily etdipa} auseinandersetzen. \par\medskip + + Das gesamte Projekt steht unter der \LaTeX{} Project Public License, welche + es erlaubt den Sourcecode, sowie die Dokumentation beliebig abzuändern und + frei weiterzuverbreiten. In jedem Fall muss eine Änderung jedoch kenntlich + gemacht werden!\par \bigskip + + Das Titelbild im \textit{Images}-Ordner der Arbeit kann einfach durch Ihr + eigenes über\-schrieb\-en werden.\par + + \subsubsection{Farbe} + Die Farbe der Diplomandenvorstellung trägt wesentlich zum Aussehen der + Arbeit bei. Da das Template an der HTL St.Pölten entstand, gibt es die + fünf Abteilungsfarben bereits vordefiniert: + \begin{itemize} + \item ETred + \item ELyellow + \item MBblue + \item IForange + \item WIgreen + \end{itemize} + + Wie in Listing~\ref{lst:colordef} ersichtlich, können Sie ihre eigene + Abteilungs-/Schulfarbe leicht selbst definieren. Über den \verb|\dipacolor|-Befehl + wird die Farbe der Diplomandenvorstellung verändert -- vgl. Listing~\ref{lst:maketitle_info}. + + \lstset{caption=Farben definieren und verwenden,label=lst:colordef} +\begin{lstlisting}[xleftmargin=.15\textwidth, xrightmargin=.15\textwidth] +% Farbdefinition +\definecolor{ETred}{RGB}{255,0,0} + +% Farbe setzen +\dipacolor{ETred} +\end{lstlisting} + + \subsubsection{Namen} + Ein weiterer essenzieller Teil des Aussehens sind die Namenskonventionen + für die Danksagung, die Eidesstattliche Erklärung und die Diplomandenvorstellung. + Für den Fall eines Änderungswunsches wurden Namensvariablen vorgesehen. Listing~\ref{lst:names} + zeigt wie Sie die Namen willkürlich ändern können.\par + + \lstset{caption=Namensvariablen ändern,label=lst:names} + \begin{lstlisting}[xleftmargin=.15\textwidth, xrightmargin=.15\textwidth] + % Diplomandenvorstellung + \dipvorname{Sch\"ulerportrait} + % Danksagung + \dankname{Dankesworte} + % Eidesstattliche Erklaerung + \eidname{Eid} + \end{lstlisting} + + + \subsubsection{Ausdruck} + Standardmäßig werden Diplomarbeiten einseitig gedruckt. Der zweiseitige + Druck wird jedoch vom Template unterstützt. + Bitte beachten Sie, dass bei der zweiseitigen Option die + Seitenränder anders aussehen. Die Option muss also unbedingt gesetzt werden, + falls zweiseitiger Druck gewünscht ist -- siehe Listing~\ref{lst:druck} + + \lstset{caption=Zweiseiten-Druck Option bei der Dokumentklasse,label=lst:druck} + \begin{lstlisting}[xleftmargin=.1\textwidth, xrightmargin=.1\textwidth] + % zweiseitig + \documentclass[twoside,paper=a4,12pt]{scrreprt} + % einseitig + \documentclass[paper=a4,12pt]{scrreprt} + \end{lstlisting} + + \subsubsection{Schriftarten} +Die Standardschriftart für serifenlose Texte wurde auf \textit{Helvetica} umgestellt. Alle +restlichen Schriftarten wurden auf \LaTeX{}-Standard belassen.\par + + \subsubsection{Eidesstattliche Erklärung} +Um die Bedienung für den Anwender möglichst einfach +zu gestalten, ist der Text der Eidesstattlichen Erklärung +vorgegeben. Die Schüler müssen daher nur ihren Namen hinzufügen +-- vgl. Listing~\ref{lst:eid}. \par \medskip + +Falls Ihre Schule einen anderen Eidestext verwendet, können Sie diesen +selbstverständlich ändern; der Komfort bei dieser Änderung +ist jedoch nicht so groß wie bei den vorherigen Einstellungen.\par \medskip + +Für die Änderung des Textes muss der Sourcecode aus Listing~\ref{lst:eidaendern} +in jede Arbeit übernommen und bei \verb|%% hier Text| Ihr +Eidestext eingefügt werden. + +\lstset{caption=Ändern des Eidestextes,label=lst:eidaendern} +\begin{lstlisting}[xleftmargin=.15\textwidth, xrightmargin=.15\textwidth] +\makeatletter + \long\def\@@eid@text{ + %% hier Text + } +\makeatother +\end{lstlisting} + +\subsubsection{Feedback} +Wenn Ihre Schule oder Firma sich dafür entscheidet dieses Template als offizielle +Vorlage zu verwenden, schreiben Sie mir bitte eine Email mit Namens- und Ortsangabe +Ihrer Institution. Diese Daten dienen rein einem persönlichen Feedback, wieweit +das Template bereits gelangt ist und werden daher auch nicht veröffentlicht.\par + +\subsection{\TeX nische Ergänzungen} + +\subsubsection[Längendefinitionen]{Längendefinitionen} +In den folgenden Absätzen werden die Längendefinitionen der Diplomarbeitsvorstellung +erläutert. +Zum besseren Verständnis befindet sich in Anhang~\ref{sec:bemassungdipl} in Abbildung~\ref{pic:bemassungdipl} +eine optische Darstellung aller Bemaßungen. + +\paragraph{Gesamtbreite der Diplomandenvorstellung.} +Diese Größe ist in Abhängigkeit von der Textbreite gesetzt. Das wirft +bei langen Argumenten (des Benutzers) das Problem von über\-stehenden +Textteilen auf. Die Defaultbreite wurde daher auf \verb|0.6\textwidth| +gesetzt, was bei einer Seitenrandskalierung von bis zu $scale=0.7$ ({\ttfamily geometry}-Package) +keine Probleme bewirkt. +\lstset{caption=Breite der Diplomandenvorstellung,label=lst:ges_breite} +\begin{lstlisting}[ xleftmargin=.15\textwidth, xrightmargin=.15\textwidth] +%Breite der gesamten Diplomandenvorstellung +\newlength{\@width@dpl} +\setlength{\@width@dpl}{0.6\textwidth} +\end{lstlisting} + +\paragraph{Rahmenabstand vom Bild.} +Eine weiteres Längenmaß ist der Abstand des Rahmens vom Bild. +Defaultwert ist hier $1\,\mathrm{mm}$. Die Strichstärke +des Rahmens ist der Standardwert von \TikZ{}. +\lstset{caption=Abstand des Rahmens vom Bild,label=lst:rahmenabstand} +\begin{lstlisting}[ xleftmargin=.15\textwidth, xrightmargin=.15\textwidth] +%Abstand Bild<->Rahmen +\newlength{\@sep@dpl} +\setlength{\@sep@dpl}{1mm} +\end{lstlisting} + +\paragraph{Defaultbreite des Bildes.} Das Makro für die Breite des Bildes wird in +Anlehnung an die \verb|\@author, \@title,...| Makros der einzelnen Dokumentklassen +gestaltet. Der Vorteil liegt für den Benutzer darin, das kein \verb|\def| oder ähnliches +verwendet werden muss und damit die Könnerstufe des \LaTeX{}-Endbenutzers nicht so hoch sein muss. +\lstset{caption=Festlegung der Breite des Diplomandenbildes,label=lst:breite_abfrage} +\begin{lstlisting}[ xleftmargin=.14\textwidth, xrightmargin=.14\textwidth] +%%Definition des Breite Makros fuer das +%%Diplomandenbild +\providecommand{\breite}[1]{\gdef\@breite{#1}} + +%% Defaultbreite wenn \breite +%% nicht vom Anwender definiert wird +\newlength{\@default@breite} +\setlength{\@default@breite}{3cm} +\breite{\@default@breite} +\end{lstlisting} + +\subsubsection{Diplomandenvorstellung Maße}\label{sec:bemassungdipl} +\vspace{-10mm} +\begin{figure}[H] +\centering +\includegraphics[width=0.8\textwidth]{Images/diplomand_erklaerung.pdf} +\caption{Festgelegte Abmessungen der Diplomandenvorstellung} +\label{pic:bemassungdipl} +\end{figure} + +\textit{Anmerkung:} Abbildung~\ref{pic:bemassungdipl} beschreibt nur das Prinzip der +Ausrichtung. Es fehlt beispielsweise die Beschreibung des Abstandes zwischen \textit{Redbox} und Bild, +welcher von der Größe von \verb|\@sep@dpl| abhängt.\\ Tatsächlich +wird im Makro die \textit{Redbox} genau \verb|\@width@dpl-\@breite| breit gesetzt. +Die Gesamtbreite ist damit die eigentliche ungenaue Größe. Abbildung~\ref{pic:bemassungdipl} +ist jedoch anschaulicher als der exakte Aufbau. + + + + + +%\newpage +%\phantomsection +%\addcontentsline{toc}{section}{Liste der Sourcecode Listings} +%\lstlistoflistings + +\newpage +\def\refname{Literaturverzeichnis} +\phantomsection +\addcontentsline{toc}{section}{Literaturverzeichnis} + +\begin{thebibliography}{abcd} +\bibitem[1]{TeXbook}{\textbf{Donald~E.~Knuth:} \emph{The \TeX{}book}. 1986, {\scshape Addison--Wesley} Verlag,\\ +ISBN-13: 978-0-201-13447-6} + +\bibitem[2]{LaTeX}{\textbf{Klaus~Braune, Joachim~{\&}~Marion~Lammarsch:}\\ + \emph{\LaTeX{}--Basissystem, Layout, Formelsatz.} +2006, Springer Verlag,\\ ISBN-13: 978-3-540-00718-0} + +\bibitem[3]{TikZ}{\textbf{Till~Tantau:} \TikZ{} \emph{and {\scshape pgf}--Manual for version~1.18.} 2007,\\ +{\scshape gnu} Free Documentation License, Version 1.2} + +\bibitem[4]{clsguide}{\textbf{The \LaTeX 3 Project:} \emph{\LaTeXe{} for class and package writers.}\\ +February 2006} + +\bibitem[5]{fonts}{\textbf{Carl~G.~Heise:} \emph{\LaTeX{} Kurs: Schriftarten (Kurzeinführung).}\\ TU~München, Oktober~2011} + +\bibitem[6]{tugboat}{\textbf{Peter~Flynn:} \emph{Rolling your own Document Class: +Using \LaTeX{} to keep away from the Dark Side.} TUGboat, Volume 28 (2007), No. 1} + +\bibitem[7]{maketitle}{\textbf{Markus~Kohm:} \emph{Titelseite mit KOMA-Script.} Version vom 8.Juni~2011,\\ +abgerufen auf \url{www.golatex.de/wiki/Titelseite_mit_KOMA-Script}} + +\bibitem[8]{headings}{\textbf{Tanja~Richter:} \emph{Fußnoten, Kopf- und Fußzeilen in \LaTeX{}.} Mai~2004} + +\bibitem[9]{acronym}{\textbf{Tobias~Oetiker:} \emph{An Acronym Environment for \LaTeXe .} Oktober~2010} + +\bibitem[10]{websites}{\textbf{Allgemeine Foren:} \url{www.latex-community.org}, \url{www.mrunix.de},\\ + \url{www.golatex.de}, \url{www.tex.stackexchange.com}, \url{www.texample.net}} +\end{thebibliography}\bigskip + +Das Literaturverzeichnis enthält alle Quellen die zur Erzeugung und Dokumentation des Diplomarbeitstemplates +verwendet wurden. Weiters dient es zum Nachschlagen für Benutzer des Templates.\par + +\end{document}
\ No newline at end of file diff --git a/macros/latex/contrib/etdipa/Help/etdipa_doc_EN.pdf b/macros/latex/contrib/etdipa/Help/etdipa_doc_EN.pdf Binary files differnew file mode 100644 index 0000000000..9ba0fad20c --- /dev/null +++ b/macros/latex/contrib/etdipa/Help/etdipa_doc_EN.pdf diff --git a/macros/latex/contrib/etdipa/Help/etdipa_doc_EN.tex b/macros/latex/contrib/etdipa/Help/etdipa_doc_EN.tex new file mode 100644 index 0000000000..432a0db7d6 --- /dev/null +++ b/macros/latex/contrib/etdipa/Help/etdipa_doc_EN.tex @@ -0,0 +1,1035 @@ + %% da_manual_EN.tex + %% Copyright 2015 Simon M. Laube + % + % 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 `author maintained'. + % + % The Current Maintainer of this work is S. M. Laube + % + % This work consists of the files listed in ./Help/files.txt + +%%~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~%% +%% Documentation of the etdipa-template %% +%%~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~%% +\PassOptionsToPackage{xcolor}{dvipsnames} +\documentclass[12pt,paper=a4]{scrartcl} +\usepackage[utf8]{inputenc} +\usepackage[naustrian,english]{babel} +\usepackage[scale=0.7]{geometry} +\usepackage{graphicx} +\usepackage{float} +\usepackage{circuitikz} +\usepackage{listings} +\usepackage{array} + + + + +\lstset{language=[LaTeX]TeX, + texcsstyle=*\ttfamily\color{red!80!black}, + literate={{ß}{{\ss}}2}, + basicstyle={\ttfamily\color{black}}, + commentstyle=\color{green!60!black}, + keywordstyle=\ttfamily\color{red!80!black}, + numberstyle=\tiny\color{red}, + numbers=left, + captionpos=b, + %otherkeywords={}, + basicstyle=\footnotesize, + morekeywords={\diplomand ,\breite ,\@width@dpl ,\@sep@dpl,\ifundefined, + \@breite,\@default@breite,\setlength,\providecommand,{\ },{\\},\includegraphics, + \responsible,\hypersetup,\tikz,\",\href,\node,\dipalistoffigures,$, \{, \}, \[, \],\includepdf,\frontmatter,\appendix,\mainmatter,\schuljahr,\professor,\maketitle,\addchap,\acro,\unterschrift,\usetikzlibrary,\includepdf, \schule,\firma, \Masse,\TikZ,\S,\D,\DS,\SD,\dipacolor,\@@eid@text,\definecolor +\dipalistoffigures,\dipalistoftables,\dplversion,\ETdipaversion,\manversion,\dokumenttyp,\dipvorname,\eidname,\dankname, +\definecolor,\place,\setmyheadings} + } + + \usepackage{etdipa} + \clearscrheadfoot\relax + \pagestyle{empty} + \pagestyle{scrheadings} + + +\setfootsepline{.5pt} +\setheadsepline{.5pt} +\ohead{\today} +\ihead{Simon~Michael~Laube} +\ifoot{{\ttfamily etdipa} -- Manual} +\ofoot{\pagemark} + + +\title{How to use the {\ttfamily etdipa}-template \ETdipaversion} +\author{Simon~Michael~Laube\\5BHET~2014/15} +\date{\today} +\def\TikZ{Ti\textit{k}Z} +\def\addtoc#1#2{\addcontentsline{toc}{#1}{#2}} +\def\nsec#1{\section*{#1}\addtoc{section}{#1}} +\def\nsubsec#1{\subsection*{#1}\addtoc{subsection}{#1}} +\def\nsubsubsec#1{\subsubsection*{#1}\addtoc{subsubsection}{#1}} +\setlength{\parindent}{0pt} + +%% DIRTY TRICK :) +\makeatletter +\def\maketitle{% +\thispagestyle{empty} +\begin{figure}[H] +\includegraphics[scale=1]{Images/ET_logo.jpg} +\centering +\end{figure} +\begin{center} + \Huge \bfseries\sffamily\@title\\ + \vskip 1em + \Large\mdseries\rmfamily\@author\\ + \vskip .5em + \large\mdseries\@date\\ + \normalsize \rmfamily +\end{center} + }% +\makeatother + +\usepackage[colorlinks=true, + linkcolor=black, + citecolor=green, + urlcolor=blue, + bookmarks=true, + bookmarksopen=true]{hyperref} + +\begin{document} + +\maketitle +\tableofcontents\newpage + + +\addtocontents{toc}{\protect \large {\bfseries Part~I: Conventions \& Structure}\protect\vspace{1mm}\hrule\normalsize} + +\nsec{Introduction} + +The {\ttfamily etdipa}-package provides a simple, lightweight +\LaTeX{} template for the documentation of scientific projects. +It is distributed as a whole working directory +for an arbitrary project\footnote{Please note that the +template is optimized for the {\ttfamily scrreprt} class.}.\par +The motivation for this template was to reach as many +users as possible at different levels of \LaTeX{} knowledge. +Nevertheless some macros are assumed as a minimum requirement +and will be used without any explaination.\par\medskip + +The current version is \ETdipaversion{}. It is now possible +to modify several colors and the title page. Further, +the manual has been translated to English. For additional information +please have a look at the \href{http://www.ctan.org/pkg/etdipa}{README} +file or the complete +\href{https://medium.com/@simon_m_laube/etdipa-offical-release-details-by-the-author-59b6d9ad104b}{project history}.\par \medskip + + +If there are any suggested improvements, feel free to write an email +using the following adress: \href{mailto:simon.laube@gmx.at}{simon.laube@gmx.at}. Please note that +this email adress is not intended to be used as a source of information +for the use of this template.\par\medskip + + +\nsubsec{Acknowledgement} +I would like to thank Prof. Mag. Dipl.-Ing. Dr.~Daniel~Asch and Prof. Dipl.-Ing. +Dr.~Wilhelm~Haager for their help with \TeX nical questions and the supervisory +of the whole project. Further, I would like to thank everyone who helped improving the template macros and documentation.\par\medskip + + + +\null\hfill -- Simon Michael Laube, \today{} -- + +\section{Conventions} +This section is to briefly summarize the conventions made +for this document.\par\bigskip +\begin{tabular}{>{\bfseries}c l} +Commands & are written in {\ttfamily typewriter}-font,\\ + & and within a \textit{listings-} or + \textit{verbatim}-environment. \\ +&\\ +\LaTeX{}-terms& and emphases are typeset in \textit{italics}. +\end{tabular}\par\bigskip + +An overview of all template-specific marcos can be found +in appendix~\ref{sec:befehle}.\par + + + + +\section{Structure} + +%% ==== Ordner ==== %% +\subsection{Directory structure} +\begin{figure}[H] +\centering +\includegraphics[width=0.7\textwidth]{Images/Ordnerstruktur.pdf} +\caption{Predefined directory structure of the template\newline + \protect\tikz{\protect\node[rectangle,fill=blue!50!white]{};} \dots\dots master directory\newline + \protect\tikz{\protect\node[rectangle,fill=yellow!70!red]{};} \dots\dots predefined subfolders\newline + \protect\tikz{\protect\node[rectangle,fill=red!80!blue]{};} \dots\dots explaination} +\label{pic:ordnerstruktur} +\end{figure} + +Figure~\ref{pic:ordnerstruktur} shows the predefined directory structure. The user +should use the master directory \verb|<Diplomarbeitsordner>| as his working +directory. +All the additional files should be copied to \textit{Data, Images} and \textit{Textparts}. +The \textit{Help} directory contains the template documentation and additional help files.\par\bigskip + +When a school or company is using this template, the given structure should not be modified +for reasons of consistency. Nevertheless the users can create subfolders within the given +structure. An example is given in figure~\ref{pic:unterordner}. +To learn how to work with multiple \LaTeX{} files you should read section~\ref{sec:master}.\par \vspace{1mm} + +\begin{figure}[H] +\centering +\includegraphics[width=0.4\textwidth]{Images/subordner.pdf} +\caption{An example for creating subfolders within the predefined directories} +\label{pic:unterordner} +\end{figure} + +\def\labelitemi{$>$} +\begin{itemize} + +\item The \textit{Data} folder contains all the additional data that is not really needed +for the documentation. This could be simulation files (e.g.: Proteus, {\scshape Spice}) +as well as technical drawings (e.g.: AutoCAD, \TikZ) or circuit diagrams (e.g.: EPlan). +One could also use this folder to create a separate presentation of the project -- e.g. with +PowerPoint, Beamer-\LaTeX{}, Prezi or any other program. + +\item The \textit{Textparts} folder is the main working directory for your documentation +files. It contains all the sub files of your master document. If you are unsure +what a master document is, please read section~\ref{sec:master}. + +\item The \textit{Images} folder contains all the images of your documentation and work. +Of course you do not have to include all the files in this folder into your document. + +\end{itemize}\bigskip + +The master document of your documentation is located in the master directory +of the template. Thus, it is possible to include all the files from your subfolders +into the master document.\par \newpage + +%% ==== Mastefile ==== %% +\subsection{Working with master files}\label{sec:master} + +Normally a \LaTeX{} document consists of one {\ttfamily *.tex} file. +Setting up a document that way makes sense, +but if the document gets longer and longer you might loose track of +all the sections and textparts. There is a special technique for +large documents, which is commonly used by real \TeX{}nicians.\par \bigskip + + +There are two cases:\par +\begin{itemize} +\item[$-$] The \LaTeX{} file is large, but not too large to loose track of your sections. +If this is true for you, you can keep your current workflow and create only one \TeX{} file. + +\item[$-$] The \LaTeX{} file is very large. In this case you should split your document +into separate files. +\end{itemize} + +Since this template is for scientific documents, the second case is true. +The following \textit{minimal working examples} show how to work with +master and sub files.\par\bigskip + +\subsubsection{Standalone documents} +Before someone starts to work with master documents, he/she normally works +with standalone documents, which are basically all the text in one file. +Listing~\ref{lst:normalesarbeiten} shows such a standalone file.\par + + +\lstset{caption=A normal \LaTeX{} document,label=lst:normalesarbeiten} +\begin{lstlisting}[ xleftmargin=.14\textwidth, xrightmargin=.14\textwidth] +% documentclass / style +\documentclass{article} +%UTF8 encoding +\usepackage[utf8]{inputenc} +\begin{document} + \section{Title} + Here is some text. + \par % end of the paragraph +\end{document} +\end{lstlisting} + + +\subsubsection{Master and sub files} +The first step for handling large documents is to create +a so called \textit{master file}. This file contains +the \LaTeX{} preamble and the start and end of the document. +Listing~\ref{lst:masterfile} shows an example of a +simple master file.\par + +\lstset{caption=A simple \LaTeX{} master file,label=lst:masterfile} +\begin{lstlisting}[ xleftmargin=.1\textwidth, xrightmargin=.1\textwidth] +% preamble +\documentclass{article} +\usepackage[utf8]{inputenc} +% document starts here +\begin{document} + % empty for now +\end{document} +% document ends here +\end{lstlisting} + +The second step is to create a \textit{sub file} that only contains +text and sections, but no preamble and no start- or end-of-document command -- see Listing~\ref{lst:subfile}. +Thus, this sub file could not be compiled +by \TeX{}! + +\lstset{caption=A \LaTeX{} sub file,label=lst:subfile} +\begin{lstlisting}[ xleftmargin=.1\textwidth, xrightmargin=.1\textwidth] +%% file: mytext.tex +\section{My text part} + This is a text part + of my large document.\par +\end{lstlisting}\par\vspace{20mm} + + +To finally create the complete document one has to use the +\TeX{} command \verb|\input|. The argument has to be the relative +path of your sub file based on the absolute path of the master file.\par +Furthermore a PDF could be included via \verb|\includepdf[<options>]{<name>}|, +but the package {\ttfamily pdfpages} needs to be included for that. +The problem with PDFs is that they have to be scaled +when included, otherwise the header and footer will not fit +the page. +\par + +\lstset{caption=\LaTeX{} master file with included subfiles,label=lst:fullmaster} +\begin{lstlisting}[ xleftmargin=.1\textwidth, xrightmargin=.1\textwidth] +% preamble +\documentclass{article} +\usepackage[utf8]{inputenc} +\usepackage{pdfpages} +% document starts here +\begin{document} + % my first text part % + \input{mytext.tex} + % my second text part % as PDF + \includepdf[pages=3-5]{mypdf.pdf} +\end{document} +% document ends here +\end{lstlisting} + +\addtocontents{toc}{\protect\large\protect\newpage{\bfseries Part~II: How to use the template} +\protect \vspace{1mm}\hrule\normalsize} + +\section{How to use the macros}\label{sec:macros} +In this section all functions and macros of the +{\ttfamily etdipa}-template will be explained. The new commands are not +part of the \LaTeX{} standard macros. Therefore, the user +has to use the \verb|etdipa.sty| package to enable the template +macros.\par + + +\subsection{Title page -- {\ttfamily maketitle}} + +In \LaTeX{} the \verb|\maketitle| command is used +to automatically create the title page from the given +information. The command was redefined for this template to +get a different title page look. +Thus, one can simply say \verb|\maketitle| at the beginning of +the document and he/she will get the template title page.\par \smallskip + +Listing~\ref{lst:maketitle_info} shows the necessary information +that the template-user has to provide.\par + +\lstset{caption=Setup for the title page,label=lst:maketitle_info} +\begin{lstlisting}[xleftmargin=.14\textwidth, xrightmargin=.14\textwidth] +%%==== Setup for the title page ===============%% +\dokumenttyp{DIPLOMARBEIT} +\title{<Title of your work>} +\author{Student 1 \and Student 2} +\place{<Place>} +\date{<Date>} +\schuljahr{<Year>} +\professor{Professor 1 \and Professor 2} +\dipacolor{<Color>} +%%============================================%% +\end{lstlisting} + +At the beginning of your document you should +use \verb|\maketitle| to create the title page. +Next to that the writer should set his +name into the footer via the \verb|\responsible| command.\par + +\lstset{caption=Possible beginning of your document,label=lst:maketitle} +\begin{lstlisting}[xleftmargin=.15\textwidth, xrightmargin=.15\textwidth] +\begin{document} +\frontmatter +%%============ Title page =============%% +\maketitle +% Author of this section +\responsible{Student 1, Student 2} +%%====================================%% + . . . + . . . + . . . +\end{lstlisting} + + +\subsection{Affidavit} +The affidavit can be added to your document by +using a predefined environment called \textit{Eid}\footnote{German word +for affidavit}. +This environment automatically +adds the affidavit text to your document, the only thing +a user has to add is the signature line -- +see listing~\ref{lst:eid}. Further, it arranges the +text at the vertical middle of the page.\par +\lstset{caption=How to add the affidavit,label=lst:eid} +\begin{lstlisting}[xleftmargin=.15\textwidth, xrightmargin=.15\textwidth] +%%===== Affidavit =======================%% +\begin{Eid} +% adding the signature lines +\unterschrift{Student 1} +\unterschrift{Student 2} +\end{Eid}\newpage +%%=======================================%% +\end{lstlisting} + + +\subsection{Acknowledgement} + +The text of your acknowledgement should be written in an +external file. Again, there is a special environment +for the acknowledgement called \textit{Danksagung}\footnote{German word +for acknowledgement}.\par +\lstset{caption=How to add the acknowledgement,label=lst:dank} +\begin{lstlisting}[xleftmargin=.15\textwidth, xrightmargin=.15\textwidth] +%% Acknowledgement +\begin{Danksagung} + +% We would like to thank \dots + +\end{Danksagung} +\end{lstlisting} + +\subsection{References} +References are one of the most important things +in technical documentations. They should be written in +a consistent style. \LaTeX{} offers the possibility +to automatically create the reference list out of an +external bibliography file, but this template does +not use this option to keep things a little bit simpler.\par\medskip + +The template uses the \LaTeX{} bibliography environment +with a little modification, so the user has to do less work. +Listing~\ref{lst:literatur} shows how to use the modified +bibliography environment.\par \newpage + + +\lstset{caption=References,label=lst:literatur} +\begin{lstlisting}[xleftmargin=.15\textwidth, xrightmargin=.15\textwidth] +%% References +\begin{Literatur} + +\bibitem[1] % optional number + {TeXbook}% cite-key + % text: + {\textbf{Donald~E.~Knuth:} + \emph{The \TeX{}book}. + 1986, {\scshape Addison--Wesley}, + ISBN-13: 978-0-201-13447-6} + +\end{Literatur} +\end{lstlisting} +The bibliography entry in listing~\ref{lst:literatur} results in +entry number~\cite{TeXbook}. To refer to a reference one has +to use the \verb|\cite| command.\par + +\lstset{caption=How to cite a bibliography entry,label=lst:zitate} +\begin{lstlisting}[xleftmargin=.15\textwidth, xrightmargin=.15\textwidth] +Text~\cite{<cite-key>} +% for example +Text~\cite{TeXbook} +\end{lstlisting} + +\subsection{Acronyms} +The \textit{acronym} package of Tobias~Oetiker~\cite{acronym} +was used to implement the list of acronyms. +Since acronyms are not always necessary, the acronym environment +was not modified for the template.\par + +\lstset{caption=List of acronyms,label=lst:abkuerz} +\begin{lstlisting}[xleftmargin=.1\textwidth, xrightmargin=.1\textwidth] +% List of acronyms +% Add chapter to contents +\addchap{Acronyms} +\begin{acronym}[ACRONYM] +% an entry: +%{spi}[SPI]{Serial Peripheral Interface} +\acro{ugs}[ugs.]{umgangssprachlich} +\end{acronym}\newpage +\end{lstlisting} + +The acronym can be used in the text +by calling \verb|\ac{spi}|. At the first +use the whole expansion is shown in the text, +for all other cases the macro expands to the acronym.\par + + +\subsection{Short CV -- the {\ttfamily diplomand} macro}\label{subsec:diplomand} +\begin{figure}[H] +\centering +\diplomand{Max~Mustermann} + {12.12.2012 in St.P\"olten} + {XY-Street 14} + {3100 St.Pölten} + {\schule{2010--2015}{HTBLuVA St.Pölten, department for electrical\\ engineering} + \schule{2006--2010}{Lower secondary school XY}} + {max.muster@xy.at} + {Images/bild} +\caption{Result of the short CV command} +\label{pic:diplomandenvorstellung} +\end{figure}\newpage + +The short CV can be used to include a short employment and +education history of yourself and every member of the project +into the documentation. The design of the CV is based on the +\LaTeX{} documentclass {\ttfamily moderncv}\footnote{This +documentclass can be used to create high quality +CVs in different colors and designs.} and was realized via \TikZ{}.\par + + +\lstset{caption=How to create a short CV,label=lst:diplomandeneintrag} +\begin{lstlisting}[ xleftmargin=.15\textwidth, xrightmargin=.15\textwidth] +\begin{Diplomandenvorstellung} + % new CV entry + \diplomand + {<Name>} + {<Date of birth>} + {<Street and number>} + {<City and Postal Code>} + {<Education and employment>} + {<Email>} + {<Path of the picture>} +\end{Diplomandenvorstellung} +\end{lstlisting} + +Listing~\ref{lst:diplomandeneintrag} shows how to use the {\verb|\diplomand|} +command. This macro uses the given data and sets up the short CV of +one person. If there are more people working on the project everyone +has to create a short CV. The individual CVs should +be separated with \verb|\newpage|, because every CV arranges itself at +the vertical middle of the page. The command also automatically sets +the person's name into the footer.\par +\medskip +All +short CVs must be written within this environment. As mentioned above they +should be +separated by \verb|\newpage|. +The width of the short CV picture can be changed by +setting it to another value via \verb|\breite|. +A default value of $3\,\mathrm{cm}$ is already preset by +the template package.\par + +\lstset{caption=Changing the picture's width,label=lst:breite} +\begin{lstlisting}[ xleftmargin=.2\textwidth, xrightmargin=.2\textwidth] +\breite{<Wert>} +\end{lstlisting} + +\subsubsection{Including your previous education or work} +Since version v2.4 there are two new macros that offer +a better possibility to add your employment or education history +to the short CV. Listing~\ref{lst:firma_schule} shows +how the commands can be used.\par +\lstset{caption=Adding your employment/education history,label=lst:firma_schule} +\begin{lstlisting}[ xleftmargin=.11\textwidth, xrightmargin=.11\textwidth] +\firma{<Period>}{<Name of your job>} +\schule{<Period>}{<Name of your education/school>} +\end{lstlisting} + +Although these commands are easy to use, the chronological order +of the entries must be set +by the user. Listing~\ref{lst:diplomandenvorstellung} shows +the source code that was used to create +figure~\ref{pic:diplomandenvorstellung}.\par + +\lstset{caption=An example for a short CV,label=lst:diplomandenvorstellung} +\begin{lstlisting}[ xleftmargin=.15\textwidth, xrightmargin=.15\textwidth] +\begin{Diplomandenvorstellung} +\diplomand{Max~Mustermann} +{12.12.2012 in St.P\"olten} +{XY-Street 14} +{3100 St.P\"olten} +{\schule{2010--2015}{HTBLuVA St.P\"olten, +department for electrical\\ engineering} + \schule{2006--2010}{Lower secondary school XY}} +{max.muster@xy.at} +{Images/bild} +\end{Diplomandenvorstellung} +\end{lstlisting} + +\subsection{Header and footer} +For the setup of the header and footer the \textit{KOMA-script} package +\verb|scrpage2.sty| is used. The style is defined in the template +package \verb|etdipa| and should not be modified. Do not use +other header-packages than \verb|scrpage2| with \verb|etdipa|, +otherwise you will get warnings or errors.\par +If the header does not show up in your document you may not have +used the \verb|\mainmatter| or \verb|\frontmatter| command. In this +case you can get the predefined style by using \verb|\setmyheadings| at the +beginning of your document.\par\medskip + +The author of a page in the project documentation should always +be listed in the footer. Therefore the \verb|\responsible| +macro was defined -- see listing~\ref{lst:responsible}.\par + +\lstset{caption=Authors names in the footer,label=lst:responsible} +\begin{lstlisting}[ xleftmargin=.2\textwidth, xrightmargin=.2\textwidth] +\responsible{<Name1>, <Name2>} +\end{lstlisting}\vspace{5mm} + + + +\subsection{Page and chapter numeration} +Mostly documentations consist of three parts. Every part +has a specific page and chapter enumeration. To toggle these +numeration styles some basic \LaTeX{} commands must be used. +\par\newpage + +\begin{enumerate} +\item \textit{Frontmatter}, contains everything that is not part of your main text (e.g.: Contents, CV,\dots) +\item \textit{Mainmatter}, contains your main text +\item \textit{Appendix}, contains additional documents like datasheets and so on +\end{enumerate}\bigskip + +All the necessary lists -- except for the table of contents -- are located after +the appendix and therefore must be included after the appendix in your master document.\par\medskip + + +The commands for toggling the enumeration are: +\lstset{caption=Toggling the enumeration within your document,label=lst:nummerierung} +\begin{lstlisting}[xleftmargin=.15\textwidth, xrightmargin=.15\textwidth] +\frontmatter % +\mainmatter % +\appendix % +\end{lstlisting}\par + + + +\newpage +\section{Basic typographical rules} + +Every kind of document follows some simple typographical rules. Like Till~Tantau says: +``keep it as simple as possible''~\cite[translated, page\,48--52]{TikZ}). The readers' attention should +be drawn to your text, not to a confusing layout. Thus, you should know some simple rules~\cite{LaTeX}:\par + +\begin{enumerate} + +\item Hyphenations are typeset with - \hfill (\verb|-| in \LaTeX{} )\\ + Domains, e.g. page numbers with ``page\,40--50'' \hfill(\verb|--| in \LaTeX{} )\\ + Dashes with -- and a space before and after\footnote{That is how it + is done in Europe and the UK, the USA~\cite{TeXbook, LaTeX} is + using---without a space before and after the dash.} + \hfill (\verb|--| in \LaTeX{} )\\ + +\item There should be a small space between a number and its unit. Units are +never typeset in \textit{italics}.\\ + e.g.: $I= 12\,\mathrm{A}$\quad\quad (\verb|$I = 12\,\mathrm{A}$|) + +\item Only use acronyms when they are necessary and keep it simple for the reader. + +\item Align and numerate long equations (in \LaTeX{} this can be obtained by the math environments \textit{displaymath, align, gather,\dots}) + +\item Use protected spaces that a name is never torn apart into its pieces e.g. \verb|S.~Laube| + +\item Use small spaces to make large numbers more readable\\ +e.g.: $1.782\,135\,567$ \quad\quad(\verb|$1.782\,135\,567$|) +\end{enumerate}\bigskip + +\subsection{Labels and referencing} +Cross referencing is one of the great strenghts of \LaTeX{}. +Thus, one should never write a sentence like: ``{\verb|Figure 1 shows|\dots}''. +This sentence contains two mistakes. At first, \LaTeX{} uses so called \textit{labels} to +get the cross references right. Second, references are always typeset with a protected +space between text and number.\par + +A typographically correct cross reference starts when the target element is included into the +document. At that point the user has to set a unique label for this element. Further, +that unique label contains the number of the included element -- for example the label +returns $1$ if your element is the float ``Figure 1''. + +\lstset{caption=Setting labels,label=lst:label} +\begin{lstlisting}[xleftmargin=.2\textwidth, xrightmargin=.2\textwidth] +% Sections +\section{Test}\label{sec:test} + +% Pictures +\label{pic:test} +% Figures / Diagrams +\label{fig:test} + +% Tables +\label{tab:test} +\end{lstlisting} + +All the created labels can be used within the text to refer to the desired element -- +see listing~\ref{lst:referenz}.\par \medskip + +\lstset{caption=Correct cross referencing,label=lst:referenz} +\begin{lstlisting}[xleftmargin=.2\textwidth, xrightmargin=.2\textwidth] + +Figure~\ref{pic:test} shows ... +\end{lstlisting} + + +\newpage +\appendix +\section{Packages} +The following listing~\ref{lst:packages} shows all the packages +that are by default loaded by the template. Thus, these packages +need not be loaded by the user.\par + +\lstset{caption=Packages loaded by the template,label=lst:packages} +\begin{lstlisting}[xleftmargin=.15\textwidth, xrightmargin=.15\textwidth] +% style +\usepackage[scale=0.75]{geometry} +\usepackage[automark]{scrpage2} +% encoding and fonts +\usepackage[utf8]{inputenc} +\usepackage[T1]{fontenc} +\usepackage{textcomp} +% language +\usepackage[english, naustrian]{babel} +% color +\usepackage[dvipsnames]{xcolor} +% floats +\usepackage{graphicx} +\usepackage{tabularx} +\usepackage{listings,scrhack} +\usepackage[printonlyused,withpage]{acronym} +\usepackage{array} +\usepackage{float} +%TikZ +\usepackage[europeanresistors, + europeaninductors]{circuitikz} +\usetikzlibrary{arrows,automata,positioning} +\usepackage{pgfgantt} +% math packages +\usepackage{amsmath,amssymb} +% others +\usepackage{pdfpages} +\usepackage{etdipa} +\usepackage{todonotes} +% hyperlinks +\usepackage[colorlinks=true, + linkcolor=black, + citecolor=green, + bookmarks=true, + urlcolor=blue, + bookmarksopen=true]{hyperref} +\end{lstlisting}\newpage + +\section{Template-specific macros}\label{sec:befehle} +\lstset{caption=List of all template-specific macros,label=lst:commands} +\begin{lstlisting}[xleftmargin=.08\textwidth, xrightmargin=.08\textwidth] +% version number +\ETdipaversion +% puts the author in +% the footer +\responsible{#1} +% header and footer +\setmyheadings +% title page +\dokumenttyp{#1} +\and +\professor{#1} +\schuljahr{#1} +\place{#1} +% affidavit +\unterschrift{#1} +% short CV +\firma{#1}{#2} +\schule{#1}{#2} +\diplomand{#1}{#2}{#3}{#4}{#5}{#6}{#7} +\breite{#1} +% colors +\dipacolor{#1} +ETred +IForange +ELyellow +MBblue +WIgreen +% name variables +\dipvorname +\dankname +\eidname +% affidavit text +\@@eid@text +% environments +\begin{Diplomandenvorstellung} +\end{Diplomandenvorstellung} +\begin{Eid} +\end{Eid} +\begin{Danksagung} +\end{Danksagung} +\begin{Literatur} +\end{Literatur} +%'zero' environments by Prof. Haager +\begin{zeroitemize} % auch mit description und enumerate +\end{zeroitemize} +% lists +\dipalistoffigures +\dipalistoftables +% additional commands +\TikZ +\Masse % GND Symbol (TikZ) +\S % Y-connection symbol +\D % delta connection symbol +\DS % delta-Y connection symb. +\SD % Y-delta connection symb. +% TabularX-extension by Prof. Haager +L / C / R % as column-type +\end{lstlisting} + +\section{Additional information for teachers} +This section is for teachers or supervisors of projects +who use this template. Please read this section before +you introduce the template to your students/colleagues.\par\medskip + +The preparation of every part of the documentation +is very essential and should be done carefully. +\par + +\subsection{Design setup} +At first you should think about the look of the +design you want to use. It is also possible to +change the look every year or two.\par \medskip + +You can either save your setup as a \TeX{} file +which is then included on top of the documentation -- see section~\ref{sec:master}, +or you help your students/colleagues setting up the document rules.\par + + \subsubsection{Document type} + On top of your document -- or better: in the preamble -- you need + to specify the type of your documentation, for example ``project documentation'' + or ``final exam project'' or something other that fits your project.\par \medskip + + The standard document type is set to the German word \textit{DIPLOMARBEIT}, but it + can easily be changed -- listing~\ref{lst:doctype} shows how.\par + + \lstset{caption=Changing the document type,label=lst:doctype} +\begin{lstlisting}[xleftmargin=.1\textwidth, xrightmargin=.1\textwidth] +%% Set document type +\dokumenttyp{DIPLOMARBEIT}% or +\dokumenttyp{PROJECT DOCUMENTATION}% or +\dokumenttyp{BIOLOGY PROJECT}% anything is possible +\end{lstlisting} + \subsubsection{Title page} + A very critical part in your document is the title page. Since it is + only possible to replace the title picture with the current + version~\ETdipaversion{} of this template, you + will have to have a look at the \LaTeX{} \textit{titlepage} environment + and the \textit{maketitle} command, if you want to completely change + the title page look.\par\medskip + + The whole document is licensed with the \LaTeX{} Project Public License, so + you are allowed to modify everything -- including the documentation -- to meet your + own needs. \par \bigskip + + + \subsubsection{Colors} + The color of the short CV is another thing supervisors have to worry + about. This template was originally written for the upper secondary + school HTL St.Pölten in Lower Austria. Thus, the five department colors + of the school are predefined by the template: + \begin{itemize} + \item ETred + \item ELyellow + \item MBblue + \item IForange + \item WIgreen + \end{itemize} + + If you do not want to use one of the predefined colors, you could easily + define your own one, like it is shown in listing~\ref{lst:colordef}.\par + + \lstset{caption=Defining your own color,label=lst:colordef} +\begin{lstlisting}[xleftmargin=.15\textwidth, xrightmargin=.15\textwidth] +% Color definition +\definecolor{ETred}{RGB}{255,0,0} + +% Set the color for your CV +\dipacolor{ETred} +\end{lstlisting} + + \subsubsection{Name variables} + Name variables are an essential feature of the template, since the + standard names are in German. The English translation for every + name variable is automatically set, if the babel option 'english' is used. + Furthermore the name variables can be changed manually -- see listing~\ref{lst:names}.\par + + \lstset{caption=Changing name variables,label=lst:names} + \begin{lstlisting}[xleftmargin=.15\textwidth, xrightmargin=.15\textwidth] + % Short CV + \dipvorname{Short student introduction} + % Acknowledgement + \dankname{Acknowledgement} + % Affidavit + \eidname{Affidavit} + \end{lstlisting} + + + \subsubsection{Printing} + In Austria most of the final year project documentations are + printed in a one-side format. Nevertheless the twoside option + is supported by the template and can be used if necessary. + In case you do not know how two change this option, please + have a look at listing~\ref{lst:druck}.\par + + \lstset{caption=The twoside option,label=lst:druck} + \begin{lstlisting}[xleftmargin=.1\textwidth, xrightmargin=.1\textwidth] + % twoside option enabled + \documentclass[twoside,paper=a4,12pt]{scrreprt} + % twoside option disabled + \documentclass[paper=a4,12pt]{scrreprt} + \end{lstlisting} + + \subsubsection{Fonts} + The font for sans-serif texts was changed to be \textit{Helvetica}. All the + other ones are still the \LaTeX{} default fonts.\par + + \subsubsection{Affidavit} + To keep things simple for the user the text for + the affidavit is predefined in the \verb|etdipa| package. + If one would like to change the text\footnote{since this is an English manual you will have to, + because the original text is written in German} he or she has to copy + the \LaTeX{} source code from listing~\ref{lst:eidaendern} into + the target document's preamble and add the new text for the affidavit. + \par \medskip + + +\lstset{caption=Changing the text of the affidavit,label=lst:eidaendern} +\begin{lstlisting}[xleftmargin=.15\textwidth, xrightmargin=.15\textwidth] +\makeatletter + \long\def\@@eid@text{ + %% put your text here + } +\makeatother +\end{lstlisting} + +\subsubsection{Leave a note} +There is one thing I want you to do: If your school or company is using +my template officially, please let me know. Just write an email +with the name and city of your institution. I am not going to +publish the information I get from your institution -- the purpose of this +question is to get a personal list of schools/companies that use the template. +Thank you in advance.\par + +\subsection{\TeX nical additions} + +\subsubsection{Definition of various dimensions} +The following paragraphs explain the internal dimensions +that were used to create the short CV macro \verb|\diplomand|. An +optical representation of the dimensions can be seen in figure~\ref{pic:bemassungdipl}.\par + +\paragraph{Width of the whole CV.} +The value of this dimension is set to be about +two thirds of \verb|\textwidth|, namely \verb|0.6\textwidth|. +This value should be appropriate for page margins up to $30\%$ -- +therefore the scaling factor of the page could be lowered to $scale=0.7$. +\lstset{caption=Width of the whole short CV,label=lst:ges_breite} +\begin{lstlisting}[ xleftmargin=.15\textwidth, xrightmargin=.15\textwidth] +\newlength{\@width@dpl} +\setlength{\@width@dpl}{0.6\textwidth} +\end{lstlisting} + +\paragraph{Distance between picture and frame.} +Another new dimension is the distance between the +picture and the surrounding frame. The default distance is +$1\,\mathrm{mm}$ and the default line width is \TikZ{}'s internal +default value. +\lstset{caption=Dimension of the frame-picture distance,label=lst:rahmenabstand} +\begin{lstlisting}[ xleftmargin=.15\textwidth, xrightmargin=.15\textwidth] +%Distance picture<->frame +\newlength{\@sep@dpl} +\setlength{\@sep@dpl}{1mm} +\end{lstlisting} + +\paragraph{Default width of the picture.} +To enable any user of this template to change the picture's width the +\verb|\breite|\footnote{German word for \textit{width}} +macro was defined. Listing~\ref{lst:breite_abfrage} shows how the +commands and dimensions related to the picture's width were defined +and how the width could be set by a user.\par\newpage +\lstset{caption=Definition of the picture's width,label=lst:breite_abfrage} +\begin{lstlisting}[ xleftmargin=.14\textwidth, xrightmargin=.14\textwidth] +% macro definition make the +% width dimension accessible +\let\@breite\relax +\providecommand{\breite}[1]{\gdef\@breite{#1}} + +% defining a default value for the width +\newlength{\@default@breite} +\setlength{\@default@breite}{3cm} +% set the value +\breite{\@default@breite} +\end{lstlisting} + +\subsubsection{Dimensions of the short CV}\label{sec:bemassungdipl} +\vspace{-10mm} +\begin{figure}[H] +\centering +\includegraphics[width=0.8\textwidth]{Images/diplomand_erklaerung.pdf} +\caption{Dimensions within the short CV} +\label{pic:bemassungdipl} +\end{figure} + + +\textit{Note:} Figure~\ref{pic:bemassungdipl} is to demonstrate +the relations between the different dimensions. As you may notice, there +is a $\approx$ sign in there. That is because even the figure does not +describe the dimensions as they really are, but it is more likely to +understand the things this way.\par + + + + + +\newpage +\def\refname{References} +\phantomsection +\addcontentsline{toc}{section}{\refname} + +\begin{thebibliography}{abcd} +\bibitem[1]{TeXbook}{\textbf{Donald~E.~Knuth:} \emph{The \TeX{}book}. 1986, {\scshape Addison--Wesley},\\ +ISBN-13: 978-0-201-13447-6} + +\bibitem[2]{LaTeX}{\textbf{Klaus~Braune, Joachim~{\&}~Marion~Lammarsch:}\\ + \emph{\LaTeX{}--Basissystem, Layout, Formelsatz.} +2006, Springer Verlag,\\ ISBN-13: 978-3-540-00718-0} + +\bibitem[3]{TikZ}{\textbf{Till~Tantau:} \TikZ{} \emph{and {\scshape pgf}--Manual for version~1.18.} 2007,\\ +{\scshape gnu} Free Documentation License, Version 1.2} + +\bibitem[4]{clsguide}{\textbf{The \LaTeX 3 Project:} \emph{\LaTeXe{} for class and package writers.}\\ +February 2006} + +\bibitem[5]{fonts}{\textbf{Carl~G.~Heise:} \emph{\LaTeX{} Kurs: Schriftarten (Kurzeinführung).}\\ TU~Munich, October~2011} + +\bibitem[6]{tugboat}{\textbf{Peter~Flynn:} \emph{Rolling your own Document Class: +Using \LaTeX{} to keep away from the Dark Side.} TUGboat, Volume 28 (2007), No. 1} + +\bibitem[7]{maketitle}{\textbf{Markus~Kohm:} \emph{Titelseite mit KOMA-Script.} 8.June~2011,\\ +found at \url{www.golatex.de/wiki/Titelseite_mit_KOMA-Script}} + +\bibitem[8]{headings}{\textbf{Tanja~Richter:} \emph{Fußnoten, Kopf- und Fußzeilen in \LaTeX{}.} May~2004} + +\bibitem[9]{acronym}{\textbf{Tobias~Oetiker:} \emph{An Acronym Environment for \LaTeXe .} October~2010} + +\bibitem[10]{websites}{\textbf{Public forums:} \url{www.latex-community.org}, \url{www.mrunix.de},\\ + \url{www.golatex.de}, \url{www.tex.stackexchange.com}, \url{www.texample.net}} +\end{thebibliography}\bigskip + +The references above contain all the sources I used to create and document +the {\ttfamily etdipa}-template. Furthermore they could be useful for any +user of this template.\par + +\end{document}
\ No newline at end of file diff --git a/macros/latex/contrib/etdipa/Help/files.txt b/macros/latex/contrib/etdipa/Help/files.txt new file mode 100644 index 0000000000..834f6b23c9 --- /dev/null +++ b/macros/latex/contrib/etdipa/Help/files.txt @@ -0,0 +1,46 @@ + %% files.txt + %% Copyright 2015 Simon M. Laube + % + % 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 `author maintained'. + % + % The Current Maintainer of this work is S. M. Laube + % + % This work consists of the files listed in ./Help/files.txt + + + + List of all the template-files in the master directory of this template: + +Master directory: +- etdipa.sty %% currently v2.5, package for the template setup +- diplomarbeit.tex %% the template-file itself; take it, rename it and write your documentation! + +Textparts %% consists of several prepared textparts +- diplomanden.tex +- abkuerzungen.tex +- literatur.tex +- danksagungen.tex +- abstract.tex +- zusammenfassung.tex + +Data + folder_description.txt % describes the purpose of the data folder + +Help +- files.txt %% this file +- da_manual_DE.pdf %% original template manual in GERMAN +- da_manual_DE.tex +- da_manual_EN.pdf %% translated manual in ENGLISH +- da_manual_EN.tex + +Images %% several images... + +(Note that the Images from the 'Image' directory are not listed here) diff --git a/macros/latex/contrib/etdipa/Images/ET_logo.jpg b/macros/latex/contrib/etdipa/Images/ET_logo.jpg Binary files differnew file mode 100644 index 0000000000..47706ace3e --- /dev/null +++ b/macros/latex/contrib/etdipa/Images/ET_logo.jpg diff --git a/macros/latex/contrib/etdipa/Images/HTL-Allgemein.jpg b/macros/latex/contrib/etdipa/Images/HTL-Allgemein.jpg Binary files differnew file mode 100644 index 0000000000..b84a1a73a9 --- /dev/null +++ b/macros/latex/contrib/etdipa/Images/HTL-Allgemein.jpg diff --git a/macros/latex/contrib/etdipa/Images/HTL.png b/macros/latex/contrib/etdipa/Images/HTL.png Binary files differnew file mode 100644 index 0000000000..de60783012 --- /dev/null +++ b/macros/latex/contrib/etdipa/Images/HTL.png diff --git a/macros/latex/contrib/etdipa/Images/Ordnerstruktur.pdf b/macros/latex/contrib/etdipa/Images/Ordnerstruktur.pdf Binary files differnew file mode 100644 index 0000000000..6b21294a13 --- /dev/null +++ b/macros/latex/contrib/etdipa/Images/Ordnerstruktur.pdf diff --git a/macros/latex/contrib/etdipa/Images/bild.pdf b/macros/latex/contrib/etdipa/Images/bild.pdf Binary files differnew file mode 100644 index 0000000000..b5b6ea5f67 --- /dev/null +++ b/macros/latex/contrib/etdipa/Images/bild.pdf diff --git a/macros/latex/contrib/etdipa/Images/diplomand_erklaerung.pdf b/macros/latex/contrib/etdipa/Images/diplomand_erklaerung.pdf Binary files differnew file mode 100644 index 0000000000..4a30202a49 --- /dev/null +++ b/macros/latex/contrib/etdipa/Images/diplomand_erklaerung.pdf diff --git a/macros/latex/contrib/etdipa/Images/subordner.pdf b/macros/latex/contrib/etdipa/Images/subordner.pdf Binary files differnew file mode 100644 index 0000000000..42509f4d97 --- /dev/null +++ b/macros/latex/contrib/etdipa/Images/subordner.pdf diff --git a/macros/latex/contrib/etdipa/Images/titlepic.pdf b/macros/latex/contrib/etdipa/Images/titlepic.pdf Binary files differnew file mode 100644 index 0000000000..4464e9d979 --- /dev/null +++ b/macros/latex/contrib/etdipa/Images/titlepic.pdf diff --git a/macros/latex/contrib/etdipa/README b/macros/latex/contrib/etdipa/README new file mode 100644 index 0000000000..cde342d076 --- /dev/null +++ b/macros/latex/contrib/etdipa/README @@ -0,0 +1,98 @@ + %% README.txt + %% Copyright 2015 Simon M. Laube + % + % 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 `author maintained'. + % + % The Current Maintainer of this work is S. M. Laube + % + % This work consists of the files listed in ./Help/files.txt + +%% The current version number of this template is v2.6 + +%% ENGLISH + +This directory and all its files provide a simple, lightweigt template +for (small) scientific documentations. Just copy the whole +directory to your working directory, then rename the diplomarbeit.tex +file and directly start writing in that file. + +For further information, please read the guide in /Help/etdipa_doc_EN.pdf + + +%% GERMAN + +Dieser Ordner und sein gesamter Inhalt bieten ein simples, +einfach zu bedienendes LaTeX Template für Diplomarbeiten, +Projektarbeiten, Vorwissenschaftliche Arbeiten oder ähnlichen +Dokumentationen. +Zum Arbeiten mit dem Template muss der ganze Ordner kopiert +werden. Dieser dient dann direkt als Arbeitsordner für die +Dokumentation. Die Datei diplomarbeit.tex muss nur +noch auf den jeweiligen Titel umbenannt werden. Es kann +und soll direkt in dieser Datei geschrieben werden. + +Für weitere Informationen lesen Sie bitte die Anleitung +in /Help/etdipa_doc_DE.pdf + + +%%---------------------------------------------%% +%% CHANGELOG +%%---------------------------------------------%% + + +v2.6 February 2015 + * translation of the manual into English. + * internal name variables are now automatically set + to the according English translation when the babel + option 'english' is used. + * added a changelog to the README. + +v2.5 February 2015 + * reworked version for CTAN, it's now possible to change + colors and the titlepage texts. First official upload + to the CTAN + www.ctan.org/pkg/etdipa + +v2.4 November 2014 + * update of the short CV macro support for employment + history entries + +v2.3 October 2014 + * several bugfixes for the presentation in front of a + group of teachers at an official TeX course at the + HTL St.Pölten, department for electrical engineering + +v2.0--v2.2 September 2014 + * improvements of the several environments before the + official departmentwide introduction of the template + +v1.8--v1.9 July 2014 + * new short CV macro, better layout + +v1.7 June 2014 + * changes in the manual and package according to the beta test + +v1.6 April--May 2014 + * first unofficial launch, a group of students tested the + template for the documentation of their final year project + (beta test) + +v1.1--v1.5 March 2014 + * first document setup possibilities + * header and footer setup + * predefined text parts + * titlepage + +v1.0 March 2014 + * start of the project + * short CV macro for fancy CVs inside a document + + diff --git a/macros/latex/contrib/etdipa/Textparts/abkuerzungen.tex b/macros/latex/contrib/etdipa/Textparts/abkuerzungen.tex new file mode 100644 index 0000000000..dc52d6b8f5 --- /dev/null +++ b/macros/latex/contrib/etdipa/Textparts/abkuerzungen.tex @@ -0,0 +1,11 @@ +%% start of file abkuerzungen.tex + +% Abkuerzungsverzeichnis +\addchap{ + \iflanguage{english}{Acronyms}{Abkürzungsverzeichnis}} +\begin{acronym}[ACRONYM] +\acro{tikz}[TikZ]{\TikZ{} ist kein Zeichenprogramm} +\acro{spi}[SPI]{Serial Peripheral Interface} +\end{acronym}\newpage + +%% end of file abkuerzungen.tex
\ No newline at end of file diff --git a/macros/latex/contrib/etdipa/Textparts/abstract.tex b/macros/latex/contrib/etdipa/Textparts/abstract.tex new file mode 100644 index 0000000000..4e9d3674c7 --- /dev/null +++ b/macros/latex/contrib/etdipa/Textparts/abstract.tex @@ -0,0 +1,9 @@ +%% start of file abstract.tex + +\selectlanguage{english} +\begin{abstract} + +\end{abstract} +\selectlanguage{naustrian} + +%% end of file abstract.tex
\ No newline at end of file diff --git a/macros/latex/contrib/etdipa/Textparts/danksagungen.tex b/macros/latex/contrib/etdipa/Textparts/danksagungen.tex new file mode 100644 index 0000000000..ee454b5581 --- /dev/null +++ b/macros/latex/contrib/etdipa/Textparts/danksagungen.tex @@ -0,0 +1,9 @@ +%% start of file danksagungen.tex + +%% Danksagungen: +\begin{Danksagung} +Wir bedanken uns bei \dots +\end{Danksagung} +\newpage + +%% end of file danksagungen.tex
\ No newline at end of file diff --git a/macros/latex/contrib/etdipa/Textparts/diplomanden.tex b/macros/latex/contrib/etdipa/Textparts/diplomanden.tex new file mode 100644 index 0000000000..202fe9694e --- /dev/null +++ b/macros/latex/contrib/etdipa/Textparts/diplomanden.tex @@ -0,0 +1,27 @@ +%% start of file diplomanden.tex + +%% Diplomandenvorstellung: +\begin{Diplomandenvorstellung} +%% Schueler1 +\diplomand{Max~Mustermann} + {12.12.2012 in St.P\"olten} + {Langestra\ss e 13} + {3100 St.Pölten} + {\schule{2010--2015}{HTBLuVA St.Pölten, Abteilung für Elektrotechnik} + \schule{2006--2010}{Gymnasium XY}} + {max.muster@xy.at} + {Images/bild} +\newpage +%% Schueler2 +\diplomand{Manuela~Musterfrau} + {12.12.2012 in St.P\"olten} + {Langestra\ss e 14} + {3100 St.Pölten} + {\schule{2010--2015}{HTBLuVA St.Pölten, Abteilung für Elektrotechnik} + \firma{2006--2010}{Elektrofirma XY} + \schule{2002--2006}{Gymnasium XY}} + {manuela.muster@xy.at} + {Images/bild} +\end{Diplomandenvorstellung} + +%% end of file diplomanden.tex diff --git a/macros/latex/contrib/etdipa/Textparts/literatur.tex b/macros/latex/contrib/etdipa/Textparts/literatur.tex new file mode 100644 index 0000000000..5c15640af1 --- /dev/null +++ b/macros/latex/contrib/etdipa/Textparts/literatur.tex @@ -0,0 +1,11 @@ +%% start of file literatur.tex + +%% Literaturverzeichnis: +\begin{Literatur} +% The TeXbook by D. E. Knuth +\bibitem[1]{TeXbook}{\textbf{Donald~E.~Knuth:} \emph{The \TeX{}book}. 1986, {\scshape Addison--Wesley} Verlag,\\ +ISBN-13: 978-0-201-13447-6} +% +\end{Literatur} + +%% end of file literatur.tex
\ No newline at end of file diff --git a/macros/latex/contrib/etdipa/Textparts/zusammenfassung.tex b/macros/latex/contrib/etdipa/Textparts/zusammenfassung.tex new file mode 100644 index 0000000000..54b703b33a --- /dev/null +++ b/macros/latex/contrib/etdipa/Textparts/zusammenfassung.tex @@ -0,0 +1,8 @@ +%% start of file zusammenfassung.tex + +\selectlanguage{naustrian} +\begin{abstract} + +\end{abstract} + +%% end of file zusammenfassung.tex
\ No newline at end of file diff --git a/macros/latex/contrib/etdipa/diplomarbeit.tex b/macros/latex/contrib/etdipa/diplomarbeit.tex new file mode 100644 index 0000000000..7ec2309ea8 --- /dev/null +++ b/macros/latex/contrib/etdipa/diplomarbeit.tex @@ -0,0 +1,161 @@ + %% diplomarbeit.tex + %% Copyright 2015 Simon M. Laube + % + % 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 `author maintained'. + % + % The Current Maintainer of this work is S. M. Laube + % + % This work consists of the files listed in ./Help/files.txt + +%%=====================================================%% +%% Neues Diplomarbeitstemplate der ET %% +%% Abteilung ab 2013/2014 %% +%% Erstellt von Simon Michael Laube %% +%% Betreut von Prof. Mag. Dipl.-Ing. Dr. Daniel Asch %% +%% Prof. Dipl.-Ing. Dr. Wilhelm Haager %% +%%=====================================================%% +%% Dokumentklasse KOMA-Script Report +\documentclass[paper=a4,12pt]{scrreprt} +% Encoding UTF8 +\usepackage[utf8]{inputenc} +% 8 Bit Aufloesung der Buchstaben +\usepackage[T1]{fontenc} +% Seitenraender +\usepackage[scale=0.72]{geometry} +% Spracheinstellungen +\usepackage[english, naustrian]{babel} % your native language must be the last one!! +% erweiterte Farbenpalette +\usepackage[dvipsnames]{xcolor} +% Abbildungen +\usepackage{graphicx} +% Tabellen (erweitert) +\usepackage{tabularx} +% TikZ + Circuit-TikZ (fuer Schaltungen) +\usepackage[europeanresistors, + europeaninductors]{circuitikz} +% Nuetzliche TikZ Libraries +\usetikzlibrary{arrows,automata,positioning} +% Mathematikpakete! +\usepackage{amsmath,amssymb} +%\usepackage{mathtools} +% PDF Einbindung (zB Datenblaetter) +\usepackage{pdfpages} +% Source Code Einbindung, Setup siehe: +% http://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings +\usepackage{listings,scrhack} %scrhack vermeidet Umschaltung auf KOMA Floats.. + +\usepackage{eurosym} +\usepackage{lscape} +% Diplomarbeitsspezifisches Package etdipa +\usepackage{etdipa} + +%% Abkuerzungsverzeichnis +\usepackage[]{acronym} + +%% Todos +\usepackage[]{todonotes} + +%% Ganttdiagramme +\usepackage{pgfgantt} + +%% Subfigures +\usepackage[lofdepth]{subfig} + + + +%%==== Definitionen fuer die Diplomarbeit ============%% +\dokumenttyp{DIPLOMARBEIT} +\title{Musterdokument} +\author{Simon Michael Laube \and NoName1 \and NoName2} +\date{\today} +\place{St. P\"olten} +\schuljahr{2014/15} +\professor{Prof. NoName \and Dr. Engineer} +\dipacolor{ETred} +%%====================================================%% + + +% Hyperlinks im Dokument +\usepackage[colorlinks=true, + linkcolor=black, + citecolor=green, + bookmarks=true, + urlcolor=black, + bookmarksopen=true]{hyperref} + +\begin{document} + +\frontmatter + +%%================ Titelseite ==========================%% +\maketitle +% Verantwortliche/Verfasser +\responsible{Simon Michael Laube} +%%======================================================%% + + +%%================ Eidesstattliche Erklaerung ==========%% +\begin{Eid}%Unterschrift der Diplomanden hinzufuegen! +\unterschrift{Simon Michael Laube} +\unterschrift{Schüler 2} +\unterschrift{Schüler 3} +\end{Eid}\newpage +%%======================================================%% + +%%================ Diplomandenvorstellung ==============%% +\input{Textparts/diplomanden.tex} +%%======================================================%% + + + +%%================ Danksagungen ========================%% +\input{Textparts/danksagungen.tex} +%%======================================================%% + +%%================ Abstract /Zusammenfass. =============%% +\input{Textparts/abstract.tex} +\input{Textparts/zusammenfassung.tex} +%\selectlanguage{english} % necessary for English speaking users +% delete this line if your native language is German +%%======================================================%% + +%%================ Inhaltsverzeichnis ==================%% +\tableofcontents +%%======================================================%% + + +%Ab hier Hauptteil +\mainmatter + +\appendix + +%%================ Abkuerzungsverzeichnis ==============%% +\input{Textparts/abkuerzungen.tex} +%%======================================================%% + + +%%================ Abbildungsverzeichnis ===============%% +\setcounter{lofdepth}{2} +\dipalistoffigures +%%======================================================%% + +%%================ Tabellenverzeichnis ================%% +\setcounter{lotdepth}{2} +\dipalistoftables +%%======================================================%% + +%%================ Literaturverzeichnis ================%% +\newpage +\input{Textparts/literatur.tex} + + +%%======================================================%% +\end{document} diff --git a/macros/latex/contrib/etdipa/etdipa.sty b/macros/latex/contrib/etdipa/etdipa.sty new file mode 100644 index 0000000000..eedcb7711b --- /dev/null +++ b/macros/latex/contrib/etdipa/etdipa.sty @@ -0,0 +1,723 @@ + %% etdipa.sty + %% Copyright 2015 Simon M. Laube + % + % 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 `author maintained'. + % + % The Current Maintainer of this work is S. M. Laube + % + % This work consists of the files listed in ./Help/files.txt + +%%========================================================%% +%% Neues Diplomarbeitstemplate der ET %% +%% Abteilung ab 2013/2014 %% +%% Erstellt von Simon Michael Laube %% +%% Betreut von Prof. Mag. Dipl.-Ing. Dr. Daniel Asch %% +%% Prof. Dipl.-Ing. Dr. Wilhelm Haager %% +%%========================================================%% +%%========================================================%% +%% Diplomarbeitspackage %% +%% %% +%% erstellt von Simon Michael Laube %% +%% 4BHET im Schuljahr 2013/14 %% +%% 5BHET im Schuljahr 2014/15 %% +%% %% +%% Dieses Usepackage ist Teil des neuen %% +%% LaTeX Diplomarbeits-Templates der ET- %% +%% Abteilung, HTBLuVA St.Poelten. %% +%% Infos zur Verwendung finden sich %% +%% unter Diplomarbeit/Help/da_manual.pdf %% +%% %% +%% Aktuelle Version: v2.6 %% +%%========================================================%% + +%% Benoetigt LaTeX2e +\NeedsTeXFormat{LaTeX2e} +%% Package DiplomarbeitET --> etdipa +\ProvidesPackage{etdipa}[2015/02/13 Diplomarbeitspackage der ET Abteilung HTL St.Poelten] + +%% Ausgabe auf der Commandline und im Log-File +\typeout{=========================================================} +\typeout{Usepackage zur Erstellung der Diplomarbeitsdokumentation,} +\typeout{ET-Abteilung, HTBLuVA St.Poelten, ab dem Schuljahr 2013/14} +\typeout{Autor: Simon Michael Laube, 4BHET 2013/14 / 5BHET 2014/15} +\typeout{=========================================================} + +% fuer das HTL Logo auf der Titelseite und im Text sowiso! +\RequirePackage{graphicx} +% KOMA Kopf- und Fusszeilen +\RequirePackage[automark]{scrpage2} +% If Abfragen +\RequirePackage{ifthen} +%% Keine Absatzeinrueckungen +%% (Ersatz zum parskip Argument von scrreprt) +\setlength{\parindent}{0pt} + +%% Versionsnummer +\def\ETdipaversion{v2.6} + +%% Offizielle ET sf-Schrift ist Helvetica: +\def\sfdefault{phv} + +%% Namenskonventionen, koennen bei Bedarf geaendert werden! +\def\@dankname{Danksagungen} +\def\@eidname{Eidesstattliche Erklärung} +\def\@dipvorname{Diplomandenvorstellung} +\long\def\@DIPLOMARBEIT{DIPLOMARBEIT} + +% Makros zum Aendern der Namen +\providecommand{\dankname}[1]{\gdef\@dankname{#1}} +\providecommand{\eidname}[1]{\gdef\@eidname{#1}} +\providecommand{\dipvorname}[1]{\gdef\@dipvorname{#1}} +\providecommand{\dokumenttyp}[1]{\gdef\@DIPLOMARBEIT{#1}} + +\iflanguage{english}{ + \dankname{Acknowledgement} + \eidname{Affidavit} + \dipvorname{Short CV} +}{} + +%% Kopf- und Fusszeileneinstellungen +%% Persoenliche Einstellungen wurden in +%% \setmyheadings festgelegt +\let\@responsible\relax + +\def\setmyheadings{% + % Mark right:section left:chapter + % Aenderung am 21.5.2014: + \if@twoside + \automark[section]{chapter} + \else + \automark{chapter} + \fi + \ifoot{\@responsible}% links unten: Name + \cfoot{}%mitte unten + \ofoot{}%rechts unten + \setfootsepline{.5pt}%Linie unten + \ihead{\headmark}% links oben: Chapter + \chead{}%mitte oben + \ohead{\pagemark}% rechts oben: Seitennummer + \setheadsepline{.5pt}%Linie oben + }% +% Damit auf Chapter-Seiten keine Nummern sind!!! +\def\chapterpagestyle{empty} + +%% Responsible Makro aus dipa.cls entnommen +%% und leicht angepasst. +%% Setzt die Fusszeile auf den aktuellen Verfasser +%% des Textteils. +\def\responsible#1{\gdef\@responsible{\protect{#1}}} + +%%======================================================%% +%% \frontmatter aus scrbook ergibt sich zu: +%% \if@twoside\cleardoubleoddpage\else +%% \clearpage\fi\@mainmatterfalse\pagenumbering{roman} +%%-------------------------------------------------------% +%% \frontmatter, \mainmatter,\backmatter gibt es nur in +%% book-Klassen --> In scrreprt sind alle Befehle ausser +%% \@mainmatterfalse vorhanden. --> Definition eines +%% eigenen \frontmatter ... usw. +%%======================================================%% +%% Es erfolgt die Definition einer boolschen Variable, +%% welche den Zustand des "Matters" anzeigen soll +%% Ganz wie in der KOMA-Script Klasse scrbook wird der +%% Befehl hier 1:1 verwendet: +\newif\if@mainmatter\@mainmattertrue +%%\@maimmattertrue = \let \if@mainmatter \iftrue +%%\@mainmatterfalse = \let \if@mainmatter \iffalse + + +%% Damit kann nun der \frontmatter-Befehl der +%% scrbook-Klasse verwendet werden! +\def\@frontmatter%aus scrbook, leicht abgeaendert + {% + \if@twoside% + \cleardoubleoddpage% + % Sonst bei frontmatter auf der leeren Rueckseite Nummer! + \clearscrheadfoot% SML + \else% + \clearpage% + \fi% + \@mainmatterfalse% + \pagenumbering{roman}%SML + \setmyheadings%SML + \pagestyle{scrheadings}%SML + }% + +%% Selbiges gilt nun auch fuer \mainmatter: +\def\@mainmatter{% + \if@twoside% + \cleardoubleoddpage% + \else% + \clearpage% + \fi% + \@mainmattertrue% + \pagenumbering{arabic}% SML + \setmyheadings%SML + \pagestyle{scrheadings}% SML + }% + +%%==========================================================> +%% Als Option des Packages wird fuer die Benutzer das +%% Arbeiten mit Umgebungen zur Verfuegung gestellt +%% \frontmatter darf dadurch aber nicht doppelt definiert +%% werden!! --> neue Abfrage \if@NOenvironments +%% \frontmatter definiert wird! + +%% ACHTUNG: Diese Option ist nicht mehr relevant, +%% nur noch als Reserve belassen worden!!!! +%% (der Source-Code der Option wird durch ==> begrenzt) +\newif\if@NOenvironments% +\@NOenvironmentstrue% + +%% Zur Verfuegung stellen der Option "environments" +\DeclareOption{environments}{% + \@NOenvironmentsfalse\relax + }% + +%% Falls der Benutzer eine Option angibt die es +%% im Package etdipa nicht gibt wird eine Warnung erzeugt +\DeclareOption*{\PackageWarning{etdipa}{The option '\CurrentOption' can't be used with this package}} + +%% Die Option des Packages muss von LaTeX +%% verarbeitet werden! +\ProcessOptions\relax + +%% wird die Option environments nicht benutzt, so +%% ist \frontmatter und \mainmatter normal definiert: +\if@NOenvironments% = true + \def\frontmatter{\@frontmatter} + \def\mainmatter{\@mainmatter} +\else + % frontmatter als Environment + \newenvironment{frontmatter}{\@frontmatter}{\@mainmatter}% + % mainmatter als Environment + \newenvironment{mainmatter}{\@mainmatter}{\appendix}% +\fi +%%>=========================================================== + +%% Fuer \backmatter wurde keine Definition festgelegt, da +%% dieser Teil wahrscheinlich nicht benoetigt wird. +%% Sollte jemand trotzdem diesen Befehl verwenden, so +%% wirkt er gleich wie \appendix, also ANHANG. +\def\backmatter{\appendix} + + +%%======================================================%% +%% Eigene Definitionen fuer \maketitle Makro (aus dipa.cls) +\let\@professor\relax +\let\@schuljahr\relax +\let\@place\relax +\providecommand{\professor}[1]{\gdef\@professor{#1}} % HAAGER +\providecommand{\schuljahr}[1]{\gdef\@schuljahr{#1}} % HAAGER +\providecommand{\place}[1]{\gdef\@place{#1}} + +\place{St.~P\"olten} +% damit die Anpassungen des Maketitle Makros funktionieren +% und trotz der Anpassung KOMA-Script Befehle verwendet werden +% koennen, muessen diese teilweise umdefiniert werden: +\def\and{\\} + +%% HTL Schriftkopf %% HAAGER +\def\@titlehead{\vspace*{-15mm}\makebox[\textwidth]{\includegraphics[width=180mm]{Images/titlepic.pdf}}} + +%% Maketitle-Kopie und Abaenderung des +%% Sourcecodes aus scrreprt.cls +%% mit ergänzten Erklaerungen +\renewcommand\maketitle[1][1]{% + % nur wenn Titelseite (environment) nicht definiert ist + \if@titlepage%dann --> Titelseite definieren + \begin{titlepage} + \setcounter{page}{#1}% optionales Argument Seitenzahl + % \let kopiert Wert in neue Definition + % \small wird in \footnotesize kopiert --> small=footnotesize + \let\footnotesize\small + % temporaere Aenderung eines Makros auf \relax + % oft in Klassen und Packages verwendet + \let\footnoterule\relax + % \footnote wird zu \thanks + \let\footnote\thanks + % Fussnotensymbol + \renewcommand*\thefootnote{\@fnsymbol\c@footnote}% + \let\@oldmakefnmark\@makefnmark + \renewcommand*{\@makefnmark}{\rlap\@oldmakefnmark}% + \ifx\@extratitle\@empty \else + \noindent\@extratitle\next@tpage\cleardoubleemptypage + \thispagestyle{empty}% Headings auf der Titelseite leer! + \fi + % \setparsizes (KOMA Makro) zum Einstellen von Absatzwerten + % mit stretching, shrinking usw. siehe auch TeXbook, Chapter: Glue + \setparsizes{\z@}{\z@}{\z@\@plus 1fil}\par@updaterelative + % Wenn \@titlehead leer dann nichts, sonst minipage mit \@titlehead + % Titlehead ist Teil des KOMA Scriptes und dient mit vielen anderen + % Befehlen zur Erstellung umfangreicherere Titelseiten mittels \maketitle + \ifx\@titlehead\@empty \else + \begin{minipage}[t]{\textwidth}% + \@titlehead + \end{minipage}\par + \fi + % \null ist ein Trick, da \vfill ohne titlehead nicht funktionieren wuerde + % \vfill funktioniert nur nach einer "horizontal box", ohne titlehead ist + % jedoch keine enthalten. \null = \hbox{} --> Ergebnis des \show Befehls + \null\vfill\vfill\vfill + %Beginn zentrierter Bereich + \begin{center} + + % Anpassung der Titelseite: Diplomarbeit + {\bfseries\sffamily\Huge\@DIPLOMARBEIT\par\vskip 1em} % HAAGER 15.5.2012 + + % Wenn kein \@subject vorhanden ist bleibt es leer, sonst wird es + % mit der Schriftart \subject@font gesetzt. + \ifx\@subject\@empty \else + {\subject@font \@subject \par}% + % vskip ist (zumindest fast) gleichbedeutend mit vspace, + % vskip ist der TeX Befehl fuer vertikalen Abstand, + % vspace der LaTeX Befehl dafuer. + \vskip 3em + \fi + % Nach dem Subject (wenn vorhanden) folgt der Titel + % in \titlefont. Titel muss! vorhanden sein + {\titlefont\huge \@title\par}% + \vskip 1em %vertikaler Abstand + % wieder Abfrage ob Untertitel leer ist, wenn nicht wird er gesetzt. + {\ifx\@subtitle\@empty\else\usekomafont{subtitle}\@subtitle\par\fi}% + \vskip 2em% + % Beginn der Tabelle fuer die Autorennamen + % Wurde auskommentiert da dieser Teil selbst angepasst wurde! + %{\Large \lineskip 0.75em + % \begin{tabular}[t]{c} + % \@author + % \end{tabular}\par + %}% + \vskip 1.5em% v. Abstand + % Datum, ebenfalls selbst angepasst --> auskommentiert + %{\Large \@date \par}% + %\vskip \z@ \@plus3fill% dehnbarer v. Abstand + {\Large \@publishers \par}% Herausgeber + \vskip 3em% v. Abstand + \end{center}\par% Zentriert Ende und Absatzende + %Thanks... wird (vorerst?) nicht benötigt + % \@thanks + + %%======== Ab hier Anpassungen des Titelblattes ========%% + %% Die Anpassungen wurden unveraendert aus der dipa.cls %% + %% von Prof. Dipl.-Ing. Dr. Wilhelm Haager entnommen! %% + \vfill\vfill% doppeltes vfill + {\sffamily\tabcolsep 0pt + \begin{tabular}[t]{l} + \iflanguage{english}{Accomplished in \@schuljahr\ + by:\\ + }{ + Ausgef\"uhrt im Schuljahr \@schuljahr\ von:\\} + \\ + \@author + \end{tabular} + \hfill + \begin{tabular}[t]{l} + \iflanguage{english}{Supervisors:\\ + }{ + Betreuer/Betreuerin:\\} + \\ + \@professor + \end{tabular} + \hfill} + \par + \vskip 2em + {\sffamily \@place , \iflanguage{english}{on}{am} \@date} + \par + \vfill%\vfill + %%======== Anpassungen Ende =============================%% + + % Bei zweiseitigen Dokumenten kann die Rückseite der + % Titelseite durch KOMA-Script nun auch mit Inhalt gefuellt + % werden. Dies geschieht mittels \uppertitleback und + % \lowertitleback + \if@twoside\next@tpage%nur bei twoside! + % Titleback oben + \begin{minipage}[t]{\textwidth} + \@uppertitleback + \end{minipage}\par + \vfill % vertikalen Abstand auffuellen + % Titleback unten + \begin{minipage}[b]{\textwidth} + \@lowertitleback + \end{minipage} + \fi + % Widmung, wenn leer, kein Text, wenn nicht leer, Text + \ifx\@dedication\@empty \else + \next@tpage\null\vfill + {\centering \Large \@dedication \par}% + \vskip \z@ \@plus3fill + \if@twoside \next@tpage\cleardoubleemptypage \fi + \fi + \end{titlepage} + %======== ENDE DER TITELSEITE(N) ============================% + + % ERRORS and WARNINGS der KOMA Klasse scrreprt + \else + \par + \@tempcnta=% + #1% + \relax\ifnum\@tempcnta=1\else + \ClassWarning{\KOMAClassName}{% + Optional argument of \string\maketitle\space ignored + at\MessageBreak + notitlepage-mode% + }% + \fi + + % Fussnoten werden erzeugt ??? + \begingroup + \renewcommand*\thefootnote{\@fnsymbol\c@footnote}% + \let\@oldmakefnmark\@makefnmark + \renewcommand*{\@makefnmark}{\rlap\@oldmakefnmark} + % Unterscheidung der Spaltenanzahl bevor \@maketitle ausgefuehrt wird + \if@twocolumn + \ifnum \col@number=\@ne + \@maketitle + \else + \twocolumn[\@maketitle]% + \fi + \else + \newpage + \global\@topnum\z@ + \@maketitle + \fi + \thispagestyle{\titlepagestyle}\@thanks + \endgroup + \fi + + %% Am Ende des Maketitle Befehls werden alle verwendeten + %% Makros "geleert" um das nachfolgende Dokument nicht zu + %% beeinflussen + \setcounter{footnote}{0}%Fussnotenzaehler reseten + % Hauptmakros werden auf \relax gesetzt + \let\thanks\relax + \let\maketitle\relax + \let\@maketitle\relax + % Die "Informationsmakros" fuer den Text werden geleert + %% Anpassung: Eigene Makros ebenfalls leeren: + \global\let\@schuljahr\@empty + \global\let\@professor\@empty + %% ========================================= %% + \global\let\@thanks\@empty + \global\let\@author\@empty + \global\let\@date\@empty + \global\let\@title\@empty + \global\let\@subtitle\@empty + \global\let\@extratitle\@empty + \global\let\@titlehead\@empty + \global\let\@subject\@empty + \global\let\@publishers\@empty + \global\let\@uppertitleback\@empty + \global\let\@lowertitleback\@empty + \global\let\@dedication\@empty + % Die Endusermakros fuer die Informationen werden = \relax + %% Anpassung: Eigene Endusermakros ebenfalls \relax setzen + \global\let\schuljahr\relax + \global\let\professor\relax + %% ===================================================== %% + \global\let\author\relax + \global\let\title\relax + \global\let\extratitle\relax + \global\let\titlehead\relax + \global\let\subject\relax + \global\let\publishers\relax + \global\let\uppertitleback\relax + \global\let\lowertitleback\relax + \global\let\dedication\relax + \global\let\date\relax + \global\let\and\relax +}% +%% ENDE MAKETITLE-MAKRO %% +%%======================================================%% + +%% Makro fuer nicht nummerierte Chapters, Sections usw. +%% Wurde aus dem Labor-Template der 4BHET 13/14 entnommen +%% Besser waere jedoch die Verwendung der KOMA Befehle +%% \addchap, \addsec, \addsubsec, \addsubsubsec !! +\def\nchap#1{\chapter*{#1}\addcontentsline{toc}{chapter}{#1}} +\def\nsec#1{\section*{#1}\addcontentsline{toc}{section}{#1}} +\def\nsubsec#1{\subsection*{#1}\addcontentsline{toc}{subsection}{#1}} +\def\nsubsubsec#1{\subsubsection*{#1}\addcontentsline{toc}{subsubsection}{#1}} + + +%% Eidesstattliche Erklaerung wird ueber eine +%% Umgebung geloest. Zum Erzeugen einer +%% "Unterschriftslinie" wird \unterschrift verwendet. +%% Die Anregung zu dieser Loesung lieferte die Diplom- +%% arbeit von Florian Griessler und Julian Palmers, +%% 5AHETI 2012 +\long\def\@@eid@text{%% Text: + Ich erkl\"are an Eides statt, dass ich die vorliegende + Diplomarbeit selbst\"andig und ohne fremde Hilfe + verfasst, andere als die angegebenen Quellen und + Hilfsmittel nicht benutzt und die den benutzten + Quellen w\"ortlich und inhaltlich entnommenen + Stellen als solche erkenntlich gemacht habe.\par + } +\def\unterschrift#1{\\ \\ \\ \hline\makebox[60mm]{#1}\\} +\newenvironment{Eid}{% + \null\vfill%vertikales Zentrieren ueber \vfill + \section*{\@eidname}%Section anlegen + \begin{center}%zentriert + \begin{minipage}{0.56\textwidth} + \@@eid@text + \end{minipage} + \end{center} + %Unterschriften sind in einspaltiger Tabelle + \begin{table}[h!] + \hfill + \begin{tabular}{c}}% + {% + \end{tabular} + \end{table} + \vfill%vertikales Zentrieren + }% + +%% Danksagungen ebenfalls ueber Umgebung +\newenvironment{Danksagung}{\null\vfill%vertikal Zentrieren + \section*{\@dankname}}%Section anlegen + {\vfill\null\vfill%vertikal Zentrieren + \newpage}% + +%% Literatur +\newenvironment{Literatur}{\iflanguage{english}{}{\def\refname{Literaturverzeichnis}}% + \phantomsection% damit Link an die richtige Stelle zeigt + %Literaturverzeichnis ins TOC hinzufuegen + \addcontentsline{toc}{chapter}{\refname}% + \begin{thebibliography}{ABCD}}% + {\end{thebibliography}}% + +%% Tabellen +\def\dipalistoftables{\phantomsection%damit Link an die richtige Stelle zeigt +\addcontentsline{toc}{chapter}{\listtablename}\listoftables} +%% Abbildungen +\def\dipalistoffigures{\phantomsection% damit Link... +\addcontentsline{toc}{chapter}{\listfigurename}\listoffigures} + +%% Bessere Definition fuer Abstracts +\renewenvironment{abstract}{\section*{\abstractname}}{} + + +%% Hilfreiche Makros fuer diverse Anwendungen %% +%% Sammlung von Simon Michael Laube %% + +% TikZ Makro laut tikzpgfmanual von T.~Tantau +\def \TikZ {{\mdseries\rmfamily Ti}{\textit{k}}{\mdseries\rmfamily Z}} + +% Masse Symbol fuer Circuitikz, da bei vielen +% TeX-Installationen das vordefinierte Makro des +% Packages nicht funktioniert! +% Kann nur in TikZ-Umgebung verwendet werden! +% \Masse{x Koordinate}{y Koordinate} +\def \Masse #1#2 {\draw(#1,#2)|-(#1-.3,#2-1) -- (#1+.3,#2-1);} + +% Stern- und Dreiecksymbol fuer Drehstrom +% (nur) Stern: +\def \S {\tikz{\draw(0,.18) -- (0,0) -- (-.14,-.14); + \draw(0,0)--(.14,-.14);}$\,$} + +\def\D{$\bitriangleup$} +% Stern / Dreieck: +\def \SD {\S /$\bigtriangleup$} +% Dreieck / Stern: +\def \DS {$\bigtriangleup$/\S} + + + +%%============================================%% + + +%% evtl. benoetigte Packages +\RequirePackage{textcomp} +\RequirePackage{array} +\RequirePackage{float} + +% c l und r Spalten in tabularx-Umgebung +% von dipa.cls % HAAGER +\newcolumntype{L}{>{\raggedright\arraybackslash}X} +\newcolumntype{C}{>{\centering\arraybackslash}X} +\newcolumntype{R}{>{\raggedleft\arraybackslash}X} + +%% Falls notwendig, Aufzaehlungsumgebungen ohne +%% Leerraeume %dipa.cls +\newenvironment{zerodescription} % Description ohne Leerraeume + {\list{}{\topsep0pt\itemsep0pt\topsep0pt\parsep0pt\labelwidth\z@% + \itemindent-\leftmargin\let\makelabel\descriptionlabel}}{\endlist} +\newenvironment{Zerodescription} + {\list{}{\topsep0pt\itemsep0pt\parsep0pt\labelwidth\z@% + \itemindent-\leftmargin\let\makelabel\descriptionlabel}}{\endlist} +\newenvironment{zeroenumerate} % Enumerate ohne Leerraeume + {\begin{list}{\arabic{enumi}.}{\usecounter{enumi}\parsep0pt\topsep0pt\itemsep0pt}} + {\end{list}} +\newenvironment{Zeroenumerate} + {\begin{list}{\arabic{enumi}.}{\usecounter{enumi}\parsep0pt\itemsep0pt}} + {\end{list}} +\newenvironment{zeroitemize} % Itemize ohne Leerraeume + {\begin{list}{$\bullet$}{\parsep0pt\topsep0pt\itemsep0pt}} + {\end{list}} +\newenvironment{Zeroitemize} + {\begin{list}{$\bullet$}{\parsep0pt\itemsep0pt}} + {\end{list}} + + + +%Hurenkinder und Schusterjungen (in der Typografie) +%fuer gute Lesbarkeit vermeiden +% --> vgl. Dipl.Template SCUB +\widowpenalty=10000 +\clubpenalty=10000 +\displaywidowpenalty=10000 + + +%% Ausgabe auf der Commandline (und Log-File) +\typeout{=========================================================} +\typeout{Diplomandenvorstellung by SML 13.02.2015 } +\typeout{=========================================================} + + +%Benoetigt die Packages TikZ und xcolor +\RequirePackage{tikz} +\usetikzlibrary{positioning} +\RequirePackage{xcolor} + +% Catcode von at-Zeichen auf Letter (11) setzen +\makeatletter + + + + +%Breite der gesamten Diplomandenvorstellung + % Laengenmaß erzeugen +\newlength{\@width@dpl} + % und setzen +\setlength{\@width@dpl}{0.6\textwidth} +%Abstand Bild<->Rahmen +\newlength{\@sep@dpl} +\setlength{\@sep@dpl}{1mm} + +%% Abfrage ob Befehl definiert ist. +%% Makro aus TeXbook, S308, D.~E.~Knuth +%\def\ifundefined#1{\expandafter\ifx\csname#1\endcsname\relax} + +%%Definition des Breite Makros fuer das +%%Diplomandenbild +\providecommand{\breite}[1]{\gdef\@breite{#1}} + +%% Defaultbreite wenn \breite +%% nicht vom Anwender definiert wird +%% auf 3cm setzen +\newlength{\@default@breite} +\setlength{\@default@breite}{3cm} +\breite{\@default@breite} + + +%% Farbenvariable +\let\@dipacolor\relax +\providecommand{\dipacolor}[1]{\gdef\@dipacolor{#1}} + +%Farbdefinition der ET Abteilung RGB(255)(0)(0) = red +\definecolor{ETred}{RGB}{255,0,0} +%Farbdefinition der WI Abteilung RGB (51)(153)(0) = special green +\definecolor{WIgreen}{RGB}{51,153,0} +%Farbdefinition der MB Abteilung RGB (51)(102)(204) = special blue +\definecolor{MBblue}{RGB}{51,102,204} +%Farbdefinition der WI Abteilung RGB (255)(204)(0) = special yellow +\definecolor{ELyellow}{RGB}{255,204,0} +%Farbdefinition der WI Abteilung RGB (255,102,0) = special orange +\definecolor{IForange}{RGB}{255,102,0} + +\dipacolor{ETred} + +%% Definition fuer den Workaround fuer mehr Schulen +%% oder Firmen: +\def\firma#1#2{\normalsize #1:\\#2\\} +\let\schule\firma + +%% Hauptmakro des Packages %% +%% Bitte nicht veraendern!! %% +%% \diplomand{Name}{Geburtsdatum}{Straße} +%% {PLZ Ort}{Gym/Haupt}{Gym/Haupt Schuljahre} +%% {HTL Schuljahre}{Email}{Dateiname_Bild} +\long\def\diplomand #1#2#3#4#5#6#7{% + \null\vfill + \responsible{#1} + \begingroup%Beginn Gruppierung damit arraystretch nur fuer Gruppe gueltig + \def\arraystretch {1.1} %Abstand Tabellenzeilen gestreckt + \hypersetup{urlcolor=black} %Link soll innerhalb der Gruppe schwarz sein + \begin{tabular}{l} + \tikz{%Anfang TikZ + %Rahmen des Bildes + \node[rectangle, inner sep=\@sep@dpl , draw=\@dipacolor] (pic) + {\includegraphics[width=\@breite]{#7}}; + %Dummy Node fuer Abstand zur Redbox + \node[above=\@sep@dpl of pic.south] (dummy){}; + %Redbox, dynamische Groesse je nach + %\withdpl und \breite des Bildes + \node[right = 0.55*\@breite of dummy, rectangle, fill=\@dipacolor, + minimum width=\@width@dpl - \@breite] (redbox) {\ }; + } %Ende TikZ + \\\\%eine Leerzeile + %% Ab hier Text --> Tabelle mit 1Spalte + {\Large #1}\\ % Name + \\ + % Geb. Datum + {\normalsize \scshape + \iflanguage{english}{Date of birth:}{Geburtsdaten:}}\\ + {\normalsize #2}\\ + \\ + % Wohnort + {\normalsize \scshape + \iflanguage{english}{Adress:}{Wohnhaft in:}}\\ + {\normalsize #3}\\ + {\normalsize #4}\\ + \\ + %Schullaufbahn + {\normalsize \scshape + \iflanguage{english}{Career:}{Beruflicher Werdegang:}}\\ + #5 + \\ + %Kontakt + {\normalsize \scshape + \iflanguage{english}{Contact details:}{Kontakt:}}\\ + {\normalsize \href{mailto:#6}{#6}}\\ + %Absatzende + \par + \end{tabular} + \endgroup%Ende der Gruppe + \vfill +} + +%% Environment zum Erstellen der Diplomandenvorstellung +\newenvironment{Diplomandenvorstellung}{\null\vspace{6mm}\section*{\@dipvorname} + \addcontentsline{toc}{chapter}{ + \iflanguage{english}{\@dipvorname}{Diplomandenvorstellung}} + \begin{center}} + {\end{center}\newpage} +%% Catcode von at-Zeichen wieder other +\makeatother + + %% end of file etdipa.sty %% SML %% 13.02.2015 + + + + + + + + + + + + + + + |