Build process plug-ins can be used to alter or extend the build process in various ways with behavior that is not present in the help file builder by default. Plug-ins can be ran before a build step, after a build step, both before and after a build step, or instead of a build step. The following build process plug-ins are supplied with the help file builder:
- Additional Content Only Plug-In
- Additional Reference Links Plug-In
- AjaxDoc Builder Plug-In
- Assembly Binding Redirection Plug-In
- Bibliography Support Plug-In
- Completion Notification Plug-In
- DBCS Fix for CHM Builds Plug-In
- Hierarchical Table of Contents Plug-In
- Output Deployment Plug-In
- Script# Reflection File Fixer Plug-In
- Table of Contents Exclusion Plug-In
- Version Builder Plug-In
- XPath Reflection File Filter Plug-In
Selecting and Configuring Build Process Plug-Ins
To select and configure plug-ins, select the PlugInConfigurations project property and click the "..." button to the right of it. The dialog below is then displayed.
Available plug-ins are listed on the left. Version, copyright, and description information is shown below the list and will change to reflect the currently selected plug-in. The list on the right displays the plug-ins selected for use in the current project. Double-click a plug-in on the left or click the Add button to add a plug-in to the project. Click the Configure button to configure the plug-in. Click the Delete button to delete a plug-in from the project. The checkboxes next to each project plug-in allow you to enable or disable the plug-in within the project. If disabled, it will remain in the project with its configuration information but it will not be used during a build.
Most plug-ins contain a default configuration but it is most likely not suitable for your project. As such, you should configure each plug-in that you add to the project so that it will work as expected. For information on creating your own build process plug-ins, see the Creating Build Process Plug-Ins topic.
Adding Third-Party Build Components
Third-party plug-ins can also be added by copying their assembly and any supporting files to the .\Components and Plug-Ins folder or a subfolder beneath it in the help file builder's Common Application Data folder. See the Special Folder Locations topic for more information. Refer to the plug-in's documentation for information about its features and configuration options. For a list of current third-party plug-ins, see the Links to Resources topic.
See Also
