<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 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 text is needed and <ref> when it is. <indexentry> may also contain a <note> element which creates subcategories.

<namegrp> may be used to bundle multiple element entries with the same <ref>, <ptr> or <ptrgrpy> element. Multiple <ref> or <ptr> links for a single access term may be bundled using <ptrgrp>.

<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.
  • ENCODINGANALOG – not required. May contain information to map this tag to a particular element in another schema.

Subelements

<indexentry> may contain further <indexentry> elements, as well as: <corpname>, <famname>, <function>, <genreform>, <geogname>, <name>, <namegrp>, <occupation>, <persname>, <ptr>, <ptrgrp>, <ref>, <subject>, and <title>. It may not contain <p> tags or plain (unencoded) text.

Examples

Same index from the <index>:

<index>
	<head>Index of Classified Alien Species</head>
	<p>Names of alien species classified in UNIT dossiers. Species are listed alphabetically and linked to the folder in which their dossier may be found. Because of the classified nature of these records, no name authorities exist.</p>
	<indexentry>
		<namegrp>
			<name>Adipose</name>
			<name>Atraxi</name>
			<name>Auton</name>
			<name>Bees</name>
			<name>Carrionite</name>
			<name>CatKind</name>
			<name>Chula</name>
			<name>Cyberman</name>
		</namegrp>
		<ref linktype="simple" target="FAtoC" show="replace" actuate="onrequest">Folder A-C</ref>
	</indexentry>
	<indexentry>
		<namegrp>
			<name>Dalek</name>
			<name>Davros</name>
			<name>Eknodine</name>
			<name>Fairies</name>
			<name>Family of Blood</name>
			<name>Flesh</name>
			<name>Futurekind</name>
			<name>Gangers</name>
			<name>Gelth</name>
			<name>Hath</name>
			<name>Judoon</name>
		</namegrp>
		<ref linktype="simple" target="FDtoJ" show="replace" actuate="onrequest">Folder D-J</ref>
	</indexentry>
	<indexentry>
		<namegrp>
			<name>Krillitane</name>
			<name>Master</name>
			<name>Mayfly</name>
			<name>Multi-form</name>
			<name>Ood</name>
			<name>Racnoss</name>
			<name>Raxacoricofallapatorian</name>
			<name>Reaper</name>
			<name>Silence</name>
			<name>Silurian</name>
			<name>Smilers</name>
			<name>Star whale</name>
			<name>Sycorax</name>
		</namegrp>
		<ref linktype="simple" target="FKtoS" show="replace" actuate="onrequest">Folder K-S</ref>
	</indexentry>
	<indexentry>
		<namegrp>
			<name>Tenza</name>
			<name>Teselecta</name>
			<name>Time Lord</name>
			<name>Vashta Nerada</name>
			<name>Weeping Angels</name>
			<name>Zocci</name>
		</namegrp>
		<ref linktype="simple" target="FTtoZ" show="replace" actuate="onrequest">Folder T-Z</ref>
	</indexentry>
</index>

EAD tag library entry for <indexentry>.