Export (0) Print
Expand All

Providing Custom Help for Visual Studio Templates and Policy 

Visual Studio 2005

As a software architect, you need efficient ways to communicate guidance to development teams. Attaching a policy file to a template allows you to encourage the development team to follow your rules of architecture. It is likely, however, that you will still need to provide other kinds of instruction and information. Visual Studio Templates and Policy (formerly Enterprise Templates) provide a method for you to include this information by enabling you to display links to your own custom, context-appropriate help pages in the Visual Studio Dynamic Help window.

Creating your own custom help pages can be as simple as creating a standard .htm file and editing a few text files. Displaying custom help topics in the Dynamic Help window requires three basic tasks:

  1. Author the custom content (create HTML files).

  2. Specify a context file that maps keywords and attributes to that custom content.

    NoteNote

    Optionally, you can also set up a Dynamic Help topic category for the new topic; this category is used to group related topics together in the Dynamic Help window.

  3. Associate element nodes in the policy file with those keywords and attributes by referencing them in a Context node.

Whenever a user (a member of the development team in this case) selects an element of a Templates and Policy project, a link to any pertinent help topic available displays in the Dynamic Help window.

In This Section

How to: Prepare Custom Help Topics for the Dynamic Help Window

Understand how you can prepare your own custom help topics for display in the Dynamic Help window.

How to: Display Help Topics for Visual Studio Templates and Policy in the Dynamic Help Window

Describes how to modify your policy file to associate specific policy-governed ELEMENT nodes of your project with specific help topics that display in the Dynamic Help window.

How to: Provide F1 Help for Visual Studio Templates and Policy

Explains how to associate your custom help topic with the F1 key when a given node is selected in Solution Explorer.

Custom Context Files and Displaying Help Topics

Explains how a context file associates your custom help topics and your policy file with the Dynamic Help window.

Related Sections

ContextKeyword Element (Visual Studio Project Policy)

Defines and gives usage guidelines for this PDL node containing a search term that returns a list of help topics relevant to the containing context.

ContextAttribute Element (Visual Studio Project Policy)

Describes a name/value pair used to constrain the list of help topics returned when its parent element is in the active context.

How to: Prepare Custom Help Topics for the Dynamic Help Window

Describes how context keywords and context attributes control what topics are displayed in the Dynamic Help window for all Visual Studio projects.

See Also

Community Additions

ADD
Show:
© 2014 Microsoft