1 | <!--
|
---|
2 | Licensed to the Apache Software Foundation (ASF) under one or more
|
---|
3 | contributor license agreements. See the NOTICE file distributed with
|
---|
4 | this work for additional information regarding copyright ownership.
|
---|
5 | The ASF licenses this file to You under the Apache License, Version 2.0
|
---|
6 | (the "License"); you may not use this file except in compliance with
|
---|
7 | the License. You may obtain a copy of the License at
|
---|
8 |
|
---|
9 | http://www.apache.org/licenses/LICENSE-2.0
|
---|
10 |
|
---|
11 | Unless required by applicable law or agreed to in writing, software
|
---|
12 | distributed under the License is distributed on an "AS IS" BASIS,
|
---|
13 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
---|
14 | See the License for the specific language governing permissions and
|
---|
15 | limitations under the License.
|
---|
16 | -->
|
---|
17 | <html>
|
---|
18 |
|
---|
19 | <head>
|
---|
20 | <meta http-equiv="Content-Language" content="en-us">
|
---|
21 | <link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
|
---|
22 | <title>StyleBook Task</title>
|
---|
23 | </head>
|
---|
24 |
|
---|
25 | <body>
|
---|
26 |
|
---|
27 | <h2><a name="stylebook">Stylebook</a></h2>
|
---|
28 | <h3>Description</h3>
|
---|
29 |
|
---|
30 | <strong>This task is deprecated as stylebook itself has been
|
---|
31 | deprecated by the Apache XML community.</strong>
|
---|
32 |
|
---|
33 | <p>This executes the apache Stylebook documentation generator.
|
---|
34 | Unlike the commandline version of this tool, all three arguments
|
---|
35 | are required to run stylebook.</p>
|
---|
36 | <p><b>Note:</b> This task depends on external libraries not included in the Ant distribution.
|
---|
37 | See <a href="../install.html#librarydependencies">Library Dependencies</a> for more information.</p>
|
---|
38 | <p>
|
---|
39 | Being extended from <code><Java></code>, all the parent's attributes
|
---|
40 | and options are available. Do not set any apart from the <tt>classpath</tt>
|
---|
41 | as they are not guaranteed to be there in future.
|
---|
42 | </p>
|
---|
43 |
|
---|
44 | <h3>Parameters</h3>
|
---|
45 | <table border="1" cellpadding="2" cellspacing="0">
|
---|
46 | <tr>
|
---|
47 | <td valign="top"><b>Attribute</b></td>
|
---|
48 | <td valign="top"><b>Description</b></td>
|
---|
49 | <td align="center" valign="top"><b>Required</b></td>
|
---|
50 | </tr>
|
---|
51 | <tr>
|
---|
52 | <td valign="top">book</td>
|
---|
53 | <td valign="top">the book xml file that the documentation generation starts from
|
---|
54 | </td>
|
---|
55 | <td valign="top" align="center">Yes</td>
|
---|
56 | </tr>
|
---|
57 | <tr>
|
---|
58 | <td valign="top">skindirectory</td>
|
---|
59 | <td valign="top">the directory that contains the stylebook skin
|
---|
60 | </td>
|
---|
61 | <td valign="top" align="center">Yes</td>
|
---|
62 | </tr>
|
---|
63 | <tr>
|
---|
64 | <td valign="top">targetdirectory</td>
|
---|
65 | <td valign="top">the destination directory where the documentation is generated
|
---|
66 | </td>
|
---|
67 | <td valign="top" align="center">Yes</td>
|
---|
68 | </tr>
|
---|
69 | </table>
|
---|
70 | <p>
|
---|
71 | The user can also specify the nested <code><classpath></code> element which defines classpath
|
---|
72 | in which the task is executed.</p>
|
---|
73 |
|
---|
74 | <h3>Examples</h3>
|
---|
75 | <blockquote>
|
---|
76 | <pre>
|
---|
77 | <stylebook targetdirectory="build/docs"
|
---|
78 | book="src/xdocs/book.xml"
|
---|
79 | skindirectory="src/skins/myskin"/>
|
---|
80 | </pre>
|
---|
81 | </blockquote>
|
---|
82 | The above will generate documentation in build/docs starting from the book
|
---|
83 | src/xdocs/book.xml and using the skin located in directory src/skins/myskin.
|
---|
84 |
|
---|
85 |
|
---|
86 |
|
---|
87 | </body>
|
---|
88 | </html>
|
---|
89 |
|
---|