Module: Cabriolet::Binary::HLPStructures

Defined in:
lib/cabriolet/binary/hlp_structures.rb

Overview

HLP (Windows Help / QuickHelp) file format binary structures

Based on the QuickHelp binary format specification from DosHelp project. HLP files store help databases with topics, compression, and hyperlinks.

Format overview:

  • Signature (2 bytes): 0x4C 0x4E (“LN”)

  • File Header (68 bytes)

  • Topic Index (variable)

  • Context Strings (variable)

  • Context Map (variable)

  • Keywords (optional, variable)

  • Huffman Tree (optional, variable)

  • Topic Texts (variable, compressed)

Defined Under Namespace

Modules: Attributes, ControlBytes, TextStyle Classes: ContextMapEntry, FileHeader, HuffmanNode, TopicHeader, TopicOffset, WinHelp3Header, WinHelp4Header, WinHelpBTreeHeader, WinHelpBTreeIndexHeader, WinHelpBTreeNodeHeader, WinHelpDirectoryEntry, WinHelpFileHeader

Constant Summary collapse

SIGNATURE =

QuickHelp file signature: 0x4C, 0x4E (“LN”)

"\x4C\x4E".b.freeze