| <html> |
| |
| <head> |
| <meta http-equiv="Content-Language" content="en-us"> |
| <title>StyleBook Task</title> |
| </head> |
| |
| <body> |
| |
| <h2><a name="stylebook">Stylebook</a></h2> |
| <h3>Description</h3> |
| <p>This executes the apache Stylebook documentation generator. |
| Unlike the commandline version of this tool, all three arguments |
| are required to run stylebook.</p> |
| <p><b>Note:</b> This task depends on external libraries not included in the Ant distribution. |
| See <a href="../install.html#librarydependencies">Library Dependencies</a> for more information.</p> |
| <p> |
| Being extended from <Java>, all the parent's attributes |
| and options are available. Do not set any apart from the <tt>classpath</tt> |
| as they are not guaranteed to be there in future. |
| </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> |
| </tr> |
| <tr> |
| <td valign="top">book</td> |
| <td valign="top">the book xml file that the documentation generation starts from |
| </td> |
| <td valign="top" align="center">Yes</td> |
| </tr> |
| <tr> |
| <td valign="top">skindirectory</td> |
| <td valign="top">the directory that contains the stylebook skin |
| </td> |
| <td valign="top" align="center">Yes</td> |
| </tr> |
| <tr> |
| <td valign="top">targetdirectory</td> |
| <td valign="top">the destination directory where the documentation is generated |
| </td> |
| <td valign="top" align="center">Yes</td> |
| </tr> |
| </table> |
| <p> |
| The user can also specify the nested <classpath> element which defines classpath |
| in which the task is executed.</p> |
| |
| <h3>Examples</h3> |
| <blockquote> |
| <pre> |
| <stylebook targetdirectory="build/docs" |
| book="src/xdocs/book.xml" |
| skindirectory="src/skins/myskin"/> |
| </pre> |
| </blockquote> |
| The above will generate documentation in build/docs starting from the book |
| src/xdocs/book.xml and using the skin located in directory src/skins/myskin. |
| |
| <hr> |
| <p align="center">Copyright © 2001-2002 Apache Software Foundation. All rights |
| Reserved.</p> |
| |
| </body> |
| </html> |
| |
