systemitem
Prev | DocBook Element Reference | Next

This is an alpha version of this book.

# systemitem

## Name

systemitem — A system-related item or term

##

# Synopsis

### Mixed Content Model

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

### Attributes

Common attributes

Name | Type | Default
class | Enumeration:
constant
groupname
library
macro
osname
resource
systemname
username
| None
moreinfo | Enumeration:
none
refentry
| "none"

### Parameter Entities

The following parameter entities contain systemitem:

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

A `SystemItem` identifies any system-related item or term. The `Class` attribute defines a number of common system-related terms.

Many inline elements in DocBook are, in fact, system-related. Some of the objects identified by the `Class` attribute on `SystemItem` may eventually migrate out to be inline elements of their own accord…and vice versa.

### Processing expectations

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

### Future Changes

In DocBook V4.0, the content model of `SystemItem` will be constrained to `(#PCDATA | Replaceable | InlineGraphic)`.

Also, the `EnvironVar` and `Prompt` values of `Class` will be discarded (use `EnVar` and `Prompt` instead).

### Future Changes

The `register` class value will be added to support CPU registers. The `constant` class value will be removed.

### Parents

These elements contain systemitem: `application`, `attribution`, `bibliomisc`, `bridgehead`, `citation`, `citetitle`, `classsynopsisinfo`, `command`, `computeroutput`, `emphasis`, `entry`, `foreignphrase`, `funcparams`, `funcsynopsisinfo`, `function`, `glosssee`, `glossseealso`, `glossterm`, `lineannotation`, `link`, `literal`, `literallayout`, `lotentry`, `member`, `msgaud`, `olink`, `optional`, `para`, `phrase`, `primary`, `primaryie`, `productname`, `programlisting`, `quote`, `refdescriptor`, `refentrytitle`, `refname`, `refpurpose`, `remark`, `screen`, `screeninfo`, `secondary`, `secondaryie`, `see`, `seealso`, `seealsoie`, `seeie`, `seg`, `segtitle`, `simpara`, `subtitle`, `synopsis`, `term`, `tertiary`, `tertiaryie`, `title`, `titleabbrev`, `tocback`, `tocentry`, `tocfront`, `trademark`, `ulink`, `userinput`.

### Children

The following elements occur in systemitem: `acronym`, `beginpage`, `indexterm`, `inlinegraphic`, `inlinemediaobject`, `replaceable`.

## Attributes

class

  `Class` indicates the type of `SystemItem`.

moreinfo

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

## See Also

`computeroutput`, `envar`, `filename`, `prompt`, `userinput`.

## 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>
    For many years, O'Reilly's primary web server,
    <ulink url="http://www.oreilly.com/">http://www.oreilly.com/</ulink>,
    was hosted by <application>WN</application> on
    <systemitem class="systemname">helio.oreilly.com</systemitem>.
    </para>

For many years, O'Reilly's primary web server, http://www.oreilly.com/, was hosted by WN on `helio.oreilly.com`.

For additional examples, see also `part` .

Prev | Home | Next
synopsis | Up | table

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