Support for referencing embedded resources in Sandcastle generated chm files

Sep 2, 2009 at 1:32 AM

I have the full length version of this question on StackOverFlow.

Basically, it seems like its completely allowable to put a fully qualified resource name as a cref attribute to a <see/> tag. However, the generated chm file from Sandcastle via sandcastle help file builder doesn't properly reflect that. Is there any support for embedded resource annotation in sandcastle?

Sep 2, 2009 at 3:09 AM

You can use an HTML anchor tag to achieve the same result.  It's like referencing image files using an <img> tag in the XML comments.

/// The resources are loaded from <a href="../Resources.TextFile.txt">Resources.TextFile.txt</a>.

Include the resource file as a content item in the project.  The example above assumes it's in the root folder.  HTML files are always in the ./html folder so it needs to go up one level.  If you put the file in a subfolder off of the root folder, add its name to the href target: "../FolderName/Resources.TextFile.txt".

If you've applied the Sandcastle Styles patch, you can use an href attribute instead of a cref attribute on the <see> tag.  The file location info would be the same.

/// The resources are loaded from <see href="../Resources.TextFile.txt" />.