[Ant-contrib-developers] SF.net SVN: ant-contrib: [92] trunk/ant-contrib/docs/manual/tasks/importurl .html

[<mat...@us...>]

Revision: 92
          http://svn.sourceforge.net/ant-contrib/?rev=92&view=rev
Author:   mattinger
Date:     2007-03-06 10:22:51 -0800 (Tue, 06 Mar 2007)

Log Message:
-----------


Modified Paths:
--------------
    trunk/ant-contrib/docs/manual/tasks/importurl.html

Modified: trunk/ant-contrib/docs/manual/tasks/importurl.html
===================================================================
--- trunk/ant-contrib/docs/manual/tasks/importurl.html	2007-03-06 16:42:27 UTC (rev 91)
+++ trunk/ant-contrib/docs/manual/tasks/importurl.html	2007-03-06 18:22:51 UTC (rev 92)
@@ -17,9 +17,11 @@
     </p>
     <p>In the case of a .jar/.zip file, the file is downloaded and then
        decompressed.  After decompression, the file 'build.xml' at the root
-       level of the jar is imported. By importing a .jar/.zip file, one can package additional resources along with
-       the build.xml file.  However, you must be careful how you refer to these resources.
-       The build.xml file must follow the same rules as any other file imported with the
+       level of the jar is imported (the name of the imported file can be
+       overriden with the 'resource' attribute). By importing a .jar/.zip file,
+       one can package additional resources along with the build.xml file.  However,
+       you must be careful how you refer to these resources. The build.xml file must
+       follow the same rules as any other file imported with the
        &lt;import&gt; task, in that references relative to the build.xml file must be
        made with the property:
            ant.file.&lt;projectname&gt;
@@ -30,7 +32,7 @@
     <pre>    
     <code>
         &lt;project name="common"&gt;
-            &lt;basedir property="ant.dir.common" file="${ant.file.common}" /&gt;
+            &lt;dirname property="ant.dir.common" file="${ant.file.common}" /&gt;
             &lt;property file="${ant.dir.common}/build.properties" /&gt;
         &lt;/project&gt;
     </code>
@@ -60,7 +62,7 @@
         <td align="center" valign="top">Yes.</td>
       </tr>
       <tr>
-        <td valign="top">ref</td>
+        <td valign="top">rev</td>
         <td valign="top">The revision of the module to be fetched.</td>
         <td align="center" valign="top">No.  Defaults to "latest.integration".
            See the ivy details for more information on the possible wildcarding
@@ -111,6 +113,21 @@
         ivy documentation for more information on the contents of this pattern.
         </td>
       </tr>
+      <tr>
+        <td valign="top">ivyPattern</td>
+        <td valign="top">The pattern used to find ivy file for the artifact in the repository.</td>
+        <td align="center" valign="top">No.  If repositoryUrl or repositoryDir
+        are specified, this defaults to the standard repository pattern:
+        "/[org]/[module]/ivy-[revision].xml".  Please see the
+        ivy documentation for more information on the contents of this pattern.
+        </td>
+      </tr>
+      <tr>
+        <td valign="top">resource</td>
+        <td valign="top">The name of the resource within a compressed file to import.</td>
+        <td align="center" valign="top">No.  Defaults to "build.xml".
+        </td>
+      </tr>
     </table>
 
 
@@ -119,9 +136,11 @@
 
     <pre>
     <code>
-    &lt;antcontrib:importurl org="antcontrib"
-                             module="common"
-                             rev="3.2" /&gt;
+    &lt;project name="build" basedir="." default="build" xmlns:ac="antlib:net.sf.antcontrib"&gt;
+        &lt;ac:antcontrib:importurl org="antcontrib"
+                                 module="common"
+                                 rev="3.2" /&gt;
+    &lt;/project&gt;
     </code>
     </pre>
     
@@ -130,7 +149,7 @@
     
     <pre>
     <code>
-    &lt;antcontrib:importurl org="antcontrib"
+    &lt;ac:antcontrib:importurl org="antcontrib"
                              module="common"
                              rev="3.2" 
                              type="xml" /&gt;
@@ -142,7 +161,7 @@
 
     <pre>
     <code>
-    &lt;antcontrib:importurl repositoryUrl="http://www.antcontrib.org/ivyrep"
+    &lt;ac:antcontrib:importurl repositoryUrl="http://www.antcontrib.org/ivyrep"
                              org="antcontrib"
                              module="common"
                              rev="3.2" /&gt;
@@ -152,6 +171,16 @@
     would look for the located at
      "http://www.antcontrib.org/ivyrep/antcontrib/common/jars/common-3.2.jar"
 
+    <pre>
+    <code>
+    &lt;ac:antcontrib:importurl ivyConfUrl="http://ivyrep.myorg.com/ivyconf.xml"
+                                org="antcontrib"
+                                module="common"
+                                rev="3.2" /&gt;
+    </code>
+    </pre>
+
+    would configure ivy using the ivy configuration file at the given ivyConfUrl.
 <p>    
     The following build.xml may be packaged into a .jar with it's corresponding
     build.properties file:


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.