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 2.1 KiB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Language" content="en-us">
  4. <title>StyleBook Task</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. <p>
  15. Being extended from &lt;Java&gt;, all the parent's attributes
  16. and options are available. Do not set any apart from the <tt>classpath</tt>
  17. as they are not guaranteed to be there in future.
  18. </p>
  19. <h3>Parameters</h3>
  20. <table border="1" cellpadding="2" cellspacing="0">
  21. <tr>
  22. <td valign="top"><b>Attribute</b></td>
  23. <td valign="top"><b>Description</b></td>
  24. <td align="center" valign="top"><b>Required</b></td>
  25. </tr>
  26. <tr>
  27. <td valign="top">book</td>
  28. <td valign="top">the book xml file that the documentation generation starts from
  29. </td>
  30. <td valign="top" align="center">Yes</td>
  31. </tr>
  32. <tr>
  33. <td valign="top">skindirectory</td>
  34. <td valign="top">the directory that contains the stylebook skin
  35. </td>
  36. <td valign="top" align="center">Yes</td>
  37. </tr>
  38. <tr>
  39. <td valign="top">targetdirectory</td>
  40. <td valign="top">the destination directory where the documentation is generated
  41. </td>
  42. <td valign="top" align="center">Yes</td>
  43. </tr>
  44. </table>
  45. <p>
  46. The user can also specify the nested &lt;classpath&gt; element which defines classpath
  47. in which the task is executed.</p>
  48. <h3>Examples</h3>
  49. <blockquote>
  50. <pre>
  51. &lt;stylebook targetdirectory=&quot;build/docs&quot;
  52. book=&quot;src/xdocs/book.xml&quot;
  53. skindirectory=&quot;src/skins/myskin&quot;/&gt;
  54. </pre>
  55. </blockquote>
  56. The above will generate documentation in build/docs starting from the book
  57. src/xdocs/book.xml and using the skin located in directory src/skins/myskin.
  58. <hr>
  59. <p align="center">Copyright &copy; 2001-2002 Apache Software Foundation. All rights
  60. Reserved.</p>
  61. </body>
  62. </html>