Ver código fonte

colorize attributes and add some more to the list

Eren Yilmaz 6 anos atrás
pai
commit
adaa54b48a
2 arquivos alterados com 17 adições e 10 exclusões
  1. 12 7
      doc/chapter/2architecture.tex
  2. 5 3
      doc/doc.tex

+ 12 - 7
doc/chapter/2architecture.tex

@@ -106,17 +106,22 @@ Therefore a node not only has edges to other nodes, but also it can contain othe
 So far this is similar to what we described in section~\ref{sec:inputFileFormat}.
 Additionally, there are multiple attributes that are used during the computation or as output variables.
 \begin{itemize}
-    \item The attributes \code{shift},  \code{sink},  \code{root} and  \code{align} correspond to the variables used by Brandes and Köpf~\cite{brandes_fast_2001}.
+    \item The attributes \member{shift}, \member{sink},  \member{root} and  \member{align} correspond to the variables used by Brandes and Köpf~\cite{brandes_fast_2001}.
     They are summarized in table~\ref{table:bk-variables}.
-    \item The \code{parent} of a node is the node that contains it in the hierarchy.
-    \item The attributes \code{x} and \code{y} are the coordinates of the node relative to its \code{parent}.
-    There is one coordinate for each of the four extremal layouts and on coordinate for the combined layout.
+    \item The \member{parent} of a node is the node that contains it in the hierarchy.
+    \item The attributes \member{x} and \member{y} are the coordinates of the node relative to its \code{parent}.
+    \item The attributes \member{w} and \member{h} are the width and height of the node.
+    \item The attributes \member{color} is the color in which the node is displayed.
+    \item The attribute \member{xUndef} determines whether the x coordinate of the node has already been assigned a value.
+    \item The attribute \member{selected} is used to highlight the node that is currently active in each layout.
 \end{itemize}
+The last five bullet points are available for each of the four extremal layouts and for the combined layout.
+
 Similarly, edges have additional attributes:
 \begin{itemize}
-    \item \code{dummy} specifies whether they are dummy edges.
-    \item \code{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 \code{bindPoints} is a list of bend points for the edge, including the beginning and end point of the edge.
+    \item \member{dummyNode} specifies whether they are dummy edges.
+    \item \member{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 \member{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 \code{graph} is displayed in figure~\ref{fig:graph}.

+ 5 - 3
doc/doc.tex

@@ -73,8 +73,6 @@
 \newcommand{\done}{\rlap{$\square$}{\raisebox{2pt}{\large\hspace{1pt}\cmark}}\hspace{-2.5pt}}
 \newcommand{\progress}{\partialsquare}
 
-\newcommand{\code}[1]{\lstinline[basicstyle=\ttfamily]|#1|}
-
 % \toprule and other commands
 \usepackage{booktabs}
 
@@ -89,7 +87,6 @@
 
 % same code font as in eclipse
 \usepackage{inconsolata}
-
 \usepackage{color, colortbl} % Farben
 
 \colorlet{punct}{red!60!black}
@@ -105,6 +102,11 @@
 \definecolor{deepred}{rgb}{0.8,0,0}
 \definecolor{deepgreen}{rgb}{0,0.4,0}
 \definecolor{grau}{gray}{0.3}
+\definecolor{member}{rgb}{0.27,0.37,0.75}
+
+\newcommand{\code}[1]{\lstinline[basicstyle=\ttfamily]|#1|}
+\newcommand{\member}[1]{\lstinline[basicstyle=\ttfamily\color{member}]|#1|}
+
 % python style code
 \lstset{
 extendedchars=true,