Eren Yilmaz 6 rokov pred
rodič
commit
7750fd6be7
2 zmenil súbory, kde vykonal 27 pridanie a 0 odobranie
  1. 1 0
      doc/chapter/1introduction.tex
  2. 26 0
      doc/chapter/appendix.tex

+ 1 - 0
doc/chapter/1introduction.tex

@@ -8,6 +8,7 @@ After each step the current progress of the algorithm is displayed visually.
 
 In chapter~\ref{ch:architecture} we provide an overview over the \appname 's internal architecture while chapter~\ref{ch:ui} presents and explains the graphical user interface.
 To provide an overview of what is going on, chapter~\ref{ch:progress} lists features and their degree of completion.
+A glossary of some of the more difficult terms we can be found in the appendix (table~\ref{table:glossary}).
 
 \appname\ is currently a work in progress so keep in mind that any of the here presented screenshot, diagram or other information may be slightly outdated\footnote{even this one}.
 Also note that some PDF viewers have problems with vector graphics exported from Visual Paradigm, so if you feel like there is a missing line in a class or component diagram, you are wrong.

+ 26 - 0
doc/chapter/appendix.tex

@@ -1,9 +1,35 @@
+\begin{table}[ht]
+	\centering
+    \small
+    \begin{longtable}{p{3cm} p{8cm} p{4cm}}
+        \rowcolor{gray!50}
+		\textbf{Term} & \textbf{Explanation} & \textbf{Example} \\
+		Phase & One phase of the Sugiyama approach~\cite{sugiyama_methods_1981} & Node Placement \\
+        \rowcolor{gray!25}
+		Stage & One stage of the BK algorithm~\cite{brandes_fast_2001} & Balancing \\
+		Step & Atomic part of a stage of the BK algorithm~\cite{brandes_fast_2001} & Computing one $x$ coordinate during balancing stage \\
+		\rowcolor{gray!25}
+        \appname & The name of the application for which this is the documentation & \\
+        \member{sink} & See table~\ref{table:bk-variables} & \\
+        \rowcolor{gray!25}
+        \member{shift} & See table~\ref{table:bk-variables} & \\
+        \member{root} & See table~\ref{table:bk-variables} & \\
+        \rowcolor{gray!25}
+        \member{align} & See table~\ref{table:bk-variables} & \\
+        Extremal layout & Defines in which order the layers are traversed and if a node is aligned with its upper or lower median. & Leftmost lower \\
+        \\\\
+	\end{longtable}
+	\caption{Glossary for the most difficult terms as we use them.}
+	\label{table:glossary}
+\end{table}
+
 \begin{figure}[htp]
     \centering
     \includegraphics{img/random-graph-dialog}
     \caption[Random graph dialog]{Dialog for generating random graphs.}
     \label{fig:random-graph-dialog}
 \end{figure}
+
 \begin{figure}[htp]
     \centering
     \includegraphics[width=\linewidth]{img/debug-table}