diff options
Diffstat (limited to 'docs/manual/tasks/urlencode.html')
-rw-r--r-- | docs/manual/tasks/urlencode.html | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/docs/manual/tasks/urlencode.html b/docs/manual/tasks/urlencode.html new file mode 100644 index 0000000..be6a322 --- /dev/null +++ b/docs/manual/tasks/urlencode.html @@ -0,0 +1,78 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <title>Ant-contrib Tasks: URLEncode</title> + </head> + + <body> + <h1>Foreach</h1> + + <p>The URLEncode task will encode a given property for use within a + a URL string. This value which is actually set will be encoded + via the <code>java.net.URLEncoder.encode()</code> method. + Typically, you must do this for all parameter values within a URL.</p> + + <h2>Parameters</h2> + <table border="1" cellpadding="2" cellspacing="0"> + <tr> + <th>Attribute</th> + <th>Description</th> + <th>Required</th> + </tr> + <tr> + <td valign="top">property</td> + <td valign="top">The name of the property to set.</td> + <td align="center" valign="top">Yes.</td> + </tr> + <tr> + <td valign="top">override</td> + <td valign="top">If the property is already set, should we change it's value. + Can be <code>true</code> or <code>false</code></td> + <td align="center" valign="top">No. Defaults to <code>false</code></td> + </tr> + <tr> + <td valign="top">name <i>Deprecated</i></td> + <td valign="top">The name of the property to set.</td> + <td align="center" valign="top">No. Use the <code>property</code> attribute + instead</td> + </tr> + <tr> + <td valign="top">value</td> + <td valign="top">The value of the property.</td> + <td align="center" valign="top">No, if refid or location is specified</td> + </tr> + <tr> + <td valign="top">location</td> + <td valign="top">The location of a file whose absolute path will be the value + of the property.</td> + <td align="center" valign="top">No, if value or refid is specified.</td> + </tr> + <tr> + <td valign="top">refid</td> + <td valign="top">The id of a saved reference whose value will be the value + of the property.</td> + <td align="center" valign="top">No, defaults to ",".</td> + </tr> + </table> + + + <h2>Example</h2> + + + The following code + + <pre> + <code> + <urlencode name="file.location" location="C:\\wwwhome\\my reports\\report.xml" /> + </code> + </pre> + + would set the "file.location" property to the value: <code> C%3A%5Cwwwhome%5Cmy+reports%5Creport.xml</code> + which could then be used in a URL. + + <hr> + <p align="center">Copyright © 2002-2003 Ant-Contrib Project. All + rights Reserved.</p> + + </body> +</html> |