Description: Provides the relationships among a set of application programming interface (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.

# apiMap module

Provides the relationships among a set of application programming interface (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 apiMap module organizes your DITA files into a hierarchy. It can also create relationship links between your topics. You can use the <apiMap> to organize your work, and to create and edit DITA API files.

#### Example

The following example shows a simple <apiMap> element for a VB.NET API:

    <apiMap title="RXE">
         <apiPackageRef navtitle=Rational RXE">
           <apiItemRef href="FileHandle.dita"></apiItemRef>
           <apiItemRef href="MultiLanguage.dita"></apiItemRef>
         </apiPackageRef>
         <apiPackageRef navtitle=Index">
           <apiItemRef href="RXEIndex.html"></apiItemRef>
         </apiPackageRef>
    </apiMap>

- apiMap
  The <apiMap> element provides the name of the application programming interface (API) reference and all the elements necessary to describe the package, or set of packages, and its components.

Parent topic: Generic API topic types