Metadata Topic Elements

Certain topic elements not represented in the rules file are searched for in order to extract common metadata that will be associated with the converted topic files:

  Note

All element names are matched case-insensitively.

The Title Element

The HTML file should contain a standard title element that defines the page title. If not found, it will be left blank in any of the supporting content files.

Index Keyword Elements

If the parser finds any MSHelp:Keyword elements, it will extract the index name and the term and will save them to the supporting content files.

Sandcastle Help File Builder Special Comment Tags

If the file parser finds any of the special comment tags used by the Sandcastle Help File Builder such as @TOCExclude, @SplitTOC, @DefaultTopic, and @SortOrder it will extract them and use them when generating the supporting content files to maintain the existing layout of the topics.

See Also

Other Resources