Table of Contents

ResolveConceptualLinksComponent Class

Definition

Namespace
Sandcastle.Tools.BuildComponents
Assembly
Sandcastle.Tools.BuildComponents.dll

This is a modified version of the original ResolveConceptualLinksComponent that is used to resolve links to conceptual topics.

public class ResolveConceptualLinksComponent : BuildComponentCore, IDisposable
Inheritance
ResolveConceptualLinksComponent
Implements

Examples

On links without inner text, if the companion file contains a linkText element, that text will be used. If not, the title is used.

<!-- Link with inner text -->
<link xlink:href="3ab3113f-984b-19ac-7812-990192aca5b0">Click Here</link>
<!-- Link with anchor reference -->
<link xlink:href="3ab3113f-984b-19ac-7812-990192aca5b1#SubTopic" />
<!-- Link with inner text and an anchor reference -->
<link xlink:href="3ab3113f-984b-19ac-7812-990192aca5b1#PropA">PropertyA</link>

<!-- Resolve conceptual links -->
<component id="Resolve Conceptual Links Component">
    <showBrokenLinkText value="true" />
    <targets base="xmlComp" type="local" />
</component>

Remarks

This version contains the following improvements and fixes:

  • Broken links use the None style rather than the Index style so that it is apparent that they do not work.
  • The inner text from the conceptual link is used if specified.
  • On broken links, when the showBrokenLinkText option is true and there is no inner text, the target value is displayed.
  • Conceptual link targets can include an optional anchor name from within the target such as "#Name" (see examples below).
  • Unnecessary whitespace is removed from the link text.
  • If the companion file contains a <linkText> element and no inner text is specified, its value will be used for the link text rather than the title. This allows for a shorter title or description to use as the default link text.

Constructors

ResolveConceptualLinksComponent(IBuildAssembler)

Constructor

Properties

BuildAssembler

This read-only property returns a reference to the build assembler instance using the component

(Inherited from BuildComponentCore)
GroupId

This is used to set an optional group ID for use with component events

(Inherited from BuildComponentCore)

Methods

Apply(XmlDocument, string)

This is implemented to resolve the conceptual links
Dispose()

This implements the Dispose() interface to properly dispose of the build component.

(Inherited from BuildComponentCore)
Initialize(XPathNavigator)

This abstract method must be overridden to initialize the component
Edit this page