Sophie

Sophie

distrib > Mageia > 7 > armv7hl > media > core-release > by-pkgid > 27fc3816ce7bb7b951b682a64459b8dd > files > 20

vizant-0.1.0-7.mga7.noarch.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO8859-1">
<title>Vizant - Ant task to visualize buildfile</title>
<link rel="stylesheet" href="main.css" media="all">
</head>
<body>

<h1>Vizant - Ant task to visualize buildfile</h1>

<p class="updated">$Date: 2002/06/17 18:15:52 $ - [ English | Japanese ]</p>


<h2>What's Vizant?</h2>

<p>
<a href="http://www.teria.com/~koseki/vizant/">Vizant</a> is an <a href="http://jakarta.apache.org/ant/" target="_blank">Apache Ant</a> task to create <a href="http://www.research.att.com/sw/tools/graphviz/" target="_blank">Graphviz</a> DOT source code from an Ant buildfile. The image created from the DOT source code shows the targets dependency.
</P>

<p>
<ul>
<li><a href="#examples">Examples</a></li>
<li><a href="#download">Download</a></li>
<li><a href="#usage">Usage</a>
<ul>
<li><a href="#parameters">Parameters</a></li>
<li><a href="#nestedelements">Parameters specified as nested element</a></li>
<li><a href="#examples">Examples</a></li>
</ul>
</li>
<li><a href="#references">References</a></li>
</ul>

<h2><a name="examples">Examples</a></h2>

<p>The below graph was created from Ant1.5beta1 build.xml.<p>
<p><a href="./ant15b1/ant15b1_1.png"><img src="./ant15b1/ant15b1_1s.png"></a></p>
<p><a href="examples.html">More examples are available.</a></p>

<h2><a name="download">Download</a></h2>

<ul>
<li><a href="http://www.teria.com/~koseki/download/vizant.jar">vizant.jar</a> (latest binary)</li>
<li><a href="http://www.teria.com/~koseki/download/vizant-0.1.zip">vizant-0.1.zip</a> (2002-06-18)</li>
</ul>

<p><strong>Note:</strong> There are no <a href="http://jakarta.apache.org/ant/manual/install.html#librarydependencies" target="_blank">library dependencies</a> in vizant task, but you will need <a href="http://www.research.att.com/sw/tools/graphviz/" target="_blank">Graphviz</a> dot command to create images.</p>

<h2><a name="usage">Usage</a></h2>

<h3><a name="parameters">Parameters</a></h3>

<p>
<table border="1" cellpadding="2" cellspacing="0">
  <tr>
    <td valign="top"><b>Attribute</b></td>
    <td valign="top"><b>Description</b></td>
    <td align="center" valign="top"><b>Required</b></td>
  </tr>

  <tr>
    <td valign="top">antfile</td>
    <td valign="top">the input Ant buildfile</td>
    <td align="center" valign="top">Yes</td>
  </tr>

  <tr>
    <td valign="top">outfile</td>
    <td valign="top">the output DOT file</td>
    <td align="center" valign="top">Yes</td>
  </tr>

  <tr>
    <td valign="top">from</td>
    <td valign="top">If the target name specified, cut down all blanches that the target doesn't depends on.</td>
    <td align="center" valign="top">No</td>
  </tr>

  <tr>
    <td valign="top">to</td>
    <td valign="top">If the target name specified, cut down all blanches that the target isn't depended from.</td>
    <td align="center" valign="top">No</td>
  </tr>

  <tr>
    <td valign="top">nocluster</td>
    <td valign="top">do not use cluster(outer rectangle) to show external buildfile</td>
    <td align="center" valign="top">No, default is false</td>
  </tr>

  <tr>
    <td valign="top">uniqueref</td>
    <td valign="top">do not drow edge repeatedly when the &lt;ant&gt; or &lt;antcall&gt; task called more than once against the same target.</td>
    <td align="center" valign="top">No, default is false</td>
  </tr>

  <tr>
    <td valign="top">ignoreant</td>
    <td valign="top">ignore all &lt;ant&gt; tasks</td>
    <td align="center" valign="top">No, default is false</td>
  </tr>

  <tr>
    <td valign="top">ignoreantcall</td>
    <td valign="top">ignore all &lt;antcall&gt; tasks</td>
    <td align="center" valign="top">No, default is false</td>
  </tr>

  <tr>
    <td valign="top">ignoredepends</td>
    <td valign="top">ignore all depends attributes</td>
    <td align="center" valign="top">No, default is false</td>
  </tr>

</table>
</p>

<h3><a name="nestedelements">Parameters specified as nested element</a></h3>
<h4>subgraph</h4>

<p>Apply attributes only to subgraphs. Subgraph is used to represent external buildfile and targets.

<p>
<ul>
<li>parent: &lt;vizant&gt;</li>
<li>child: &lt;attrstmt&gt;</li>
</ul>
</p>

<h4>attrstmt</h4>

<p>&lt;attrstmt&gt; nested element represents <i>attr_stmt</i> nonterminal in <a href="http://www.research.att.com/~erg/graphviz/info/lang.html" target="_blank">the DOT language specification</a>. This element creates an group of attributes.</p>

<p>
<ul>
<li>parent: &lt;vizant&gt; &lt;subgraph&gt;</li>
<li>child: &lt;attr&gt;</li>
</ul>
</p>

<p>
<table border="1" cellpadding="2" cellspacing="0">
  <tr>
    <td valign="top"><b>Attribute</b></td>
    <td valign="top"><b>Description</b></td>
    <td align="center" valign="top"><b>Required</b></td>
  </tr>

  <tr>
    <td valign="top">type</td>
    <td valign="top">
The value must be one of the
<ul>
<li>graph</li>
<li>node</li>
<li>edge</li>
<li>node.default</li>
<li>edge.ant</li>
<li>edge.antcall</li>
<li>edge.depends</li>
</ul>
</td>
    <td align="center" valign="top">Yes</td>
  </tr>

</table>

</p>

<h4>attr</h4>



<p>&lt;attr&gt; nested element represents a DOT attribute. You can get the complete <a href="http://www.research.att.com/~erg/graphviz/info/attrs.html" target="_blank">list of attributes</a> at the Graphviz site.</p>

<p>
<ul>
<li>parent: &lt;attrstmt&gt;</li>
<li>child: none</li>
</ul>
</p>

<p>
<table border="1" cellpadding="2" cellspacing="0">
  <tr>
    <td valign="top"><b>Attribute</b></td>
    <td valign="top"><b>Description</b></td>
    <td align="center" valign="top"><b>Required</b></td>
  </tr>

  <tr>
    <td valign="top">name</td>
    <td valign="top">the DOT attribute name.</td>
    <td align="center" valign="top">Yes</td>
  </tr>

  <tr>
    <td valign="top">value</td>
    <td valign="top">the DOT attribute value.</td>
    <td align="center" valign="top">Yes</td>
  </tr>

</table>
</p>


<h3><a name="examples">Examples</a></h3>

<p>The most simple usage is like this.</p>

<blockquote>
&lt;vizant antfile="build.xml" outfile="build.dot"/&gt;<br>
&lt;exec executable="dot" &gt;&lt;arg line="-Tpng build.dot -o build.png"/&gt;&lt;/exec&gt;
</blockquote>


<p>You can apply various DOT attributes using nested elements.</p>

<blockquote>
&lt;vizant antfile="build.xml" outfile="build.dot"&gt;<br>
&nbsp;&nbsp;&lt;attrstmt type="node"&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&lt;attr name="style" value="filled"/&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&lt;attr name="shape" value="egg"/&gt;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&lt;attr name="color" value="grey90"/&gt;<br>
&nbsp;&nbsp;&lt;/attrstmt&gt;<br>
&lt;/vizant&gt;<br>
&lt;exec executable="dot" &gt;&lt;arg line="-Tsvg build.dot -o build.svg"/&gt;&lt;/exec&gt;<br>
</blockquote>

<p><a href="examples.html">And more.</a></p>
<h2><a name="references">References</a></h2>

<ul>
<li><a href="http://jakarta.apache.org/ant/">Apache Ant</a></li>
<li><a href="http://www.research.att.com/sw/tools/graphviz/">Graphviz - open source graph drawing software</a></li>

</ul>

<hr>
<address><a href="http://www.teria.com/~koseki/index_en.html">KOSEKI Kengo</a> &lt;<a href="mailto:kengo@tt.rim.or.jp">kengo@tt.rim.or.jp</a>&gt;</address>

</body>
</html>