Share via

The Difference Between Binary and Site Map Indexes

  • Article

There are two types of indexes available for help authors to use, a binary index or a site map index. Each type of index has its own unique features.

Binary index

This type of index is used only with compiled help (.chm) files. The following are some characteristics a binary index:

  • Good for large indexes because its compiled size is very small.
  • Is automatically sorted during compile. A help author cannot customize how a binary index is sorted.
  • Can be merged with other indexes. All indexes are then sorted at compile time as one.
  • Can be used with KLinks to create links to specific topics.
  • Will automatically merge keywords added to HTML files with Keyword links (KLinks) added to the index file.

Site map index

This type of index must be used when authoring an index for a Web site. It can also be used with compiled help files. The following are some characteristics of a site map index:

  • Works on a Web site.
  • Help author has complete control over how the index is sorted.
  • Works without being compiled (but can also be compiled).
  • Same index can be used for Web site and compiled help file.
  • Is better to use with smaller indexes because site map indexes are larger than binary indexes.
  • Keywords are not merged with other indexes or sorted during compile.
  • KLinks do not work with site map indexes.

Note

The method you use for creating keywords depends on whether you are creating an index that will be used in a compiled help file, on a Web site, or in a situation where there are multiple indexes.

About Creating Index Files