Attribute Definition (.Hxa) File

Defines the attributes used by a compiled Help file. An attribute is a name-value pair used to describe various aspects of content within a Help file. Each attribute has a name and a set of possible values, and when used in conjunction with filters, makes it possible for users to selectively display the type of information they are interested in. The attributes that are defined in this file can then be added to the XML data islands within HTML topics.

Example

The following example shows the basic structure of an attribute definition file.

Note

The file consists of tags, each of which contains one or more attributes.

Choose an attribute to see its corresponding topic.

Comments indicate which attributes are required.

Where applicable, defined choices are displayed in parentheses.

All attribute values must be enclosed in quotation marks.

The double-quote character (") cannot be used within the value of the Name attribute for the AttName and AttVal tags. This is applicable whether the quote is specified literally, or using a character escape sequence (&quote).

As with all XML documents, the tags and attributes in this file are case-sensitive.

<?xml version="1.0"?>

<!DOCTYPE HelpAttributes SYSTEM "MS-Help://Hx/Resources/HelpAttributes.dtd">

<HelpAttributes

   Id Attribute= ""

   DTDVersion Attribute = "1.0" <!-- Required -->

   FileVersion Attribute = ""

>

<AttName <!-- Can appear 0 or more times -->

   Name Attribute= "" <!-- Required -->

   Display Attribute= ""

   UIString Attribute= ""

   AttType Attribute= ""

>

   <AttVal <!-- Can appear 0 or more times -->

      Name Attribute = "" <!-- Required -->

      Display Attribute = ""

      UIString Attribute = ""

/>

   <ToolData <!-- Can appear 0 or more times -->

      Name Attribute = "" <!-- Required -->

      Value Attribute = "" <!-- Required -->

   />

</AttName>

</HelpAttributes>

See Also

Concepts

Viewing the DTDs

Reference

Help XML Tags

Other Resources

Help XML Attributes