mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 08:28:54 +00:00
Fix issues in ps directory (#712)
Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>
This commit is contained in:
parent
ef1ae5d45f
commit
9486a954ad
3 changed files with 176 additions and 170 deletions
|
@ -21,6 +21,11 @@
|
|||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
&no.function.parameters;
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
|
|
|
@ -100,21 +100,23 @@
|
|||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Bugs</title>
|
||||
<para>
|
||||
The second parameter is currently not always evaluated. The color is
|
||||
sometimes set for filling and drawing just as if
|
||||
<literal>fillstroke</literal> were passed.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="notes">
|
||||
&reftitle.notes;
|
||||
<caution>
|
||||
<para>
|
||||
The second parameter is currently not always evaluated. The color is
|
||||
sometimes set for filling and drawing just as if
|
||||
<literal>fillstroke</literal> were passed.
|
||||
</para>
|
||||
</caution>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
@ -137,4 +139,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
|
|||
vim: et tw=78 syn=sgml
|
||||
vi: ts=1 sw=1
|
||||
-->
|
||||
|
||||
|
|
|
@ -101,11 +101,11 @@
|
|||
<term><parameter>hmode</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The parameter <parameter>hmode</parameter> can be "justify",
|
||||
"fulljustify", "right", "left", or "center". The difference of
|
||||
"justify" and "fulljustify" just affects the last line of the box. In
|
||||
fulljustify mode the last line will be left and right justified unless
|
||||
this is also the last line of paragraph. In justify mode it will always
|
||||
The parameter <parameter>hmode</parameter> can be <literal>justify</literal>,
|
||||
<literal>fulljustify</literal>, <literal>right</literal>, <literal>left</literal>, or <literal>center</literal>.
|
||||
The difference of <literal>justify</literal> and <literal>fulljustify</literal> just affects the last line of the box. In
|
||||
<literal>fulljustify</literal> mode the last line will be left and right justified unless
|
||||
this is also the last line of paragraph. In <literal>justify</literal> mode it will always
|
||||
be left justified.
|
||||
</para>
|
||||
</listitem>
|
||||
|
@ -120,163 +120,163 @@
|
|||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Used parameters</title>
|
||||
<para>
|
||||
The output of <function>ps_show_boxed</function> can be configured with
|
||||
several parameters and values which must be set with either
|
||||
<function>ps_set_parameter</function> or <function>ps_set_value</function>.
|
||||
Beside the parameters and values which affect text output, the following
|
||||
parameters and values are evaluated.
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>leading (value)</term>
|
||||
<listitem>
|
||||
<para>Distance between baselines of two consecutive lines.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>linebreak (parameter)</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Set to "true" if you want a carriage return to start a new line instead
|
||||
of treating it as a space. Defaults to "false".
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>parbreak (parameter)</term>
|
||||
<listitem>
|
||||
<para>
|
||||
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".
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>hyphenation (parameter)</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Set to "true" in order to turn hyphenation on. This requires a
|
||||
dictionary to be set with the parameter "hyphendict". Defaults to
|
||||
"false".
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>hyphendict (parameter)</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Filename of the dictionary used for hyphenation pattern (see below).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>hyphenminchar (value)</term>
|
||||
<listitem>
|
||||
<para>
|
||||
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.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>parindent (value)</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Set the amount of space in pixel for indenting the first m lines of a
|
||||
paragraph. m can be set with the value "numindentlines".
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>parskip (value)</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Set the amount of extra space in pixel between paragraphs. Defaults to
|
||||
0 which will result in a normal line distance.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>numindentlines (value)</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Number of lines from the start of the paragraph which will be indented.
|
||||
Defaults to 1.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>parindentskip (value)</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Number of paragraphs in the box whose first lines will not be indented.
|
||||
This defaults to 0. 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 1.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>linenumbermode (parameter)</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Set how lines are to be numbered. Possible values are "box" for
|
||||
numbering lines in the whole box or "paragraph" to number lines within
|
||||
each paragraph.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>linenumberspace (value)</term>
|
||||
<listitem>
|
||||
<para>
|
||||
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.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>linenumbersep (value)</term>
|
||||
<listitem>
|
||||
<para>
|
||||
The space between the column with line numbers and the line itself.
|
||||
Defaults to 5.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect2>
|
||||
<title>Used parameters</title>
|
||||
<para>
|
||||
The output of <function>ps_show_boxed</function> can be configured with
|
||||
several parameters and values which must be set with either
|
||||
<function>ps_set_parameter</function> or <function>ps_set_value</function>.
|
||||
Beside the parameters and values which affect text output, the following
|
||||
parameters and values are evaluated.
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>leading (value)</term>
|
||||
<listitem>
|
||||
<para>Distance between baselines of two consecutive lines.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>linebreak (parameter)</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Set to <literal>true</literal> if you want a carriage return to start a new line instead
|
||||
of treating it as a space. Defaults to <literal>false</literal>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>parbreak (parameter)</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Set to <literal>true</literal> if you want a carriage return on a single line to start a
|
||||
new paragraph instead of treating it as a space. Defaults to <literal>true</literal>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>hyphenation (parameter)</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Set to <literal>true</literal> in order to turn hyphenation on. This requires a
|
||||
dictionary to be set with the parameter <parameter>hyphendict</parameter>. Defaults to
|
||||
<literal>false</literal>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>hyphendict (parameter)</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Filename of the dictionary used for hyphenation pattern (see below).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>hyphenminchar (value)</term>
|
||||
<listitem>
|
||||
<para>
|
||||
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.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>parindent (value)</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Set the amount of space in pixel for indenting the first m lines of a
|
||||
paragraph. m can be set with the value <literal>numindentlines</literal>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>parskip (value)</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Set the amount of extra space in pixel between paragraphs. Defaults to
|
||||
<literal>0</literal> which will result in a normal line distance.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>numindentlines (value)</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Number of lines from the start of the paragraph which will be indented.
|
||||
Defaults to <literal>1</literal>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>parindentskip (value)</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Number of paragraphs in the box whose first lines will not be indented.
|
||||
This defaults to <literal>0</literal>. 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 <literal>1</literal>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>linenumbermode (parameter)</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Set how lines are to be numbered. Possible values are <literal>box</literal> for
|
||||
numbering lines in the whole box or <literal>paragraph</literal> to number lines within
|
||||
each paragraph.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>linenumberspace (value)</term>
|
||||
<listitem>
|
||||
<para>
|
||||
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 <literal>20</literal>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>linenumbersep (value)</term>
|
||||
<listitem>
|
||||
<para>
|
||||
The space between the column with line numbers and the line itself.
|
||||
Defaults to <literal>5</literal>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect2>
|
||||
|
||||
<refsect1>
|
||||
<title>Hyphenation</title>
|
||||
<para>
|
||||
Text is hyphenated if the parameter <literal>hyphenation</literal> 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:
|
||||
<simplelist>
|
||||
<member>
|
||||
<filename class="directory">/usr/share/apps/koffice/hyphdicts/</filename>
|
||||
</member>
|
||||
<member>
|
||||
<filename class="directory">/usr/lib/scribus/dicts/</filename>
|
||||
</member>
|
||||
<member>
|
||||
<filename class="directory">/usr/lib/openoffice/share/dict/ooo/</filename>
|
||||
</member>
|
||||
</simplelist>
|
||||
Currently scribus appears to have the most complete hyphenation
|
||||
dictionaries.
|
||||
</para>
|
||||
<refsect2>
|
||||
<title>Hyphenation</title>
|
||||
<para>
|
||||
Text is hyphenated if the parameter <literal>hyphenation</literal> 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:
|
||||
<simplelist>
|
||||
<member>
|
||||
<filename class="directory">/usr/share/apps/koffice/hyphdicts/</filename>
|
||||
</member>
|
||||
<member>
|
||||
<filename class="directory">/usr/lib/scribus/dicts/</filename>
|
||||
</member>
|
||||
<member>
|
||||
<filename class="directory">/usr/lib/openoffice/share/dict/ooo/</filename>
|
||||
</member>
|
||||
</simplelist>
|
||||
Currently scribus appears to have the most complete hyphenation
|
||||
dictionaries.
|
||||
</para>
|
||||
</refsect2>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
|
|
Loading…
Reference in a new issue