/[debian]/libjpf-java/trunk/jdocs/tools.jxp
ViewVC logotype

Contents of /libjpf-java/trunk/jdocs/tools.jxp

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1601 - (show annotations)
Sat Feb 28 23:28:19 2009 UTC (12 years, 5 months ago) by gregoa
File size: 34433 byte(s)
[svn-inject] Forking libjpf-java source to Trunk
1 <%
2 // Java Plug-in Framework (JPF)
3 // Copyright (C) 2004 - 2007 Dmitry Olshansky
4 // $Id: tools.jxp,v 1.5 2007/04/30 11:51:25 ddimon Exp $
5 %>
6 <%
7 include("/functions.ijxp");
8
9 printHeader("Tools");
10 printMenu("tools");
11 %>
12 <div class="content">
13 <h1>JPF Tools Reference</h1>
14 <p>
15 Most JPF tools are implemented as special purpose Java classes and wrapped as Ant tasks for ease of use. To make JPF specific tasks available in your build file insert following declaration in the beginning of Ant build script:<br />
16 <code>&lt;typedef resource="org/java/plugin/tools/ant/jpf-tasks.properties" /&gt;</code><br />
17 Note that jpf-tool.jar library should be available in classpath (you may use nested <code>&lt;classpath&gt;</code> element in <code>&lt;typedef&gt;</code> tag).
18 </p>
19 <p>
20 <a href="#integrityChecking">Integrity Check Tool</a><br />
21 <a href="#pluginDocumenting">Documentation Tool</a><br />
22 <a href="#pluginArchiving">Plug-in Archive Tool</a><br />
23 <a href="#singleFilePlugin">Single File Plug-in Tool</a><br />
24 <a href="#manifestInfo">Manifest Info Tool</a><br />
25 <a href="#versionUpdate">Version Update Tool</a><br />
26 <a href="#path">Classpath Tool</a><br />
27 <a href="#sort">Sorting Tool</a><br />
28 </p>
29
30 <h3><a name="integrityChecking">Integrity Check Tool</a></h3>
31 <p>
32 The tool is implemented as Ant task (<strong>jpf-check</strong>) and allows to check integrity of plug-ins collection.
33 </p>
34 <table border="1" cellspacing="0" cellpadding="5">
35 <tr>
36 <th valign="top">Attribute</th>
37 <th valign="top">Description</th>
38 <th valign="top">Required</th>
39 </tr>
40 <tr>
41 <td valign="top">basedir</td>
42 <td valign="top">Directory to resolve relative links. By default is equal to project base directory <code>${basedir}</code>.</td>
43 <td valign="top">No</td>
44 </tr>
45 <tr>
46 <td valign="top">verbose</td>
47 <td valign="top">If "true", more detailed report will be generated. Default is "false".</td>
48 <td valign="top">No</td>
49 </tr>
50 <tr>
51 <td valign="top">includes</td>
52 <td valign="top">comma- or space-separated list of patterns of plug-in manifest files that must be included. All files are included when omitted.</td>
53 <td valign="top">No</td>
54 </tr>
55 <tr>
56 <td valign="top">includesfile</td>
57 <td valign="top">The name of a file. Each line of this file is taken to be an include pattern.</td>
58 <td valign="top">No</td>
59 </tr>
60 <tr>
61 <td valign="top">excludes</td>
62 <td valign="top">Comma- or space-separated list of patterns of plug-in manifest files that must be excluded. No files (except default excludes) are excluded when omitted.</td>
63 <td valign="top">No</td>
64 </tr>
65 <tr>
66 <td valign="top">excludesfile</td>
67 <td valign="top">The name of a file. Each line of this file is taken to be an exclude pattern.</td>
68 <td valign="top">No</td>
69 </tr>
70 <tr>
71 <td valign="top">defaultexcludes</td>
72 <td valign="top">Indicates whether default excludes should be used or not (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>
73 <td valign="top">No</td>
74 </tr>
75 <tr>
76 <td valign="top">whitelist</td>
77 <td valign="top">The name of a file. Each line of this file is taken to be an ID or UID of plug-in to be included in processing. All plug-ins are included when file omitted.</td>
78 <td valign="top">No</td>
79 </tr>
80 <tr>
81 <td valign="top">blacklist</td>
82 <td valign="top">The name of a file. Each line of this file is taken to be an ID or UID of plug-in to be excluded from processing. No plug-ins are excluded when file omitted.</td>
83 <td valign="top">No</td>
84 </tr>
85 <tr>
86 <td valign="top">usepathresolver</td>
87 <td valign="top">If "true", JPF will try to resolve URL's specified in manifests to check existence of plug-in resources. Default is "false".</td>
88 <td valign="top">No</td>
89 </tr>
90 </table>
91 <h5>Parameters specified as nested elements</h5>
92 <dl>
93 <dt>fileset</dt>
94 <dd>Ant's FileSets can be used to select plug-in manifest files for plug-ins to be checked.</dd>
95 </dl>
96 <h5>Example</h5>
97 <pre>&lt;!-- Define custom JPF specific Ant tasks --&gt;
98 &lt;typedef resource="org/java/plugin/tools/ant/jpf-tasks.properties" /&gt;
99 &lt;!-- Call "jpf-check" task to check plug-ins integrity --&gt;
100 &lt;jpf-check
101 basedir="${basedir}/plugins"
102 includes="*/plugin.xml,*/plugin-fragment.xml"
103 verbose="true"
104 usepathresolver="true"/&gt;</pre>
105
106 <h3><a name="pluginDocumenting">Documentation Tool</a></h3>
107 <p>The javadoc-like tool to generate documentation for plug-ins. The tool implemented as special <a href="api/org/java/plugin/tools/docgen/DocGenerator.html">utility class</a> and wrapped with Ant task (<strong>jpf-doc</strong>) for ease of use.</p>
108 <p><strong>Note:</strong> documentation design looks not very good now, but this is just design problem, not the documentation engine! Good HTML design contributions are <a href="http://sourceforge.net/forum/forum.php?forum_id=378299">welcome</a>!</p>
109 <table border="1" cellspacing="0" cellpadding="5">
110 <tr>
111 <th valign="top">Attribute</th>
112 <th valign="top">Description</th>
113 <th valign="top">Required</th>
114 </tr>
115 <tr>
116 <td valign="top">basedir</td>
117 <td valign="top">Directory to resolve relative links. By default is equal to project base directory <code>${basedir}</code>.</td>
118 <td valign="top">No</td>
119 </tr>
120 <tr>
121 <td valign="top">verbose</td>
122 <td valign="top">If "true", more detailed report will be generated. Default is "false".</td>
123 <td valign="top">No</td>
124 </tr>
125 <tr>
126 <td valign="top">includes</td>
127 <td valign="top">comma- or space-separated list of patterns of plug-in manifest files that must be included. All files are included when omitted.</td>
128 <td valign="top">No</td>
129 </tr>
130 <tr>
131 <td valign="top">includesfile</td>
132 <td valign="top">The name of a file. Each line of this file is taken to be an include pattern.</td>
133 <td valign="top">No</td>
134 </tr>
135 <tr>
136 <td valign="top">excludes</td>
137 <td valign="top">Comma- or space-separated list of patterns of plug-in manifest files that must be excluded. No files (except default excludes) are excluded when omitted.</td>
138 <td valign="top">No</td>
139 </tr>
140 <tr>
141 <td valign="top">excludesfile</td>
142 <td valign="top">The name of a file. Each line of this file is taken to be an exclude pattern.</td>
143 <td valign="top">No</td>
144 </tr>
145 <tr>
146 <td valign="top">defaultexcludes</td>
147 <td valign="top">Indicates whether default excludes should be used or not (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>
148 <td valign="top">No</td>
149 </tr>
150 <tr>
151 <td valign="top">whitelist</td>
152 <td valign="top">The name of a file. Each line of this file is taken to be an ID or UID of plug-in to be included in processing. All plug-ins are included when file omitted.</td>
153 <td valign="top">No</td>
154 </tr>
155 <tr>
156 <td valign="top">blacklist</td>
157 <td valign="top">The name of a file. Each line of this file is taken to be an ID or UID of plug-in to be excluded from processing. No plug-ins are excluded when file omitted.</td>
158 <td valign="top">No</td>
159 </tr>
160 <tr>
161 <td valign="top">destdir</td>
162 <td valign="top">Base directory for generated documentation files.</td>
163 <td valign="top">Yes</td>
164 </tr>
165 <tr>
166 <td valign="top">overview</td>
167 <td valign="top">Documentation overview HTML file.</td>
168 <td valign="top">No</td>
169 </tr>
170 <tr>
171 <td valign="top">encoding</td>
172 <td valign="top">Source files encoding name (templates, overview etc.) Default is system encoding.</td>
173 <td valign="top">No</td>
174 </tr>
175 <tr>
176 <td valign="top">docencoding</td>
177 <td valign="top">Output files encoding name. Default is UTF-8.</td>
178 <td valign="top">No</td>
179 </tr>
180 <tr>
181 <td valign="top">stylesheetfile</td>
182 <td valign="top">CSS style sheet to use. Predefined style will be used if no file specified.</td>
183 <td valign="top">No</td>
184 </tr>
185 <tr>
186 <td valign="top">templates</td>
187 <td valign="top">path to template files (should be available in classpath). Predefined templates set will be used if not specified.</td>
188 <td valign="top">No</td>
189 </tr>
190 </table>
191 <h5>Parameters specified as nested elements</h5>
192 <dl>
193 <dt>fileset</dt>
194 <dd>Ant's FileSets can be used to select plug-in manifest files, documentation should be generated for.</dd>
195 </dl>
196 <h5>Example</h5>
197 <pre>&lt;!-- Define custom JPF specific Ant tasks --&gt;
198 &lt;typedef resource="org/java/plugin/tools/ant/jpf-tasks.properties" /&gt;
199 &lt;!-- Call "jpf-doc" task to generate plug-ins documentation --&gt;
200 &lt;jpf-doc
201 basedir="${basedir}/plugins"
202 includes="*/plugin.xml,*/plugin-fragment.xml"
203 destdir="${build.home}/docs"/&gt;</pre>
204
205 <h3><a name="pluginArchiving">Plug-in Archive Tool</a></h3>
206 <p>Tool implemented as special <a href="api/org/java/plugin/tools/configuration/PluginArchiver.html">utility class</a> and wrapped with Ant tasks (<strong>jpf-pack</strong> and <strong>jpf-unpack</strong>) for ease of use. Plug-in archive is specially prepared ZIP format file that holds all packed plug-ins and special descriptor for quick extracting plug-ins meta-data without need of unpacking the whole archive file.</p>
207 <h5>Plug-ins archiving task (jpf-pack).</h5>
208 <table border="1" cellspacing="0" cellpadding="5">
209 <tr>
210 <th valign="top">Attribute</th>
211 <th valign="top">Description</th>
212 <th valign="top">Required</th>
213 </tr>
214 <tr>
215 <td valign="top">basedir</td>
216 <td valign="top">Directory to resolve relative links. By default is equal to project base directory <code>${basedir}</code>.</td>
217 <td valign="top">No</td>
218 </tr>
219 <tr>
220 <td valign="top">verbose</td>
221 <td valign="top">If "true", more detailed report will be generated. Default is "false".</td>
222 <td valign="top">No</td>
223 </tr>
224 <tr>
225 <td valign="top">includes</td>
226 <td valign="top">comma- or space-separated list of patterns of plug-in manifest files that must be included. All files are included when omitted.</td>
227 <td valign="top">No</td>
228 </tr>
229 <tr>
230 <td valign="top">includesfile</td>
231 <td valign="top">The name of a file. Each line of this file is taken to be an include pattern.</td>
232 <td valign="top">No</td>
233 </tr>
234 <tr>
235 <td valign="top">excludes</td>
236 <td valign="top">Comma- or space-separated list of patterns of plug-in manifest files that must be excluded. No files (except default excludes) are excluded when omitted.</td>
237 <td valign="top">No</td>
238 </tr>
239 <tr>
240 <td valign="top">excludesfile</td>
241 <td valign="top">The name of a file. Each line of this file is taken to be an exclude pattern.</td>
242 <td valign="top">No</td>
243 </tr>
244 <tr>
245 <td valign="top">defaultexcludes</td>
246 <td valign="top">Indicates whether default excludes should be used or not (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>
247 <td valign="top">No</td>
248 </tr>
249 <tr>
250 <td valign="top">whitelist</td>
251 <td valign="top">The name of a file. Each line of this file is taken to be an ID or UID of plug-in to be included in processing. All plug-ins are included when file omitted.</td>
252 <td valign="top">No</td>
253 </tr>
254 <tr>
255 <td valign="top">blacklist</td>
256 <td valign="top">The name of a file. Each line of this file is taken to be an ID or UID of plug-in to be excluded from processing. No plug-ins are excluded when file omitted.</td>
257 <td valign="top">No</td>
258 </tr>
259 <tr>
260 <td valign="top">destfile</td>
261 <td valign="top">Target archive file.</td>
262 <td valign="top">Yes</td>
263 </tr>
264 </table>
265 <h5>Plug-ins un-archiving task (jpf-unpack).</h5>
266 <table border="1" cellspacing="0" cellpadding="5">
267 <tr>
268 <th valign="top">Attribute</th>
269 <th valign="top">Description</th>
270 <th valign="top">Required</th>
271 </tr>
272 <tr>
273 <td valign="top">basedir</td>
274 <td valign="top">Directory to resolve relative links. By default is equal to project base directory <code>${basedir}</code>.</td>
275 <td valign="top">No</td>
276 </tr>
277 <tr>
278 <td valign="top">verbose</td>
279 <td valign="top">If "true", more detailed report will be generated. Default is "false".</td>
280 <td valign="top">No</td>
281 </tr>
282 <tr>
283 <td valign="top">includes</td>
284 <td valign="top">comma- or space-separated list of patterns of plug-in manifest files that must be included. All files are included when omitted.</td>
285 <td valign="top">No</td>
286 </tr>
287 <tr>
288 <td valign="top">includesfile</td>
289 <td valign="top">The name of a file. Each line of this file is taken to be an include pattern.</td>
290 <td valign="top">No</td>
291 </tr>
292 <tr>
293 <td valign="top">excludes</td>
294 <td valign="top">Comma- or space-separated list of patterns of plug-in manifest files that must be excluded. No files (except default excludes) are excluded when omitted.</td>
295 <td valign="top">No</td>
296 </tr>
297 <tr>
298 <td valign="top">excludesfile</td>
299 <td valign="top">The name of a file. Each line of this file is taken to be an exclude pattern.</td>
300 <td valign="top">No</td>
301 </tr>
302 <tr>
303 <td valign="top">defaultexcludes</td>
304 <td valign="top">Indicates whether default excludes should be used or not (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>
305 <td valign="top">No</td>
306 </tr>
307 <tr>
308 <td valign="top">whitelist</td>
309 <td valign="top">The name of a file. Each line of this file is taken to be an ID or UID of plug-in to be included in processing. All plug-ins are included when file omitted.</td>
310 <td valign="top">No</td>
311 </tr>
312 <tr>
313 <td valign="top">blacklist</td>
314 <td valign="top">The name of a file. Each line of this file is taken to be an ID or UID of plug-in to be excluded from processing. No plug-ins are excluded when file omitted.</td>
315 <td valign="top">No</td>
316 </tr>
317 <tr>
318 <td valign="top">srcfile</td>
319 <td valign="top">Archive file to be unpacked.</td>
320 <td valign="top">Yes</td>
321 </tr>
322 <tr>
323 <td valign="top">destdir</td>
324 <td valign="top">Folder where to extract archived plug-ins.</td>
325 <td valign="top">Yes</td>
326 </tr>
327 </table>
328 <h5>Parameters specified as nested elements</h5>
329 <dl>
330 <dt>fileset</dt>
331 <dd>Ant's FileSets can be used to select plug-in manifest files, documentation should be generated for.</dd>
332 </dl>
333 <h5>Example</h5>
334 <pre>&lt;!-- Define custom JPF specific Ant tasks --&gt;
335 &lt;typedef resource="org/java/plugin/tools/ant/jpf-tasks.properties" /&gt;
336 &lt;!-- Call "jpf-pack" task to pack plug-ins into archive --&gt;
337 &lt;jpf-pack
338 basedir="${basedir}/plugins"
339 includes="*/plugin.xml,*/plugin-fragment.xml"
340 destfile="${build.home}/all-plugins.zip"/&gt;
341 &lt;!-- Call "jpf-unpack" task to extract plug-ins from archive --&gt;
342 &lt;jpf-unpack
343 srcfile="${build.home}/all-plugins.zip"
344 destdir="${build.home}/all-plugins-extracted"/&gt;</pre>
345
346 <h3><a name="singleFilePlugin">Single File Plug-in Tool</a></h3>
347 <p>
348 The tool is implemented as Ant task (<strong>jpf-zip</strong>) and allows to process plug-ins collection packaging every plug-in and plug-in fragment into single ZIP file. ZIP file names compozed according to the following scheme: <code>&lt;plugin-ID&gt;-&lt;plugin-version&gt;.zip</code>
349 </p>
350 <table border="1" cellspacing="0" cellpadding="5">
351 <tr>
352 <th valign="top">Attribute</th>
353 <th valign="top">Description</th>
354 <th valign="top">Required</th>
355 </tr>
356 <tr>
357 <td valign="top">basedir</td>
358 <td valign="top">Directory to resolve relative links. By default is equal to project base directory <code>${basedir}</code>.</td>
359 <td valign="top">No</td>
360 </tr>
361 <tr>
362 <td valign="top">destdir</td>
363 <td valign="top">Directory to store generated ZIP files.</td>
364 <td valign="top">Yes</td>
365 </tr>
366 <tr>
367 <td valign="top">verbose</td>
368 <td valign="top">If "true", more detailed report will be generated. Default is "false".</td>
369 <td valign="top">No</td>
370 </tr>
371 <tr>
372 <td valign="top">includes</td>
373 <td valign="top">comma- or space-separated list of patterns of plug-in manifest files that must be included. All files are included when omitted.</td>
374 <td valign="top">No</td>
375 </tr>
376 <tr>
377 <td valign="top">includesfile</td>
378 <td valign="top">The name of a file. Each line of this file is taken to be an include pattern.</td>
379 <td valign="top">No</td>
380 </tr>
381 <tr>
382 <td valign="top">excludes</td>
383 <td valign="top">Comma- or space-separated list of patterns of plug-in manifest files that must be excluded. No files (except default excludes) are excluded when omitted.</td>
384 <td valign="top">No</td>
385 </tr>
386 <tr>
387 <td valign="top">excludesfile</td>
388 <td valign="top">The name of a file. Each line of this file is taken to be an exclude pattern.</td>
389 <td valign="top">No</td>
390 </tr>
391 <tr>
392 <td valign="top">defaultexcludes</td>
393 <td valign="top">Indicates whether default excludes should be used or not (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>
394 <td valign="top">No</td>
395 </tr>
396 <tr>
397 <td valign="top">whitelist</td>
398 <td valign="top">The name of a file. Each line of this file is taken to be an ID or UID of plug-in to be included in processing. All plug-ins are included when file omitted.</td>
399 <td valign="top">No</td>
400 </tr>
401 <tr>
402 <td valign="top">blacklist</td>
403 <td valign="top">The name of a file. Each line of this file is taken to be an ID or UID of plug-in to be excluded from processing. No plug-ins are excluded when file omitted.</td>
404 <td valign="top">No</td>
405 </tr>
406 <tr>
407 <td valign="top">usepathresolver</td>
408 <td valign="top">If "true", JPF will try to resolve URL's specified in manifests to check existence of plug-in resources. Default is "false".</td>
409 <td valign="top">No</td>
410 </tr>
411 </table>
412 <h5>Parameters specified as nested elements</h5>
413 <dl>
414 <dt>fileset</dt>
415 <dd>Ant's FileSets can be used to select plug-in manifest files for plug-ins to be processed.</dd>
416 </dl>
417 <h5>Example</h5>
418 <pre>&lt;!-- Define custom JPF specific Ant tasks --&gt;
419 &lt;typedef resource="org/java/plugin/tools/ant/jpf-tasks.properties" /&gt;
420 &lt;!-- Call "jpf-zip" task to process plug-ins packaging every plug-in as
421 single ZIP file --&gt;
422 &lt;jpf-zip
423 basedir="${build.home}/plugins"
424 includes="*/*.xml"
425 destdir="${build.home}/plugins"/&gt;</pre>
426
427 <h3><a name="manifestInfo">Manifest Info Tool</a></h3>
428 <p>Simple (but quite useful :) task (<strong>jpf-info</strong>) to read some data from plug-in manifest into project properties. This task is modeled after similar purpose <a href="api/org/java/plugin/registry/PluginRegistry.html#readManifestInfo(java.net.URL)">method in plug-in resgistry</a> and covers the same properties as corresponding <a href="api/org/java/plugin/registry/PluginRegistry.ManifestInfo.html">manifest info interface</a></p>
429 <table border="1" cellspacing="0" cellpadding="5">
430 <tr>
431 <th valign="top">Attribute</th>
432 <th valign="top">Description</th>
433 <th valign="top">Required</th>
434 </tr>
435 <tr>
436 <td valign="top">manifest</td>
437 <td valign="top">Plug-in or plug-in fragment file to read data from.</td>
438 <td valign="top">Yes</td>
439 </tr>
440 <tr>
441 <td valign="top">propertyid</td>
442 <td valign="top">Name of the property where to put plug-in or plug-in fragment ID.</td>
443 <td valign="top">No</td>
444 </tr>
445 <tr>
446 <td valign="top">propertyversion</td>
447 <td valign="top">Name of the property where to put plug-in or plug-in fragment version. If no version specified in manifest, the empty string will be used.</td>
448 <td valign="top">No</td>
449 </tr>
450 <tr>
451 <td valign="top">propertyvendor</td>
452 <td valign="top">Name of the property where to put plug-in or plug-in fragment vendor.</td>
453 <td valign="top">No</td>
454 </tr>
455 <tr>
456 <td valign="top">propertypluginid</td>
457 <td valign="top">Name of the property where to put plug-in ID (applicable for plug-in fragment manifest only).</td>
458 <td valign="top">No</td>
459 </tr>
460 <tr>
461 <td valign="top">propertypluginversion</td>
462 <td valign="top">Name of the property where to put plug-in version (applicable for plug-in fragment manifest only). If no version specified in manifest, the empty string will be used.</td>
463 <td valign="top">No</td>
464 </tr>
465 <tr>
466 <td valign="top">propertymatchingrule</td>
467 <td valign="top">Name of the property where to put plug-in fragment matchin rule (applicable for plug-in fragment manifest only).</td>
468 <td valign="top">No</td>
469 </tr>
470 </table>
471 <h5>Example</h5>
472 <pre>&lt;!-- Define custom JPF specific Ant tasks --&gt;
473 &lt;typedef resource="org/java/plugin/tools/ant/jpf-tasks.properties" /&gt;
474 &lt;!-- Call "jpf-info" task to read plug-in ID into "plugin.id" property
475 and plug-in version into "plugin.version" property --&gt;
476 &lt;jpf-info
477 manifest="${basedir}/plugin.xml"
478 propertyid="plugin.id"
479 propertyversion="plugin.version"/&gt;</pre>
480
481 <h3><a name="versionUpdate">Version Update Tool</a></h3>
482 <p>Task (<strong>jpf-version</strong>) to automatically updade plug-in versions and version references. This task upgrades vesions build number and optionally version name (see <a href="api/org/java/plugin/registry/Version.html">Version class documentation</a>) if plug-in has modified since previous task run. Actual version numbers and timestamps are stored in simple text file in Java properties format.</p>
483 <table border="1" cellspacing="0" cellpadding="5">
484 <tr>
485 <th valign="top">Attribute</th>
486 <th valign="top">Description</th>
487 <th valign="top">Required</th>
488 </tr>
489 <tr>
490 <td valign="top">basedir</td>
491 <td valign="top">Directory to resolve relative links. By default is equal to project base directory <code>${basedir}</code>. The folder should contain non-ziped plain folders with plug-ins and plug-in fragments. Note that this task will modify manifests in this folder (leaving manifest file timestamps unchanged).</td>
492 <td valign="top">No</td>
493 </tr>
494 <tr>
495 <td valign="top">versionsfile</td>
496 <td valign="top">File where to store versions related data. If not exist, will be created automatically.</td>
497 <td valign="top">Yes</td>
498 </tr>
499 <tr>
500 <td valign="top">alterreferences</td>
501 <td valign="top">If "true", version references should be upgraded also. Default is "false".</td>
502 <td valign="top">No</td>
503 </tr>
504 <tr>
505 <td valign="top">timestampversion</td>
506 <td valign="top">If "true", the plug-in timestamp will be included into version name field. Default is "false".</td>
507 <td valign="top">No</td>
508 </tr>
509 <tr>
510 <td valign="top">verbose</td>
511 <td valign="top">If "true", more detailed report will be generated. Default is "false".</td>
512 <td valign="top">No</td>
513 </tr>
514 <tr>
515 <td valign="top">includes</td>
516 <td valign="top">comma- or space-separated list of patterns of plug-in manifest files that must be included. All files are included when omitted.</td>
517 <td valign="top">No</td>
518 </tr>
519 <tr>
520 <td valign="top">includesfile</td>
521 <td valign="top">The name of a file. Each line of this file is taken to be an include pattern.</td>
522 <td valign="top">No</td>
523 </tr>
524 <tr>
525 <td valign="top">excludes</td>
526 <td valign="top">Comma- or space-separated list of patterns of plug-in manifest files that must be excluded. No files (except default excludes) are excluded when omitted.</td>
527 <td valign="top">No</td>
528 </tr>
529 <tr>
530 <td valign="top">excludesfile</td>
531 <td valign="top">The name of a file. Each line of this file is taken to be an exclude pattern.</td>
532 <td valign="top">No</td>
533 </tr>
534 <tr>
535 <td valign="top">defaultexcludes</td>
536 <td valign="top">Indicates whether default excludes should be used or not (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>
537 <td valign="top">No</td>
538 </tr>
539 <tr>
540 <td valign="top">whitelist</td>
541 <td valign="top">The name of a file. Each line of this file is taken to be an ID or UID of plug-in to be included in processing. All plug-ins are included when file omitted.</td>
542 <td valign="top">No</td>
543 </tr>
544 <tr>
545 <td valign="top">blacklist</td>
546 <td valign="top">The name of a file. Each line of this file is taken to be an ID or UID of plug-in to be excluded from processing. No plug-ins are excluded when file omitted.</td>
547 <td valign="top">No</td>
548 </tr>
549 </table>
550 <h5>Parameters specified as nested elements</h5>
551 <dl>
552 <dt>fileset</dt>
553 <dd>Ant's FileSets can be used to select plug-in manifest files for plug-ins to be processed.</dd>
554 </dl>
555 <h5>Example</h5>
556 <pre>&lt;!-- Define custom JPF specific Ant tasks --&gt;
557 &lt;typedef resource="org/java/plugin/tools/ant/jpf-tasks.properties" /&gt;
558 &lt;!-- Call "jpf-version" task to update versions of modified plug-ins --&gt;
559 &lt;jpf-version
560 basedir="${build.home}/plugins"
561 includes="*/plugin.xml,*/plugin-fragment.xml"
562 versionsfile="${basedir}/plugins/versions.properties"
563 timestampversion="true"/&gt;</pre>
564
565 <h3><a name="path">Classpath Tool</a></h3>
566 <p>Task (<strong>jpf-path</strong>) to compose plug-in(s) classpath according to manifest data (libraries and dependencies declarations).</p>
567 <table border="1" cellspacing="0" cellpadding="5">
568 <tr>
569 <th valign="top">Attribute</th>
570 <th valign="top">Description</th>
571 <th valign="top">Required</th>
572 </tr>
573 <tr>
574 <td valign="top">basedir</td>
575 <td valign="top">Directory to resolve relative links. By default is equal to project base directory <code>${basedir}</code>.</td>
576 <td valign="top">No</td>
577 </tr>
578 <tr>
579 <td valign="top">pathid</td>
580 <td valign="top">Composed path-like structure ID.</td>
581 <td valign="middle" rowspan="2">One of two attriutes should be set.</td>
582 </tr>
583 <tr>
584 <td valign="top">pathidref</td>
585 <td valign="top">Path-like structure ID reference.</td>
586 </tr>
587 <tr>
588 <td valign="top">pluginid</td>
589 <td valign="top">Plug-in ID to compose classpath for.</td>
590 <td valign="middle" rowspan="2">At least one of two attriutes should be set.</td>
591 </tr>
592 <tr>
593 <td valign="top">pluginids</td>
594 <td valign="top">Comma separated list of plug-in ID's to compose classpath for.</td>
595 </tr>
596 <tr>
597 <td valign="top">followexports</td>
598 <td valign="top">If "true", libraries export rules will be taken into account. Default is "true".</td>
599 <td valign="top">No</td>
600 </tr>
601 <tr>
602 <td valign="top">verbose</td>
603 <td valign="top">If "true", more detailed report will be generated. Default is "false".</td>
604 <td valign="top">No</td>
605 </tr>
606 <tr>
607 <td valign="top">includes</td>
608 <td valign="top">comma- or space-separated list of patterns of plug-in manifest files that must be included. All files are included when omitted.</td>
609 <td valign="top">No</td>
610 </tr>
611 <tr>
612 <td valign="top">includesfile</td>
613 <td valign="top">The name of a file. Each line of this file is taken to be an include pattern.</td>
614 <td valign="top">No</td>
615 </tr>
616 <tr>
617 <td valign="top">excludes</td>
618 <td valign="top">Comma- or space-separated list of patterns of plug-in manifest files that must be excluded. No files (except default excludes) are excluded when omitted.</td>
619 <td valign="top">No</td>
620 </tr>
621 <tr>
622 <td valign="top">excludesfile</td>
623 <td valign="top">The name of a file. Each line of this file is taken to be an exclude pattern.</td>
624 <td valign="top">No</td>
625 </tr>
626 <tr>
627 <td valign="top">defaultexcludes</td>
628 <td valign="top">Indicates whether default excludes should be used or not (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>
629 <td valign="top">No</td>
630 </tr>
631 <tr>
632 <td valign="top">whitelist</td>
633 <td valign="top">The name of a file. Each line of this file is taken to be an ID or UID of plug-in to be included in processing. All plug-ins are included when file omitted.</td>
634 <td valign="top">No</td>
635 </tr>
636 <tr>
637 <td valign="top">blacklist</td>
638 <td valign="top">The name of a file. Each line of this file is taken to be an ID or UID of plug-in to be excluded from processing. No plug-ins are excluded when file omitted.</td>
639 <td valign="top">No</td>
640 </tr>
641 </table>
642 <h5>Parameters specified as nested elements</h5>
643 <dl>
644 <dt>fileset</dt>
645 <dd>Ant's FileSets can be used to select plug-in manifest files for plug-ins to be processed.</dd>
646 </dl>
647 <h5>Example</h5>
648 <pre>&lt;!-- Define custom JPF specific Ant tasks --&gt;
649 &lt;typedef resource="org/java/plugin/tools/ant/jpf-tasks.properties" /&gt;
650 &lt;!-- Call "jpf-path" task to compose classpath for plug-in "my.plugin" and
651 put result in path-like structure with ID "plugin.classpath". --&gt;
652 &lt;jpf-path
653 basedir="${build.home}/plugins"
654 includes="*/plugin.xml,*/plugin-fragment.xml"
655 pathid="plugin.classpath"
656 pluginid="my.plugin"/&gt;</pre>
657
658 <h3><a name="sort">Sorting Tool</a></h3>
659 <p>Task (<strong>jpf-sort</strong>) to sort plug-in(s) in correct build order. Places result into output path-like structure.</p>
660 <table border="1" cellspacing="0" cellpadding="5">
661 <tr>
662 <th valign="top">Attribute</th>
663 <th valign="top">Description</th>
664 <th valign="top">Required</th>
665 </tr>
666 <tr>
667 <td valign="top">basedir</td>
668 <td valign="top">Directory to resolve relative links. By default is equal to project base directory <code>${basedir}</code>.</td>
669 <td valign="top">No</td>
670 </tr>
671 <tr>
672 <td valign="top">pathid</td>
673 <td valign="top">Composed path-like structure ID.</td>
674 <td valign="middle" rowspan="2">One of two attriutes should be set.</td>
675 </tr>
676 <tr>
677 <td valign="top">pathidref</td>
678 <td valign="top">Path-like structure ID reference.</td>
679 </tr>
680 <tr>
681 <td valign="top">pathmode</td>
682 <td valign="top">
683 Regulates what to place into output path. Possible values are:
684 <dl>
685 <dt>DIR</dt>
686 <dd>put plug-in directory into output path</dd>
687 <dt>BUILD</dt>
688 <dd>put plug-in's <code>build.xml</code> file into output path</dd>
689 <dt>MANIFEST</dt>
690 <dd>put original plug-in manifest file into output path</dd>
691 </dl>
692 Default value is MANIFEST.
693 </td>
694 <td valign="top">No</td>
695 </tr>
696 <tr>
697 <td valign="top">reverse</td>
698 <td valign="top">If "true", result entries will be placed into output path in reversed order. Default is "false".</td>
699 <td valign="top">No</td>
700 </tr>
701 <tr>
702 <td valign="top">verbose</td>
703 <td valign="top">If "true", more detailed report will be generated. Default is "false".</td>
704 <td valign="top">No</td>
705 </tr>
706 <tr>
707 <td valign="top">includes</td>
708 <td valign="top">comma- or space-separated list of patterns of plug-in manifest files that must be included. All files are included when omitted.</td>
709 <td valign="top">No</td>
710 </tr>
711 <tr>
712 <td valign="top">includesfile</td>
713 <td valign="top">The name of a file. Each line of this file is taken to be an include pattern.</td>
714 <td valign="top">No</td>
715 </tr>
716 <tr>
717 <td valign="top">excludes</td>
718 <td valign="top">Comma- or space-separated list of patterns of plug-in manifest files that must be excluded. No files (except default excludes) are excluded when omitted.</td>
719 <td valign="top">No</td>
720 </tr>
721 <tr>
722 <td valign="top">excludesfile</td>
723 <td valign="top">The name of a file. Each line of this file is taken to be an exclude pattern.</td>
724 <td valign="top">No</td>
725 </tr>
726 <tr>
727 <td valign="top">defaultexcludes</td>
728 <td valign="top">Indicates whether default excludes should be used or not (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>
729 <td valign="top">No</td>
730 </tr>
731 <tr>
732 <td valign="top">whitelist</td>
733 <td valign="top">The name of a file. Each line of this file is taken to be an ID or UID of plug-in to be included in processing. All plug-ins are included when file omitted.</td>
734 <td valign="top">No</td>
735 </tr>
736 <tr>
737 <td valign="top">blacklist</td>
738 <td valign="top">The name of a file. Each line of this file is taken to be an ID or UID of plug-in to be excluded from processing. No plug-ins are excluded when file omitted.</td>
739 <td valign="top">No</td>
740 </tr>
741 </table>
742 <h5>Parameters specified as nested elements</h5>
743 <dl>
744 <dt>fileset</dt>
745 <dd>Ant's FileSets can be used to select plug-in manifest files for plug-ins to be processed.</dd>
746 </dl>
747 <h5>Example</h5>
748 <pre>&lt;!-- Define custom JPF specific Ant tasks --&gt;
749 &lt;typedef resource="org/java/plugin/tools/ant/jpf-tasks.properties" /&gt;
750 &lt;!-- Call "jpf-sort" task to sort all plug-ins in correct build order and
751 put their folders in path-like structure with ID "plugins". --&gt;
752 &lt;jpf-sort
753 basedir="${build.home}/plugins"
754 includes="*/plugin.xml,*/plugin-fragment.xml"
755 pathid="plugins"
756 pathmode="DIR"/&gt;</pre>
757
758 <p>Look at the source code of <a href="http://sourceforge.net/project/showfiles.php?group_id=110394">JPF-Demo application</a> to get working example of tools usage.</p>
759 </div>
760 <%
761 printFooter();
762 %>

  ViewVC Help
Powered by ViewVC 1.1.26