[Ant-contrib-developers] CVS: ant-contrib/manual/tasks urlencode.html,NONE,1.1 toc.html,1.8,1.9

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 454-5900

Update of /cvsroot/ant-contrib/ant-contrib/manual/tasks
In directory sc8-pr-cvs1:/tmp/cvs-serv1946/manual/tasks

Modified Files:
	toc.html 
Added Files:
	urlencode.html 
Log Message:
Added the URLEncode task.


--- NEW FILE: urlencode.html ---
<!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">name</td>
        <td valign="top">The name of the property to set.</td>
        <td align="center" valign="top">Yes.</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 &quot;,&quot;.</td>
      </tr>
    </table>


    <h2>Example</h2>


    The following code

    <pre>
    <code>
    &lt;urlencode name="file.location" location="C:\\wwwhome\\my reports\\report.xml" /&gt;
    </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 &copy; 2002-2003 Ant-Contrib Project. All
    rights Reserved.</p>

  </body>
</html>

Index: toc.html
===================================================================
RCS file: /cvsroot/ant-contrib/ant-contrib/manual/tasks/toc.html,v
retrieving revision 1.8
retrieving revision 1.9
diff -C2 -d -r1.8 -r1.9
*** toc.html	2 May 2003 15:19:58 -0000	1.8
--- toc.html	16 May 2003 13:56:08 -0000	1.9
***************
*** 27,30 ****
--- 27,31 ----
        <li><a href="pathtofileset.html" target="mainFrame">Pathtofileset</a></li>
        <li><a href="propertyregex.html" target="mainFrame">PropertyRegex</a></li>
+       <li><a href="urlencode.html" target="mainFrame">URLEncode</a></li>
      </ul>
    </body>