break-width
Full Description
swirl
Syntax
  break-width preferred-width (to maximum-width)?


Purpose

Defines acceptable line widths for all streams. break-width can be used either as a declaration in an OmniMark program or as an open modifier.

Both preferred-width and maximum-width are positive integers. The first value, preferred-width, is the preferred output line width, expressed as a character count. (OmniMark will try to break lines with more than this number of characters.) The second value, maximum-width, is optional. It gives the maximum acceptable output line width. If this number is given, an error occurs if the output line exceeds the value and OmniMark can't find an acceptable place to break it. Obviously, the maximum-width value must be greater than the preferred-width value.

There can be only one break-width declaration in an OmniMark program.

Unlike the other open modifiers, break-width must be parenthesized within a set action. This avoids potential ambiguity in the interpretation of the to keyword.

Older versions of OmniMark allowed the keyword to to be omitted when specifying the maximum width. This use is now deprecated.

Copyright © OmniMark Technologies Corporation, 1988-1998.