This is a copy of the Readme file that ships with Help Viewer 1.1 (VS 2010 SP1). I've included it in the wiki so that it is searchable on the web. It contains a lot of useful information. The file is normally located in the following location:
C:\Program Files\Microsoft Help Viewer\v1.0\ReadMe_ENG.htm
Help Viewer 1.1 Readme
Table of Contents
- 1.0 Introduction
- 1.1 Obtaining Microsoft Help Viewer 1.1
- 2.0 Setup and Removal
- 2.1 Installing Microsoft Help Viewer 1.1
- 2.3 Uninstalling Microsoft Help Viewer 1.1
- 2.4 Supported Operating Systems and Platforms
- 3.0 Managing Help settings and Installing Content
- 4.0 Known Issues
- 5.0 Getting Assistance and Providing Feedback
Microsoft® Help Viewer 1.1 is a product help platform.
1.1 Obtaining Microsoft Help Viewer 1.1
Microsoft Help Viewer 1.1 is not a standalone release. This product is obtained with various Microsoft products.
2.0 Setup and Removal
2.1 Installing Microsoft Help Viewer 1.1
Microsoft Help Viewer 1.1 is not a standalone release. This product is installed with various Microsoft products.
2.2 Uninstalling Microsoft Help Viewer 1.1
To uninstall Microsoft Help Viewer 1.1, go to Control Panel, click either Add/Remove Programs or Programs and Features and locate the entry for Microsoft Help Viewer 1.1. Click Remove or Uninstall.
2.3 Supported Operating Systems and Platforms
This release of Microsoft Help Viewer 1.1 and Visual Studio 2010 Product Documentation supports the following:
Supported Windows Operating Systems
- Microsoft Windows® XP Professional SP3
- Microsoft Windows Server® 2003 SP2
- Microsoft Windows Server® 2008 SP2
- Microsoft Windows Vista® SP2
- Microsoft Windows® 7 RTM
- Microsoft Windows Server® 2008 R2 RTM
Supported Web Browsers
- Microsoft Internet Explorer® 6.01
- Microsoft Internet Explorer® 7.0
- Microsoft Internet Explorer® 8.0
3.0 Managing Help Settings and Installing Content
You can use the Help Library Manager (HLM) to set your preference to online help or offline help.
The name of the file that HLM uses to install content is HelpContentSetup.msha. This is an HTML file that identifies help content that can be installed locally.
To find and install help content from media:
||Launch Help Library Manager by clicking Start, All Programs, Microsoft Visual Studio 2010, Visual Studio Tools, Manage Help Settings.
||Click "Install content from disk".
||Navigate to the directory that contains the content setup file (HelpContentSetup.msha).
||Select the file and click "OK". The next screen shows the content available on the media, and any content that is already installed.
||Select the content to install by clicking "Add" next to the content title. When you are finished selecting content to install, click "Update" at the bottom of the screen.
4.0 Known Issues
||Uninstalling Help Viewer 1.1 will not restore Help Viewer 1.0.
||Uninstalling Help Viewer 1.1 will not remove content from your machine. Run Help Library Manager to remove content before removing Help Viewer 1.1.
||The product documentation shortcut will not work after you uninstall Help Viewer 1.1.
||Help Library Manager requires the BITS service to be running if you want to use the “Check for updates online” or “Install content from online” features. Removing content and installing content locally does not require the BITS service.
||Help Library Manager will hang if you attempt to install offline content when there is insufficient disk space for the BITS service to download the content.
||If port 47873 is used by another process (not via the http.sys service), the Help Library Agent will not be able to attach and use that port and will fail. You can change the port number by adding the string registry valueAgentPort under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Help\v1.0 with the value of the port to use (for example, 81). Because of the http.sys ACL settings, you must run the following http.sys configuration command from an administrator-elevated command line. On Vista, Windows 2003, and Windows 7 run the following command:
netsh http add urlacl url=http://127.0.0.1:<port number>/help/ sddl=D:(A;;GX;;;WD)
On Windows XP and Windows 2003 run the following command:
httpcfg set urlacl /u http://127.0.0.1:<port number>/help/ /a D:(A;;GX;;;WD)
If the command is not found, you may have to download httpcfg.exe from Microsoft as part of the Windows XP Service Pack 3 Support Tools (http://go.microsoft.com/fwlink/?LinkId=206681).
Now the Help Library Agent will run on the selected port number.
||In Control Panel, Add/Remove Programs, selecting the Repair option may cause Help Library Manager to display an error if the help documentation was originally installed somewhere other than the default location. To work around this error, browse to helplibmanager.exe.config (C:\Program Files\Microsoft Help Viewer\v1.0\), open helplibmanager.exe.config (in Notepad), and change key="FirstTimeRun" value="False" to key="FirstTimeRun" value="True". The next time you run Help Library Manager, it will prompt for a folder path to store documents.
||Power Tool for the Help Viewer is not supported for the Help Viewer v1.1 in Visual Studio 2010 SP1.
- Under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Help\v1.0 create a registry key with the name IPv6 and a value of 1 (DWORD(32 bit))
- Set the security ACLs for the port for IPv6 by running the following command from an administrator-elevated command prompt:
netsh http add urlacl url=http://[::1]:47873/help/ sddl=D:(A;;GX;;;WD)
||When content is updated or added, the Local Help Viewer has to be restarted in order for the table of contents to render the updated content.
5.0 Getting Assistance and Providing Feedback
To get assistance or provide feedback on Microsoft Help Viewer 1.1, please use the MSDN online forums. Check the Visual Studio 2010 documentation for more information.