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

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

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

<para>
<sgmltag>RefNameDiv</sgmltag> is the first mandatory section in a
<sgmltag>RefEntry</sgmltag>.  It is a peer to
<sgmltag>RefSynopsisDiv</sgmltag> and <sgmltag>RefSect1</sgmltag>.
</para>
<para>
The elements in <sgmltag>RefNameDiv</sgmltag> identify the topic of the
reference page (<sgmltag>RefDescriptor</sgmltag> or <sgmltag>RefName</sgmltag>), provide a
concise summary (<sgmltag>RefPurpose</sgmltag>), and classify the
page (<sgmltag>RefClass</sgmltag>).
</para>

<refsect2><title>Processing expectations</title>
<para>
&format.block; <sgmltag>RefNameDiv</sgmltag> usually generates a
section heading, in the same typographic style as a
<sgmltag>RefSect1</sgmltag> <sgmltag>Title</sgmltag>, called <quote>Name.</quote>
</para>
<para>
The content of this section is traditionally the <sgmltag>RefDescriptor</sgmltag>
or <sgmltag>RefName</sgmltag>, and the <sgmltag>RefPurpose</sgmltag>, separated by an
em dash.
</para>
<para>
The <sgmltag>RefClass</sgmltag> may be presented, or it may be suppressed and used
only to select a group of reference pages to process.  You might use the value of <sgmltag>RefClass</sgmltag> to print all the reference pages
appropriate to <productname>Solaris</productname> &UNIX;, for example.
</para>
<para>
Formatting reference pages may require a fairly sophisticated
processing system.  Much of the meta-information about a
reference page (its name, type, purpose, title, and
classification) is stored in wrappers near the beginning of
the <sgmltag>RefEntry</sgmltag>.
</para>
<para>
Common presentational features, such as titles and running
headers, may require data from several of these wrappers plus
some generated text. Other formatting often requires that
these elements be reordered.
</para>
</refsect2>



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

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

