diff options
Diffstat (limited to 'framework/src/ant/apache-ant-1.9.6/manual/Tasks/splash.html')
| -rw-r--r-- | framework/src/ant/apache-ant-1.9.6/manual/Tasks/splash.html | 154 |
1 files changed, 154 insertions, 0 deletions
diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/splash.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/splash.html new file mode 100644 index 00000000..e158bd29 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/splash.html @@ -0,0 +1,154 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>Apache 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">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> + <tr> + <td valign="top">progressregexp</td> + <td valign="top">Progress regular expression which is used to + parse the output and dig out current progress. Exactly one group + pattern must exists, and it represents the progress number (0-100) + (i.e "Progress: (.*)%")<br/> + <em>since Apache Ant 1.8.0</em></td> + <td valign="top" align="center">No</td> + <td valign="top" align="center">progress is increased every action + and log output line</td> + </tr> + <tr> + <td valign="top">displaytext</td> + <td valign="top">display text presented in the splash window<br/> + <em>since Ant 1.8.0</em></td> + <td valign="top" align="center">No</td> + <td valign="top" align="center">Building ...</td> + </tr> +</table> +<h3>Deprecated properties</h3> + +The following properties can be used to configure the proxy settings to retrieve +an image from behind a firewall. However, the settings apply not just to this +task, but to all following tasks. Therefore they are now deprecated in +preference to the <code><setproxy></code> task, that makes it clear to readers of +the build exactly what is going on. + +<table border="1" cellpadding="2" cellspacing="0"> + <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> + +</table> +<h3>Examples</h3> +<blockquote><pre> +<splash/> +</pre></blockquote> +<p>Splash <code>images/ant_logo_large.gif</code> from the classpath.</p> +<blockquote><pre> +<splash imageurl="http://jakarta.apache.org/images/jakarta-logo.gif" + useproxy="true" + showduration="5000"/> + +</pre></blockquote> +<p>Splashes the jakarta logo, for an initial period of 5 seconds.</p> + +<p>Splash with controlled progress and nondefault text</p> +<blockquote><pre> + <target name="test_new_features"> + <echo>New features</echo> + <splash progressRegExp="Progress: (.*)%" showduration="0" displayText="Test text"/> + <sleep seconds="1"/> + <echo>Progress: 10%</echo> + <sleep seconds="1"/> + <echo>Progress: 20%</echo> + <sleep seconds="1"/> + <echo>Progress: 50%</echo> + <sleep seconds="1"/> + <echo>Progress: 70%</echo> + <sleep seconds="1"/> + <echo>Progress: 100%</echo> + <sleep seconds="3"/> + </target> +</pre></blockquote> + + + +</body> +</html> + |