Export (0) Print
Expand All

Microsoft 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.

NoteNote

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.

Element Description Used in

<Attr>

Contains attribute data for a virtual topic.

Virtual Topic Definition (.HxV) File

<AttName>

Defines the name of an attribute.

Attribute Definition (.HxA) File

<AttributeDef>

Contains the path to the attribute definition (.HxA) file for a Help collection.

Collection Definition (.HxC) File

<AttVal>

Defines a value for an attribute.

Attribute Definition (.HxA) File

<CombinedHelpIndex>

Contains options for generating a combined Help index using HxMerge.exe.

HxMerge Project (.HxM) File

<CompilerOptions>

Specifies optional compiler instructions.

Collection Definition (.HxC) File

<ExcludeExt>

Contains data about file extensions to exclude from a sample file at compile time.

Sample Definition (.HxE) File

<File>

Indicates which files to include in a compiled Help (.HxS) file.

Include (.HxF) File

<FTSText>

Contains full-text search text for a virtual topic.

Virtual Topic Definition (.HxV) File

<HelpAttributes>

Contains data about attributes to use in a compiled Help file.

Attribute Definition (.HxA) File

<HelpCollection>

Defines the general properties of a Help collection.

Collection Definition (.HxC) File

<HelpFileList>

Defines the general properties of an include (.HxF) file.

Include (.HxF) File

<HelpIndex>

Defines the general properties of an index (.HxK) file.

Index (.HxK) File

<HelpSamples>

Defines the general properties of a sample definition (.HxE) file.

Sample Definition (.HxE) File

<HelpTOC>

Defines the general properties of a table of contents (.HxT) file.

Table of Contents (.HxT) File

<HelpTOCNode>

Defines the properties of a node within a table of contents (TOC).

Table of Contents (.HxT) File

<IncludeDir>

Specifies a subdirectory of a sample's source directory, the contents of which are included with a sample file.

Sample Definition (.HxE) 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.

Collection Definition (.HxC) File

HxMerge Project (.HxM) File

<ItemMoniker>

Contains data about the monikers that have been defined for a Help collection.

Collection Definition (.HxC) File

<Jump>

Contains URL data for an index entry.

Index (.HxK) File

<Keyword>

Contains keyword data for an index entry.

Index (.HxK) File

Virtual Topic Definition (.HxV) File

<KeywordIndexDef>

Indicates the keyword index definition (.HxK) file to associate with a Help collection.

Collection Definition (.HxC) File

<MSHelp:Attr>

Specifies which of the attributes defined in the attribute definition (.HxA) file applies to a topic.

Microsoft Help XML Data Island Markup

<MSHelp:FTSIndex>

Adds a virtual topic to the full-text search (FTS) index.

Microsoft Help XML Data Island Markup

<MSHelp:Include>

Instructs the compiler to include an HTML topic file in the compiled Help file.

Microsoft Help XML Data Island Markup

<MSHelp:Keyword>

Contains keyword data for an index entry.

Microsoft Help XML Data Island Markup

<MSHelp:link>

Contains markup for a Microsoft Help XLink.

Microsoft Help Link Markup Overview

<MSHelp:ktable>

Contains markup for a Microsoft Help KTable.

Microsoft Help Link Markup Overview

<MSHelp:NoSearch>

Instructs the compiler to exclude the topic from the FTS index.

Microsoft Help XML Data Island Markup

<MSHelp:RLTitle>

Contains the topic title that appears in an index.

Microsoft Help XML Data Island Markup

<MSHelp:TOCTitle>

Contains the topic title that appears in the table of contents.

Microsoft Help XML Data Island Markup

<ParsedVTopic>

Contains data for a parsed virtual topic.

Virtual Topic Definition (.HxV) File

<Sample>

Contains data about a specific sample.

Sample Definition (.HxE) File

<SampleDef>

Indicates the sample definition (.HxE) file to associate with a Help collection.

Collection Definition (.HxC) File

<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.

Collection Definition (.HxC) File

<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

Collection Definition (.HxC) File

Index (.HxK) File

Table of Contents (.HxT) File

<VTopic>

Contains data for a virtual topic.

Virtual Topic Definition (.HxV) File

<VTopicDef>

Indicates the virtual topic definition (.HxV) file to associate with a Help collection.

Collection Definition (.HxC) File

<VTopicSet>

Contains data for a set of virtual topics.

Virtual Topic Definition (.HxV) File

Community Additions

ADD
Show:
© 2014 Microsoft