Introduction to InnovaHxReg

In This Topic

InnovaHxReg is a command line utility that allows you to register Microsoft Help 2.x Namespaces, Files and PlugIns. Without a tool such as InnovaHxReg Microsoft Help 2.x Namespaces and Files must be registered manually by creating a set of custom merge modules.

InnovaHxReg is dependency free so can easily be shipped as part of a setup kit. You do not need to distribute any other files to use InnovaHxReg. However, in order for InnovaHxReg to make use of the Microsoft Help 2.x API, you need to run it on a machine with the Microsoft Help 2.x API installed. This means a machine with Visual Studio or a recent edition of MSDN.

InnovaHxReg.exe is located in the bin sub-folder below your main Innovasys installation folder, for example C:\Program Files\Innovasys\DocumentX2010\bin.

Document! X automatically generates 2 batch files; RegisterHelp2.bat and UnRegisterHelp2.bat as part of every build. The files are created in the same directory as the .hxs. These batch files contain the InnovaHxReg commands necessary to register the generated Help System. You can edit the batch files to customize integration with Visual Studio 2002, 2003, 2005 or 2008.

Example of using InnovaHxReg to register a Help 2.x help file

If you have a HXS file or HXC file created by Document! X you can use the InnovaHxReg commands below to register the help collection and file and plug it in to the Visual Studio help collection.

Replace MyNamespace and FileID with the Namespace and File ID values you specified in the Build Profile.

The Namespace and File ID values you provide to InnovaHxReg must match the values you specified in the Build Profile for the help file you are trying to register.

Replace Collectionfilename and HXSFileName with the appropriate filenames (e.g. COL_MyProject.hxc and COL_MyProject.hxs).

Document! X generates several .hxc collection files. The file you must pass to InnovaHxReg (CollectionFilename.hxc) is the .hxc file generated by Document! X that begins with COL_.

Example Help 2.x Registration Script	Copy Code
REM Register the Microsoft Help 2.x namespace by passing the COL_ filenameREM If you are not going to plug your Microsoft Help 2.x Help System intoREM Visual Studio, you can register your main .hxc fileREM instead (e.g. /Collection:MyHelpSystem.hxc) InnovaHxReg /R /N /Namespace:MyNamespace /Description:"My Namespace" /Collection:COL_MyHelpSystem.hxc REM Register the help file (title in Microsoft Help 2.x terminology) InnovaHxReg /R /T /namespace:MyNamespace /id:MyFileID /langid:1033 /helpfile:MyHelpSystem.hxs REM For Visual Studio integration InnovaHxReg /R /P /productnamespace:MS.VSCC /producthxt:_DEFAULT /namespace:MyNamespace /hxt:_DEFAULT REM For Visual Studio.2003 integration InnovaHxReg /R /P /productnamespace:MS.VSCC.2003 /producthxt:_DEFAULT /namespace:MyNamespace /hxt:_DEFAULT REM For Visual Studio.2005 integration InnovaHxReg /R /P /productnamespace:MS.VSIPCC.v80 /producthxt:_DEFAULT /namespace:MyNamespace /hxt:_DEFAULT REM For Visual Studio.2008 integration InnovaHxReg /R /P /productnamespace:MS.VSIPCC.v90 /producthxt:_DEFAULT /namespace:MyNamespace /hxt:_DEFAULT

Example Help 2.x Registration Script

Copy Code

REM Register the Microsoft Help 2.x namespace by passing the COL_ filenameREM If you are not going to plug your Microsoft Help 2.x Help System intoREM  Visual Studio, you can register your main .hxc fileREM  instead (e.g. /Collection:MyHelpSystem.hxc)

InnovaHxReg /R /N /Namespace:MyNamespace /Description:"My Namespace" /Collection:COL_MyHelpSystem.hxc

REM Register the help file (title in Microsoft Help 2.x terminology)

InnovaHxReg /R /T /namespace:MyNamespace /id:MyFileID /langid:1033 /helpfile:MyHelpSystem.hxs

REM For Visual Studio integration

InnovaHxReg /R /P /productnamespace:MS.VSCC /producthxt:_DEFAULT /namespace:MyNamespace /hxt:_DEFAULT

REM For Visual Studio.2003 integration

InnovaHxReg /R /P /productnamespace:MS.VSCC.2003 /producthxt:_DEFAULT /namespace:MyNamespace /hxt:_DEFAULT

REM For Visual Studio.2005 integration

InnovaHxReg /R /P /productnamespace:MS.VSIPCC.v80 /producthxt:_DEFAULT /namespace:MyNamespace /hxt:_DEFAULT

REM For Visual Studio.2008 integration

InnovaHxReg /R /P /productnamespace:MS.VSIPCC.v90 /producthxt:_DEFAULT /namespace:MyNamespace /hxt:_DEFAULT

Send Feedback