|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
4 <html xmlns="http://www.w3.org/1999/xhtml"> |
|
5 <head> |
|
6 <title>Java API Reference Specialization</title> |
|
7 </head> |
|
8 <body><div><h1>Java API Reference Specialization</h1> |
|
9 <p><strong>Purpose:</strong> |
|
10 The Java API Reference specialization provides a basis for documenting |
|
11 Java class libraries. |
|
12 The specialization can be used or examined as an example of how to |
|
13 extend the base API Reference specialization. |
|
14 </p> |
|
15 <p><strong>Prerequisite:</strong> |
|
16 API Reference specialization. |
|
17 </p> |
|
18 <p>You can view the <a href="doc/frameset.html">reference |
|
19 documentation</a> for the Java API Reference specialization.</p> |
|
20 <div><h2>Building</h2> |
|
21 <p>The Java API Reference specialization provides the conductor.xml file |
|
22 to extend the base Ant targets with the following build targets:</p> |
|
23 <dl> |
|
24 <dt>javaref2xhtml</dt> |
|
25 <dd>Build the Java API map for a sample Java package to XHTML.</dd> |
|
26 </dl> |
|
27 <p>The run-ant.xml file executes this build targets on the sample |
|
28 content.</p> |
|
29 <p>You should run the sample Ant build from the base directory for the DITA |
|
30 Open Toolkit, using a relative path to the Java API Reference specialization:</p> |
|
31 <pre>ant -f demo\javaapiref\install_plugin.xml |
|
32 ant -f demo\javaapiref\run_ant.xml <i>optionalTarget</i></pre> |
|
33 <p>You need only execute the install_plugin.xml file after initial |
|
34 installation or update of any plugin.</p> |
|
35 </div> |
|
36 <div><h2>Contents</h2><p>The specialization includes subdirectories |
|
37 with the following contents:</p><dl> |
|
38 <dt>doc</dt> |
|
39 <dd>The source files and output for the documentation.</dd> |
|
40 <dt>dtd</dt> |
|
41 <dd>DTDs for the document type for the API Reference specialization.</dd> |
|
42 <dt>out</dt> |
|
43 <dd>Formatted sample output files from the Ant build.</dd> |
|
44 <dt>sample</dt> |
|
45 <dd>Source files for an example of package content.</dd> |
|
46 <dt>xsd</dt> |
|
47 <dd>XML Schemas for the document type for the API Reference specialization.</dd> |
|
48 <dt>xsl</dt> |
|
49 <dd>Transforms for producing the output of the Ant build.</dd> |
|
50 </dl></div> |
|
51 <div><h2>Contributors</h2><p>Erik Hennum, Dennis Grace, Mariana Alupului, |
|
52 Michael Priestley, Michelle C Carey, Nigel Hopper, Rob Pierce, and |
|
53 Robert D Anderson</p> |
|
54 </div> |
|
55 </div> |
|
56 </body> |
|
57 </html> |