Help 1/Website Category Properties

The Help 1/Website category properties control the features of HTML Help 1 (CHM) files and websites. It also contains a couple of properties related the Open XML and Markdown help file formats.

Help 1 SDK link type (HtmlSdkLinkType)

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 or MSDN (the default) which renders links to the online help content for the topic. When set to MSDN, the Sdk Link Target property is used to define where the external links will open in the browser.

Create a binary table of contents to reduce load time (BinaryTOC)

When set to True, the default, a binary table of contents is created for the help file. According to the HTML Help Compiler documentation this can significantly reduce the amount of time required to load a very large help document.

Include a Favorites tab in the compiled help file (IncludeFavorites)

If this property is set to True, a Favorites tab will be included in the compiled help file. By default, it is set to false and only the Contents, Index, and Search tabs are available.

Website/Open XML SDK link type (WebsiteSdkLinkType)

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 or MSDN (the default) which renders links to the online help content for the topic. When set to MSDN, the Sdk Link Target property is used to define where the external links will open in the browser.

  Note

This property is also used as the SDK link type setting for the Open XML and Markdown help file formats. For the Open XML format, the SDK Link Target property is ignored and all URLs are opened in an external browser instance.

Website Ad Content (WebsiteAdContent)

This property is used to insert script and other HTML elements related to ad content providers such as Google AdWords or Developer Media advertisement tags. It only applies to website output. Enter the necessary script and HTML in this property and it will be inserted into the page at the very bottom after the page footer. If you want to place the ads in a location other than at the end of the topic, you will need to create your own presentation style and modify where the ad content is inserted.

Include the '.md' filename extension on markdown topic URLs (AppendMarkdownFileExtensionsToUrls)

This property is used to determine whether or not to append ".md" extensions to topic URLs in markdown output. This option is off by default, suitable for GitHib wiki content which does not add the filename extensions. Adding them causes the wiki to link to the raw file content rather than the rendered topic. If your site uses them or if you are rendering content to store in source control where they are used, enable this property.

See Also