Documenting Recipes to Show in the Guidance Navigator

  • Article
Retired Content

This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies.
This page may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

For the Guidance Navigator to show additional information about the recipe, you have to add documentation links to the recipe definition. The guidance package configuration schema has been extended so now the <Recipe> element includes the <DocumentationLinks> element, which in turn contains the <Link> elements. This is shown in the following code example.

<Recipe Name="GenerateRepeatingClassT4" Bound="false">
  <DocumentationLinks>
    <Link Caption="This is a link" Url="https://www.microsoft.com" Kind="Documentation"/>
    <Link Caption="This is another link" Url="ms-help://blah" Kind="Documentation" />
    <Link Caption="Create Business Entity" Url="recipe://SomeOtherRecipeName" Kind="NextStep" />
  </DocumentationLinks>
...
</Recipe>

Each <Link> element is used for each kind of the information you want the Guidance Navigator to display about the recipe. The attributes of the element should be self-explanatory:

  • Caption. This attribute contains the name for the link. It should be short and informative because it will be displayed in a tool window.
  • Url. This attribute is a link to one of the following:
    • A Web page (http://)
    • A Microsoft Help topic (ms-help://)
    • A recipe (recipe://) (if the Kind attribute is properly set to NextStep)
  • Kind. The value of this attribute determines whether the link should be displayed when you click the Available Guidance tab (always) or the History tab (only when set to NextStep).

See also

Developing Recipes | Specifying Command Bars | Specifying Bound References | Specifying Unbound References | Gathering Arguments | Using the Guidance Navigator