Documentation for splash task.

Submitted by: Les Hughes <leslie.hughes@rubus.com> git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@272159 13f79535-47bb-0310-9956-ffa450edef68
23 years ago · 61cbe76230
--- a/docs/manual/CoreTasks/uptodate.html
+++ b/docs/manual/CoreTasks/uptodate.html
@@ -116,7 +116,7 @@ if <code>/usr/local/bin/testit</code> is newer than
 </p>

 <hr>
 <p align="center">Copyright &copy; 2001,2002 Apache Software Foundation.
 <p align="center">Copyright &copy; 2001-2002 Apache Software Foundation.
 All rights Reserved.</p>

 </body>
--- a/docs/manual/OptionalTasks/splash.html
+++ b/docs/manual/OptionalTasks/splash.html
@@ -0,0 +1,95 @@
 <html>

 <head>
 <meta http-equiv="Content-Language" content="en-us">
 <title>Ant User Manual</title>
 </head>

 <body>

 <h2><a name="Splash">Splash</a></h2>
 <p>by Les Hughes (leslie.hughes@rubus.com)
 <h3>Description</h3>
 <p>This task creates a splash screen. The splash screen is displayed
 for the duration of the build and includes a handy progress bar as
 well. Use in conjunction with the sound task to provide interest
 whilst waiting for your builds to complete...</p>
 <h3>Parameters</h3>
 <table border="1" cellpadding="2" cellspacing="0">
  <tr>
    <td valign="top"><b>Attribute</b></td>
    <td valign="top"><b>Description</b></td>
    <td align="center" valign="top"><b>Required</b></td>
    <td align="center" valign="top"><b>Default</b></td>
  </tr>
  <tr>
    <td valign="top">imageurl</td>
    <td valign="top">A URL pointing to an image to display.</td>
    <td valign="top" align="center">No</td>
    <td valign="top" align="center">antlogo.gif from the classpath</td>
  </tr>
  <tr>
    <td valign="top">useproxy</td>
    <td valign="top">Use a proxy to access imgurl. Note: Only tested
    on JDK 1.2.2 and above</td>
    <td valign="top" align="center">No</td>
    <td valign="top" align="center">None</td>
  </tr>
  <tr>
    <td valign="top">proxy</td>
    <td valign="top">IP or hostname of the proxy server</td>
    <td valign="top" align="center">No</td>
    <td valign="top" align="center">None</td>
  </tr>
  <tr>
    <td valign="top">port</td>
    <td valign="top">Proxy portnumber</td>
    <td valign="top" align="center">No</td>
    <td valign="top" align="center">None</td>
  </tr>
  <tr>
    <td valign="top">user</td>
    <td valign="top">User to authenticate to the proxy as.</td>
    <td valign="top" align="center">No</td>
    <td valign="top" align="center">None</td>

  </tr>
  <tr>
    <td valign="top">password</td>
    <td valign="top">Proxy password</td>
    <td valign="top" align="center">No</td>
    <td valign="top" align="center">None</td>
  </tr>
  <tr>
    <td valign="top">showduration</td>
    <td valign="top">Initial period to pause the build to show the
    splash in milliseconds.</td>
    <td valign="top" align="center">No</td>
    <td valign="top" align="center">5000 ms</td>
  </tr>
 </table>
 <h3>Examples</h3>
 <blockquote><pre>
 &lt;splash/&gt;
 </pre></blockquote>
 <p>Splash <code>images/ant_logo_large.gif</code> from the classpath.</p>
 <blockquote><pre>
 &lt;splash imageurl=&quot;http://jakarta.apache.org/images/jakarta-logo.gif&quot;
           useproxy=&quot;true&quot;
           showduration=&quot;5000&quot;
           proxy=&quot;proxy.mydomain.com&quot;
           port=&quot;8080&quot;
           user=&quot;BuildEng&quot;
           password=&quot;LetMePass&quot;/>

 </pre></blockquote>
 <p>Splashes the jakarta logo, via a connection through the proxy at
 proxy.mydomain.com on port 8080 (as user BuildEng/LetMePass) for
 an initial period of 5 seconds.</p>
 <hr>
 <p align="center">Copyright &copy; 2002 Apache Software Foundation. All rights
 Reserved.</p>

 </body>
 </html>

--- a/docs/manual/optionaltasklist.html
+++ b/docs/manual/optionaltasklist.html
@@ -48,6 +48,7 @@
 <a href="OptionalTasks/script.html">Script</a><br>
 <a href="OptionalTasks/sound.html">Sound</a><br>
 <a href="OptionalTasks/sos.html">SourceOffSite</a><br>
 <a href="OptionalTasks/splash.html">Splash</a><br>
 <a href="OptionalTasks/starteam.html">Starteam Tasks</a><br>
 <a href="OptionalTasks/stylebook.html">Stylebook</a><br>
 <a href="OptionalTasks/telnet.html">Telnet</a><br>
--- a/docs/manual/tasksoverview.html
+++ b/docs/manual/tasksoverview.html
@@ -650,6 +650,11 @@ documentation.</p>
     the build failed or succeeded.</p></td>
  </tr>

  <tr valign="top">
    <td nowrap><a href="OptionalTasks/splash.html">Splash</a></td>
    <td><p>Displays a splash screen.</p></td>
  </tr>

  <tr valign="top">
    <td nowrap><a href="CoreTasks/sql.html">Sql</a></td>
    <td><p>Executes a series of SQL statements via JDBC to a database.