ps_show_boxed
ps_show_boxed
Output text in a box
int **ps_show_boxed** resource $psdoc string $text float $left float $bottom float $width float $height string $hmode string $feature
Outputs a text in a given box. The lower left corner of the box is at
(, ). Line breaks
will be inserted where needed. Multiple spaces are treated as one.
Tabulators are treated as spaces.
left``bottom
The text will be hyphenated if the parameter
is set to true
and the parameter contains a valid
filename for a hyphenation
file. The line spacing is taken from the value .
Paragraphs can be
separated by an empty line just like in TeX. If the value
is
set to value > 0.0 then the first n lines will be indented. The number n
of lines is set by the parameter .
In order to prevent
indenting of the first m paragraphs set the value
to a
positive number.
hyphenation``hyphendict``leading``parindent``numindentlines``parindentskip
psdoc
Resource identifier of the postscript file
as returned by .
ps_new
textThe text to be output into the given box.
leftx-coordinate of the lower left corner of the box.
bottomy-coordinate of the lower left corner of the box.
widthWidth of the box.
heightHeight of the box.
hmode
The parameter can be ,
, , , or .
The difference of and just affects the last line of the box. In
mode the last line will be left and right justified unless
this is also the last line of paragraph. In mode it will always
be left justified.
hmode``justify``fulljustify``right``left``center``justify``fulljustify``fulljustify``justify
feature
Used parameters
The output of can be configured with
several parameters and values which must be set with either
or .
Beside the parameters and values which affect text output, the following
parameters and values are evaluated.
ps_show_boxed``ps_set_parameter``ps_set_valueDistance between baselines of two consecutive lines.
Set to true if you want a carriage return to start a new line instead of treating it as a space. Defaults to false.
Set to true if you want a carriage return on a single line to start a new paragraph instead of treating it as a space. Defaults to true.
Set to true in order to turn hyphenation on. This requires a
dictionary to be set with the parameter . Defaults to
false.
`hyphendict`
Filename of the dictionary used for hyphenation pattern (see below).
The number of chars which must at least be left over before or after the hyphen. This implies that only words of at least two times this value will be hyphenated. The default value is three. Setting a value of zero will result in the default value.
Set the amount of space in pixel for indenting the first m lines of a
paragraph. m can be set with the value .
`numindentlines`
Set the amount of extra space in pixel between paragraphs. Defaults to
which will result in a normal line distance.
`0`
Number of lines from the start of the paragraph which will be indented.
Defaults to .
`1`
Number of paragraphs in the box whose first lines will not be indented.
This defaults to . This is useful for paragraphs right after a section
heading or text being continued in a second box. In both case one would
set this to .
`0``1`
Set how lines are to be numbered. Possible values are for
numbering lines in the whole box or to number lines within
each paragraph.
`box``paragraph`
The space for the column left of the numbered line containing the line
number. The line number will be right justified into this column.
Defaults to .
`20`
The space between the column with line numbers and the line itself.
Defaults to .
`5`
Hyphenation
Text is hyphenated if the parameter is set
to true and a valid hyphenation dictionary is set. pslib does not ship its own
hyphenation dictionary but uses one from openoffice, scribus or koffice.
You can find their dictionaries for different languages in one of the
following directories if the software is installed:
Currently scribus appears to have the most complete hyphenation
dictionaries.
hyphenation
Number of characters that could not be written.
ps_continue_text