|
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>API Reference Specialization</title> |
|
7 </head> |
|
8 <body><div><h1>API Reference Specialization</h1> |
|
9 <p><strong>Purpose:</strong> |
|
10 The API Reference specialization provides a general-purpose basis for |
|
11 documenting callable programming libraries. |
|
12 The design of API Reference is based loosely on the principle objects from the |
|
13 <a href="http://download.eclipse.org/tools/emf/2.2.0/javadoc/org/eclipse/emf/ecore/package-summary.html">eCore metamodel</a> |
|
14 of the <a href="http://www.eclipse.org/emf/">Eclipse Modeling Framework (EMF)</a>. |
|
15 The API Reference can used to create basic API documentation or can be |
|
16 specialized for a programming language or library type to make it |
|
17 easier to write complete and accurate documentation for such libraries. |
|
18 The Java API Reference provides an example of how to extend |
|
19 the API Reference specialization for the libraries of a specific |
|
20 programming language. </p> |
|
21 <p>You can view the <a href="doc/frameset.html">reference |
|
22 documentation</a> for the API Reference specialization.</p> |
|
23 <div><h2>Building</h2> |
|
24 <p>The API Reference specialization provides the conductor.xml file |
|
25 to extend the base Ant targets with the following build targets:</p> |
|
26 <dl> |
|
27 <dt>apiref2xhtml</dt> |
|
28 <dd>Build the API map for a package to XHTML.</dd> |
|
29 </dl> |
|
30 <p>The run-ant.xml file executes this build targets on the sample |
|
31 content.</p> |
|
32 <p>You should run the sample Ant build from the base directory for the DITA |
|
33 Open Toolkit, using a relative path to the API Reference specialization:</p> |
|
34 <pre>ant -f demo\apiref\install_plugin.xml |
|
35 ant -f demo\apiref\run_ant.xml <i>optionalTarget</i></pre> |
|
36 <p>You need only execute the install_plugin.xml file after initial |
|
37 installation or update of any plugin.</p> |
|
38 </div> |
|
39 <div><h2>Contents</h2><p>The specialization includes subdirectories |
|
40 with the following contents:</p><dl> |
|
41 <dt>doc</dt> |
|
42 <dd>The source files and output for the documentation.</dd> |
|
43 <dt>dtd</dt> |
|
44 <dd>DTDs for the document type for the API Reference specialization.</dd> |
|
45 <dt>out</dt> |
|
46 <dd>Formatted sample output files from the Ant build.</dd> |
|
47 <dt>sample</dt> |
|
48 <dd>Source files for an example of package content.</dd> |
|
49 <dt>xsd</dt> |
|
50 <dd>XML Schemas for the document type for the API Reference specialization.</dd> |
|
51 <dt>xsl</dt> |
|
52 <dd>Transforms for producing the output of the Ant build.</dd> |
|
53 </dl></div> |
|
54 <div><h2>Contributors</h2><p>Erik Hennum, Dennis Grace, Mariana Alupului, |
|
55 Michael Priestley, Michelle C Carey, Nigel Hopper, Rob Pierce, and |
|
56 Robert D Anderson</p> |
|
57 </div> |
|
58 </div> |
|
59 </body> |
|
60 </html> |