Help XML Tags
The following table shows all the Microsoft Help XML tags and if they are used in one or more project files, a data island, or both.
Note
In the XML DTDs, tags are referred to as elements.
For information about which attributes each tag contains, see the reference topic listed under the third column.
XML Tags
Element |
Description |
Used in |
|---|---|---|
<Attr> |
Contains attribute data for a virtual topic. |
|
<AttName> |
Defines the name of an attribute. |
|
<AttributeDef> |
Contains the path to the attribute definition (.HxA) file for a Help collection. |
|
<AttVal> |
Defines a value for an attribute. |
|
<CombinedHelpIndex> |
Contains options for generating a combined Help index using HxMerge.exe. |
|
<CompilerOptions> |
Specifies optional compiler instructions. |
|
<ExcludeExt> |
Contains data about file extensions to exclude from a sample file at compile time. |
|
<File> |
Indicates which files to include in a compiled Help (.HxS) file. |
|
<FTSText> |
Contains full-text search text for a virtual topic. |
|
<HelpAttributes> |
Contains data about attributes to use in a compiled Help file. |
|
<HelpCollection> |
Defines the general properties of a Help collection. |
|
<HelpFileList> |
Defines the general properties of an include (.HxF) file. |
|
<HelpIndex> |
Defines the general properties of an index (.HxK) file. |
|
<HelpSamples> |
Defines the general properties of a sample definition (.HxE) file. |
|
<HelpTOC> |
Defines the general properties of a table of contents (.HxT) file. |
|
<HelpTOCNode> |
Defines the properties of a node within a table of contents (TOC). |
|
<IncludeDir> |
Specifies a subdirectory of a sample's source directory, the contents of which are included with a sample file. |
|
<IncludeFile> |
In the collection definition (.HxC) file, indicates one or more include (.HxF) files to associate with a Help collection. In the HxMerge project (.HxM) file, contains the path to an include (.HxF) file. |
|
<ItemMoniker> |
Contains data about the monikers that have been defined for a Help collection. |
|
<Jump> |
Contains URL data for an index entry. |
|
<Keyword> |
Contains keyword data for an index entry. |
|
<KeywordIndexDef> |
Indicates the keyword index definition (.HxK) file to associate with a Help collection. |
|
<MSHelp:Attr> |
Specifies which of the attributes defined in the attribute definition (.HxA) file applies to a topic. |
|
<MSHelp:FTSIndex> |
Adds a virtual topic to the full-text search (FTS) index. |
|
<MSHelp:Include> |
Instructs the compiler to include an HTML topic file in the compiled Help file. |
|
<MSHelp:Keyword> |
Contains keyword data for an index entry. |
|
<MSHelp:link> |
Contains markup for a Microsoft Help XLink. |
|
<MSHelp:ktable> |
Contains markup for a Microsoft Help KTable. |
|
<MSHelp:NoSearch> |
Instructs the compiler to exclude the topic from the FTS index. |
|
<MSHelp:RLTitle> |
Contains the topic title that appears in an index. |
|
<MSHelp:TOCTitle> |
Contains the topic title that appears in the table of contents. |
|
<ParsedVTopic> |
Contains data for a parsed virtual topic. |
|
<Sample> |
Contains data about a specific sample. |
|
<SampleDef> |
Indicates the sample definition (.HxE) file to associate with a Help collection. |
|
<StopWord> |
Contains the value for a term to be included in a stop word list. |
Help stop word list file |
<TOCDef> |
Indicates one or more table of contents (.HxT) files to associate with a Help collection. |
|
<ToolData> |
Contains arbitrary author-defined content. Build tools can use <ToolData> tags to store information about Help projects. This information is stored and persists upon decompile. This data is not available at run time, and can only be accessed from uncompiled source files. It can be used to store data specific to an authoring tool. |
Attribute Definition (.Hxa) File |
<VTopic> |
Contains data for a virtual topic. |
|
<VTopicDef> |
Indicates the virtual topic definition (.HxV) file to associate with a Help collection. |
|
<VTopicSet> |
Contains data for a set of virtual topics. |