~ubuntu-branches/ubuntu/raring/dot2tex/raring

Committer: Bazaar Package Importer
Author(s): Peter Collingbourne
Date: 2008-01-16 01:31:30 UTC
mfrom: (1.1.5 upstream)
Revision ID: james.westby@ubuntu.com-20080116013130-z4dr2lw8mswabbso

Tags: 2.7.0-1

* New upstream release
* dot2tex/dot2tex.py: backed out all changes apart from shebang as
taken upstream
* debian/dot2tex.1: documented new command line option --codeonly
* debian/rules: moved patching system to CDBS simple-patchsys
* debian/control: updated Standards-Version
* debian/control: added Uploaders, Vcs-Svn, Vcs-Browser fields for
PAPT
* debian/copyright: changed year to 2008

files added:
debian/patches

debian/patches/01-shebang.patch

doc/img/dot2texiex1.png

doc/img/dot2texiex2.png

doc/usage.pdf

examples/graphanndtti.tex

files removed:
doc/docgraphs/Copy of ex1.dot

files modified:
PKG-INFO

README.txt

changelog.txt

debian/changelog

debian/control

debian/copyright

debian/dot2tex.1

debian/rules

doc/usage.html

doc/usage.txt

dot2tex/dot2tex

dot2tex/dot2tex.py

setup.py

Show diffs side-by-side

added added

removed removed

doc/usage.html

294

<tr><th class="docinfo-name">Author:</th>

295

<td>Kjell Magne Fauske</td></tr>

296

<tr><th class="docinfo-name">Version:</th>

297

297

298

<tr class="field"><th class="docinfo-name">Licence:</th><td class="field-body">MIT</td>

299

</tr>

300

</tbody>

320

Users have reported problems using dot2tex with old versions of pyparsing and Graphviz.

321

Dot2tex was developed and tested using <a class="reference external" href="http://www.python.org">Python</a> 2.4. However, dot2tex will probably run fine using Python 2.3.

322

</div>

323

324

<h2>Installation</h2>

325

326

<h3>From source</h3>

327

Download a zip or a tarball from the <a class="reference external" href="http://www.fauskes.net/code/dot2tex/download/">download</a> page. It is also available on <a class="reference external" href="http://www.ctan.org/tex-archive/help/Catalogue/entries/dot2tex.html">CTAN</a>. Unpack the file to a directory and run <tt class="docutils literal">python</tt> on the <tt class="docutils literal">setup.py</tt> file:

328

329

$ python setup.py install

330

</pre>

331

This will create a dot2tex module in your Python module directory and a wrapper script in your <tt class="docutils literal">SCRIPTS</tt> directory. Note that a few warnings will be displayed. You can safely ignore them. The warnings are shown because there is some extra information in the <tt class="docutils literal">setup.py</tt> file that distutils does not understand.

332

</div>

333

334

<h3>Using easy_install</h3>

335

The easiest way to install dot2tex is to use <a class="reference external" href="http://peak.telecommunity.com/DevCenter/EasyInstall">easy_install</a>:

336

337

$ easy_install dot2tex

338

</pre>

339

The command will locate dot2tex and download it automatically. Note that documentation and examples are not installed by default. <a class="reference external" href="http://peak.telecommunity.com/DevCenter/EasyInstall">Easy_install</a> will also create a wrapper script or EXE file for you and install dependencies if necessary.

340

</div>

341

342

<h3>Binary packages</h3>

343

Binary packages are available for <a class="reference external" href="http://packages.qa.debian.org/d/dot2tex.html">Debian</a> and <a class="reference external" href="http://download.opensuse.org/repositories/home:/jimfunk/">OpenSUSE</a>.

344

</div>

345

346

<h3>Development version</h3>

347

The development version of <tt class="docutils literal">dot2tex</tt> is available from a <a class="reference external" href="http://code.google.com/p/dot2tex/source">Subversion repository</a> hosted at Google code. To get the code you can use the following command:

348

349

svn checkout http://dot2tex.googlecode.com/svn/trunk/ dot2tex

350

</pre>

351

</div>

352

</div>

323

353

324

354

<h2>Usage</h2>

325

355

Syntax:

414

444

<kbd>--figonly</kbd></td>

415

445

<td>Output the graph without a document preamble. Useful if the graph is to be included in a master document.</td></tr>

416

446

447

<kbd>--codeonly</kbd></td>

448

<td>Output only the drawing commands, without wrapping it in a <tt class="docutils literal">tikzpicture</tt> or <tt class="docutils literal">pspicture</tt> environment. Useful when used with the dot2texi package.</td></tr>

449

417

450

<kbd>--preproc</kbd></td>

418

451

<td>Preprocess the graph through LaTeX using the <a class="reference external" href="http://www.ctan.org/tex-archive/help/Catalogue/entries/preview.html">preview</a> package. Will generate a new dot file where the height and widths of nodes and edge labels are set based on the results from <a class="reference external" href="http://www.ctan.org/tex-archive/help/Catalogue/entries/preview.html">preview</a>.</td></tr>

419

452

525

558

526

559

This is the default output format. Generates code for the <a class="reference external" href="http://www.ctan.org/tex-archive/help/Catalogue/entries/pgf.html">Portable Graphics Format</a> (PGF) package . Mixes both PGF and TikZ commands.

527

560

</div>

528

561

529

562

<h3>PSTricks</h3>

530

563

Generates code for the <a class="reference external" href="http://tug.org/PSTricks/main.cgi/">PSTricks</a> package.

531

564

</div>

539

572

<li>Labels will fit inside nodes without preprocessing.</li>

540

573

<li>Full access to the power of PGF and TikZ.</li>

541

574

</ul>

575

You can find more details in the section: <a class="reference internal" href="#use-the-tikz-output-format-for-maximum-flexibility">Use the tikz output format for maximum flexibility</a>.

542

576

543

577

Note

544

578

The <tt class="docutils literal">tikz</tt> output format requires detailed knowledge of the PGF and TikZ package. Some of Graphviz' features will not work with this output format.

545

579

</div>

546

<!-- sdfsdf

547

The difference between the ``pgf`` and ``tikz`` output formats is best shown with an example. Consider the following graph:

548

549

.. sourcecode:: dot

550

551

graph G {

552

mindist = 0.5;

553

node [shape=circle];

554

a - - b - - c - - a;

555

}

556

557

Rendering the graph using ``circo`` and the ``pgf`` and ``tikz`` output formats::

558

559

$ circo -Txdot simple.dot | dot2tex -tmath -fpgf -s

560

$ circo -Txdot simple.dot | dot2tex -tmath -ftikz -s

561

562

gives visually different graphs:

563

564

.. figure:: img/pgftikzsimple.png

565

:alt: Difference between pgf and tikz output format

566

567

However, the main difference is in the generated code. Here is the ``pgf`` output:

568

569

.. sourcecode:: latex

570

571

% Edge: a - - b

572

\draw [] (19bp,38bp) - - (19bp,60bp);

573

% Edge: b - - c

574

\draw [] (35bp,70bp) - - (55bp,58bp);

575

% Edge: c - - a

576

\draw [] (55bp,40bp) - - (35bp,28bp);

577

% Node: a

578

\begin{scope}

579

\pgfsetstrokecolor{black}

580

\draw (19bp,19bp) ellipse (18bp and 19bp);

581

\draw (19bp,19bp) node {$a$};

582

\end{scope}

583

% Node: b

584

\begin{scope}

585

\pgfsetstrokecolor{black}

586

\draw (19bp,79bp) ellipse (18bp and 19bp);

587

\draw (19bp,79bp) node {$b$};

588

\end{scope}

589

% Node: c

590

\begin{scope}

591

\pgfsetstrokecolor{black}

592

\draw (71bp,49bp) ellipse (18bp and 19bp);

593

\draw (71bp,49bp) node {$c$};

594

\end{scope}

595

596

Compare the above code with the ``tikz`` output:

597

598

.. sourcecode:: latex

599

600

\node (a) at (19bp,19bp) [draw,circle,] {$a$};

601

\node (b) at (19bp,79bp) [draw,circle,] {$b$};

602

\node (c) at (71bp,49bp) [draw,circle,] {$c$};

603

\draw [] (a) - - (b);

604

\draw [] (b) - - (c);

605

\draw [] (c) - - (a);

606

607

The code is much more compact and it is quite easy to modify the graph. -->

608

580

</div>

609

581

</div>

610

582

1328

1300

}

1329

1301

</pre></div>

1330

1302

</div>

1303

1304

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

1305

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

1306

<div class="highlight"><pre>graph G {

1307

mindist = 0.5;

1308

node [shape=circle];

1309

a -- b -- c -- a;

1310

}

1311

</pre></div>

1312

Rendering the graph using <tt class="docutils literal">circo</tt> and the <tt class="docutils literal">pgf</tt> and <tt class="docutils literal">tikz</tt> output formats:

1313

1314

$ circo -Txdot simple.dot | dot2tex -tmath -fpgf -s

1315

$ circo -Txdot simple.dot | dot2tex -tmath -ftikz -s

1316

</pre>

1317

gives visually different graphs:

1318

1319

1320

</div>

1321

However, the main difference is in the generated code. Here is the <tt class="docutils literal">pgf</tt> output:

1322

<div class="highlight"><pre>% Edge: a -- b

1323

\draw [] (19bp,38bp) -- (19bp,60bp);

1324

% Edge: b -- c

1325

\draw [] (35bp,70bp) -- (55bp,58bp);

1326

% Edge: c -- a

1327

\draw [] (55bp,40bp) -- (35bp,28bp);

1328

% Node: a

1329

\begin{scope}

1330

\pgfsetstrokecolor{black}

1331

\draw (19bp,19bp) ellipse (18bp and 19bp);

1332

\draw (19bp,19bp) node {$a$};

1333

\end{scope}

1334

% Node: b

1335

\begin{scope}

1336

\pgfsetstrokecolor{black}

1337

\draw (19bp,79bp) ellipse (18bp and 19bp);

1338

\draw (19bp,79bp) node {$b$};

1339

\end{scope}

1340

% Node: c

1341

\begin{scope}

1342

\pgfsetstrokecolor{black}

1343

\draw (71bp,49bp) ellipse (18bp and 19bp);

1344

\draw (71bp,49bp) node {$c$};

1345

\end{scope}

1346

</pre></div>

1347

Compare the above code with the <tt class="docutils literal">tikz</tt> output:

1348

<div class="highlight"><pre>\node (a) at (19bp,19bp) [draw,circle,] {$a$};

1349

\node (b) at (19bp,79bp) [draw,circle,] {$b$};

1350

\node (c) at (71bp,49bp) [draw,circle,] {$c$};

1351

\draw [] (a) -- (b);

1352

\draw [] (b) -- (c);

1353

\draw [] (c) -- (a);

1354

</pre></div>

1355

The code is much more compact and it is quite easy to modify the graph.

1356

</div>

1357

1358

<h3>The dot2texi LaTeX package</h3>

1359

The dot2texi package allows you to embed DOT graphs directly in you LaTeX document. The package will automatically run <tt class="docutils literal">dot2tex</tt> for you and include the generated code. Example:

1360

<div class="highlight"><pre>\documentclass{article}

1361

\usepackage{dot2texi}

1362

1363

\usepackage{tikz}

1364

\usetikzlibrary{shapes,arrows}

1365

1366

\begin{document}

1367

\begin{dot2tex}[neato,options=-tmath]

1368

digraph G {

1369

node [shape="circle"];

1370

a_1 -> a_2 -> a_3 -> a_4 -> a_1;

1371

}

1372

\end{dot2tex}

1373

1374

\end{document}

1375

</pre></div>

1376

When the above code is run through LaTeX, the following will happen is shell escape is enabled:

1377

1378

<li>The graph is written to file.</li>

1379

1380

<li>The generated code is included in the document.</li>

1381

</ul>

1382

The whole process is completely automated. The generated graph will look like this:

1383

1384

1385

</div>

1386

The <tt class="docutils literal">codeonly</tt> option is useful in conjunction with <tt class="docutils literal">dot2texi</tt>, especially when used with the <tt class="docutils literal">tikz</tt> output format. Here is an example that shows how to annotate a graph:

1387

<div class="highlight"><pre>\documentclass{article}

1388

\usepackage{tikz}

1389

\usetikzlibrary{arrows,shapes}

1390

\usepackage{dot2texi}

1391

\begin{document}

1392

% Define layers

1393

\pgfdeclarelayer{background}

1394

\pgfdeclarelayer{foreground}

1395

\pgfsetlayers{background,main,foreground}

1396

1397

% The scale option is useful for adjusting spacing between nodes.

1398

% Note that this works best when straight lines are used to connect

1399

% the nodes.

1400

\begin{tikzpicture}[>=latex',scale=0.8]

1401

% set node style

1402

\tikzstyle{n} = [draw,shape=circle,minimum size=2em,

1403

inner sep=0pt,fill=red!20]

1404

\begin{dot2tex}[dot,tikz,codeonly,styleonly,options=-s -tmath]

1405

digraph G {

1406

node [style="n"];

1407

A_1 -> B_1; A_1 -> B_2; A_1 -> B_3;

1408

B_1 -> C_1; B_1 -> C_2;

1409

B_2 -> C_2; B_2 -> C_3;

1410

B_3 -> C_3; B_3 -> C_4;

1411

}

1412

\end{dot2tex}

1413

% annotations

1414

\node[left=1em] at (C_1.west) (l3) {Level 3};

1415

\node at (l3 |- B_1) (l2){Level 2};

1416

\node at (l3 |- A_1) (l1) {Level 1};

1417

% Draw lines to separate the levels. First we need to calculate

1418

% where the middle is.

1419

\path (l3) -- coordinate (l32) (l2) -- coordinate (l21) (l1);

1420

\draw[dashed] (C_1 |- l32) -- (l32 -| C_4);

1421

\draw[dashed] (C_1 |- l21) -- (l21 -| C_4);

1422

\draw[<->,red] (A_1) to[out=-120,in=90] (C_2);

1423

% Highlight the A_1 -> B_1 -> C_2 path. Use layers to draw

1424

% behind everything.

1425

\begin{pgfonlayer}{background}

1426

\draw[rounded corners=2em,line width=3em,blue!20,cap=round]

1427

(A_1.center) -- (B_1.west) -- (C_2.center);

1428

\end{pgfonlayer}

1429

\end{tikzpicture}

1430

\end{document}

1431

</pre></div>

1432

1433

1434

</div>

1435

</div>

1331

1436

</div>

1332

1437

</div>

1333

1438

</body>

Older »