Ref Attribute

  • Article

Specifies an existing index entry when using a Term attribute to create a cross-reference.

Used in

Parent tag

Required

Index (.Hxk) File

<Keyword>

No

Values

Legal XML character data (CDATA).

Example

Term = "Bitmaps, see .bmp files, editing"
Ref = ".bmp files, editing"

Remarks

Because comma, semicolon, and colon characters are used to define the index, they need to be escaped. The escape sequence is used when you want the actual character to appear in the term, without affecting the layout of the index. For example, the term ".bmp files, editing;graphics" would result in the following index entries:

.bmp files
   editing
graphics

The term ".bmp files%2C editing%3B graphics" would result in the following index entry:

.bmp files, editing; graphics

The following table shows the escape sequences to use.

Character

Escape sequence

comma (,)

%2C

semicolon (;)

%3B

colon (:)

%3A

See Also

Reference

Help XML Tags