To select and configure build components, select the ComponentConfigurations project property and click the "..." button to the right of it. The dialog below is then displayed. As noted above, the Code Block Component and Post-Transform Component already exist in the help file builder configuration file templates so you do not need to add them to the project unless you want to override their default configurations.

Available build components are listed on the left. Version, copyright, and description information is shown below the list and will change to reflected the currently selected component. The list on the right displays the components selected for use in the current project. Double-click a component on the left or click the Add button to add a component to the project. Click the Configure button to configure the component. Click the Delete button to delete a component from the project. The checkboxes next to each project component allow you to enable or disable the component within the project. If disabled, it will remain in the project with its configuration information but it will not be used during a build. As noted above, the Code Block and Post-Transform components appear by default in the help file builder configuration file so if you disable your customized settings, the component will still be used but will revert to the default configuration. Third-party build components contain a default configuration but it may not be suitable for your project. As such, you should configure each component that you add to the project so that it will work as expected.

For information on writing your own custom build components, see the Code Project article Creating Custom Build Components for Sandcastle.

Third-party build components can also be added by copying their assembly, configuration file, 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 component's documentation for information about its features and configuration options. See the Creating a Component Configuration File topic for information on creating a configuration file for a third-party component that does not have one or to allow configuration of a stock Sandcastle build component. For a list of current third-party build components, see the Links to Resources topic.

Custom language syntax filter generators can be made available via the project's SyntaxFilters property by creating a syntax filter generator definition file. Copy the syntax filter generator's assembly, configuration file, 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 component's documentation for information about its features and configuration options. See the Creating a Syntax Filter Generator Definition File topic for information on creating a configuration file for a third-party syntax generator that does not have one. For a list of current third-party build components, see the Links to Resources topic.

Other Resources