source: other-projects/trunk/realistic-books/packages/AntInstaller/web/manual/manual/OptionalTasks/splash.html@ 19253

Last change on this file since 19253 was 19253, checked in by davidb, 15 years ago

Establishing a source code repository for Veronica's Realistic Book's software

File size: 4.0 KB
Line 
1<!--
2 Licensed to the Apache Software Foundation (ASF) under one or more
3 contributor license agreements. See the NOTICE file distributed with
4 this work for additional information regarding copyright ownership.
5 The ASF licenses this file to You under the Apache License, Version 2.0
6 (the "License"); you may not use this file except in compliance with
7 the License. You may obtain a copy of the License at
8
9 http://www.apache.org/licenses/LICENSE-2.0
10
11 Unless required by applicable law or agreed to in writing, software
12 distributed under the License is distributed on an "AS IS" BASIS,
13 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 See the License for the specific language governing permissions and
15 limitations under the License.
16-->
17<html>
18
19<head>
20<meta http-equiv="Content-Language" content="en-us">
21<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
22<title>Ant User Manual</title>
23</head>
24
25<body>
26
27<h2><a name="Splash">Splash</a></h2>
28<p>by Les Hughes ([email protected])
29<h3>Description</h3>
30<p>This task creates a splash screen. The splash screen is displayed
31for the duration of the build and includes a handy progress bar as
32well. Use in conjunction with the sound task to provide interest
33whilst waiting for your builds to complete...</p>
34<h3>Parameters</h3>
35<table border="1" cellpadding="2" cellspacing="0">
36 <tr>
37 <td valign="top"><b>Attribute</b></td>
38 <td valign="top"><b>Description</b></td>
39 <td align="center" valign="top"><b>Required</b></td>
40 <td align="center" valign="top"><b>Default</b></td>
41 </tr>
42 <tr>
43 <td valign="top">imageurl</td>
44 <td valign="top">A URL pointing to an image to display.</td>
45 <td valign="top" align="center">No</td>
46 <td valign="top" align="center">antlogo.gif from the classpath</td>
47 </tr>
48
49 <tr>
50 <td valign="top">showduration</td>
51 <td valign="top">Initial period to pause the build to show the
52 splash in milliseconds.</td>
53 <td valign="top" align="center">No</td>
54 <td valign="top" align="center">5000 ms</td>
55 </tr>
56</table>
57<h3>Deprecated properties</h3>
58
59The following properties can be used to configure the proxy settings to retrieve
60an image from behind a firewall. However, the settings apply not just to this
61task, but to all following tasks. Therefore they are now mostly deprecated in
62preference to the <code>&lt;setproxy&gt;</code> task, that makes it clear to readers of
63the build exactly what is going on. We say mostly as this task's support
64includes proxy authentication, so you may still need to use its
65proxy attributes.
66
67<table border="1" cellpadding="2" cellspacing="0">
68 <tr>
69 <td valign="top">useproxy</td>
70 <td valign="top">Use a proxy to access imgurl. Note: Only tested
71 on JDK 1.2.2 and above</td>
72 <td valign="top" align="center">No</td>
73 <td valign="top" align="center">None</td>
74 </tr>
75 <tr>
76 <td valign="top">proxy</td>
77 <td valign="top">IP or hostname of the proxy server</td>
78 <td valign="top" align="center">No</td>
79 <td valign="top" align="center">None</td>
80 </tr>
81 <tr>
82 <td valign="top">port</td>
83 <td valign="top">Proxy portnumber</td>
84 <td valign="top" align="center">No</td>
85 <td valign="top" align="center">None</td>
86 </tr>
87 <tr>
88 <td valign="top">user</td>
89 <td valign="top">User to authenticate to the proxy as.</td>
90 <td valign="top" align="center">No</td>
91 <td valign="top" align="center">None</td>
92
93 </tr>
94 <tr>
95 <td valign="top">password</td>
96 <td valign="top">Proxy password</td>
97 <td valign="top" align="center">No</td>
98 <td valign="top" align="center">None</td>
99 </tr>
100
101</table>
102<h3>Examples</h3>
103<blockquote><pre>
104&lt;splash/&gt;
105</pre></blockquote>
106<p>Splash <code>images/ant_logo_large.gif</code> from the classpath.</p>
107<blockquote><pre>
108&lt;splash imageurl=&quot;http://jakarta.apache.org/images/jakarta-logo.gif&quot;
109 useproxy=&quot;true&quot;
110 showduration=&quot;5000&quot;/&gt;
111
112</pre></blockquote>
113<p>Splashes the jakarta logo, for
114an initial period of 5 seconds.</p>
115
116
117</body>
118</html>
119
Note: See TracBrowser for help on using the repository browser.