systemitem

systemitem — A system-related item or term.

Synopsis

systemitem ::= [-]

Attributes

Common attributes and common linking attributes.

Additional attributes:

  • At most one of:
    • class (enumeration)
      • “daemon”
      • “domainname”
      • “etheraddress”
      • “event”
      • “eventhandler”
      • “filesystem”
      • “fqdomainname”
      • “groupname”
      • “ipaddress”
      • “library”
      • “macro”
      • “netmask”
      • “newsgroup”
      • “osname”
      • “process”
      • “protocol”
      • “resource”
      • “securitycontext”
      • “server”
      • “service”
      • “systemname”
      • “username”
    • All or none of:
      • class (enumeration)
        • “other”
      • otherclass (NMTOKEN)

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 become separate inline elements, and some inline elements may migrate into systemitem.

Processing expectations

Formatted inline.

Attributes

Common attributes and common linking attributes.

class

Identifies the nature of the system item

Enumerated values:
“daemon”

A daemon or other system process (syslogd)

“domainname”

A domain name (example.com)

“etheraddress”

An ethernet address (00:05:4E:49:FD:8E)

“event”

An event of some sort (SIGHUP)

“eventhandler”

An event handler of some sort (hangup)

“filesystem”

A filesystem (ext3)

“fqdomainname”

A fully qualified domain name (my.example.com)

“groupname”

A group name (wheel)

“ipaddress”

An IP address (127.0.0.1)

“library”

A library (libncurses)

“macro”

A macro

“netmask”

A netmask (255.255.255.192)

“newsgroup”

A newsgroup (comp.text.xml)

“osname”

An operating system name (Hurd)

“process”

A process (gnome-cups-icon)

“protocol”

A protocol (ftp)

“resource”

A resource

“securitycontext”

A security context (a role, permission, or security token, for example)

“server”

A server (mail.example.com)

“service”

A service (ppp)

“systemname”

A system name (hephaistos)

“username”

A user name (ndw)

otherclass

Identifies the nature of the non-standard system item

Children

The following elements occur in systemitem: text, abbrev, acronym, alt, anchor, annotation, biblioref, co, coref, date, emphasis (db._emphasis), firstterm (db._firstterm), footnote, footnoteref, foreignphrase (db._foreignphrase), glossterm (db._glossterm), indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), inlinemediaobject, link, olink, phrase (db._phrase), quote (db._quote), remark, replaceable, subscript, superscript, trademark, wordasword, xref.

Examples

<article xmlns='http://docbook.org/ns/docbook'
         xmlns:xlink='http://www.w3.org/1999/xlink'>
<title>Example systemitem</title>

<para>For many years, O'Reilly's primary web server, 
<link xlink:href="http://www.oreilly.com/">http://www.oreilly.com/</link>,
was hosted by <application>WN</application> on
<systemitem class="systemname">helio.oreilly.com</systemitem>.
</para>

</article>

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

Last revised by Norman Walsh on (git hash: a5bf9d0f457b11f1d181c442e7789af392c4e1b6 9ea0f4c253876426b585b1ed5a3a381a983013c5)