Click or drag to resize
Sandcastle Help File BuilderPaths Category Properties
HTML Help 1 compiler path (HtmlHelp1xCompilerPath)

This property lets you specify the path to the HTML Help 1 compiler (HHC.EXE). By default, the builder will try to locate it automatically by searching the Program Files special folder on all fixed hard drives. As such, you only need to specify the path if the build fails with a message stating that it could not be found.

MS Help 2 compiler path (HtmlHelp2xCompilerPath)

This property lets you specify the path to the MS Help 2 compiler (HXCOMP.EXE). By default, the builder will try to locate it automatically by searching the Program Files special folder on all fixed hard drives. As such, you only need to specify the path if the build fails with a message stating that it could not be found.

Project-specific components path (ComponentPath)

This property lets you specify the path where the help file builder can find custom build components, plug-ins, syntax generators, and presentation styles specific to the project. If left blank, the project's folder is searched instead. This is useful for XCOPY deployments or when developing build components so that they don't have to be installed in the standard location (the common application data folder).

Help content output path (OutputPath)

This property lets you specify where the compiled help file should be placed. The default is to store it in a folder called .\Help\ relative to the project folder. It is also the location of the temporary .\Working\ folder used to store the generated build files unless it is changed with the Working Path property. This property cannot be set to the same value as the Working Path property as the working path folder is cleared prior to the build.

Caution note Caution

Be aware that if an option is selected that produces a website, the output folder specified by the Output Path property will be cleared of all of its current content without any prompting before the web site content is copied to it. In other words, don't do something stupid like set it to the root of your C: drive or your desktop folder. The help file builder will try to take steps to ensure this does not happen. When producing Help 1, Help 2, and/or MS Help Viewer files, the output folder is not cleared.

Working files path (WorkingPath)

This property lets you specify an alternate location with a shorter path in which to perform the build if it fails due to long file path names. If not specified, the working folder will be placed under the output path and will be called .\Working. This property cannot be set to the same value as the Output Path property as the working path folder is cleared prior to the build.

Caution note Caution

Be aware that the working folder specified by the Working Path property will be cleared of all of its current content without any prompting before the build begins. In other words, don't do something stupid like set it to the root of your C: drive or your desktop folder. The help file builder will try to take steps to ensure this does not happen.

See Also