Sandcastle Help File Builder Documentation
Sandcastle
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
| AdditionalContentOnlyPlugIn | 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. |
| AdditionalReferenceLinksPlugIn | 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 a help collection or additional online content. |
| BindingRedirectResolverPlugIn | This plug-in class is used to add assembly binding redirection support to the MRefBuilder configuration file. |
| BindingRedirectSettings | This represents binding redirection settings for the BindingRedirectResolverPlugIn. |
| CompletionNotificationPlugIn | 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. |
| DbcsFixPlugIn | 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. |
| DeploymentLocation | This represents a deployment location |
| DeploymentPlugIn | 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.). |
| DocumentedEntitiesOnlyPlugIn | This plug-in is used to automatically generate an API filter based on the XML comments member IDs to limit the help file content to only the documented entities. |
| IntelliSenseOnlyPlugIn | This plug-in class can be used to build an IntelliSense XML comments file without a related help file |
| LightweightWebsiteStylePlugIn | This plug-in class is used to add elements for the lightweight website style such as a search box and a table of contents in the topics similar to the MSDN lightweight style. |
| MemberIdFixUpPlugIn | This plug-in class is used to fix up member IDs in the XML comments files due to quirks in the various compilers that cause a mismatch between the member IDs in the XML comments and the reflection data. |
| MemberIdMatchExpression | This is used to hold the member ID match expression settings |
| ReferenceLinkSettings | This represents reference link settings for the AdditionalReferenceLinksPlugIn |
| TocExcludePlugIn | 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. |
| VersionBuilderPlugIn | 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. |
| VersionSettings | This represents version settings for the VersionBuilderPlugIn. |
| WebsiteTableOfContentsGeneratorPlugIn | This plug-in class is used to generate table of contents information for website-based presentation styles. |
| WildcardReferenceSettings | This represents wildcard reference settings for the WildcardReferencesPlugIn. |
| WildcardReferencesPlugIn | This plug-in class is designed to modify the MRefBuilder project file by adding in reference assemblies matching wildcard search paths. |
| XPathReflectionFileFilterPlugIn | This plug-in class is used to filter out unwanted information from the reflection information file using XPath queries. |