This project has moved and is read-only. For the latest updates, please go here.

Conceptual Linking From API in MS Help Viewer

Topics: User Forum
Dec 12, 2012 at 11:07 PM

I just upgraded to the latest Sandcastle and SHFB versions in order to generate Help Viewer content for Visual Studio 2010 users. The linking to our API docs works fine, but not from the API docs to the conceptual docs we have provided. These links are scattered throughout our code comments, and all have been entered manually.

For example, our code might include something along the lines of: "See My Link"

These work fine in the Help1 and Help2 content, but in the Help Viewer the page is no longer "1234567b-c123-1234-1234-d1fc1234aaa1.htm" but instead "".

Is there a way to get these links to work correctly, without also breaking linking in Help1 and 2? The mshc archive contains the raw files with links updated to "ms-xhelp:///?Id=1234567b-c123-1234-1234-d1fc1234aaa1", but these aren't working. Any suggestions from anyone? Is this a hierarchy/nesting issue?

Dec 13, 2012 at 2:19 AM

Use a conceptualLink element with a target attribute that is set to the GUID of the topic to which it should link:

<conceptualLink target="topicGUID" />


<conceptualLink target="topicGUID">inner text</conceptualLink>

This will work across all help file formats as the build component will generate the link based on the help file format.



Dec 13, 2012 at 9:39 PM

Brilliant, that worked great! Thanks so much, Eric!