This property is used to define the type of links used to reference other help topics referring to framework (SDK) help topics. It can be set to None which renders non-clickable links, Index which renders MS Help 2 style MSHelp style links (index links within the collection), or MSDN (the default) which renders links to the online MSDN help content for the topic. When set to MSDN, the SDK Link Target property is used to define where the MSDN links will open in the browser.

This property is used to set the collection table of contents style used when the help file content is plugged into an MS Help 2 collection. If set to Hierarchical (group under a root container, the default), the help file's table of contents entries will be grouped under a container node in the merged table of contents. The Help Title property setting is used for the container's title. If set to Flat (list at the root level), the help file's table of contents entries will appear at the root level in the merged table of contents.

Note
This property will not cause the entries in your help file's table of contents to change from flat to hierarchical. To do that, use the Hierarchical Table of Contents Plug-In.

This property is used to specify a comma-separated list of namespaces that the collection will be plugged into when deployed using H2Reg.exe. The default setting will plug the collection into any help namespace starting with ms.vsipcc or ms.vsexpresscc. See the H2Reg documentation for more information on what namespaces can be used and how to specify them.

This property is used to specify the version number that will be applied to the help file. The version number appears when you view the properties of the help file in Windows Explorer. You can set it to match the version number of the product to which the help file belongs. The value is a string which allows you to use custom project properties to define the value (i.e. {@Version} or {@Major}.{@Minor}.{@Build}.{@Revision}). The end result must still evaluate to a valid four-part version number. If not, a build error will occur (BE0066).

This property is used to specify whether or not the stop word list will be compiled into the help file. The stop word list is used to identify words that should be omitted from the Help 2 full text search index.

This property represents a collection of additional <MSHelp:Attr> attributes that will be added to the XML data island in each generated API help topic. Click the "..." button to the right of the property when it is selected to open the editor. In it, you can enter a name and value for each additional attribute. Click the Default button to add a default set of attributes (DocSet/NETFramework, DocSet/{@HtmlHelpName}, and TargetOS/Windows). If producing an MS Help 2 file, you should at least add the default attributes so that filtering is supported. When attributes exist in this property, the MS Help 2 Attributes component is automatically added to the Sandcastle configuration file at build time.

For the attribute value, you can specify any of the replacement tags to substitute a project setting at build time. For example, when you add the default attributes, a DocSet entry is added with the value set to {@HtmlHelpName} so that the current HTML Help name value is used.

Be aware that the Sandcastle transformations add ApiLocation, ApiType, DevLang, Locale, and TopicType attributes with appropriate values to each generated API topic so there is no need to add them here.

Other Resources