You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by di...@apache.org on 2002/12/14 01:22:17 UTC

cvs commit: jakarta-turbine-maven/src/plugins-build/graph/xdocs changes.xml properties.xml navigation.xml goals.xml

dion        2002/12/13 16:22:17

  Added:       src/plugins-build/graph/xdocs changes.xml properties.xml
                        navigation.xml goals.xml
  Log:
  Updated docs
  
  Revision  Changes    Path
  1.1                  jakarta-turbine-maven/src/plugins-build/graph/xdocs/changes.xml
  
  Index: changes.xml
  ===================================================================
  <?xml version="1.0"?>
  <document>
    <properties>
      <title>Changes</title>
      <author email="dion@apache.org">dIon Gillard</author>
    </properties>
    <body>
      <release version="1.0" date="2002-07-14">
        <action dev="jvanzyl" type="add">
          Initial plugin created
        </action>
      </release>
    </body>
  </document>
  
  
  
  
  1.1                  jakarta-turbine-maven/src/plugins-build/graph/xdocs/properties.xml
  
  Index: properties.xml
  ===================================================================
  <?xml version="1.0" encoding="ISO-8859-1"?>
  <document>
  
    <properties>
      <title>Properties</title>
      <author email="dion@apache.org">dIon Gillard</author>
    </properties>
  
    <body>
      <section name="Graph Settings">
        <table>
          <tr><th>Property</th><th>Optional?</th><th>Description</th><th>Default</th></tr>
          <tr>
            <td>maven.graph.viewer.executable</td>
            <td>Yes</td>
            <td>
              <p>Defaults to <code>dotty</code></p>
              <p>
                Specifies the executable to use when viewing graphs.
              </p>
            </td>
          </tr>
          <tr>
            <td>maven.graph.rasterizer.executable</td>
            <td>Yes</td>
            <td>
              <p>Defaults to <code>dot</code>.</p>
              <p>
                Specifies the executable to use to produce the image file
              </p>
            </td>
          </tr>
          <tr>
            <td>maven.graph.output.xml</td>
            <td>Yes</td>
            <td>
              The file name used for output when producing an xml file
            </td>
          </tr>
          <tr>
            <td>maven.graph.output.dot</td>
            <td>Yes</td>
            <td>
              The XML file name used as an intermediate step in
              producing an image
            </td>
          </tr>
          <tr>
            <td>maven.graph.output.image.format</td>
            <td>Yes</td>
            <td>
              <p>Defaults to <code>gif</code></p>
              <p>The format of the image file produced</p>
            </td>
          </tr>
          <tr>
            <td>maven.graph.output.image.file</td>
            <td>Yes</td>
            <td>
              <p>Defaults to <code>${maven.build.dir}/graph/goals.${maven.graph.output.image.format}</code></p>
              <p>
                The name of the image file produced
              </p>
            </td>
          </tr>
        </table>
      </section>
    </body>
  </document>
  
  
  
  1.1                  jakarta-turbine-maven/src/plugins-build/graph/xdocs/navigation.xml
  
  Index: navigation.xml
  ===================================================================
  <?xml version="1.0" encoding="ISO-8859-1"?>
  <project name="Maven Graph Plugin">
  
    <title>Maven Graph Plugin</title>
  
    <body>
      <links>
        <item name="Maven" href="http://jakarta.apache.org/turbine/maven/"/>
      </links>
      <menu name="Overview">
        <item name="Goals"              href="/goals.html" />
        <item name="Properties"         href="/properties.html" />
      </menu>
    </body>
  </project>
  
  
  
  1.1                  jakarta-turbine-maven/src/plugins-build/graph/xdocs/goals.xml
  
  Index: goals.xml
  ===================================================================
  <?xml version="1.0"?>
  <document>
  
    <properties>
      <title>Maven Graph Plug-in Goals</title>
      <author email="dion@apache.org">dIon Gillard</author>
    </properties>
    <body>
      <goals>
        <goal>
          <name>graph</name>
          <description>
            Simply attains the <a href="#graph:goals-to-xdoc">goals-to-xdoc</a>
            goal
          </description>
        </goal>
        <goal>
          <name>graph:goals-to-image</name>
          <description>
            Get a .gif graph of current goals and their dependencies
          </description>
        </goal>
        <goal>
          <name>graph:goals-to-xdoc</name>
          <description>
            Create an xdoc document from the project goals
          </description>
        <goal>
          <name>graph:goals-to-xml</name>
          <description>Get an xml file representing the goal structure</description>
        </goal>
        <goal>
          <name>graph:project-dependencies</name<
          <description>
            Under construction
          </description>
        </goal>
      </goals>
    </body>
  </document>