Windows Live Alerts

Sandcastle

Documentation compilers for managed class libraries
Welcome to MSDN Blogs Sign in | Join | Help
Resolving reference links in Sandcastle using none, local, index and msdn link type options

Sandcastle supports 4 different link type options. The link type options are defined in sandcastle.config file under ResolveReferenceLinks component. The 4 different type options under this component are the following:

  1. none - Results in text with no active link
  2. local - Results in links within project using <a href> tag
  3. index - ms-help style links for HxS
  4. msdn - links to Framework topics in MSDN

For building a CHM or HxS the sample Sandcastle.config at C:\Program Files\Sandcastle\Presentation\Configurationfile could be used. For a CHM build the link type option in Sandcastle.config is defined as shown below:

<!-- resolve reference links -->
 <component type="Microsoft.Ddue.Tools.ResolveReferenceLinksComponent" assembly="..\..\ProductionTools\BuildComponents\BuildComponents.dll">
   <targets files="reflection.xml" type="local" />
   <targets files="..\cpref_reflection\*.xml" type="msdn" />
 </component>

For HxS build this section could be modified to the following:

<!-- resolve reference links -->
 <component type="Microsoft.Ddue.Tools.ResolveReferenceLinksComponent" assembly="..\..\ProductionTools\BuildComponents\BuildComponents.dll">
   <targets files="reflection.xml" type="index" />
   <targets files="..\cpref_reflection\*.xml" type="msdn" />
 </component>

If you would like to create a build with no active links then the section could be modified to the following:

<!-- resolve reference links -->
 <component type="Microsoft.Ddue.Tools.ResolveReferenceLinksComponent" assembly="..\..\ProductionTools\BuildComponents\BuildComponents.dll">
   <targets files="reflection.xml" type="none" />
   <targets files="..\cpref_reflection\*.xml" type="none" />
 </component>

 

Posted: Monday, August 28, 2006 6:44 AM by aram
Filed under:

Comments

Lorenzo Barbieri @ UGIblogs! said:

# August 28, 2006 3:56 AM

Brenton House said:

Resolving reference links in Sandcastle using none, local, index and msdn link type options Via Sandcastle
# August 28, 2006 6:51 AM

ssj4finalflash said:

Using Sandcastle August CTP 2006 I've generated some documentation for an application including internal APIs. This is nice, however ideally I'd like to merge in some overview information to the resultant help file. This would be similar to say the "SQL Server Overview" section in the Visual Studio 2005 help. I'd like to make a page of an arbitrary format that links to other high level documentation.

What is the best and most automatic way to combine this with Sandcastle /Internal+ documentation? I was thinking about creating HTML pages manually and simply adding them to the hhp file, however I'm not sure this is ideal. Is there a way to script/integrate this with the build process?

This question may relate more to HTML Help than sandcastle.
# September 6, 2006 12:37 PM

ssj4finalflash said:

Sorry, I realize I probably should have posted this as a comment on the August CTP entry. Regardless, I'd appreciate any help.
# September 6, 2006 12:48 PM

aram said:

You may want to post questions like this at the help forum http://forums.microsoft.com/MSDN/ShowForum.aspx?ForumID=66&SiteID=1 as it will be useful for others reading the forum.

Currently there is not an easy way other than hacking HHP. Eric has written a GUI and there is an option to merge overview conceptual page. Please see his GUI at http://forums.microsoft.com/MSDN/ShowPost.aspx?PostID=641182&SiteID=1

Anand..
# September 6, 2006 12:55 PM

ssj4finalflash said:

Thanks,

I'll post questions like this there in the future.
# September 6, 2006 1:11 PM

Sandcastle said:

Sadcastle uses Microsoft Technet Publishing System (MTPS) content service to resolve refeence links to

# July 20, 2007 2:45 AM

Noticias externas said:

Sadcastle uses Microsoft Technet Publishing System (MTPS) content service to resolve refeence links to

# July 20, 2007 2:58 AM

Dave Sexton's Blog said:

In this post I'm going to provide details and screen shots of some of the new features in the DocProject

# January 15, 2008 3:32 PM
Anonymous comments are disabled

Page view tracker