Freigeben über

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

  • Artikel

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>

Comments

  • Anonymous
    August 27, 2006
    Resolving reference links in Sandcastle using none, local, index and msdn link type options Via Sandcastle

  • Anonymous
    September 06, 2006
    The comment has been removed

  • Anonymous
    September 06, 2006
    Sorry, I realize I probably should have posted this as a comment on the August CTP entry. Regardless, I'd appreciate any help.

  • Anonymous
    September 06, 2006
    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..

  • Anonymous
    September 06, 2006
    Thanks,

    I'll post questions like this there in the future.

  • Anonymous
    July 19, 2007
    Sadcastle uses Microsoft Technet Publishing System (MTPS) content service to resolve refeence links to

  • Anonymous
    July 19, 2007
    Sadcastle uses Microsoft Technet Publishing System (MTPS) content service to resolve refeence links to

  • Anonymous
    January 15, 2008
    In this post I'm going to provide details and screen shots of some of the new features in the DocProject