2006-09-11 04:19:00 +00:00
|
|
|
<!--
|
|
|
|
|
Licensed to the Apache Software Foundation (ASF) under one or more
|
|
|
|
|
contributor license agreements. See the NOTICE file distributed with
|
|
|
|
|
this work for additional information regarding copyright ownership.
|
|
|
|
|
The ASF licenses this file to You under the Apache License, Version 2.0
|
|
|
|
|
(the "License"); you may not use this file except in compliance with
|
|
|
|
|
the License. You may obtain a copy of the License at
|
|
|
|
|
|
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
|
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
|
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
|
See the License for the specific language governing permissions and
|
|
|
|
|
limitations under the License.
|
|
|
|
|
-->
|
2001-02-13 12:32:01 +00:00
|
|
|
<html>
|
|
|
|
|
|
|
|
|
|
<head>
|
|
|
|
|
<meta http-equiv="Content-Language" content="en-us">
|
2005-04-29 18:58:16 +00:00
|
|
|
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
|
2002-02-03 22:11:39 +00:00
|
|
|
<title>StyleBook Task</title>
|
2001-02-13 12:32:01 +00:00
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body>
|
|
|
|
|
|
|
|
|
|
<h2><a name="stylebook">Stylebook</a></h2>
|
|
|
|
|
<h3>Description</h3>
|
2005-03-31 11:24:06 +00:00
|
|
|
|
|
|
|
|
<strong>This task is deprecated as stylebook itself has been
|
|
|
|
|
deprecated by the Apache XML community.</strong>
|
|
|
|
|
|
2001-02-13 12:32:01 +00:00
|
|
|
<p>This executes the apache Stylebook documentation generator.
|
|
|
|
|
Unlike the commandline version of this tool, all three arguments
|
|
|
|
|
are required to run stylebook.</p>
|
2001-08-30 13:23:14 +00:00
|
|
|
<p><b>Note:</b> This task depends on external libraries not included in the Ant distribution.
|
|
|
|
|
See <a href="../install.html#librarydependencies">Library Dependencies</a> for more information.</p>
|
2002-07-09 21:06:15 +00:00
|
|
|
<p>
|
2004-11-19 09:07:12 +00:00
|
|
|
Being extended from <code><Java></code>, all the parent's attributes
|
2002-07-09 21:06:15 +00:00
|
|
|
and options are available. Do not set any apart from the <tt>classpath</tt>
|
|
|
|
|
as they are not guaranteed to be there in future.
|
|
|
|
|
</p>
|
2001-02-13 12:32:01 +00:00
|
|
|
|
|
|
|
|
<h3>Parameters</h3>
|
|
|
|
|
<table border="1" cellpadding="2" cellspacing="0">
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top"><b>Attribute</b></td>
|
|
|
|
|
<td valign="top"><b>Description</b></td>
|
|
|
|
|
<td align="center" valign="top"><b>Required</b></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">book</td>
|
|
|
|
|
<td valign="top">the book xml file that the documentation generation starts from
|
|
|
|
|
</td>
|
|
|
|
|
<td valign="top" align="center">Yes</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">skindirectory</td>
|
|
|
|
|
<td valign="top">the directory that contains the stylebook skin
|
|
|
|
|
</td>
|
|
|
|
|
<td valign="top" align="center">Yes</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">targetdirectory</td>
|
|
|
|
|
<td valign="top">the destination directory where the documentation is generated
|
|
|
|
|
</td>
|
|
|
|
|
<td valign="top" align="center">Yes</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
<p>
|
2004-11-19 09:07:12 +00:00
|
|
|
The user can also specify the nested <code><classpath></code> element which defines classpath
|
2001-02-13 12:32:01 +00:00
|
|
|
in which the task is executed.</p>
|
|
|
|
|
|
|
|
|
|
<h3>Examples</h3>
|
|
|
|
|
<blockquote>
|
|
|
|
|
<pre>
|
|
|
|
|
<stylebook targetdirectory="build/docs"
|
|
|
|
|
book="src/xdocs/book.xml"
|
|
|
|
|
skindirectory="src/skins/myskin"/>
|
|
|
|
|
</pre>
|
|
|
|
|
</blockquote>
|
|
|
|
|
The above will generate documentation in build/docs starting from the book
|
|
|
|
|
src/xdocs/book.xml and using the skin located in directory src/skins/myskin.
|
|
|
|
|
|
2006-09-11 04:33:25 +00:00
|
|
|
|
2001-02-13 12:32:01 +00:00
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
|
|
|
|
|
