SBR

Name

SBR -- An explicit line break in a command synopsis

Synopsis

Content Model

SBR ::=
EMPTY

Attributes

Common attributes

Tag Minimization

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

Description

For the most part, DocBook attempts to describe document structure rather than presentation. However, in some complex environments, it is possible to demonstrate that there is no reasonable set of processing expectations that can guarantee correct formatting.

CmdSynopsis is one of those environments. Within a long synopsis, it may be necessary to specify the location of a line break explicitly.

The SBR element indicates the position of such a line break in a CmdSynopsis. It is purely presentational.

Processing expectations

SBR causes a line break.

Parents

These elements contain SBR: Arg, CmdSynopsis, Group.

Children

In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.

See Also

Arg, CmdSynopsis, Group, RefSynopsisDiv, SynopFragment, SynopFragmentRef

Examples

For examples, see SynopFragment.

Copyright © 1999 O'Reilly & Associates, Inc. All rights reserved.