<index> Index

<index> is a wrapper element used to encode key terms and reference pointers which enhance access to the described materials or a helpful alphabetical overview of subjects, correspondents, photographers, or other entities represented in the collection. It may include links to further information or container numbers where the information about this specific topic/person/etc. may be found.

<index> may repeat terms and names found elsewhere in the finding aid or may clarify a previously unnamed term or entity. For example, a folder heading may be titled “Dalek to Judoon” and names for each species profiled in said folder, such as “Futurekind,” may be listed in the index. It should contain <indexentry> elements which contain the actual data, consisting of an access element such as <name> or <subject>, followed by <ptr/>, <ptrgrp>, or <ref>.

<index> is one of the elements which may be used within <archdesc>, <c>, <c01> … <c12>, and itself.

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

<index> may contain optional <head> element and zero or more <blockquote>, <chronlist>, <list>, <p>, and <table> elements. It then must contain either further <index> elements or a combination of an optional <listhead> and at least one <indexentry>.

To write it another way:

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

<index> contained @lang and @script. It lost <address> and <note>.

EAD3 Tag Library Entry

View the official tag library entry for <index>