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

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

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

<para>
The use of <sgmltag>See</sgmltag> in an <sgmltag>IndexTerm</sgmltag> indicates that
the reader should be directed elsewhere in the index if they attempt
to look up this term.
</para>

<para>
The content of <sgmltag>See</sgmltag> identifies another term in the
index which the reader should consult <emphasis>instead</emphasis> of
the current term.
</para>

<refsect2><title>Processing expectations</title>
<para>
&format.suppress; This element provides data for processing but it
is not rendered in the primary flow of text.
</para>
<para>It is possible for multiple <sgmltag>IndexTerm</sgmltag>s, taken together,
to form an illogical index.  For example, given the following
<sgmltag>IndexTerm</sgmltag>s:

<screen>
<![CDATA[
<indexterm><primary>Extensible Markup Language</primary>
  <see>XML</see></indexterm>
<indexterm><primary>Extensible Markup Language</primary>
  <secondary>definition of</secondary>
</indexterm>
]]>
</screen>
</para>
<para>
there's no way to construct a logical index because an entry in
the index should never have both a <sgmltag>see</sgmltag> and other
content.
</para>
<para>
DocBook cannot detect these errors. You will have to rely on an
external process to find them.
</para>
</refsect2>

<refsect2 role='fu' revision="4.0"><title>&FutureChanges;</title>
<para>
<!--do not index this occurance-->
&fu.interfacedefinition;
</para>
</refsect2>


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

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

