source: other-projects/trunk/realistic-books/packages/AntInstaller/web/miniinstaller.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: 10.4 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3<head>
4 <title>Ant Installer</title>
5 <link href="style.css" type="text/css" rel="stylesheet">
6 <link href="css/nav.css" rel="stylesheet" type="text/css">
7 <link rel="SHORTCUT ICON" type="image/png" href="images/antinstaller-icon.png">
8 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
9 <meta name="keywords"
10 content="Ant, installer, AntInstall, gui, console, input, parameters, properties, swing, user interface, validation, configuration">
11 <script type="text/javascript" src="js/menu.js"></script>
12 <script type="text/javascript" src="js/sstree.js"></script>
13 <script type="text/javascript" src="js/winfix.js"></script>
14</head>
15<body onload="collapseAll('contents-panel', ['ol']); "><div id="tpallcontent">
16<table cellspacing="0" width="100%">
17 <tbody>
18 <tr class="tpheader">
19 <th class="tpleft">
20 <a target="_top" href="index.html" title="home"><img src="images/ant-install-small.png" alt="AntInstaller" id="logo" width="76" height="50"/></a>
21 <script type="text/javascript">winFix();</script>
22 </th>
23 <th class="tptop" valign="bottom">
24 <img src="space.gif" height="1" width="440" alt="spacer"/><br/>
25
26 <table>
27 <tr>
28 <td valign="top">
29 <div class="tpheadertitle">AntInstaller</div>
30 <!--img src="images/ant-install-title.png" alt="AntInstaller"/-->
31 </td>
32 <td width="100%" align="right" valign="bottom" nowrap="NOWRAP">
33 <div class="tpraised">
34 <a class="tpbutton" target="_top" href="index.html">home</a>
35 <a class="tpbutton" target="_top" href="http://sourceforge.net/project/showfiles.php?group_id=123466&amp;package_id=134917">download</a>
36 <a class="tpbutton" target="_top" href="http://sf.net">sourceforge</a>
37 <a class="tpbutton" target="_top" href="manual-ant.html">antmanual</a>
38 <a class="tpbutton" target="_top" href="http://sourceforge.net/tracker/?group_id=123466&amp;atid=696615">RFEs</a>
39 <a class="tpbutton" target="_top" href="http://sourceforge.net/tracker/?group_id=123466&amp;atid=696612">Bugs</a></div>
40 </td>
41 </tr>
42 </table>
43 </th>
44 </tr>
45 <tr class="tpbody">
46 <td class="tpleft" valign="bottom">
47 <br/>
48 <div id="logoset">
49 <a target="_top" href="http://sourceforge.net"><img src="http://sourceforge.net/sflogo.php?group_id=123466&amp;type=2" alt="SourceForge.net Logo" border="0" height="37" width="125"></a>
50 <br/><br/>
51 <a target="_top" href="http://sourceforge.net/donate/index.php?group_id=123466">
52 <img src="http://sourceforge.net/images/project-support.jpg" alt="donate to AntInstaller"/>
53 </a>
54 </div>
55 </td>
56 <td class="tpright" valign="top">
57 <div class="tpcontent">
58 <!--[segment-content] page content start -->
59 <h2>MiniInstaller</h2>
60The mini installer is the selfextracting jar component of AntInstaller with a few modifications<br/>
61
62 It simply extracts all the files in the Jar to a user selected directory.
63 It works on the command line or with a GUI if possible.<br/>
64 It is available as a separate download.
65
66<h3>Usage</h3>
67Simply place <code>org.tp23.mini.MiniInstaller.class</code> and
68 <code>org.tp23.mini.ProgressIndicator.class</code>
69 in the Jar and add a <code>/META-INF/MANIFEST.mf</code>
70 with the Main-Class attribute set to <code>org.tp23.mini.MiniInstaller</code>.
71 <br/>
72 If the manifest includes an attribute <code>Overwrite-Files</code> with any value
73 the installer will overwrite existing files.<br/><br/>
74
75 <h3>LookAndFeel</h3>
76 If the manifest can include an attribute <code>Look-And-Feel</code> with a value
77 that specifies a look and feel on the claspath that look and feel will be used.<br/>
78 As with AntInstaller a modified verison of the JGoodies look and feel is included.
79 This is cut down to 150K (after compression) since only the file chooser and
80 JOptionPane are used.
81 If it is still too much just don't include the package <code>org.tp23.jgoodies</code> in the installer
82 and the default LookAndFeel will be used.
83 <br/><br/>
84
85 <h3>Extending MiniInstaller</h3>
86 <p>A Hook class can be implemented in the default package that must implement
87 this imaginary interface.
88 <pre>
89interface Hook{
90 public int exec(MiniInstaller installer, boolean graphicsEnv);
91}
92<pre>
93 The interface is <i>imaginary</i> since it does not exist and is not required on the classpath
94 .Reflection is used to find the method.
95 The Hook should never throw exceptions. <br/>
96 <code>MiniInstaller.isGraphicsEnv()</code> can be used to determine if there is a graphics environment.<br/>
97 <code>MiniInstaller.printXorTextWarning(String)</code> can be used to print a message.<br/>
98 <code>MiniInstaller.getArchiveFile()</code> returns a file handle on the Jar being extracted.<br/>
99 All classes in the package <code>org.tp23</code> including ProgressIndicator,MiniInstaller,Hook and the image
100 resources/extract-image.png are not extracted.<br/><br/>
101
102 If you add other classes to Help your Hook class they should be added to the
103 package <code>org.skip</code> and they will not be extracted.
104
105
106 <!-- content end [segment-end]-->
107 </div>
108 </td>
109 </tr>
110 </tbody>
111</table>
112<div id="contents-panel">
113<!--[segment-file://contents-include.html] menu start -->
114<div id="contents-menu">
115<ol class="sidebar" id="root">
116 <li class="panel"><a href="#default" class="folder" onclick="toggle(this)"></a><b>Site map</b>
117 <ol>
118 <li class="sidebar"><a href="introduction.html">Introduction</a></li>
119 <li class="panel"><a href="#default" class="folder" onclick="toggle(this)"></a><b>Developer References</b>
120 <ol>
121 <li class="sidebar"><a href="quickstart.html">Quick Start</a></li>
122 <li class="panel"><a href="#default" class="folder" onclick="toggle(this)"></a><a href="manual.html">Manual</a>
123 <ol class="init-hidden">
124 <li class="sidebar"><a href="manual.html#config">antinstall-config.xml</a></li>
125 <li class="panel"><a href="#default" class="folder" onclick="toggle(this)"></a><a href="manual.html#page">Pages</a>
126 <ol class="init-hidden">
127 <li class="sidebar"><a href="manual.html#pagesplash">Splash Page</a></li>
128 <li class="sidebar"><a href="manual.html#pagetext">Text Page</a></li>
129 <li class="sidebar"><a href="manual.html#pagelicense">License Page</a></li>
130 <li class="sidebar"><a href="manual.html#pageinput">Input Page</a></li>
131 <li class="sidebar"><a href="manual.html#pageprogress">Progress Page</a></li>
132 </ol>
133 </li>
134 <li class="panel"><a href="#default" class="folder" onclick="toggle(this)"></a><a href="manual.html#inputtypes">Input types</a>
135 <ol class="init-hidden">
136 <li class="sidebar"><a href="manual.html#app-root">Application Root</a></li>
137 <li class="sidebar"><a href="manual.html#checkbox">Checkbox</a></li>
138 <li class="sidebar"><a href="manual.html#comment">Comment</a></li>
139 <li class="sidebar"><a href="manual.html#date">Date</a></li>
140 <li class="sidebar"><a href="manual.html#directory">Directory</a></li>
141 <li class="sidebar"><a href="manual.html#file">File</a></li>
142 <li class="sidebar"><a href="manual.html#large-select">Large Select</a></li>
143 <li class="sidebar"><a href="manual.html#password">Password Text</a></li>
144 <li class="sidebar"><a href="manual.html#password-confirm">Confirm Password</a></li>
145 <li class="sidebar"><a href="manual.html#select">Select</a></li>
146 <li class="sidebar"><a href="manual.html#target">Target</a></li>
147 <li class="sidebar"><a href="manual.html#target-select">Target Select</a></li>
148 <li class="sidebar"><a href="manual.html#text">Unvalidated Text</a></li>
149 <li class="sidebar"><a href="manual.html#validated">Validated Text</a></li>
150 <li class="sidebar"><a href="manual.html#extvalidated">Externally Validated Text</a></li>
151 </ol>
152 </li>
153 <li class="sidebar"><a href="manual.html#extractor">Self Extractor</a></li>
154 <li class="sidebar"><a href="manual.html#non-extractor">Non Extractor</a></li>
155 <li class="sidebar"><a href="manual.html#scripts">Start Scripts</a></li>
156 <li class="sidebar"><a href="manual.html#refs">Dynamic References</a></li>
157 <li class="sidebar"><a href="manual.html#pagedisplay">Page Displaying</a></li>
158 </ol>
159 </li>
160 <li class="sidebar"><a href="installertask.html">Installer Ant task</a></li>
161 <li class="sidebar"><a href="validationofconfig.html">Validation of config</a></li>
162 <li class="sidebar"><a href="lookandfeels.html">LookAndFeels</a> <br/>(inc screenshots)</li>
163 <li class="sidebar"><a href="classpathresources.html">Resources/Classpath issues</a></li>
164 <li class="sidebar"><a href="i18n.html">Internationalisation</a></li>
165 <li class="sidebar"><a href="auto.html">Automated installs</a></li>
166 <li class="sidebar"><a href="installtypes.html">Multiple install types</a></li>
167 <li class="sidebar"><a href="posttargets.html">Post display targets</a></li>
168 <li class="sidebar"><a href="icons.html">Button Icons</a></li>
169 <li class="sidebar"><a href="antinstall-config-example.html">Example antinstall-config.xml</a></li>
170 </ol>
171 </li>
172 <li class="sidebar"><a href="manual-ant.html">Ant Manual</a></li>
173 <li class="sidebar"><a href="antlinks.html">Ant links</a></li>
174 <li class="sidebar"><a href="userusage.html">User usage</a></li>
175 <li class="sidebar"><a href="licenses.html">Licenses</a></li>
176 <li class="sidebar"><a href="potentialuses.html">Potential uses</a></li>
177 <li class="sidebar"><a href="roadmap.html">Road Map</a></li>
178 <li class="sidebar"><a href="wanted.html">Wanted</a></li>
179 <li class="sidebar"><a href="dtds.html">DTDs</a></li>
180 <li class="sidebar"><a href="changelog.html">Changelog</a></li>
181 <li class="sidebar"><a href="http://sourceforge.net/projects/antinstaller">Project page on SourceForge</a></li>
182 <li class="sidebar"><a href="java2html/antinstaller/index.html">Java2HTML (main)</a></li>
183 <li class="sidebar"><a href="java2html/ext/index.html">Java2HTML (extensions)</a></li>
184 <li class="sidebar"><a href="http://antinstaller.cvs.sourceforge.net/antinstaller">Public CVS over HTTP</a></li>
185 <li class="sidebar"><a href="http://sourceforge.net/sendmessage.php?touser=616485">Contact AntInstaller Admin</a></li>
186 </ol>
187 </li>
188</ol>
189<br/>
190<br/>
191</div>
192
193
194<!-- menu end [segment-end]-->
195</div>
196<div id="contents-options">
197<a id="toggle" href="#" onclick="toggleMenu(); return false;">show menu</a>
198</div>
199
200</div>
201</body>
202</html>
Note: See TracBrowser for help on using the repository browser.