<indexentry> Index Entry

<indexentry> is a wrapper element that pairs an index term with one or more linking elements. Each <indexentry> must contain an access element as described below, such as <name> or <subject>. These may use controlled vocabulary and the @source attribute to facilitate access within the system. It may contain a <ptr/>, <ptrgrp> or <ref> element. <ptr/> should be used when no descriptive text is needed and <ref> when it is. <indexentry> is used within <index> and may also contain further <indexentry> elements.

<namegrp> may be used to bundle multiple element entries with the same <ref>, <ptr/> or <ptrgrp> element. <indexentry> may occur within <index> and higher-level <indexentry> elements.

Attributes

  • @altrender – not required. Use if the content of the element should be displayed or printed differently than the rendering established in a style sheet for other occurrences of the element.
  • @audience – not required. Use to set whether the element’s contents will be visible to external users or to internal ones. Possible values are: “internal” and “external.”
  • @id – not required. Creates an ID for element. Can be used for linking.
  • @lang – not required. Three-letter code that indicates the language in which the element’s contents were written. It should come from ISO 639-2b.
  • @script – not required. Four-letter code that indicates the script in which the element’s contents were written. It should come from ISO 15924.

Child Elements

<indexentry> must contain one of the following: <namegrp> to group multiple elements, or, <corpname>, <famname>, <function>, <genreform>, <geogname>, <name>, <occupation>, <persname>, <subject>, or <title>.

Following those, it may contain <ptr/>, <ptrgrp>, or <ref>.

Last, it may contain as many further <indexentry> elements as needed for desired nesting.

Examples

<index>
	<head>Index of Animals Described</head>
	<p>Animals are grouped by class and paired with a link to the official Ministry of Magic magical creature class description.</p>
	<indexentry>
		<namegrp>
			<name><part>Imp</part></name>
			<name><part>Salamander</part></name>
		</namegrp>
		<ref href="http://regcontrol.ministry.magic.uk/magical-creature-tables/class_1" show="new" actuate="onrequest">Table of Class 1 Creatures</ref>
	</indexentry>
	<indexentry>
		<namegrp>
			<name><part>Cockatrice</part></name>
			<name><part>Griffin</part></name>
			<name><part>Thestral</part></name>
		</namegrp>
		<ref href="http://regcontrol.ministry.magic.uk/magical-creature-tables/class_2" show="new" actuate="onrequest">Table of Class 2 Creatures</ref>
	</indexentry>
	<indexentry>
		<name><part>Basilisk</part></name>
		<ref href="http://regcontrol.ministry.magic.uk/magical-creature-tables/class_3" show="new" actuate="onrequest">Table of Class 3 Creatures</ref>
	</indexentry>
</index>

Changes from EAD 2002

<indexentry> contained @lang and @script. It lost <note>.

EAD3 Tag Library Entry

View the official tag library entry for <indexentry>