<item>

Description

Items in index metadata.

Index items form the first level in a two level index. The entry attribute specifies the text to render in the index. The actual index text searches are specified via the descendant match elements.

Indexes are not supported via direct browser loading.

Attributes

Attribute name	Description
entry	The text to render for the first level item in the index.

Immediate descendants

Element name	Description
match	An index match to search for in the document.

Immediate ancestors

Element name	Relation
index	The enclosing index element containing the index item.

Example

<document xmlns="http://boradoc.org/1.0">
  <metadata>
    <index-entries>
      <item entry="unit">
        <match entry="unit" />
        <match entry="test" search="unit test" />
        <match entry="test" search="unit tests" />
        <match entry="testing" search="unit testing" />
      </item>
      <item entry="code">
        <match entry="C++" />
        <match entry="C++ file" search=".cpp" />
        <match entry="C++ file" search=".hpp" />
        <match entry="Java" />
        <match entry="Java file" search=".java" />
      </item>
    </index-entries>
  </metadata>
  <-- Main document contents follows. -->
</document>

The above BDML renders to the following in the document's index:

unit - 42

test - 123, 154

testing - 123

code

C++ - 23, 184

C++ file - 23, 24, 185

Java - 32, 45, 89

Java file - 186