You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

stylebook.html 1.9 KiB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Language" content="en-us">
  4. <title>Apache Ant User Manual</title>
  5. </head>
  6. <body>
  7. <h2><a name="stylebook">Stylebook</a></h2>
  8. <h3>Description</h3>
  9. <p>This executes the apache Stylebook documentation generator.
  10. Unlike the commandline version of this tool, all three arguments
  11. are required to run stylebook.</p>
  12. <p><b>Note:</b> This task depends on external libraries not included in the Ant distribution.
  13. See <a href="../install.html#librarydependencies">Library Dependencies</a> for more information.</p>
  14. <h3>Parameters</h3>
  15. <table border="1" cellpadding="2" cellspacing="0">
  16. <tr>
  17. <td valign="top"><b>Attribute</b></td>
  18. <td valign="top"><b>Description</b></td>
  19. <td align="center" valign="top"><b>Required</b></td>
  20. </tr>
  21. <tr>
  22. <td valign="top">book</td>
  23. <td valign="top">the book xml file that the documentation generation starts from
  24. </td>
  25. <td valign="top" align="center">Yes</td>
  26. </tr>
  27. <tr>
  28. <td valign="top">skindirectory</td>
  29. <td valign="top">the directory that contains the stylebook skin
  30. </td>
  31. <td valign="top" align="center">Yes</td>
  32. </tr>
  33. <tr>
  34. <td valign="top">targetdirectory</td>
  35. <td valign="top">the destination directory where the documentation is generated
  36. </td>
  37. <td valign="top" align="center">Yes</td>
  38. </tr>
  39. </table>
  40. <p>
  41. The user can also specify the nested &lt;classpath&gt; element which defines classpath
  42. in which the task is executed.</p>
  43. <h3>Examples</h3>
  44. <blockquote>
  45. <pre>
  46. &lt;stylebook targetdirectory=&quot;build/docs&quot;
  47. book=&quot;src/xdocs/book.xml&quot;
  48. skindirectory=&quot;src/skins/myskin&quot;/&gt;
  49. </pre>
  50. </blockquote>
  51. The above will generate documentation in build/docs starting from the book
  52. src/xdocs/book.xml and using the skin located in directory src/skins/myskin.
  53. <hr>
  54. <p align="center">Copyright &copy; 2000,2001 Apache Software Foundation. All rights
  55. Reserved.</p>
  56. </body>
  57. </html>