<refentry id="indexentry.element">
<?dbhtml filename="indexentry.html"?>
<refentryinfo>
<pubdate>$Date$</pubdate>
<releaseinfo>$Revision$</releaseinfo>
</refentryinfo>

<refmeta>
<indexterm><primary>elements</primary>
<secondary>indexentry</secondary></indexterm>
<refentrytitle>indexentry</refentrytitle>
<refmiscinfo>Element</refmiscinfo>
</refmeta>
<refnamediv>
<refname>indexentry</refname>
<refpurpose>&indexentry.purpose;</refpurpose>
</refnamediv>

&indexentry.synopsis.gen;
<refsect1 condition='ref.description'><title>Description</title>

<para>
An <sgmltag>IndexEntry</sgmltag> wraps all of the index terms associated with
a particular primary index term.  This includes an arbitrary list of
<link linkend="secondaryie.element">secondary</link> and 
<link linkend="tertiaryie.element">tertiary</link> elements as well as 
<link linkend="seeie.element">See</link> and
<link linkend="seealsoie.element">SeeAlso</link> elements.
</para>

<refsect2><title>Processing expectations</title>
<para>
&format.block; 
A rendered index usually places secondary items under primary items
and tertiary items under secondary.
</para>
</refsect2>


&indexentry.parents.gen;
&indexentry.children.gen;
</refsect1>
<refsect1 condition='ref.elem.seealso'><title>See Also</title>
&indexentry.seealso.gen;
</refsect1>
<refsect1><title>Examples</title>

&indexentry.example.seealso.gen;
</refsect1>
</refentry>

