 | SandcastleBuilder.PlugIns Namespace |
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| Class | Description | |
|---|---|---|
 | 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 Help 2/MS Help Viewer collections or additional online MSDN content.
|
| AjaxDocPlugIn |
This plug-in class is designed to generate XML comments and reflection file information for Atlas client
script libraries using AjaxDoc.
|
| BibliographySupportPlugIn |
This plug-in class is used to add bibliography support to the topics
|
| 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.
|
| BindingRedirectSettingsCollection |
This collection class is used to hold the binding redirect settings information 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.).
|
| HierarchicalTocPlugIn |
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.
|
| 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 current 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
|
| ProxyCredentials |
This class is used to specify credentials for a proxy server.
|
| ReferenceLinkSettings |
This represents reference link settings for the
AdditionalReferenceLinksPlugIn.
|
| ReferenceLinkSettingsCollection |
This collection class is used to hold the reference link settings
information for the AdditionalReferenceLinksPlugIn.
|
| ScriptSharpPlugIn |
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.
|
| 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.
|
| UserCredentials |
This class is used to specify user credentials.
|
| 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.
|
| VersionSettingsCollection |
This collection class is used to hold the version settings information
for the VersionBuilderPlugIn.
|
| WildcardReferenceSettings |
This represents wildcard reference settings for the
WildcardReferencesPlugIn.
|
| WildcardReferenceSettingsCollection |
This collection class is used to hold the wildcard reference settings
information 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.
|