From 98d6077c1d5f4e37889123fdd6c2b4bb32014328 Mon Sep 17 00:00:00 2001 From: mattinger Date: Thu, 24 Aug 2006 18:00:19 +0000 Subject: git-svn-id: file:///home/sven/projects/JOGL/temp/ant-contrib/svn/ant-contrib-code/trunk/ant-contrib@44 32d7a393-a5a9-423c-abd3-5d954feb1f2f --- docs/manual/tasks/importurl.html | 260 +++++++++++++++++++++------------------ 1 file changed, 137 insertions(+), 123 deletions(-) (limited to 'docs/manual/tasks/importurl.html') diff --git a/docs/manual/tasks/importurl.html b/docs/manual/tasks/importurl.html index f2b4bc2..52ed7d1 100755 --- a/docs/manual/tasks/importurl.html +++ b/docs/manual/tasks/importurl.html @@ -7,40 +7,40 @@

Importurl

The Importurl task will download a file, and import it's contents into the - current project. The file can be in the form of a standard ant .xml project - file, or a .jar/.zip file. -

In the case of an .xml file, the file is downloaded, and imported as - is. In this case, the file itself is the only thing downloaded (ie. - no corresponding .properties files, or other build files are downloaded). -

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 - <import> task, in that references relative to the build.xml file must be - made with the property: - ant.file.<projectname> - where <projectname> is the name of the project being imported, as specified - in the project tag. Example: -

- -

    
-    
-        <project name="common">
-            <basedir property="ant.dir.common" file="${ant.file.common}" />
-            <property file="${ant.dir.common}/build.properties" />
-        </project>
-    
+    The Importurl task will download a file, and import it's contents into the
+       current project.  The file can be in the form of a standard ant .xml project
+       file, or a .jar/.zip file.
+    
+    In the case of an .xml file, the file is downloaded, and imported as
+       is.  In this case, the file itself is the only thing downloaded (ie.
+       no corresponding .properties files, or other build files are downloaded).
+    
+    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
+       <import> task, in that references relative to the build.xml file must be
+       made with the property:
+           ant.file.<projectname>
+       where <projectname> is the name of the project being imported, as specified
+       in the project tag.  Example:
+    
+    
+        
+    
+        <project name="common">
+            <basedir property="ant.dir.common" file="${ant.file.common}" />
+            <property file="${ant.dir.common}/build.properties" />
+        </project>
+    
         
-
-    
-       This task should be compatible with older versions of ant, but has only been
-       tested with Ant 1.6.x.  The underlying implementation is done using the
-       Ivy dependency resolver software,
-       and thus, it needs available to the same classloader that loads this task.
+
+    

+       This task should be compatible with older versions of ant, but has only been
+       tested with Ant 1.6.x.  The underlying implementation is done using the
+       Ivy dependency resolver software,
+       and thus, it needs available to the same classloader that loads this task.
     
     Parameters
     
@@ -54,104 +54,118 @@
         
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
+      
+        
+        
+        
+      
+      
+        
+        
+        
+      
+      
+        
+        
+        
+      
+      
+        
+        
+        
+      
+      
+        
+        
+        
+      
+      
+        
+        
+        
+      
+      
+        
+        
+        
+      
+      
+        
+        
+        
+      The organization that publishes the script.
         Yes.
       
module The name of the module which is to be fetched. Yes.
ref The revision of the module to be fetched. No.  Defaults to "latest.integration".
-           See the ivy details for more information on the possible wildcarding
-           that can be used for this value.
type The type of file to be downloaded No.  Defaults to 'jar'.  Can be
-            any file extension.  However, unless the type is 'xml', the
-            file is assumed to be a compressed file, expandable by ant's
-            <expand> task (which is aliased to unjar, unzip).
repositoryUrl The URL base of the repository to use.  This
-        results in using Ivy's URLResolver to resolve the requested
-        resource. No.  Defaults to the IvyRepResolver.
repositoryDir The file base of the repository to use.  This
-        results in using Ivy's FileSystemResolver to resolve the requested
-        resource. No.  Defaults to the IvyRepResolver.
artifactPattern The pattern used to find artifacts in the repository. No.  If repositoryUrl or repositoryDir
-        are specified, this defaults to the standard repository pattern:
-        "/[org]/[module]/[ext]s/[module]-[revision].[ext]".  Please see the
-        ivy documentation for more information on the contents of this pattern.
-        
module The name of the module which is to be fetched. Yes.
ref The revision of the module to be fetched. No.  Defaults to "latest.integration".
+           See the ivy details for more information on the possible wildcarding
+           that can be used for this value.
type The type of file to be downloaded No.  Defaults to 'jar'.  Can be
+            any file extension.  However, unless the type is 'xml', the
+            file is assumed to be a compressed file, expandable by ant's
+            <expand> task (which is aliased to unjar, unzip).
ivyConfUrl The URL of an ivy configuration file to use.  We
+        will use the default resolver in this file to find the requested
+        resource. No.  Defaults to the IvyRepResolver.
ivyConfFile The path of an ivy configuration file to use.  We
+        will use the default resolver in this file to find the requested
+        resource. No.  Defaults to the IvyRepResolver.
repositoryUrl The URL base of the repository to use.  This
+        results in using Ivy's URLResolver to resolve the requested
+        resource. No.  Defaults to the IvyRepResolver.
repositoryDir The file base of the repository to use.  This
+        results in using Ivy's FileSystemResolver to resolve the requested
+        resource. No.  Defaults to the IvyRepResolver.
artifactPattern The pattern used to find artifacts in the repository. No.  If repositoryUrl or repositoryDir
+        are specified, this defaults to the standard repository pattern:
+        "/[org]/[module]/[ext]s/[module]-[revision].[ext]".  Please see the
+        ivy documentation for more information on the contents of this pattern.
+        
     
 
 
     Example
 
 
-    -    
-    <antcontrib:importurl org="antcontrib"
-                             module="common"
-                             rev="3.2" />
-    
-    
-    
-    would look for the file "antcontrib/common/jars/common-3.2.jar" in the IvyRep
-    repository.
+    +    
+    <antcontrib:importurl org="antcontrib"
+                             module="common"
+                             rev="3.2" />
+    
+    
+    
+    would look for the file "antcontrib/common/jars/common-3.2.jar" in the IvyRep
+    repository.
     
-    -    
-    <antcontrib:importurl org="antcontrib"
-                             module="common"
-                             rev="3.2" 
-                             type="xml" />
-    
-    
+    +    
+    <antcontrib:importurl org="antcontrib"
+                             module="common"
+                             rev="3.2" 
+                             type="xml" />
+    
+    
+
+    would look for the file "antcontrib/common/jars/common-3.2.xml" in the IvyRep
+    repository.
+
+    +    
+    <antcontrib:importurl repositoryUrl="http://www.antcontrib.org/ivyrep"
+                             org="antcontrib"
+                             module="common"
+                             rev="3.2" />
+    
+    
+
+    would look for the located at
+     "http://www.antcontrib.org/ivyrep/antcontrib/common/jars/common-3.2.jar"
+
+    
+    The following build.xml may be packaged into a .jar with it's corresponding
+    build.properties file:
+
+
+    +    
+    <project name="common">
+    <basedir property="ant.dir.common" file="${ant.file.common}" />
+    <property file="${ant.dir.common}/build.properties" />
+    </project>
+    
+    
 
-    would look for the file "antcontrib/common/jars/common-3.2.xml" in the IvyRep
-    repository.
-
-    -    
-    <antcontrib:importurl repositoryUrl="http://www.antcontrib.org/ivyrep"
-                             org="antcontrib"
-                             module="common"
-                             rev="3.2" />
-    
-    
-
-    would look for the located at
-     "http://www.antcontrib.org/ivyrep/antcontrib/common/jars/common-3.2.jar"
-
-    
-    The following build.xml may be packaged into a .jar with it's corresponding
-    build.properties file:
-
-
-    -    
-    <project name="common">
-    <basedir property="ant.dir.common" file="${ant.file.common}" />
-    <property file="${ant.dir.common}/build.properties" />
-    </project>
-    
-    
-
 
     
     Copyright © 2002-2006 Ant-Contrib Project. All
-- 
cgit v1.2.3

The organization that publishes the script.	Yes.
module	The name of the module which is to be fetched.	Yes.
ref	The revision of the module to be fetched.	No. Defaults to "latest.integration". - See the ivy details for more information on the possible wildcarding - that can be used for this value.
type	The type of file to be downloaded	No. Defaults to 'jar'. Can be - any file extension. However, unless the type is 'xml', the - file is assumed to be a compressed file, expandable by ant's - <expand> task (which is aliased to unjar, unzip).
repositoryUrl	The URL base of the repository to use. This - results in using Ivy's URLResolver to resolve the requested - resource.	No. Defaults to the IvyRepResolver.
repositoryDir	The file base of the repository to use. This - results in using Ivy's FileSystemResolver to resolve the requested - resource.	No. Defaults to the IvyRepResolver.
artifactPattern	The pattern used to find artifacts in the repository.	No. If repositoryUrl or repositoryDir - are specified, this defaults to the standard repository pattern: - "/[org]/[module]/[ext]s/[module]-[revision].[ext]". Please see the - ivy documentation for more information on the contents of this pattern. -
module	The name of the module which is to be fetched.	Yes.
ref	The revision of the module to be fetched.	No. Defaults to "latest.integration". + See the ivy details for more information on the possible wildcarding + that can be used for this value.
type	The type of file to be downloaded	No. Defaults to 'jar'. Can be + any file extension. However, unless the type is 'xml', the + file is assumed to be a compressed file, expandable by ant's + <expand> task (which is aliased to unjar, unzip).
ivyConfUrl	The URL of an ivy configuration file to use. We + will use the default resolver in this file to find the requested + resource.	No. Defaults to the IvyRepResolver.
ivyConfFile	The path of an ivy configuration file to use. We + will use the default resolver in this file to find the requested + resource.	No. Defaults to the IvyRepResolver.
repositoryUrl	The URL base of the repository to use. This + results in using Ivy's URLResolver to resolve the requested + resource.	No. Defaults to the IvyRepResolver.
repositoryDir	The file base of the repository to use. This + results in using Ivy's FileSystemResolver to resolve the requested + resource.	No. Defaults to the IvyRepResolver.
artifactPattern	The pattern used to find artifacts in the repository.	No. If repositoryUrl or repositoryDir + are specified, this defaults to the standard repository pattern: + "/[org]/[module]/[ext]s/[module]-[revision].[ext]". Please see the + ivy documentation for more information on the contents of this pattern. +