Ver código fonte

actually make the checklist a checklist instead of using color-coding

Eren Yilmaz 6 anos atrás
pai
commit
26ac6ea5e3
2 arquivos alterados com 29 adições e 16 exclusões
  1. 12 12
      doc/chapter/3progress.tex
  2. 17 4
      doc/doc.tex

+ 12 - 12
doc/chapter/3progress.tex

@@ -1,14 +1,14 @@
-The following features are either \planned{planned}, \inprogress{under construction} or \done{done}:
+The following features are either planned (\planned), under construction (\progress) or done (\done):
 \begin{itemize}
-    \item \done{Reading from an input file as described in section~\ref{sec:inputFileFormat}.}
-    \item \done{Drawing a graph with specified node sizes and positions.}
-    \item \inprogress{Running the node placement algorithm by Brandes and Köpf~\cite{brandes_fast_2001}.}
-    \item \done{Illustrating the progress while the algorithm is running.}
-    \item \done{Running the algorithm step by step manually (by pushing a button labeled \enquote{Step}).}
-    \item \inprogress{Running the algorithm step by step with configurable delay.}
-    \item \planned{Using debugger-like commands such as \enquote{step into}, \enquote{step over}, \enquote{step out}.}
-    \item \done{Working with hierarchical graphs.}
-    \item \done{Scaling the display with the (adjustable) window size.}
-    \item \planned{Creating ElkNode~\cite{noauthor_elk:_2018} objects from LayeredNode (\ref{sec:internalGraphRepresentation}) objects}
-    \item \planned{Creating LayeredNode (\ref{sec:internalGraphRepresentation}) objects from ElkNode~\cite{noauthor_elk:_2018} objects (low priority)}
+    \item[\done] Reading from an input file as described in section~\ref{sec:inputFileFormat}.
+    \item[\done] Drawing a graph with specified node sizes and positions.
+    \item[\progress] Running the node placement algorithm by Brandes and Köpf~\cite{brandes_fast_2001}.
+    \item[\done] Illustrating the progress while the algorithm is running.
+    \item[\done] Running the algorithm step by step manually (by pushing a button labeled \enquote{Step}).
+    \item[\progress] Running the algorithm step by step with configurable delay.
+    \item[\planned] Using debugger-like commands such as \enquote{step into}, \enquote{step over}, \enquote{step out}.
+    \item[\done] Working with hierarchical graphs.
+    \item[\done] Scaling the display with the (adjustable) window size.
+    \item[\planned] Creating ElkNode~\cite{noauthor_elk:_2018} objects from LayeredNode (\ref{sec:internalGraphRepresentation}) objects
+    \item[\planned] Creating LayeredNode (\ref{sec:internalGraphRepresentation}) objects from ElkNode~\cite{noauthor_elk:_2018} objects (low priority)
 \end{itemize}

+ 17 - 4
doc/doc.tex

@@ -6,7 +6,7 @@
 \pdfsuppresswarningpagegroup=1
 % Allgemeines
 \usepackage[automark]{scrlayer-scrpage} % Kopf- und Fußzeilen
-\usepackage{amsmath,marvosym} % Mathesachen
+\usepackage{amsmath,marvosym,amssymb} % Mathesachen
 \usepackage[T1]{fontenc} % Ligaturen, richtige Umlaute im PDF
 \usepackage[utf8]{inputenc}% UTF8-Kodierung für Umlaute usw
 % Schriften
@@ -57,6 +57,22 @@
 \setlength{\abovecaptionskip}{0.2cm} % Abstand der zwischen Bild- und Bildunterschrift
 \usepackage{enumitem} % Referenzen auf Item in enumerate-Blocks
 
+% A checklist for the current progress
+\usepackage{pifont}
+\usepackage{tikz}
+\usetikzlibrary{shapes.geometric}
+\newcommand{\cmark}{\ding{51}}%
+\newcommand{\xmark}{\ding{55}}%
+\newcommand\partialsquare{%
+\begin{tikzpicture}[baseline=0]
+\draw (0,0)  rectangle (0.3,0.3);
+\fill (0.05,0.05)  rectangle (0.25,0.25);
+\end{tikzpicture}%
+}
+\newcommand{\planned}{$\square$}
+\newcommand{\done}{\rlap{$\square$}{\raisebox{2pt}{\large\hspace{1pt}\cmark}}\hspace{-2.5pt}}
+\newcommand{\progress}{\partialsquare}
+
 % \toprule and other commands
 \usepackage{booktabs}
 
@@ -83,9 +99,6 @@
 \definecolor{deepred}{rgb}{0.8,0,0}
 \definecolor{deepgreen}{rgb}{0,0.4,0}
 \definecolor{grau}{gray}{0.3}
-\newcommand{\planned}[1]{\textcolor{deepred}{#1}}
-\newcommand{\done}[1]{\textcolor{deepgreen}{#1}}
-\newcommand{\inprogress}[1]{\textcolor{deepblue}{#1}}
 % python style code
 \lstset{
 extendedchars=true,