| 1 | <html>
|
|---|
| 2 |
|
|---|
| 3 | <head>
|
|---|
| 4 | <meta http-equiv="Content-Language" content="en-us">
|
|---|
| 5 | <title>StyleBook Task</title>
|
|---|
| 6 | <link rel="stylesheet" type="text/css" href="../stylesheets/antmanual.css">
|
|---|
| 7 | </head>
|
|---|
| 8 |
|
|---|
| 9 | <body>
|
|---|
| 10 |
|
|---|
| 11 | <h2><a name="stylebook">Stylebook</a></h2>
|
|---|
| 12 | <h3>Description</h3>
|
|---|
| 13 | <p>This executes the apache Stylebook documentation generator.
|
|---|
| 14 | Unlike the commandline version of this tool, all three arguments
|
|---|
| 15 | are required to run stylebook.</p>
|
|---|
| 16 | <p><b>Note:</b> This task depends on external libraries not included in the Ant distribution.
|
|---|
| 17 | See <a href="../install.html#librarydependencies">Library Dependencies</a> for more information.</p>
|
|---|
| 18 | <p>
|
|---|
| 19 | Being extended from <code><Java></code>, all the parent's attributes
|
|---|
| 20 | and options are available. Do not set any apart from the <tt>classpath</tt>
|
|---|
| 21 | as they are not guaranteed to be there in future.
|
|---|
| 22 | </p>
|
|---|
| 23 |
|
|---|
| 24 | <h3>Parameters</h3>
|
|---|
| 25 | <table border="1" cellpadding="2" cellspacing="0">
|
|---|
| 26 | <tr>
|
|---|
| 27 | <td valign="top"><b>Attribute</b></td>
|
|---|
| 28 | <td valign="top"><b>Description</b></td>
|
|---|
| 29 | <td align="center" valign="top"><b>Required</b></td>
|
|---|
| 30 | </tr>
|
|---|
| 31 | <tr>
|
|---|
| 32 | <td valign="top">book</td>
|
|---|
| 33 | <td valign="top">the book xml file that the documentation generation starts from
|
|---|
| 34 | </td>
|
|---|
| 35 | <td valign="top" align="center">Yes</td>
|
|---|
| 36 | </tr>
|
|---|
| 37 | <tr>
|
|---|
| 38 | <td valign="top">skindirectory</td>
|
|---|
| 39 | <td valign="top">the directory that contains the stylebook skin
|
|---|
| 40 | </td>
|
|---|
| 41 | <td valign="top" align="center">Yes</td>
|
|---|
| 42 | </tr>
|
|---|
| 43 | <tr>
|
|---|
| 44 | <td valign="top">targetdirectory</td>
|
|---|
| 45 | <td valign="top">the destination directory where the documentation is generated
|
|---|
| 46 | </td>
|
|---|
| 47 | <td valign="top" align="center">Yes</td>
|
|---|
| 48 | </tr>
|
|---|
| 49 | </table>
|
|---|
| 50 | <p>
|
|---|
| 51 | The user can also specify the nested <code><classpath></code> element which defines classpath
|
|---|
| 52 | in which the task is executed.</p>
|
|---|
| 53 |
|
|---|
| 54 | <h3>Examples</h3>
|
|---|
| 55 | <blockquote>
|
|---|
| 56 | <pre>
|
|---|
| 57 | <stylebook targetdirectory="build/docs"
|
|---|
| 58 | book="src/xdocs/book.xml"
|
|---|
| 59 | skindirectory="src/skins/myskin"/>
|
|---|
| 60 | </pre>
|
|---|
| 61 | </blockquote>
|
|---|
| 62 | The above will generate documentation in build/docs starting from the book
|
|---|
| 63 | src/xdocs/book.xml and using the skin located in directory src/skins/myskin.
|
|---|
| 64 |
|
|---|
| 65 | <hr>
|
|---|
| 66 | <p align="center">Copyright © 2001-2002,2004 The Apache Software Foundation. All rights
|
|---|
| 67 | Reserved.</p>
|
|---|
| 68 |
|
|---|
| 69 | </body>
|
|---|
| 70 | </html>
|
|---|
| 71 |
|
|---|
