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.3 KiB

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