Navigation: Learn About All Features  > Application Behavior >

Map IDs

 

 

 

 

  As a programmer, you can leverage HTML Executable to compile help files or documentation in HTML format for your applications. The HTML Executable APIs allow you to open help publications, specify the help topic to be displayed, and close them when your application is closed, effectively integrating the publications with your own applications.

 

Rather than specifying the HTML page's filename for the help topic you wish to display, you have the option to pass a numeric ID to the API or the command line. HTML Executable conveniently associates a unique ID (page ID) with each HTML page it compiles into a publication.

 

These IDs collectively form what is known as a map. HTML Executable can be configured to export this map to a file (termed as MAP file) that can be seamlessly integrated into your application's project.

 

  At present, HTML Executable can generate MAP files in Object Pascal (compatible with Embarcadero Delphi and FreePascal), C/C++ (compatible with Borland C++ Builder or Microsoft Visual C++) and in simple text files. Just select the programming language that suits your need.

 

By default, the map file is created in the same folder as the output file (provided the option is enabled).

 

  If desired, you can add your own custom page IDs (similar to HTML anchors, HEScript commands) to work with map IDs or the HTML Executable API SDK. These custom page IDs will be automatically exported to the map file. To add a custom page ID, click 'Add' and input its target. To remove a custom page ID, select it and click 'Remove'.

 

Map IDs can also be passed via the command line, giving you control over your publication from other applications.

 

  The HTML Executable API SDK is available to registered users upon request.