Microsoft Help Viewer 2.0 is now available as part of Visual Studio 2012. With this release of the Help Viewer, our goal was to deliver a fast, simple and highly productive reference experience while making it easier to discover and manage local help content.
- If you are a current/former Document Explorer user, you’ll find that this new Help Viewer is faster, provides fresher content and eliminates the dreaded first-time F1 penalty.
- If you currently use Help Viewer 1.x, you’ll benefit from integrated content management and productivity improvements to search, TOC and the keyword index.
- If you use the online MSDN Library exclusively, I encourage you to try out the Help Viewer. It provides several features not available in the online MSDN Library, notably the keyword index and the TOC filter. Many developers appreciate the productivity benefits of the Help Viewer index when looking up familiar APIs.
Before I discuss the new features in Help Viewer 2.0, I should point out that MSDN documentation is not installed by VS 2012. Use the Manage Content tab in Help Viewer to select and download documentation for local use. If your development machine doesn’t have access to the internet, you can create an install disk or order a documentation DVD.
In addition, with this final, RTM release we’ve made some improvements to the behavior of Help Viewer if the content you need is *not* locally available. Read on.
Cool New Feature: Redirect-to-Web
A new feature of Help Viewer that I haven’t discussed previously is “Redirect-to-Web.”
We can’t eliminate hyperlinks between books when we package content for offline use. Unless all MSDN content is installed, developers will inevitably click on a link to a topic that’s not locally available. When that happens, Help Viewer 1.x automatically displays its equivalent of a 404 message: Topic Not Found.
However, when Help Viewer 2.0 hits a link that’s not local, it redirects to the web. The correct MSDN topic will display in the Help Viewer as long as two conditions are met:
- You have a live connection to the web.
- “Go online to get content and check for updates” is checked in Help Viewer options. (Unchecking this box disables the Redirect-to-Web feature.)
You can easily tell when content is being displayed from the web because the topic displays a banner with the following message:
Note the “Select a book to download” link on the right-hand side of the message banner. Click on that link to display a drop-down that helps you discover and download a book that contains the topic you’re viewing. This feature, which works with F1 help as well, really reduces the inconvenience of not having the right help content installed locally.
Help Viewer 2.0 Features
I’ve blogged about many of the new features during the development of Help Viewer 2.0. You can read more about the following features in my post on the Developer Preview:
- Simpler setup and configuration
- Local content management integrated into the Help Viewer
- Search filters
- Help Runtime incorporated into Windows 8 (Help Library Agent eliminated!)
…and about these features in my post on the Beta release:
- TOC Filter
- Keyword Index: “Begins With” vs. “Contains”
- Docking Windows
- Color Themes
- Search Filter UI
- Improved Performance
Finally, here’s a link to the official Microsoft Help Viewer 2.0 help documentation.
Alternatives to Help Viewer
Those of you who prefer a help experience that’s integrated into the Visual Studio IDE should check out Jason Josephy’s Visual Studio 2012 Integrated Help Extension. This extension, written by a member of the Help Viewer development team, consumes the same API used by Help Viewer 2.0 but displays help within the IDE. (Note that you’ll still need to manage your local content using the Help Viewer application. Click on “Add and Remove Help Content” in the Visual Studio Help menu.)
If you’re interested in building your own help utility or just want to learn more about the help runtime API, check out the Microsoft Help Viewer 2 Runtime API Samples on CodePlex.
We welcome your feedback on Help Viewer:
- Leave a comment at the bottom of this blog post
- Send us an email at email@example.com, or
- Share your thoughts on the Visual Studio General Questions forum (note that the Developer Documentation and Help System forum has recently been retired)
In closing, I want to thank the Help Viewer team for their dedication to the needs of developers across several challenging releases. As you can see in The Story of Help in Visual Studio 2010, we put this team through a lot of change and churn and they responded with grace and professionalism. It has been a privilege to work with them.