~ubuntu-branches/ubuntu/trusty/dot2tex/trusty-proposed

<tbody valign="top">

<tr class="field"><th class="field-name">Author:</th><td class="field-body">Kjell Magne Fauske</td>

</tr>

</tr>

<tr class="field"><th class="field-name">Licence:</th><td class="field-body"><a class="reference external" href="http://www.opensource.org/licenses/mit-license.php">MIT</a></td>

</tr>

<div class="section" id="label-examples">

<h3>Label examples</h3>

<p>Consider the following graph:</p>

    a_1-&gt; a_2 -&gt; a_3 -&gt; a_1;

}

</pre></div>

<img alt="Difference between math and verbatim mode" src="img/ex1comb.png" />

</div>

<p>Example of using <tt class="docutils literal"><span class="pre">texlbl</span></tt>:</p>

    a_1 [texlbl=&quot;$\frac{\gamma}{x^2}$&quot;];

    a_1-&gt; a_2 -&gt; a_3 -&gt; a_1;

}

<img alt="Using the special texlbl attribute" src="img/ex2.png" />

</div>

<p>Example of using the <tt class="docutils literal"><span class="pre">texmode</span></tt> attribute:</p>

    a_1 [texlbl=&quot;$\frac{\gamma}{2x^2+y^3}$&quot;];

    a_1 -&gt; a_2 -&gt; a_3 -&gt; a_1

    a_1 -&gt; b_1 -&gt; b_2 -&gt; a_3;

    b_1 [label=&quot;\\frac{\\gamma}{x^2}&quot;];

    b_4 [label=&quot;\\beta&quot;]

    a_3 -&gt; b_4 -&gt; a_1;

}

<h3>Vertical label alignment</h3>

<p>Dot2tex relies on the xdot format for drawing nodes and placing node labels. The fonts that Graphviz and LaTeX use are different, so using the label coordinates from Graphviz does not always give good results. Dot2tex's default behavior is to place node labels in the middle of the node. However, you can change this behavior by setting the <tt class="docutils literal"><span class="pre">valignmode</span></tt> option to <tt class="docutils literal"><span class="pre">dot</span></tt>. Labels will then be placed using the coordinates supplied by Graphviz.</p>

<p>Here is an example graph where it is necessary to use the <tt class="docutils literal"><span class="pre">valignmode</span></tt> option:</p>

    node0 [label=&quot;{left|right}&quot;, shape=record];

    node1 [shape=rectangle, label=&quot;node 1&quot;];

    node0 -&gt; node1;

<img alt="blabla" src="img/valignmode2.png" />

</div>

<p>The result is better, but to get even better alignment you have to change the node font size. Graphviz' default font size is 14pt, which is larger than the typical 10pt or 11pt used in LaTeX documents. By changing the node font size to 10pt we can trick Graphviz to give us a better alignment:</p>

    node0 [label=&quot;{left|right}&quot;, shape=record];

    node1 [shape=rectangle, label=&quot;node 1&quot;];

    node0 -&gt; node1;

<div class="section" id="examples">

<h3>Examples</h3>

<p>Consider the following graph:</p>

    a_1 [texlbl=&quot;$x^2+\frac{\sin y}{y^2+\cos \beta}+\gamma_3$&quot;];

    a_1 -&gt; a_2 [label=&quot; &quot;, texlbl=&quot;$x_1+x_3^2+z+c+v~~$&quot;];

    a_2 -&gt; a_1;

<img alt="Graph with preprocessed labels" src="img/preproc1b.png" />

</div>

<p>Modifying node sizes using the <tt class="docutils literal"><span class="pre">widht/height</span></tt> and <tt class="docutils literal"><span class="pre">margin</span></tt> attributes can be a bit counterintuitive. A few examples will hopefully make it clearer:</p>

    a_1 [margin=&quot;0&quot;];

    a_2 [margin=&quot;0.7,0.4&quot;];

    a_3 [width=&quot;2&quot;,height=&quot;1&quot;];

<h3>Using styles</h3>

<p>The dot language defines the <tt class="docutils literal"><span class="pre">style</span></tt> attribute that can be used to modify the appearance of graphs, nodes, and edges. The <tt class="docutils literal"><span class="pre">style</span></tt> attribute is passed to the rendering backend, and is a powerful and flexible way of customizing the look and feel of your graphs. Using styles requires detailed knowledge of the output format.</p>

<p>The following example shows how interesting visual results can be achieved with the PGF/TikZ output format. The styles are PGF/TikZ specific. See the user guide for details:</p>

          style=&quot;ball color =green&quot;, label=&quot;&quot;];

    a_1 -- c -- a_2;

    c [style=&quot;ball color=black&quot;];

    a_3 -- c -- a_4 --a_3;

}

</pre></div>

<div class="section" id="changing-arrow-types">

<h4>Changing arrow types</h4>

<p>The style attribute can be used to change arrow types. A PGF/TikZ example:</p>

    c -&gt; n_1 [style=&quot;-stealth&quot;];

    c -&gt; n_2 [style=&quot;-to&quot;];

    c -&gt; n_3 [style=&quot;-latex&quot;];

<img alt="Setting default PGF/TikZ arrows." src="img/ex1gstyle.png" />

</div>

<p>A PSTricks example:</p>

    d2tdocpreamble=&quot;\usepackage{pstricks-add}&quot;;

    c -&gt; n_1 [style=&quot;arrows=-&gt;&quot;];

    c -&gt; n_2 [style=&quot;arrows=-&gt;&gt;&quot;];

    c -&gt; n_3 [style=&quot;arrows=-&lt;&quot;];

<div class="highlight"><pre><span class="k">\draw</span> (157bp,52bp) node[lblstyle] <span class="nb">{</span>label<span class="nb">}</span>;

</pre></div>

<p>Example:</p>

    a -&gt; b [label=&quot;label&quot;,lblstyle=&quot;draw=red,cross out&quot;];

    b -&gt; c [label=&quot;test&quot;,lblstyle=&quot;below=0.5cm,rotate=20,fill=blue!20&quot;];

    a [label=&quot;aa&quot;,lblstyle=&quot;blue&quot;];

<h3>TikZ edge labels</h3>

<p>With the <tt class="docutils literal"><span class="pre">--tikzedgelabel</span></tt> option you can bypass the XDOT edge label placement and let PGF and TikZ do the job instead. This can be useful in some cases. However, this only works properly for straight edges and <tt class="docutils literal"><span class="pre">to</span></tt> paths.</p>

<p>Example:</p>

    mindist = 0.5;

    a -- b [label=&quot;ab&quot;];

    b -- c [label=&quot;bc&quot;];

    c -- a [label=&quot;ca&quot;];

<h3>To paths</h3>

<p>The <tt class="docutils literal"><span class="pre">topath</span></tt> edge attribute offers a way to override the edges drawn by Graphviz. When a <tt class="docutils literal"><span class="pre">topath</span></tt> attribute is encountered, dot2tex inserts a so called <tt class="docutils literal"><span class="pre">to</span></tt> path operation to connect the nodes. A number of predefined to paths are defined by TikZ, and you can create your own.</p>

<p>Example:</p>

    mindist = 0.5;

    a -&gt; b [topath=&quot;bend right&quot;];

    c -&gt; b [topath=&quot;bend left&quot;];

    c -&gt; a [topath=&quot;out=10,in=-90&quot;];

<p class="last">To paths works best with layout tools that generate straight edges (neato, fdp, circo, twopi). The <tt class="docutils literal"><span class="pre">topath</span></tt> attribute overrides the edge routing done by Graphviz. You may therefore end up with overlapping edges.</p>

</div>

<p>Here is a larger example that uses the <tt class="docutils literal"><span class="pre">automata</span></tt> library:</p>

    d2tdocpreamble = &quot;\usetikzlibrary{automata}&quot;;

    d2tfigpreamble = &quot;\tikzstyle{every state}= \

    [draw=blue!50,very thick,fill=blue!20]&quot;;

    A [style=&quot;state, initial&quot;];

    A -&gt; B [label=2];

    A -&gt; D [label=7];

$ dot2tex -tikz -tmath --tikzedgelabels ex1.dot

</pre>

<p>each time, use <tt class="docutils literal"><span class="pre">d2toptions</span></tt> like this:</p>

    d2toptions =&quot;-tikz -tmath --tikzedgelabels&quot;;

    ...

}

<div class="section" id="use-the-tikz-output-format-for-maximum-flexibility">

<h3>Use the tikz output format for maximum flexibility</h3>

<p>The difference between the <tt class="docutils literal"><span class="pre">pgf</span></tt> and <tt class="docutils literal"><span class="pre">tikz</span></tt> output formats is best shown with an example. Consider the following graph:</p>

    mindist = 0.5;

    a -- b -- c -- a;

}

</pre></div>