property

$Revision: 1.3 $

$Date: 2002/06/12 11:18:30 $

property — A unit of data associated with some part of a computer system

Synopsis

Mixed Content Model

property ::=
(#PCDATA|link|olink|ulink|action|application|classname|methodname|
 interfacename|exceptionname|ooclass|oointerface|ooexception|
 command|computeroutput|database|email|envar|errorcode|errorname|
 errortype|errortext|filename|function|guibutton|guiicon|guilabel|
 guimenu|guimenuitem|guisubmenu|hardware|interface|keycap|keycode|
 keycombo|keysym|literal|code|constant|markup|medialabel|
 menuchoice|mousebutton|option|optional|parameter|prompt|property|
 replaceable|returnvalue|sgmltag|structfield|structname|symbol|
 systemitem|uri|token|type|userinput|varname|nonterminal|anchor|
 remark|subscript|superscript|inlinegraphic|inlinemediaobject|
 indexterm|beginpage)*

Attributes

Common attributes

Name

Type

Default

moreinfo
Enumeration:
none
refentry
"none"

Description

The notion of a Property is very domain-dependent in computer documentation. Some object-oriented systems speak of properties; the components from which GUIs are constructed have properties; and one can speak of properties in very general terms; “the properties of a relational database.

You might use Property for any of these in your documentation.

Processing expectations

Formatted inline. The MoreInfo attribute can help generate a link or query to retrieve additional information.

Future Changes

The content model of Property will be constrained to (#PCDATA | Replaceable | InlineGraphic) in DocBook V4.0.

Attributes

moreinfo

If MoreInfo is set to RefEntry, it implies that a RefEntry exists which further describes the Property.

See Also

classname, interface, structfield, structname, symbol, token, type.

Examples

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<para>
When Emacs is running under X Windows, the <property>borderWidth</property>
resource controls the width of the external border.
</para>

When Emacs is running under X Windows, the borderWidth resource controls the width of the external border.