packagethis Wiki & Documentation Rss Feed

Updated Wiki: MSHC Install Dialog

helpware — Mon, 22 Oct 2012 16:51:39 GMT

Install Mshc Help File dialog

This dialog allows you to install your newly created .mshc help into an existing help collection.

.MSHA File

When PackageThis creates a .mshc help file it also creates a matching .msha (install manifest) file. The .msha file is passed to the Help Manager application to install our .mshc help file. Click the browse button to select the desired .msha file.

Note: You will also find a duplicate .msha file called "HelpContentSetup.msha" as Help Viewer 1.0 (VS 2010 RTM with no service pack) requires this fixed name. Using any other name will cause install to fail.

Help Viewer 1.x

Select this option to install into VS 2010 RTM (HV 1.0) or VS 2010 SP1 (HV 1.1) help.

The VS 2010 help catalog is identified by the Product/Version/Locale combination of "vs/100/en-US" (your help system may be non-English and use a different locale). The Reset button will return you to the default values should you forget them.

Help Viewer 2.x

Select this option to install into VS 2012 help.

The VS 2012 help catalog is identified by the Catalog/Locale combination of "VisualStudio11/en-US" (your help system may be non-English and use a different locale). The Reset button will return you to the default values should you forget them.

Open Help Manager link

Click this link to open the selected Help Manager (see Target Help Catalog radio buttons). You may want to do this to uninstalled an older version of help. Or see what help is currently installed.

Install Button

Installs your help into the target help collection.

For HV 1.x we pass the .msha file and parameters to
c:\program files\Microsoft Help Viewer\v1.0\HelpLibManager.exe

For HV 2.x we pass the .msha file and parameters to
c:\program files\Microsoft Help Viewer\v2.0\HlpCtntMgr.exe

Note that HV 2.x runs help installs in the background. You will see a message in the Windows taskbar tray when the help installation has completed. You can also monitor the install by opening the HV 2.x help manager UI (in VS 2012 Help Viewer).

Notes:

Before installing help you must first uninstall any old help. Otherwise help appears to install OK but the new changes are not visible.
When installing help that does not match the current Visual Studio help locale you must first do some work. See also:
- Language and Branding
- Language Packs for Help Viewer 1.x

Updated Wiki: MSHC Install Dialog

helpware — Fri, 19 Oct 2012 03:25:05 GMT

Install Mshc Help File dialog

This dialog allows you to install your newly created .mshc help into an existing help collection.

.MSHA File

Help Viewer 1.x

Help Viewer 2.x

Open Help Manager link

Click this link to open the selected Help Manager (see Target Help Catalog radio buttons). You may want to do this to uninstalled an older version of help. Or see what help is currently installed.

Install Button

Notes:

Before installing help you must first uninstall any old help. Otherwise help appears to install OK but the new changes are not visible.
When installing help that does not match the current Visual Studio help locale you must first do some work. See also:
- Language and Branding
- Language Packs for Help Viewer 1.x

Updated Wiki: MSHC Export Dialog

helpware — Fri, 19 Oct 2012 03:24:50 GMT

Export to Mshc File dialog

Enter the required fields and click OK to package (zip) all downloaded files to a .mshc help file (this is the help file format for Visual Studio 2010 & 2012). We also create the associated .msha (install manifest) file which can be used later to install the help on a PC.

Note: Once export is finished you will find a duplicate .msha file called "HelpContentSetup.msha" since Help Viewer 1.0 (VS 2010 RTM with no service pack) requires this fixed name. Using any other name will cause your help install to fail.

Mshc File

Click the "browse" button to enter a name and directory for the output .mshc help file.

Vendor Name

Help packages are stored internally in the help store under this name and is required for installing and uninstalling a help package. Do not use the reserved name "Microsoft" otherwise your help package will require signing to install.

Product Name & Book Name

Both Product name and Book name will be displayed in Help Manager when you install and uninstall help.

Root Topic Title Suffix

This will make your new package easier to locate in the TOC. When set, the root topic(s) of the new .mshc help packaged will have its topic TOC title appended with this text.

Root Topic Parent

This defaults to "-1" (if left blank) which lets your package parent into the root of the VS Table of Contents. To parent under another TOC node, enter the ID of that node (use the topic's "Microsoft.Help.Id" meta tag).

Warning: Your package topics may not appear in the VS Table of Contents (TOC)...

If the specified parent topic ID does not exist in the target collection
If the parent topic contains a different TopicVersion (see Topic Version below)

Topic Version

Set a Topic Version number to stamp all files. This will allow all topics to show correctly in the Table of Contents.

Every topic contains a TopicVersion meta tag
eg. . Help topics from different versions of help (eg. Blend 3 and Blend 4) may have duplicate help IDs (meta tag "Microsoft.Help.Id"), and the TopicVersion tag helps keep the different versions separate. Unfortunately if there is a mixture of TopicVersion tags across the topics in the help package you will find that topics may be not show in the TOC. To fix this we overriding the TopicVersion of all topics and recommend you parent the help package in the root of the TOC (TocParent="-1").

Updated Wiki: MSHC Export Dialog

helpware — Fri, 19 Oct 2012 03:24:10 GMT

Export to Mshc File dialog

Enter the required fields and click OK to package (zip) all downloaded files to a .mshc help file (this is the help file format for Visual Studio 2010 & 2012). We also create the associated .msha (install manifest) file which can be used later to install the help on a PC.

Note: Once export is finished you will find a duplicate .msha file called "HelpContentSetup.msha" since Help Viewer 1.0 (VS 2012 RTM with no service pack) requires this fixed name. Using any other name will cause your help install to fail.

Mshc File

Click the "browse" button to enter a name and directory for the output .mshc help file.

Vendor Name

Product Name & Book Name

Both Product name and Book name will be displayed in Help Manager when you install and uninstall help.

Root Topic Title Suffix

This will make your new package easier to locate in the TOC. When set, the root topic(s) of the new .mshc help packaged will have its topic TOC title appended with this text.

Root Topic Parent

If the specified parent topic ID does not exist in the target collection
If the parent topic contains a different TopicVersion (see Topic Version below)

Topic Version

Updated Wiki: MSHC Install Dialog

helpware — Fri, 19 Oct 2012 03:21:50 GMT

Install Mshc Help File dialog

This dialog allows you to install your newly created .mshc help into an existing help collection.

.MSHA File

When PackageThis creates a .mshc help file it also creates a matching .msha (install manifest) file. The .msha file is passed to the Help Manager application to install our .mshc help file. Click the browse button to select the desired .msha file.

Note: You will also find a duplicate .msha file called "HelpContentSetup.msha" as Help Viewer 1.0 (VS 2012 RTM with no service pack) requires this fixed name. Using any other name will cause install to fail.

Help Viewer 1.x

Help Viewer 2.x

Open Help Manager link

Click this link to open the selected Help Manager (see Target Help Catalog radio buttons). You may want to do this to uninstalled an older version of help. Or see what help is currently installed.

Install Button

Notes:

Before installing help you must first uninstall any old help. Otherwise help appears to install OK but the new changes are not visible.
When installing help that does not match the current Visual Studio help locale you must first do some work. See also:
- Language and Branding
- Language Packs for Help Viewer 1.x

Updated Wiki: MSHC Export Dialog

helpware — Fri, 19 Oct 2012 03:20:56 GMT

Export to Mshc File dialog

Enter the required fields and click OK to package (zip) all downloaded files to a .mshc help file (this is the help file format for Visual Studio 2010 "VS version 10" and above). We also create the associated .msha (install manifest) file which can be used later to install the help on a PC.

Mshc File

Click the "browse" button to enter a name and directory for the output .mshc help file.

Vendor Name

Product Name & Book Name

Both Product name and Book name will be displayed in Help Manager when you install and uninstall help.

Root Topic Title Suffix

This will make your new package easier to locate in the TOC. When set, the root topic(s) of the new .mshc help packaged will have its topic TOC title appended with this text.

Root Topic Parent

If the specified parent topic ID does not exist in the target collection
If the parent topic contains a different TopicVersion (see Topic Version below)

Topic Version

Updated Wiki: MSHC Export Dialog

helpware — Fri, 19 Oct 2012 03:19:40 GMT

Export to Mshc File dialog

Enter the required fields and click OK to package (zip) all downloaded files to a .mshc help file (this is the help file format for Visual Studio 2010 "VS version 10" and above). We also tweak a few files and create the associated .msha (install manifest) file which can be used later to install the help file into a collection.

Mshc File

Click the "browse" button to enter a name and directory for the output .mshc help file.

Vendor Name

Product Name & Book Name

Both Product name and Book name will be displayed in Help Manager when you install and uninstall help.

Root Topic Title Suffix

This will make your new package easier to locate in the TOC. When set, the root topic(s) of the new .mshc help packaged will have its topic TOC title appended with this text.

Root Topic Parent

If the specified parent topic ID does not exist in the target collection
If the parent topic contains a different TopicVersion (see Topic Version below)

Topic Version

Updated Wiki: MSHC Export Dialog

helpware — Fri, 19 Oct 2012 03:18:48 GMT

Export to Mshc File dialog

Enter the required fields and click OK to package (zip) all downloaded files to a .mshc help file (this is the help file format for Visual Studio 2010 "VS version 10" and above). We also tweak a few settings and create the associated .msha (install manifest) file which is used to install the help file into a collection.

Mshc File

Click the "browse" button to enter a name and directory for the output .mshc help file.

Vendor Name

Product Name & Book Name

Both Product name and Book name will be displayed in Help Manager when you install and uninstall help.

Root Topic Title Suffix

This will make your new package easier to locate in the TOC. When set, the root topic(s) of the new .mshc help packaged will have its topic TOC title appended with this text.

Root Topic Parent

If the specified parent topic ID does not exist in the target collection
If the parent topic contains a different TopicVersion (see Topic Version below)

Topic Version

Updated Wiki: MSHC Install Dialog

helpware — Fri, 19 Oct 2012 03:16:15 GMT

Install Mshc Help File dialog

This dialog allows you to install your newly created .mshc help into an existing help collection.

.MSHA File

Note: When PackageThis creates a .mshc help file it also creates a matching .msha (install manifest) file. The .msha file is passed to the Help Manager application to install our .mshc help file. Click the browse button to select the desired .msha file.

Note: You will also find a duplicate .msha file called "HelpContentSetup.msha" as Help Viewer 1.0 (VS 2012 RTM with no service pack) requires this fixed name. Using any other name will cause install to fail.

Help Viewer 1.x

Help Viewer 2.x

Open Help Manager link

Click this link to open the selected Help Manager (see Target Help Catalog radio buttons). You may want to do this to uninstalled an older version of help. Or see what help is currently installed.

Install Button

Notes:

Before installing help you must first uninstall any old help. Otherwise help appears to install OK but the new changes are not visible.
When installing help that does not match the current Visual Studio help locale you must first do some work. See also:
- Language and Branding
- Language Packs for Help Viewer 1.x

Updated Wiki: MSHC Install Dialog

helpware — Fri, 19 Oct 2012 03:15:02 GMT

Install Mshc Help File dialog

This dialog allows you to install your newly created .mshc help into an existing help collection.

.MSHA File

Help Viewer 1.x

Help Viewer 2.x

Open Help Manager link

Click this link to open the selected Help Manager (see Target Help Catalog radio buttons). You may want to do this to uninstalled an older version of help. Or see what help is currently installed.

Install Button

Notes:

Before installing help you must first uninstall any old help. Otherwise help appears to install OK but the new changes are not visible.
When installing help that does not match the current Visual Studio help locale you must first do some work. See also:
- Language and Branding
- Language Packs for Help Viewer 1.x

Updated Wiki: MSHC Install Dialog

helpware — Fri, 19 Oct 2012 03:14:20 GMT

Install Mshc Help File dialog

This dialog allows you to install your newly created .mshc help into an existing help collection.

.MSHA File

Note: When PackageThis creates a .mshc help file it also creates a matching .msha file (manifest install file). The .msha file is passed to the Help Manager application to install our .mshc help file. Click the browse button to select the desired .msha file.

Note: You will also find a duplicate .msha file called "HelpContentSetup.msha" as Help Viewer 1.0 (VS 2012 RTM with no service pack) requires this fixed name. Using any other name will cause install to fail.

Help Viewer 1.x

Help Viewer 2.x

Open Help Manager link

Click this link to open the selected Help Manager (see Target Help Catalog radio buttons). You may want to do this to uninstalled an older version of help. Or see what help is currently installed.

Install Button

Notes:

Before installing help you must first uninstall any old help. Otherwise help appears to install OK but the new changes are not visible.
When installing help that does not match the current Visual Studio help locale you must first do some work. See also:
- Language and Branding
- Language Packs for Help Viewer 1.x

Updated Wiki: MSHC Install Dialog

helpware — Fri, 19 Oct 2012 03:13:36 GMT

Install Mshc Help File dialog

This dialog allows you to install your newly created .mshc help into an existing help collection.

.MSHA File

Note when PackageThis creates a .mshc help file it also creates a matching .msha file (manifest install file). The .msha file is passed to the Help Manager application to install our .mshc help file. Click the browse button to select the desired .msha file.

Note: You will also find a duplicate .msha file called "HelpContentSetup.msha" as Help Viewer 1.0 (VS 2012 RTM with no service pack) requires this fixed name. Using any other name will cause install to fail.

Help Viewer 1.x

Help Viewer 2.x

Open Help Manager link

Click this link to open the selected Help Manager (see Target Help Catalog radio buttons). You may want to do this to uninstalled an older version of help. Or see what help is currently installed.

Install Button

Notes:

Before installing help you must first uninstall any old help. Otherwise help appears to install OK but the new changes are not visible.
When installing help that does not match the current Visual Studio help locale you must first do some work. See also:
- Language and Branding
- Language Packs for Help Viewer 1.x

Updated Wiki: MSHC Install Dialog

helpware — Fri, 19 Oct 2012 03:13:09 GMT

Install Mshc Help File dialog

This dialog allows you to install your newly created .mshc help into an existing help collection.

.MSHA File

Help Viewer 1.x

Help Viewer 2.x

Open Help Manager link

Click this link to open the selected Help Manager (see Target Help Catalog radio buttons). You may want to do this to uninstalled an older version of help. Or see what help is currently installed.

Install Button

Notes:

Before installing help you must first uninstall any old help. Otherwise help appears to install OK but the new changes are not visible.
When installing help that does not match the current Visual Studio help locale you must first do some work. See also:
- Language and Branding
- Language Packs for Help Viewer 1.x

Updated Wiki: MSHC Install Dialog

helpware — Fri, 19 Oct 2012 03:12:23 GMT

Install Mshc Help File dialog

This dialog allows you to install your newly created .mshc help into an existing help collection.

.MSHA File

Help Viewer 1.x

Help Viewer 2.x

Open Help Manager link

Click this link to open the selected Help Manager (see Target Help Catalog radio buttons). You may want to do this to uninstalled an older version of help. Or see what help is currently installed.

Install Button

Installs your help into the target help collection.

For HV 1.x we pass the .msha file and parameters to
c:\program files\Microsoft Help Viewer\v1.0\HelpLibManager.exe

For HV 2.x we run
c:\program files\Microsoft Help Viewer\v2.0\HlpCtntMgr.exe

Note that HV 2.x runs help installs in the background. You will see a message in the Windows taskbar tray when the help installation has completed. You can also monitor the install by opening the HV 2.x help manage UI (in VS 2012 Help Viewer).

Notes:

Before installing help you must first uninstall any old help. Otherwise help appears to install OK but the new changes are not visible.
When installing help that does not match the current Visual Studio help locale you must first do some work. See also:
- Language and Branding
- Language Packs for Help Viewer 1.x

Updated Wiki: MSHC Install Dialog

helpware — Fri, 19 Oct 2012 03:10:25 GMT

Install Mshc Help File dialog

This dialog allows you to install your newly created .mshc help into an existing help collection.

.MSHA File

Help Viewer 1.x

Help Viewer 2.x

Open Help Manager link

Click this link to open the selected Help Manager (see Target Help Catalog radio buttons). You may want to do this to uninstalled an older version of help. Or see what help is currently installed.

Install Button

For HV 1.x we pass the .msha file and parameters to
c:\program files\Microsoft Help Viewer\v1.0\HelpLibManager.exe

For HV 2.x we run
c:\program files\Microsoft Help Viewer\v2.0\HlpCtntMgr.exe

Note that HV 2.x runs help installs in the background. You will see a message in the Windows taskbar tray when the help installation has completed. You can also monitor the install by opening the HV 2.x help manage UI (in VS 2012 Help Viewer).

Notes:

Before installing help you must first uninstall any old help. Otherwise help appears to install OK but the new changes are not visible.
When installing help that does not match the current Visual Studio help locale you must first do some work. See also:
- Language and Branding
- Language Packs for Help Viewer 1.x

Updated Wiki: MSHC Install Dialog

helpware — Fri, 19 Oct 2012 03:05:10 GMT

Install Mshc Help File dialog

This dialog allows you to install your newly created .mshc help into an existing help collection.

.MSHA File

Help Viewer 1.x

Help Viewer 2.x

Open Help Manager link

Click this link to open the selected Help Manager (see Target Help Catalog radio buttons). You may want to do this to uninstalled an older version of help. Or see what help is currently installed.

Install Button

For HV 1.x we pass the .msha file and parameters to
c:\program files\Microsoft Help Viewer\v1.0\HelpLibManager.exe

For HV 2.x we run
c:\program files\Microsoft Help Viewer\v2.0\HlpCtntMgr.exe

Notes:

Before installing help you must first uninstall any old help. Otherwise help appears to install OK but the new changes are not visible.
When installing help that does not match the current Visual Studio help locale you must first do some work. See also:
- Language and Branding
- Language Packs for Help Viewer 1.x

Updated Wiki: MSHC Install Dialog

helpware — Fri, 19 Oct 2012 03:03:33 GMT

Install Mshc Help File dialog

This dialog allows you to install your newly created .mshc help into an existing help collection.

.MSHA File

Help Viewer 1.x

Help Viewer 2.x

Open Help Manager link

Click this link to open the selected Help Manager (see Target Help System radio buttons). You may want to do this to uninstalled an older version of help. Or view what help is currently installed.

Install Button

For HV 1.x we pass the .msha file and parameters to
c:\program files\Microsoft Help Viewer\v1.0\HelpLibManager.exe

For HV 2.x we run
c:\program files\Microsoft Help Viewer\v2.0\HlpCtntMgr.exe

Notes:

Before installing help you must first uninstall any old help. Otherwise help appears to install OK but the new changes are not visible.
When installing help that does not match the current Visual Studio help locale you must first do some work. See also:
- Language and Branding
- Language Packs for Help Viewer 1.x

Updated Wiki: MSHC Install Dialog

helpware — Fri, 19 Oct 2012 03:02:18 GMT

Install Mshc Help File dialog

This dialog allows you to install your newly created .mshc help into an existing help collection.

.MSHA File

Help Viewer 1.x

Help Viewer 2.x

Open Help Manager link

Click this link to open the help manager selected (see Target Help System radio buttons). You may want to do this to uninstalled an older version of help. Or see what's currently installed.

Install Button

For HV 1.x we pass the .msha file and parameters to
c:\program files\Microsoft Help Viewer\v1.0\HelpLibManager.exe

For HV 2.x we run
c:\program files\Microsoft Help Viewer\v2.0\HlpCtntMgr.exe

Notes:

Before installing help you must first uninstall any old help. Otherwise help appears to install OK but the new changes are not visible.
When installing help that does not match the current Visual Studio help locale you must first do some work. See also:
- Language and Branding
- Language Packs for Help Viewer 1.x

Updated Wiki: MSHC Install Dialog

helpware — Fri, 19 Oct 2012 02:59:56 GMT

Install Mshc Help File dialog

This dialog allows you to install your newly created .mshc help into an existing help collection.

.MSHA File

Help Viewer 1.x

Help Viewer 2.x

Open Help Manager link

Click this link to open the help manager selected (see radio button selection). You may want to do this especially if an old needs to be uninstalled before proceeding.

Install Button

For HV 1.x we pass the .msha file and parameters to
c:\program files\Microsoft Help Viewer\v1.0\HelpLibManager.exe

For HV 2.x we run
c:\program files\Microsoft Help Viewer\v2.0\HlpCtntMgr.exe

Notes:

Before installing help you must first uninstall any old help. Otherwise help appears to install OK but the new changes are not visible.
When installing help that does not match the current Visual Studio help locale you must first do some work. See also:
- Language and Branding
- Language Packs for Help Viewer 1.x

Updated Wiki: MSHC Install Dialog

helpware — Fri, 19 Oct 2012 02:57:58 GMT

Install Mshc Help File dialog

This dialog allows you to install your newly created .mshc help into an existing help collection.

.MSHA File

Help Viewer 1.x

Help Viewer 2.x

Install Button

For HV 1.x we pass the .msha file and parameters to
c:\program files\Microsoft Help Viewer\v1.0\HelpLibManager.exe

For HV 2.x we run
c:\program files\Microsoft Help Viewer\v2.0\HlpCtntMgr.exe

Notes:

Before installing help you must first uninstall any old help. Otherwise help appears to install OK but the new changes are not visible.
When installing help that does not match the current Visual Studio help locale you must first do some work. See also:
- Language and Branding
- Language Packs for Help Viewer 1.x