This is an alpha version of this book.

property

Name

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

Synopsis

Mixed Content Model

property ::=
(#PCDATA|replaceable|inlinegraphic|inlinemediaobject|indexterm|
 beginpage)*

Attributes

Common attributes

Name

Type

Default

moreinfo

Enumeration:

none
refentry
"none"

Parameter Entities

The following parameter entities contain property:

Parameter Entities
%cptr.char.mix; %ndxterm.char.mix; %para.char.mix;
%refinline.char.mix; %refname.char.mix; %tbl.entry.mdl;
%tech.char.class; %title.char.mix;  

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.

[4.0] Future Changes

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

Children

The following elements occur in property: beginpage, indexterm, inlinegraphic, inlinemediaobject, replaceable.

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.

Copyright © 1999, 2000, 2001 O'Reilly & Associates, Inc.