The Visual Studio .NET Help Integration Kit (VSHIK) is a legacy, specialized development toolset released by Microsoft to enable developers and component vendors to build and integrate custom documentation into the internal MS Help 2.0 (.hxs) system used by early versions of Visual Studio (primarily VS 2002, 2003, and 2005) and the MSDN Library.
Because modern versions of Visual Studio rely on completely different web-based and MS Help Viewer formats (.mshc), using VSHIK effectively requires understanding its role as an archival tool for maintaining legacy software environments. 🛠️ Core Utilities Contained in VSHIK
When you install VSHIK, it silently deploys the Microsoft Help 2.0 SDK (typically located in your Program Files directory), which provides three core command-line executables required for the integration pipeline:
hxconv.exe (The Converter): Converts legacy HTML Help 1.x (.chm) files into a collection of uncompiled MS Help 2.0 XML project files.
hxcomp.exe (The Compiler): Compiles your XML source project files into a final, monolithic .hxs help file.
hxreg.exe (The Register): Registers your compiled help title into the local Visual Studio Combined Collection (VSCC) so it shows up natively in the IDE’s help windows. 📋 Step-by-Step Pipeline to Use VSHIK Effectively
To manually process and integrate documentation into an older Visual Studio environment, follow this technical pipeline: 1. Convert an Existing Help File
If you already have a compiled .chm file from an external documentation engine, run the converter to break it down into an MS Help 2.0 schema structure: hxconv -o output_directory my_legacy_help.chm Use code with caution.
This generates standard configuration and project index files such as .HxC (Collection), .HxF (File list), and .HxK (Index). 2. Compile the Project into .hxs
Target the main collection file (.HxC) generated in the previous step using the compiler utility: hxcomp -p output_directory\my_legacy_help.HxC Use code with caution.
Note: Ensure all underlying image, style, and XHTML topic assets remain relative to the configuration file, or the compiler will output broken references. 3. Register the Collection Internally
To hook your newly compiled help file directly into the Visual Studio / MSDN Library table of contents, use the local registration tool:
hxreg -n “MyCompany.MyProduct.Help” -c “VS.MSDNExpress.1033” -f my_legacy_help.hxs Use code with caution. ⚠️ Critical Best Practices & Practical Realities
Leave a Reply