youys
/
ant
Not watched
1
0
Fork 1
Code
Releases 0 Wiki Activity
Issues 0 Pull Requests 0 Datasets Model Cloudbrain
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.
Tree: 6d93fb1572
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '6d93fb1572'
${ noResults }
ant/docs/manual/OptionalTasks/stylebook.html

71 lines
2.2 kB
Raw Blame History 

  1. <html>

  2. 

  3. <head>

  4. <meta http-equiv="Content-Language" content="en-us">

  5. <title>StyleBook Task</title>

  6. </head>

  7. 

  8. <body>

  9. 

  10. <h2><a name="stylebook">Stylebook</a></h2>

  11. <h3>Description</h3>

  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 &lt;Java&gt;, 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. 

  23. <h3>Parameters</h3>

  24. <table border="1" cellpadding="2" cellspacing="0">

  25.   <tr>

  26.     <td valign="top"><b>Attribute</b></td>

  27.     <td valign="top"><b>Description</b></td>

  28.     <td align="center" valign="top"><b>Required</b></td>

  29.   </tr>

  30.   <tr>

  31.     <td valign="top">book</td>

  32.     <td valign="top">the book xml file that the documentation generation starts from

  33.     </td>

  34.     <td valign="top" align="center">Yes</td>

  35.   </tr>

  36.   <tr>

  37.     <td valign="top">skindirectory</td>

  38.     <td valign="top">the directory that contains the stylebook skin

  39.     </td>

  40.     <td valign="top" align="center">Yes</td>

  41.   </tr>

  42.   <tr>

  43.     <td valign="top">targetdirectory</td>

  44.     <td valign="top">the destination directory where the documentation is generated 

  45.     </td>

  46.     <td valign="top" align="center">Yes</td>

  47.   </tr>

  48. </table>

  49. <p>

  50. The user can also specify the nested &lt;classpath&gt; element which defines classpath 

  51. in which the task is executed.</p>

  52. 

  53. <h3>Examples</h3>

  54. <blockquote>

  55. <pre>

  56. &lt;stylebook targetdirectory=&quot;build/docs&quot; 

  57.            book=&quot;src/xdocs/book.xml&quot; 

  58.            skindirectory=&quot;src/skins/myskin&quot;/&gt;

  59. </pre>

  60. </blockquote>

  61. The above will generate documentation in build/docs starting from the book 

  62. src/xdocs/book.xml and using the skin located in directory src/skins/myskin.

  63. 

  64. <hr>

  65. <p align="center">Copyright &copy; 2001-2002 Apache Software Foundation. All rights

  66. Reserved.</p>

  67. 

  68. </body>

  69. </html>