work on documentation

doc/chapter/2architecture.tex

@@ -21,15 +21,8 @@ For parsing the JSON file the JSON-java library~\cite{leary_json-java:_2018} is
 The classes for reading and writing those JSON files are displayed in figure~\ref{fig:io}.
 The internal representation of graphs is further explained in the section~\ref{sec:model}.
 
-\begin{figure}[tp]
-    \centering
-    \includegraphics[width=\linewidth, trim={0 20cm 0 0}]{img/IO.pdf}
-    \caption{Class diagram of the \enquote{IO} package, containing utilities for reading and writing graphs.}
-    \label{fig:io}
-\end{figure}
-
 \centering
-\begin{longtable}{|p{1.8cm}|p{2cm}|p{1.8cm}|p{8.5cm}|}
+\begin{longtable}{|p{1.8cm}|p{2.3cm}|p{1.7cm}|p{8.5cm}|}
     \hline
     Attribute & Type & Optional & Explanation \\\hline\hline
     name & string & yes & If not omitted, this must be unique for a given parent node. \\\hline
@@ -43,8 +36,16 @@ The internal representation of graphs is further explained in the section~\ref{s
     \label{table:node-attributes}
 \end{longtable}
 
+\begin{figure}[tp]
+    \centering
+    \includegraphics[width=\linewidth, trim={0 20cm 0 0}]{img/IO.pdf}
+    \caption[Class diagram of the \enquote{IO} package]{Class diagram of the \enquote{IO} package, containing utilities for reading and writing graphs.}
+    \label{fig:io}
+\end{figure}
+
 \newpage
 
+\TODO{attribute for dummy nodes}
 \begin{longtable}{|p{1.8cm}|p{2cm}|p{1.8cm}|p{8.5cm}|}
     \hline
     Attribute & Type & Optional & Explanation \\\hline\hline
@@ -64,6 +65,7 @@ The internal representation of graphs is further explained in the section~\ref{s
 %    \label{fig:iff}
 %\end{figure}
 
+\TODO{Kante in beispielJSON}
 \begin{figure}
     \begin{lstinputlisting}[language=json,emph={}]{img/graph.json}
     \end{lstinputlisting}
@@ -86,7 +88,7 @@ Similarly, edges have additional attributes:
 \begin{itemize}
     \item \enquote{dummy} specifies whether they are dummy edges.
     \item \enquote{conflicted} corresponds to the variable used by Brandes and Köpf~\cite{brandes_fast_2001} and indicates that this edge won't be drawn vertically.
-    \item \enquote{bindPoints} is a list of bend points for the edge.
+    \item \enquote{bindPoints} is a list of bend points for the edge, including the beginning and end point of the edge.
 \end{itemize}
 
 A class diagram of the package \enquote{Model} is displayed in figure~\ref{fig:model}.

doc/chapter/3ui.tex

@@ -6,7 +6,7 @@ Note that since the application is still under construction, so not all screensh
 \begin{figure}[tp]
     \centering
     \includegraphics[width=0.6\linewidth]{img/example.jpg}
-    \caption{A simple graph with 5 nodes after the four extremal layout have been computed, but not balanced yet.
+    \caption[A simple graph with 5 nodes]{A simple graph with 5 nodes after the four extremal layout have been computed, but not balanced yet.
     The vertical directions are down (upper row), up (lower row) and the horizontal directions are left (left column) and right (right column).
     The background colors of the nodes display which block they belong to: For example the two blue nodes on the top right are in the same block.
     Round nodes are the roots of the blocks.
@@ -27,6 +27,6 @@ It is planned to add both additional commands as well as some kind of graphical
     Right arrow key & Perform one backward step (\enquote{undo one step}) of the algorithm. \\\hline
     P & Pause/unpause the automatic execution. Initially paused. \\\hline
     D & Print a debug table to standard out. \\\hline
-    \caption{Overview over the currently available keyboard commands.}
+    \caption{Overview of the currently available keyboard commands.}
     \label{table:keys}
 \end{longtable}

doc/chapter/4progress.tex

@@ -8,7 +8,11 @@ The following features are either planned (\planned), under construction (\progr
     \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}.
     \begin{itemize}
-        \item[\done] Calculating the blocks.
+        \item[\progress] Calculating the conflicts between edges.
+        \begin{itemize}
+            \item[\planned] Differentiating between dummy nodes and non-dummy nodes.
+        \end{itemize}
+        \item[\progress] Calculating the blocks.
         \item[\progress] Compacting the layout.
         \item[\planned] Combining the layouts.
     \end{itemize}