Setting up links to external documentation in Sandcastle

 
Resolving reference links in Sandcastle using none, local, index and msdn link type options
Via Sandcastle Blog

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 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>

 

Sandcastle Monday, August 28, 2006
 
This message was created using Onfolio

Recent Posts

Tag Cloud

No Comments