Compartir a través de


How to: Deploy and Integrate Your Help Collection

After you have created your Help content, you undoubtedly want to make your collection available to your customers. This section discusses options for integrating your content with Visual Studio and deploying your collection.

Integrating and Registering Your Help Collection

There are two ways to integrate and register your Help content with Visual Studio:

  • Use the Help merge modules provided by Microsoft.

  • Use InnovaHxReg, a command-line registration tool offered with HelpStudio Lite.

The following procedures provide overviews of the different methods and links to topics with detailed instructions.

To use the Help merge modules to register and integrate your content

To use InnovaHxReg to register and integrate your content

  1. Use HelpStudio Lite to generate Help 2 files.

  2. Use InnovaHxReg to deploy and register your collection.

    For more information see the HelpStudio Lite documentation.

Improving the Discoverability of Your Help Collection

The Visual Studio SDK offers two new features to make your Help content more discoverable, the TOC Plug-in feature and "How Do I" pages.

To expose your Help collection

  • Set the location of your Help collection in the table of contents by using the TOC Plug-in feature.

    For more information, see Inserting the TOC of a Child Collection into a Parent Collection.

  • Provide a custom "How Do I" page.

    A "How Do I" page is used to expose the most important nodes of your Help collection. To display a list of existing "How Do I" pages click How Do I on the Help menu in the Visual Studio integrated development environment (IDE). Alternatively, click the How Do I button on the toolbar in the Microsoft Document Explorer window.

    For more information, see Custom "How Do I" Pages.

See Also

Concepts

What's New in Help and Help Integration