From f4e6936fb947ac52a258ac6b3f59b9fd1bb901dc Mon Sep 17 00:00:00 2001 From: Steve Loughran Date: Tue, 23 Aug 2005 14:46:53 +0000 Subject: [PATCH] documentation for makeurl. also fixed up errors in tasksoverview.html git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@278541 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/CoreTasks/makeurl.html | 216 +++++++++++++++++++++++++++++ docs/manual/coretasklist.html | 1 + docs/manual/tasksoverview.html | 80 ++++++----- 3 files changed, 260 insertions(+), 37 deletions(-) create mode 100644 docs/manual/CoreTasks/makeurl.html diff --git a/docs/manual/CoreTasks/makeurl.html b/docs/manual/CoreTasks/makeurl.html new file mode 100644 index 000000000..22da3ebad --- /dev/null +++ b/docs/manual/CoreTasks/makeurl.html @@ -0,0 +1,216 @@ + + + + + Makeurl + Task + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ Makeurl + Task +
This task takes one or more filenames and turns them into URLs, which it then assigns to a property. + 		+ + + Apache Ant + +
+
+ + + + + + + + + + +
 
+ + + Description +
+ This task takes one or more filenames and turns them into URLs, which it then assigns to a property. Useful when setting up RMI codebases. Nested filesets are supported; if present, these are turned into the url with the given separator between them (default = " ").

Example

 <makeurl file="${user.home}/.m2/repository" property="m2.repository.url" />
Sets the property m2.repository.url to the file: URL of the local Maven2 repository. 
 <makeurl property="codebase"> <fileset dir="lib includes="*.jar"/> </makeurl>
Set the property codebase to the three URLs of the files provided as nested elements. +
+ + + + + + + + + + + + +
 
+ + + Parameters +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Attribute + + Description + + Type + + Requirement +
+ file + + the name of a file to be converted into a URL + + File + + Optional +
+ property + + set the name of a property to fill with the URL + + String +
+ separator + + set the separator for the multi-url option. + + String +
+ validate + + set this flag to trigger validation that every named file exists. Optional: default=true + + boolean +
+
+ + + + + + + + + + +
 
+ + + Parameters as nested elements +
+ + + + + +
 
+ + fileset (org.apache.tools.ant.types.FileSet) +
+ a fileset of jar files to include in the URL, each separated by the separator + + + +
+ + + + + + +
 
+ + path (org.apache.tools.ant.types.Path) +
+ add a path to the URL. All elements in the path will be converted to individual URL entries + + + +
+ + +
+ + + +
+
+
+
+ Copyright © 2000-2005, Apache Software Foundation +
+
+ + + diff --git a/docs/manual/coretasklist.html b/docs/manual/coretasklist.html index e00bf34a2..56f703146 100644 --- a/docs/manual/coretasklist.html +++ b/docs/manual/coretasklist.html @@ -65,6 +65,7 @@ Libraries
LoadFile
LoadProperties
+MakeURL
Mail
MacroDef
Manifest
diff --git a/docs/manual/tasksoverview.html b/docs/manual/tasksoverview.html index a8c9d69fe..b52d8ed22 100644 --- a/docs/manual/tasksoverview.html +++ b/docs/manual/tasksoverview.html @@ -39,8 +39,9 @@ documentation.

+Archive Tasks + @@ -163,8 +164,8 @@ documentation.

-Archive Tasks [Back to top]
- +Audit/Coverage Tasks + @@ -212,8 +213,8 @@ documentation.

-Audit/Coverage Tasks [Back to top]
- +Compile Tasks + @@ -281,8 +282,8 @@ documentation.

-Compile Tasks [Back to top]
- +Deployment Tasks + @@ -305,8 +306,8 @@ documentation.

-Deployment Tasks [Back to top]
- +Documentation Tasks + @@ -335,8 +336,8 @@ documentation.

-Documentation Tasks [Back to top]
- +EJB Tasks + @@ -357,8 +358,8 @@ documentation.

-EJB Tasks [Back to top]
- +Execution Tasks + @@ -449,8 +450,8 @@ documentation.

-Execution Tasks [Back to top]
- +File Tasks + @@ -617,8 +618,8 @@ documentation.

-File Tasks [Back to top]
- +Java2 Extensions Tasks + @@ -671,8 +672,8 @@ documentation.

-Java2 Extensions Tasks [Back to top]
- +Logging Tasks + @@ -695,8 +696,8 @@ documentation.

-Logging Tasks [Back to top]
- +Mail Tasks + @@ -724,8 +725,8 @@ documentation.

-Mail Tasks [Back to top]
- +Miscellaneous Tasks + @@ -821,8 +822,8 @@ documentation.

-Miscellaneous Tasks [Back to top]
- +.NET Tasks + @@ -843,8 +844,8 @@ documentation.

-.NET Tasks [Back to top]
- +Pre-process Tasks + @@ -956,8 +957,8 @@ documentation.

-Pre-process Tasks [Back to top]
- +Property Tasks + @@ -1018,6 +1019,11 @@ documentation.

and it cannot be specified outside a target.

+ + + + +
-Property Tasks [Back to top]
MakeURL

Creates a URL (list) from a file/fileset or path

PathConvert

Converts a nested path, path reference, filelist reference, or @@ -1063,8 +1069,8 @@ documentation.

- +Remote Tasks + @@ -1115,8 +1121,8 @@ documentation.

-Remote Tasks [Back to top]
- +SCM Tasks + @@ -1211,8 +1217,8 @@ documentation.

-SCM Tasks [Back to top]
- +Testing Tasks + @@ -1249,8 +1255,8 @@ documentation.

-Testing Tasks [Back to top]
- +Visual Age for Java Tasks +
-Visual Age for Java Tasks [Back to top]