This namespace contains the plug-ins supplied with the Sandcastle Help File Builder. These can be used in a project to extend or alter the build process in various ways such as supporting build completion notification, deployment, and generating documentation with AjaxDoc.

Classes

  ClassDescription
Public classAdditionalContentOnlyPlugIn
This plug-in class can be used to build a help file consisting of nothing but additional content items. It is also useful for proofreading your additional content without having to build all the API topics.
Public classAdditionalReferenceLinksPlugIn
This plug-in class is designed to add additional reference link targets to the Reflection Index Data and Resolve Reference Links build components so that links can be created to other third party help in Help 2/MS Help Viewer collections or additional online MSDN content.
Public classAjaxDocPlugIn
This plug-in class is designed to generate XML comments and reflection file information for Atlas client script libraries using AjaxDoc.
Public classBibliographySupportPlugIn
This plug-in class is used to add bibliography support to the topics
Public classBindingRedirectResolverPlugIn
This plug-in class is used to add assembly binding redirection support to the MRefBuilder configuration file.
Public classBindingRedirectSettings
This represents binding redirection settings for the BindingRedirectResolverPlugIn.
Public classBindingRedirectSettingsCollection
This collection class is used to hold the binding redirect settings information for the BindingRedirectResolverPlugIn.
Public classCompletionNotificationPlugIn
This plug-in class is designed to run after the build completes to send notification of the completion status via e-mail. The log file can be sent as an attachment.
Public classDbcsFixPlugIn
This plug-in class is designed to modify the HTML files and alter the build so as to overcome the encoding issues encountered when building HTML Help 1 (.chm) files for various foreign languages.
Public classDeploymentLocation
This represents a deployment location
Public classDeploymentPlugIn
This plug-in class is used to copy the resulting help file output to a location other than the output folder (i.e. a file share, an FTP site, a web server, etc.).
Public classHierarchicalTocPlugIn
This plug-in class can be used to rearrange the table of contents such that namespaces are nested within their parent namespaces rather than appearing as a flat list of all namespaces at the root level.
Public classProxyCredentials
This class is used to specify credentials for a proxy server.
Public classReferenceLinkSettings
This represents reference link settings for the AdditionalReferenceLinksPlugIn.
Public classReferenceLinkSettingsCollection
This collection class is used to hold the reference link settings information for the AdditionalReferenceLinksPlugIn.
Public classScriptSharpPlugIn
This plug-in class is designed to modify the reflection information file produced after running MRefBuilder on assemblies produced by the Script# compiler so that it is suitable for use in producing a help file.
Public classTocExcludePlugIn
This plug-in class can be used to exclude API members from the table of contents via the <tocexclude /> XML comment tag. The excluded items are still accessible in the help file via other topic links.
Public classUserCredentials
This class is used to specify user credentials.
Public classVersionBuilderPlugIn
This plug-in class is designed to generate version information for assemblies in the current project and others related to the same product that can be merged into the current project's help file topics.
Public classVersionSettings
This represents version settings for the VersionBuilderPlugIn.
Public classVersionSettingsCollection
This collection class is used to hold the version settings information for the VersionBuilderPlugIn.
Public classWildcardReferenceSettings
This represents wildcard reference settings for the WildcardReferencesPlugIn.
Public classWildcardReferenceSettingsCollection
This collection class is used to hold the wildcard reference settings information for the WildcardReferencesPlugIn.
Public classWildcardReferencesPlugIn
This plug-in class is designed to modify the MRefBuilder project file by adding in reference assemblies matching wildcard search paths.
Public classXPathReflectionFileFilterPlugIn
This plug-in class is used to filter out unwanted information from the reflection information file using XPath queries.