Skip to content
Snippets Groups Projects
Commit fc7f21a9 authored by Michael Grinberg's avatar Michael Grinberg
Browse files

Viele größere Änderungen:

- Umstieg auf Nutzung des Pakets todonotes (statt eigener Makros)
- Dazu nötig: Verschiebung von \showif und \hideif-Definitionen
parent c2f2e7fb
No related branches found
No related tags found
No related merge requests found
......@@ -23,48 +23,8 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\input{preambel/Header.tex}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%% Macros for hiding individual chapters, remarks, TODOs %%%%
%%%% use showif{} or hideif{} for showing or hiding parts %%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\showif{showCoverPage}
\showif{showCV}
\showif{showAbstractEN}
\showif{showAbstractDE}
\showif{showAcknowledgments}
\showif{showContents}
\showif{showNotation}
\showif{showExamples}
\showif{showIntro}
\showif{showRelatedWork}
\showif{showConcept}
\showif{showSystem}
\showif{showEvaluation}
\showif{showConclusion}
\showif{showOutlook}
\showif{showBackmatter}
\showif{showBibliography}
\showif{showOwnPublications}
\showif{showOwnPatents}
\showif{showSupervisedTheses}
\showif{showListOfFigures}
\showif{showListOfTables}
\showif{showListOfListings}
\showif{showListOfAcronyms}
\showif{showListOfSymbols}
\showif{showNomenclature}
\showif{showGlossary}
\showif{showIndex}%
\showif{showAppendix}
\showif{showTODOs}
\hideif{showMarginNotes}
\begin{document}
%
%% Add all acronyms, glossary entries, etc.
%\glsaddall
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%% BEGIN of the document content %%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
......
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Randnotizen}%
\section{Randnotizen und TODO-Notizen}%
\index{Randnotizen}%
\index{TODO-Notizen}%
\label{sec:Randnotizen}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
Randnotizen
\floatmarginnote{Ich bin eine überflüssige Randnotiz}%
werden mit dem Kommando \lc{floatmarginnote} gesetzt.
Diese eignet sich zum Beispiel um im Text Stellen zu kennzeichnen,
an denen man noch arbeiten sollte.
Da die Vorgaben des \glsgen{ac:KSP} für den Seitenlayout
einen sehr kleinen Randbereich vorsehen, der zudem nicht bedruckt werden darf,
werden keine Randnotizen in der endgültigen Version des Manuskriptes akzeptiert.
Die Randnotizen lassen sich bequem in der Hauptdatei ausschalten,
indem man \texttt{\bs showif\{showMarginNotes\}}
zu \texttt{\bs hideif\{showMarginNotes\}} ändert.
\ No newline at end of file
Diese eignet sich zum Beispiel um wichtige Begriffe oder Aussagen zu verdeutlichen
oder durch eine Kurzzusammenfassung jedes einzelnen Textabschnitts
den roten Faden zu verdeutlichen.
Da die Vorgaben des \glsgen{ac:KSP} für den Seitenlayout einen sehr kleinen Randbereich vorsehen, der zudem nicht bedruckt werden darf,
werden keine Randnotizen in der endgültigen Druckversion des Manuskriptes akzeptiert.
Um ggf. vorhandene Randnotizen auszublenden,
muss man in der Datei \printfilepath{preambel/AlleAngaben.tex} den Wert des Schalters
\printkeyword{showMarginNotes} auf \printkeyword{false} setzen.
TODOs im Text lassen sich mit Hilfe des Befehls \lc{todo\{<Hinweistext>\}} aus dem Paket \pkg{todonotes} setzen.
\todo{Features des Pakets \pkg{todonotes} beschreiben!}
Mit dem Befehl \lc{missingfigure\{<Hinweistext>\}} lässt sich auf eine fehlende Grafik hinweisen.
\missingfigure{Hier fehlt eine Grafik!}
\ No newline at end of file
......@@ -236,10 +236,11 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{showTODOs}
\phantomsection%
\listofTODOs%
\hypertarget{TODO-List}{}%
% Zum Inhaltsverzeichnis hinzufügen
\addcontentsline{toc}{chapter}{\TodoListName}%
%\addcontentsline{toc}{chapter}{\TodoListName}%
\todototoc%
\listoftodos%
\hypertarget{TODO-List}{}%
\end{showTODOs}%
%
\end{showBackmatter}%
\ No newline at end of file
......@@ -5,17 +5,18 @@
\label{chap:StandDerTechnik}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
Hier kommen die Inhalte rein \todo{Inhalte einfügen!}.
Hier kommen die Inhalte rein.
%
%\input{content/2-Grundlagen/StandDerTechnik.tex}
%
Hier noch ein paar Beispiele für TODOs.
Und einige Zitate wie z.B.
\cite{BarShalom-Tse-TICEWPDA-Automatica-75,BarShalom-TrackingMethodsin-1978,Bar-Shalom-AC1984-JPDA,BarShalom-MTMST-1990,BarShalom-MTT-Buch-Band2,BarShalom-MMTAA-Buch-2000}
sowie
\cite{Zomotor-Fahrverhalten-1991}.
Hier kann ein Bild hinzugefügt werden.
\todo{Inhalte einfügen!}.
\myTodoImg
\missingfigure{Bildliche Demonstration der neuesten Features einfügen!}
%
\end{showRelatedWork}%
\ No newline at end of file
......@@ -12,7 +12,8 @@
\newboolean{useCMYKcolors} % Sollen alle Farben in den CMYK-Farbraum konvertiert werden (für den Druck)?
\newboolean{istgenehmigt} % Bei Dissertationen: handelt es sich um die genehmigte Version?
\newboolean{showFrame} % Sollen die Satzspiegel-Ränder angezeigt werden?
\newboolean{showGrid} % soll ein Gitter angezeigt werden?
\newboolean{showGrid} % Soll ein Gitter angezeigt werden?
\newboolean{showMarginNotes} % Sollen Randnotizen angezeigt werden?
%% Hier true oder false auswählen!!!
\setboolean{iesenglishs}{false}
......@@ -25,6 +26,43 @@
\setboolean{istgenehmigt}{false}
\setboolean{showFrame}{false}
\setboolean{showGrid}{false}
\setboolean{showMarginNotes}{true}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%% Macros for hiding individual chapters, remarks, TODOs %%%%
%%%% use showif{} or hideif{} for showing or hiding parts %%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\showif{showCoverPage}
\showif{showCV}
\showif{showAbstractEN}
\showif{showAbstractDE}
\showif{showAcknowledgments}
\showif{showContents}
\showif{showNotation}
\showif{showExamples}
\showif{showIntro}
\showif{showRelatedWork}
\showif{showConcept}
\showif{showSystem}
\showif{showEvaluation}
\showif{showConclusion}
\showif{showOutlook}
\showif{showBackmatter}
\showif{showBibliography}
\showif{showOwnPublications}
\showif{showOwnPatents}
\showif{showSupervisedTheses}
\showif{showListOfFigures}
\showif{showListOfTables}
\showif{showListOfListings}
\showif{showListOfAcronyms}
\showif{showListOfSymbols}
\showif{showNomenclature}
\showif{showGlossary}
\showif{showIndex}%
\showif{showAppendix}
\showif{showTODOs}
% Titel der Arbeit
\newcommand{\Worktitle}{Hier den kompletten Titel der Arbeit angeben}
......
......@@ -69,6 +69,9 @@
% Encoding der Quellcode-Dateien (sonst funktionieren Umlaute in den Quellcodedateien nicht)
\input{preambel/EncodingAndFont.tex}
%%% Wichtige Befehle für weitere Präambel-Dateien
\input{preambel/preambel-commands.tex}
%%%%%%%%%%%%%%%% HIER EINSTELLEN, OB ENGLISCH ODER DEUTSCH USW.
%%% Angaben zum Dokument (Autor, Titel etc.)
\input{preambel/AlleAngaben.tex}
......@@ -79,9 +82,7 @@
%%% Einstellungen zu Farben etc.
\input{preambel/ColorSettings.tex}
%%% LaTeX-Präambel
%%% Hier werden Pakete eingebunden, Teil I
\input{preambel/preambel-commands.tex}
%% Es werden jeweils eines der begrenzt verfügbaren TeX-\writes verwendet für
% Table of Contents
......
......@@ -19,6 +19,7 @@ track-ing
\babelhyphenation[ngerman]{%
di-men-sio-nale
Dis-tri-bu-ti-o-nen
Fea-tures
Kal-man
Kon-fi-gu-ra-ti-ons-da-tei-en
Kor-res-pon-denz-su-che
......
......@@ -4,16 +4,6 @@
%% IfThenElse: muss frueher eingebunden werden wegen Abfragen zur Sprache etc.
%\usepackage{ifthen}
%% for adding invisible comments
%% not needed anymore since included in package "versions"
%% Braucht ein \write. Vielleicht eins zuviel, Asymptote braucht auch welche, es gibt ing. nur 16.
%\usepackage{comment}
%\includecomment{showcomment}
%\excludecomment{hidecomment}
%for conditional text inclusions
\usepackage[nogroup]{versions}
%for compact lists
\usepackage{mdwlist}
......@@ -49,13 +39,6 @@
%\AtBeginEnvironment{description*}{\preto\item{\raggedright}}
%
%for allowing hyphenation of words that contain a dash
%using shortcuts \-/, \=/, \--, \==, \---, and \===
\usepackage[shortcuts]{extdash}
%Zur besseren Silbentrennung
%s. http://de.wikibooks.org/wiki/LaTeX-W%C3%B6rterbuch:_Silbentrennung
\usepackage[ngerman=ngerman-x-latest]{hyphsubst}
\usepackage[super]{nth}
......
......@@ -91,228 +91,6 @@
%Hilfsmakros:
% Definition von Hilfsmacros \showif und \hideif, die
% das Verstecken bzw. Einblenden von Textteilen ermöglichen werden:
% Es wird eine Boolean-Variable mit dem angegebenen Namen angelegt
% und entsprechend auf true (showif) oder false (hideif) gesetzt.
% Außerdem werden entsprechende includeversion/excludeversion-Macros aufgerufen.
\newcommand{\showif}[1]{%
\ifcsname#1\endcsname%
%falls ein Makro mit diesem Namen bereits existiert: Fehlermeldung ausgeben
\GenericError{}{A macro with the name #1 is already defined somewhere else! Please use another name}{}{}%
\else%
\newboolean{#1}%
\fi%
\setboolean{#1}{true}%
\includeversion{#1}%
}
\newcommand{\hideif}[1]{%
\ifcsname#1\endcsname%
%falls ein Makro mit diesem namen bereits existiert: Fehlermeldung ausgeben
\GenericError{}{A macro with the name #1 is already defined somewhere else! Please use another name}{}{}%
\else%
\newboolean{#1}%
\fi%
\setboolean{#1}{false}%
\excludeversion{#1}%
}
%Ein TikZ-TODO-Bild:
\newcommand{\myTodoImg}{%
\begin{tikzpicture}
\draw[
use as bounding box,
black,
thick,
double,
double distance = 4pt,
rounded corners = 6pt]
(-4,-3)rectangle(4,3);
\node[rotate=45,scale = 5,opacity = 0.5] at (0,0) {TODO!};
\end{tikzpicture}%
}
%% Erzeugung einer ToDo-Liste
%% newlistof bedarf das Paket tocloft (\usepackage{tocloft})
\newlistof{TODOs}{tdo}{\TodoListName}%tdo ist die Erweiterung der zu bildenden Hilfsdatei
%% Befehl zum Eintragen der Inhalte in die ToDo-Liste
\newcommand{\addToTodoList}[1]{%
\refstepcounter{TODOs}%
\addcontentsline{tdo}{TODOs}{%
%Füge den Eintrag als eine neue Zeile zur ToDo-Liste hinzu
\protect{\numberline{\theTODOs:}} % (\thechapter.\thesection)}}
\ifx\relax#1\relax% Falls Argument #1 leer:
\textcolor{red}{ToDo!}%
\else% Falls #1 mit Inhalt:
\textcolor{red}{#1}%
\fi%
}%
}
\newcounter{imgtdoCounter}
%TODO-Gestaltungsmakro für Textmodus mit einer Unterscheidung,
%ob etwas übergeben worden ist oder nicht
%und mit einem optionalen Argument für die Nachfrage-Liste
\newcommand{\myTodo}[2][]{%
\ifthenelse{\boolean{showTODOs}}{%if TODOs should be displayed:
\ifx\relax#2\relax% Falls der erforderliche Argument #2 leer:
\hyperlink{TODO-List}{\textcolor{red}{\textbf{ToDo!}}}%
\ifx\relax#2\relax% Falls der optionale Argument #1 ebenfalls leer:
\addToTodoList{\textcolor{red}{ToDo!}}%
\else% #2 leer aber #1 mit Inhalt
\addToTodoList{\textcolor{red}{#1}}%
\fi%
\else% Falls der erforderliche Argument #2 mit Inhalt:
\hyperlink{TODO-List}{\textcolor{red}{\textbf{ToDo: }}}\textcolor{red}{ #2}%
\ifx\relax#1\relax% Falls der optionale Argument #1 leer:
\addToTodoList{\textcolor{red}{#2}}
\else% sowohl #2 als auch #1 mit Inhalt
\addToTodoList{\textcolor{red}{#1}}
\fi%
\fi%
}{%if no TODOs should be displayed: don't do anything
\ }%
}
%% TODO-Gestaltungsmakro für Mathe-Modus mit einer Unterscheidung,
%% ob etwas übergeben worden ist oder nicht
%% und mit einem optionalen Argument für die TODO-Liste
%% Verwendung, z.B. \myMathTodo[Alternativtext für die Übersicht]{x+y=z}
\newcommand{\myMathTodo}[2][]{%
\ifthenelse{\boolean{showTODOs}}{%if TODOs should be displayed:
\ifx\relax#2\relax% Falls der erforderliche Argument #2 leer:
\hyperlink{TODO-List}{\textcolor{red}{\symbf{\textnormal{ ToDo! }}}}%
\ifx\relax#1\relax% Falls der optionale Argument #1 auch leer:
\addToTodoList{TODO in an equation}%
\else% Argument #2 leer, aber Argument #1 nicht leer
\addToTodoList{#1}%
\fi%
\else% Falls der erforderliche Argument #2 mit Inhalt:
\hyperlink{TODO-List}{\textcolor{red}{\symbf{\textcolor{red}{#2}}}}%
\ifx\relax#1\relax% Falls der optionale Argument #1 leer:
\addToTodoList{$#2$}%
\else% sowohl #1 als auch #2 mit Inhalt
\addToTodoList{#1}%
\fi%
\fi%
}{%if no TODOs should be displayed: don't do anything
\. }%
}
%TODO-Makro für Zitate
%mit einem optionalen Argument für die TODO-Liste
\newcommand{\myCiteTodo}[1]{%
\ifx\relax#1\relax%
\myTodo[Literaturverweis!]{Referenz!}%
\else%
\myTodo[Bib-Eintrag für #1!]{[#1]}%
\fi%
}
%TODO-Makro für Querverweise
%mit einem optionalen Argument für die TODO-Liste
\newcommand{\myRefTodo}[1]{%
\ifx\relax#1\relax%
\myTodo[Verweis!]{Querverweis!}%
\else%
\myTodo[Verweis auf #1!]{(#1)}%
\fi%
}
%TODO-Makro für Fußnoten
%mit dem optionalen ersten Argument für die TODO-Liste
\newcommand{\myFootTodo}[2][]{%
\ifx\relax#1\relax%
\myTodo[#2]{\footnote{#2}}%
\else%
\myTodo[#1]{\footnote{#2}}%
\fi%
}
%Makro für Qualltext-TODOs
%mit einem optionalen Argument für die TODO-Liste
\newcommand{\myRemTodo}[1]{\myTodo[#1]{s. Quelltext}}
%#1: [optional] short caption
%#2: caption
%#3: label, z.B. fig:Blockschaltbild
\newcommand{\myImgTodo}[3][]
{
% increase image-todo counter
\stepcounter{imgtdoCounter}
\ifx\relax#1\relax%
\addToTodoList{Bild: #2}%
\else%
\addToTodoList{Bild: #1}%
\fi%
% new figure floating environment
\begin{figure}[!htb]
\centering
% TODO-image
\myTodoImg
%\includegraphics[width=0.8\textwidth]{\myTodoImg}
\caption[#1]{\hyperlink{TODO-List}{\color{red}{ToDo:}} \color{red}{#2}}
\label{#3}
\end{figure}
}
%TODO-Befehle für den Textmodus
%optional argument #1 for alternative text in the TODO list
\newcommand{\todo}[2][]{\myTodo[#1]{#2}}
\newcommand{\ToDo}[2][]{\myTodo[#1]{#2}}
\newcommand{\Todo}[2][]{\myTodo[#1]{#2}}
\newcommand{\TODO}[2][]{\myTodo[#1]{#2}}
%Add a ToDo for a citation
\newcommand{\citetodo}[1]{\myCiteTodo{#1}}
\newcommand{\citeToDo}[1]{\myCiteTodo{#1}}
\newcommand{\citeTodo}[1]{\myCiteTodo{#1}}
\newcommand{\citeTODO}[1]{\myCiteTodo{#1}}
%add a ToDo for a reference
\newcommand{\reftodo}[1]{\myRefTodo{#1}}
\newcommand{\refToDo}[1]{\myRefTodo{#1}}
\newcommand{\refTodo}[1]{\myRefTodo{#1}}
\newcommand{\refTODO}[1]{\myRefTodo{#1}}
%add a ToDo as a footnote
\newcommand{\foottodo}[2][]{\myFootTodo[#1]{#2}}
\newcommand{\footToDo}[2][]{\myFootTodo[#1]{#2}}
\newcommand{\footTodo}[2][]{\myFootTodo[#1]{#2}}
\newcommand{\footTODO}[2][]{\myFootTodo[#1]{#2}}
%TODO-Befehle für den Mathe-Modus
% Verwendung, z.B.
% \mathTodo[Alternativtext für die Übersicht]{x+y=z}
\newcommand{\mathtodo}[2][]{\myMathTodo[#1]{#2}}
\newcommand{\mathToDo}[2][]{\myMathTodo[#1]{#2}}
\newcommand{\mathTodo}[2][]{\myMathTodo[#1]{#2}}
\newcommand{\mathTODO}[2][]{\myMathTodo[#1]{#2}}
%Erzeugen eines TODO-Bildes:
%[#1]: optionale Kurzbeschriftung (in eckigen Klammern)
%{#2}: Beschriftung
%{#3}: Label, z.B. fig:Blockschaltbild
\newcommand{\imgtodo}[3][]{\myImgTodo[#1]{#2}{#3}}
\newcommand{\imgToDo}[3][]{\myImgTodo[#1]{#2}{#3}}
\newcommand{\imgTodo}[3][]{\myImgTodo[#1]{#2}{#3}}
\newcommand{\imgTODO}[3][]{\myImgTodo[#1]{#2}{#3}}
\newenvironment{myNotationTable}{%
\setlength{\tabcolsep}{0pt}% Kein Einzug bei Notation
\renewcommand{\arraystretch}{1.3}% Etwas mehr Abstand zwuischen den Zeilen, damit sie nicht zusammenfasllen
......
......@@ -55,9 +55,6 @@
\addtolanguagecommand{\AppendixName}{ngerman}{Anhang}
\addtolanguagecommand{\AppendixName}{english}{Appendix}
\addtolanguagecommand{\TodoListName}{ngerman}{Todo-Liste}
\addtolanguagecommand{\TodoListName}{english}{Todo List}
\addtolanguagecommand{\TransAcknowledgements}{ngerman}{Danksagung}
\addtolanguagecommand{\TransAcknowledgements}{english}{Acknowledgements}
......
......@@ -128,4 +128,36 @@
\makeatother
%for conditional text inclusions and invisible comments
\usepackage[nogroup]{versions}
%Hilfsmakros:
% Definition von Hilfsmacros \showif und \hideif, die
% das Verstecken bzw. Einblenden von Textteilen ermöglichen werden:
% Es wird eine Boolean-Variable mit dem angegebenen Namen angelegt
% und entsprechend auf true (showif) oder false (hideif) gesetzt.
% Außerdem werden entsprechende includeversion/excludeversion-Macros aufgerufen.
\newcommand{\showif}[1]{%
\ifcsname#1\endcsname%
%falls ein Makro mit diesem Namen bereits existiert: Fehlermeldung ausgeben
\GenericError{}{A macro with the name #1 is already defined somewhere else! Please use another name}{}{}%
\else%
\newboolean{#1}%
\fi%
\setboolean{#1}{true}%
\includeversion{#1}%
}
\newcommand{\hideif}[1]{%
\ifcsname#1\endcsname%
%falls ein Makro mit diesem namen bereits existiert: Fehlermeldung ausgeben
\GenericError{}{A macro with the name #1 is already defined somewhere else! Please use another name}{}{}%
\else%
\newboolean{#1}%
\fi%
\setboolean{#1}{false}%
\excludeversion{#1}%
}
%%% ----------------------------------------------------------------
\ No newline at end of file
......@@ -81,6 +81,23 @@
{\usepackage[ngerman,english]{babel}}%
{\usepackage[english,ngerman]{babel}}
% The \babelhyphenation macro has been introduced
% only in the babel v.3.9 released in March 2013.
% For the sake of compatibility with older TeX distribution:
\providecommand{\babelhyphenation}[2][english]{%
\begin{hyphenrules}{#1}
\hyphenation{#2}
\end{hyphenrules}
}
%for allowing hyphenation of words that contain a dash
%using shortcuts \-/, \=/, \--, \==, \---, and \===
\usepackage[shortcuts]{extdash}
%Zur besseren Silbentrennung
%s. http://de.wikibooks.org/wiki/LaTeX-W%C3%B6rterbuch:_Silbentrennung
\usepackage[ngerman=ngerman-x-latest]{hyphsubst}
%% Paket zur Abfrage der aktuellen Sprache
\usepackage{iflang}
......@@ -1492,8 +1509,11 @@ afterskip=\myparagraphafterskip%
%% PW: Todo-Liste. Braucht anscheinend eines der begrenzt verfügbaren TeX-\writes
%\usepackage{todonotes}
\ifthenelse{\boolean{showTODOs}}{%
\usepackage[textsize=footnotesize,ngerman,colorinlistoftodos]{todonotes}
}{%
\usepackage[disable]{todonotes}
}
% -------------------------------------------------------
% Aussehen des Inhaltsverzeichnisses: tocloft
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment