mshcMigrate.exe

The mshcMigrate utility was developed by The Helpware Group in partnership with Microsoft and allows you to migrate older help content (MS Help 2 and MS HTML Help 1.x) to MS Help Viewer format (.mshc) used by VS 2010/2012/+ and Windows 8.  

Inputs
Migrates both HTML Help & MS Help 2 to Help Viewer format. Converts projects files (.hxc, .hhp) & compiled help files (.hxs, .chm), as well as help source folders. 

Outputs 
Outputs include .mshc & .cab help package files as well as the .msha manifest file. 

Other Features
The application includes several additional tools that allows you to test, install/uninstall, view the HelpLibManager output log, perform API calls, and explore the help library data store. The utility can also be operated in batch mode for overnight builds and command line operation.

Part of FAR HTML 
The utility is part of Helpware's FAR HTML v5 product set which provides advanced meta tag editing and TOC/Index editing for MS Help Viewer projects. MshcMigrate can also be downloaded and licensed separately (see licensing section below).


Migrate features include:
  • Outputs to both .mshc and .cab help file formats.
  • Includes a .mshi Index file into the .cab if available.
  • Generates a .msha manifest file for installing.
  • Batch mode for unattended operation.
  • Rezip (Update) any folder to a .mshc help file.
What does migrate do?
  • Converts Index and TOC files to topic meta tags.
  • Converts embedded topic tags to topic meta tags.
  • Converts topic HTML source to the required XHTML format.
  • Converts link paths to topics, images, CSS & JS files.
  • Implements required MS Help Viewer 1.0 work-a-rounds using a smart JavaScript include file.
  • Allows you to use Visual Studio branding or use your own JS and CSS via the SelfBranded meta tag.
Additional features include:
  • Manifest page: Create a .msha manifest file using one or multiple help files. Required for installation.
  • Help Library Manager page: Run the HLM application. Shows the various command line options. 
  • View the HLM event log and get notifications as errors are logged.
  • Help Library Agent page: Test the various MS Help Viewer API calls. Test your help. A powerful aid for both authors and programmers.
  • Help Library Store page: This page rips through the meta data in the Help library data store and displays the content and location of all help packages installed on your PC. You can also view the source and decompile help files.
VS 10 Help vs VS 11 Help
  • The .mshc help format is the same for VS 10 and VS 11 (VS 2010 and VS 2012). So the core migration code has not needed to change moving to VS 2012 (VS 11) and beyond.
  • The help run-time executables and catalog store are now different in VS 2012 (VS 11), so the latest version of mshcMigrate now let's you select between HV 1 (VS 10 help) and HV 2 (VS 11 help) when registering or viewing help.

Further Information

Detailed information on MS Help Viewer 1.0 can be found on our Helpware web site
Keeping up to date:

Read Me First

There are several annoying problems in MS Help Viewer 1.0. Help Viewer 2.0 should be better. We've list some of the problems in the Help 1.0 Notebook page

System requirements

  • Windows XP or greater. 
  • .HxS Migrate + decompile requires MS Help 2 (ie. VS 2002/2003/2005/2008 installed).
  • .NET Framework 2.0

Download

Please download mshcMigrate.exe from Visual Studio Gallery.

     
       Current Version: 30-June-2011, 1.1 Build 67 -- See Change Notes


If you like mshcMigrate please leave a Rating or Review. If not, tell us why so we can fix it.

      


Beta drops. Try new features. Grab the Beta from the end of this page.

Licensing

Commercial use of this software requires that you purchase a license to help support this project.

This migrate utility is free: for non-profit organizations; for evaluation purposes; for experimenting; and as a learning aid; 

Purchasing a license gives you email support for when you get stuck; Encourages us to keep the tool up to date as new versions of VS help come out; and removes a nag screen from showing.

Note that customers who own a copy of FAR HTML v5 are already licensed. If you are a licensed FAR HTML 5 user and have FAR 5 installed then the mshcMigrate about box will say "licensed". 

The license is a "per user" license. So if user X owns a FAR HTML v5 license, then user X may install FAR and mshcMigrate on multiple machines and concurrently run all copies. If you own a team, site or world license then sharing is not an issue.

Please contact us if you need assistance.

Support

If you own a mhcMigrate license, or a copy of FAR HTML v5 then you may contact us directly for support. Please try the public support groups first if possible.

Support Groups

Helpware, MS Help MVPs and Microsoft help team monitor the following discussion groups:

MSHelpViewer Yahoo Discussion Group 
- Community group of VS 2010 help integrators. Run by MVPs, with MS presence.

MSDN Forums > VS General 
- The official MSDN discussion group for help has been discontinued. MS suggest posting in the VS General.

Contact Us




Č
ċ
mshcMigrate_Setup_061a.zip
(1139k)
Robert Chandler,
Jul 8, 2010, 10:06 AM
ċ
mshcMigrate_Setup_062.zip
(1153k)
Robert Chandler,
Apr 19, 2011, 1:15 AM
ċ
mshcMigrate_Setup_064.zip
(1153k)
Robert Chandler,
May 29, 2011, 8:25 AM
ċ
mshcMigrate_Setup_066.zip
(1153k)
Robert Chandler,
Jun 13, 2011, 4:55 AM
ċ
mshcMigrate_Setup_067.zip
(1315k)
Robert Chandler,
Aug 29, 2011, 3:41 PM
ċ
Robert Chandler,
Jul 27, 2012, 6:28 PM
ċ
Robert Chandler,
Mar 14, 2013, 1:45 AM