javaAPIMap module

Provides the relationships among a set of Java API topic types, and can be used to create a Table of Contents (TOC), aggregate Java API topics into a PDF document, or to create links between topics in output.

Description

Maps provide a way to express these relationships in a single common format for the Java API reference that can be used for different outputs. The javaAPIMap module organizes your DITA files into a hierarchy. It can also create relationship links between your topics. You can use the <javaAPIMap> to organize your work, and to create and edit Java API DITA files.

Example

<javaAPIMap title="RXE">
   <javaPackageRef href="RXE_Package.dita" search="yes">
     <javaInterfaceRef navtitle="IRXEAbstraction Interface" 
            href="irxeabstraction.dita" locktitle="yes"></javaInterfaceRef>
     <javaInterfaceRef navtitle="IRXEAccess Interface" 
            href="irxeaccess.dita" locktitle="yes"></javaInterfaceRef>
     <javaInterfaceRef navtitle="IRXEActionResult Interface" 
            href="irxeactionresult.dita" locktitle="yes"></javaInterfaceRef>
   </javaPackageRef>
</javaAPIMap>

Processing Expectations

The javaAPIMap topic contains the following elements: