[Prev] [Next]

RefPurpose

Name

Synopsis

  (#PCDATA | FootnoteRef | XRef | Abbrev | Acronym | Citation
  | CiteRefEntry | CiteTitle | Emphasis | FirstTerm
  | ForeignPhrase | GlossTerm | Footnote | Phrase | Quote
  | Trademark | WordAsWord | Link | OLink | ULink | Action
  | Application | ClassName | Command | ComputerOutput
  | Database | Email | EnVar | ErrorCode | ErrorName
  | ErrorType | Filename | Function | GUIButton | GUIIcon
  | GUILabel | GUIMenu | GUIMenuItem | GUISubmenu | Hardware
  | Interface | InterfaceDefinition | KeyCap | KeyCode
  | KeyCombo | KeySym | Literal | Markup | MediaLabel
  | MenuChoice | MouseButton | MsgText | Option | Optional
  | Parameter | Prompt | Property | Replaceable | ReturnValue
  | SGMLTag | StructField | StructName | Symbol | SystemItem
  | Token | Type | UserInput | Anchor | Author | AuthorInitials
  | CorpAuthor | ModeSpec | OtherCredit | ProductName
  | ProductNumber | RevHistory | Comment | Subscript
  | Superscript)+

Attributes

This element has common and Role attributes.

Tag Minimization

The start-tag is required for this element. The end-tag is optional, if your SGML declaration allows minimization.

Description

Short phrase describing the subject of the reference page. It may contain in-line elements and has common attributes.

Parents

RefPurpose occurs in RefNameDiv.

Children

RefPurpose contains these elements: Abbrev, Acronym, Action, Anchor, Application, Author, AuthorInitials, Citation, CiteRefEntry, CiteTitle, ClassName, Command, Comment, ComputerOutput, CorpAuthor, Database, Email, Emphasis, EnVar, ErrorCode, ErrorName, ErrorType, Filename, FirstTerm, Footnote, FootnoteRef, ForeignPhrase, Function, GUIButton, GUIIcon, GUILabel, GUIMenu, GUIMenuItem, GUISubmenu, GlossTerm, Hardware, Interface, InterfaceDefinition, KeyCap, KeyCode, KeyCombo, KeySym, Link, Literal, Markup, MediaLabel, MenuChoice, ModeSpec, MouseButton, MsgText, OLink, Option, Optional, OtherCredit, #PCDATA, Parameter, Phrase, ProductName, ProductNumber, Prompt, Property, Quote, Replaceable, ReturnValue, RevHistory, SGMLTag, StructField, StructName, Subscript, Superscript, Symbol, SystemItem, Token, Trademark, Type, ULink, UserInput, WordAsWord, and XRef.

Examples

<REFNAMEDIV ID="X061-RP72">
<REFNAME>abcwm
</REFNAME>
<REFPURPOSE>the ABC window manager
</REFPURPOSE>
<REFCLASS>ABC system</REFCLASS>
</REFNAMEDIV>

<REFNAMEDIV ID="X061-RP73">
<REFNAME>grep
</REFNAME>
<REFNAME>egrep
</REFNAME>
<REFNAME>fgrep
</REFNAME>
<REFPURPOSE>search a file for a string or regular expression
</REFPURPOSE>
</REFNAMEDIV>

<REFNAMEDIV ID="X061-RP74">
<REFDESCRIPTOR>string
</REFDESCRIPTOR>
<REFNAME>strcat
</REFNAME>
<REFNAME>strdup
</REFNAME>
<REFNAME>strncat
</REFNAME>
<REFNAME>strcmp
</REFNAME>
<REFNAME>strncmp
</REFNAME>
<REFPURPOSE>string operators
</REFPURPOSE>
</REFNAMEDIV>

[Prev] RefNameDiv
[Next] RefSect1Info
[Reference Home] [Davenport Group Home]