| fmt |
(String text[, Array limits[, int squeeze]]) |
yoix.string |
| |
|
Breaks or consolidates
text
at space or line boundaries into multiple lines each with length within
the values specified by
limits,
as indicated below.
If
squeeze
is non-zero, multiple spaces or line breaks between words will be reduced to one space
or line break.
The default behavior is not to squeeze out the extra space.
The
Array
limits
consists of one, two or three
int
values specifying, respectively, a
goal,
a
maximum
and a
force_maximum
indicator.
If no
maximum
is supplied, the 10 more than the goal is used.
If no
goal
is supplied, the 65 is used.
The function attempts to make each line roughly
goal
long, but certainly no longer than
maximum,
unless the lack of a word boundary forces the
maximum
to be exceeded.
However, when
force_maximum
is supplied and is non-zero, then a break will be forced at the
maximum
whether or not a word boundary is encountered.
|
Yoix is a registered trademark of AT&T Inc.
|
