reference/ps/functions/ps-show-boxed.xml
cdc9d28d334bbc08386fecf8aade66080004a9dd
...
...
@@ -101,11 +101,11 @@
101
101
<term><parameter>hmode</parameter></term>
102
102
<listitem>
103
103
<para>
104
-
The parameter <parameter>hmode</parameter> can be "justify",
105
-
"fulljustify", "right", "left", or "center". The difference of
106
-
"justify" and "fulljustify" just affects the last line of the box. In
107
-
fulljustify mode the last line will be left and right justified unless
108
-
this is also the last line of paragraph. In justify mode it will always
104
+
The parameter <parameter>hmode</parameter> can be <literal>justify</literal>,
105
+
<literal>fulljustify</literal>, <literal>right</literal>, <literal>left</literal>, or <literal>center</literal>.
106
+
The difference of <literal>justify</literal> and <literal>fulljustify</literal> just affects the last line of the box. In
107
+
<literal>fulljustify</literal> mode the last line will be left and right justified unless
108
+
this is also the last line of paragraph. In <literal>justify</literal> mode it will always
109
109
be left justified.
110
110
</para>
111
111
</listitem>
...
...
@@ -120,163 +120,163 @@
120
120
</varlistentry>
121
121
</variablelist>
122
122
</para>
123
-
</refsect1>
124
123

125
-
<refsect1>
126
-
<title>Used parameters</title>
127
-
<para>
128
-
The output of <function>ps_show_boxed</function> can be configured with
129
-
several parameters and values which must be set with either
130
-
<function>ps_set_parameter</function> or <function>ps_set_value</function>.
131
-
Beside the parameters and values which affect text output, the following
132
-
parameters and values are evaluated.
133
-
<variablelist>
134
-
<varlistentry>
135
-
<term>leading (value)</term>
136
-
<listitem>
137
-
<para>Distance between baselines of two consecutive lines.</para>
138
-
</listitem>
139
-
</varlistentry>
140
-
<varlistentry>
141
-
<term>linebreak (parameter)</term>
142
-
<listitem>
143
-
<para>
144
-
Set to "true" if you want a carriage return to start a new line instead
145
-
of treating it as a space. Defaults to "false".
146
-
</para>
147
-
</listitem>
148
-
</varlistentry>
149
-
<varlistentry>
150
-
<term>parbreak (parameter)</term>
151
-
<listitem>
152
-
<para>
153
-
Set to "true" if you want a carriage return on a single line to start a
154
-
new paragraph instead of treating it as a space. Defaults to "true".
155
-
</para>
156
-
</listitem>
157
-
</varlistentry>
158
-
<varlistentry>
159
-
<term>hyphenation (parameter)</term>
160
-
<listitem>
161
-
<para>
162
-
Set to "true" in order to turn hyphenation on. This requires a
163
-
dictionary to be set with the parameter "hyphendict". Defaults to
164
-
"false".
165
-
</para>
166
-
</listitem>
167
-
</varlistentry>
168
-
<varlistentry>
169
-
<term>hyphendict (parameter)</term>
170
-
<listitem>
171
-
<para>
172
-
Filename of the dictionary used for hyphenation pattern (see below).
173
-
</para>
174
-
</listitem>
175
-
</varlistentry>
176
-
<varlistentry>
177
-
<term>hyphenminchar (value)</term>
178
-
<listitem>
179
-
<para>
180
-
The number of chars which must at least be left over before or after
181
-
the hyphen. This implies that only words of at least two times this
182
-
value will be hyphenated. The default value is three. Setting a value
183
-
of zero will result in the default value.
184
-
</para>
185
-
</listitem>
186
-
</varlistentry>
187
-
<varlistentry>
188
-
<term>parindent (value)</term>
189
-
<listitem>
190
-
<para>
191
-
Set the amount of space in pixel for indenting the first m lines of a
192
-
paragraph. m can be set with the value "numindentlines".
193
-
</para>
194
-
</listitem>
195
-
</varlistentry>
196
-
<varlistentry>
197
-
<term>parskip (value)</term>
198
-
<listitem>
199
-
<para>
200
-
Set the amount of extra space in pixel between paragraphs. Defaults to
201
-
0 which will result in a normal line distance.
202
-
</para>
203
-
</listitem>
204
-
</varlistentry>
205
-
<varlistentry>
206
-
<term>numindentlines (value)</term>
207
-
<listitem>
208
-
<para>
209
-
Number of lines from the start of the paragraph which will be indented.
210
-
Defaults to 1.
211
-
</para>
212
-
</listitem>
213
-
</varlistentry>
214
-
<varlistentry>
215
-
<term>parindentskip (value)</term>
216
-
<listitem>
217
-
<para>
218
-
Number of paragraphs in the box whose first lines will not be indented.
219
-
This defaults to 0. This is useful for paragraphs right after a section
220
-
heading or text being continued in a second box. In both case one would
221
-
set this to 1.
222
-
</para>
223
-
</listitem>
224
-
</varlistentry>
225
-
<varlistentry>
226
-
<term>linenumbermode (parameter)</term>
227
-
<listitem>
228
-
<para>
229
-
Set how lines are to be numbered. Possible values are "box" for
230
-
numbering lines in the whole box or "paragraph" to number lines within
231
-
each paragraph.
232
-
</para>
233
-
</listitem>
234
-
</varlistentry>
235
-
<varlistentry>
236
-
<term>linenumberspace (value)</term>
237
-
<listitem>
238
-
<para>
239
-
The space for the column left of the numbered line containing the line
240
-
number. The line number will be right justified into this column.
241
-
Defaults to 20.
242
-
</para>
243
-
</listitem>
244
-
</varlistentry>
245
-
<varlistentry>
246
-
<term>linenumbersep (value)</term>
247
-
<listitem>
248
-
<para>
249
-
The space between the column with line numbers and the line itself.
250
-
Defaults to 5.
251
-
</para>
252
-
</listitem>
253
-
</varlistentry>
254
-
</variablelist>
255
-
</para>
256
-
</refsect1>
124
+
<refsect2>
125
+
<title>Used parameters</title>
126
+
<para>
127
+
The output of <function>ps_show_boxed</function> can be configured with
128
+
several parameters and values which must be set with either
129
+
<function>ps_set_parameter</function> or <function>ps_set_value</function>.
130
+
Beside the parameters and values which affect text output, the following
131
+
parameters and values are evaluated.
132
+
<variablelist>
133
+
<varlistentry>
134
+
<term>leading (value)</term>
135
+
<listitem>
136
+
<para>Distance between baselines of two consecutive lines.</para>
137
+
</listitem>
138
+
</varlistentry>
139
+
<varlistentry>
140
+
<term>linebreak (parameter)</term>
141
+
<listitem>
142
+
<para>
143
+
Set to &true; if you want a carriage return to start a new line instead
144
+
of treating it as a space. Defaults to &false;.
145
+
</para>
146
+
</listitem>
147
+
</varlistentry>
148
+
<varlistentry>
149
+
<term>parbreak (parameter)</term>
150
+
<listitem>
151
+
<para>
152
+
Set to &true; if you want a carriage return on a single line to start a
153
+
new paragraph instead of treating it as a space. Defaults to &true;.
154
+
</para>
155
+
</listitem>
156
+
</varlistentry>
157
+
<varlistentry>
158
+
<term>hyphenation (parameter)</term>
159
+
<listitem>
160
+
<para>
161
+
Set to &true; in order to turn hyphenation on. This requires a
162
+
dictionary to be set with the parameter <parameter>hyphendict</parameter>. Defaults to
163
+
&false;.
164
+
</para>
165
+
</listitem>
166
+
</varlistentry>
167
+
<varlistentry>
168
+
<term>hyphendict (parameter)</term>
169
+
<listitem>
170
+
<para>
171
+
Filename of the dictionary used for hyphenation pattern (see below).
172
+
</para>
173
+
</listitem>
174
+
</varlistentry>
175
+
<varlistentry>
176
+
<term>hyphenminchar (value)</term>
177
+
<listitem>
178
+
<para>
179
+
The number of chars which must at least be left over before or after
180
+
the hyphen. This implies that only words of at least two times this
181
+
value will be hyphenated. The default value is three. Setting a value
182
+
of zero will result in the default value.
183
+
</para>
184
+
</listitem>
185
+
</varlistentry>
186
+
<varlistentry>
187
+
<term>parindent (value)</term>
188
+
<listitem>
189
+
<para>
190
+
Set the amount of space in pixel for indenting the first m lines of a
191
+
paragraph. m can be set with the value <literal>numindentlines</literal>.
192
+
</para>
193
+
</listitem>
194
+
</varlistentry>
195
+
<varlistentry>
196
+
<term>parskip (value)</term>
197
+
<listitem>
198
+
<para>
199
+
Set the amount of extra space in pixel between paragraphs. Defaults to
200
+
<literal>0</literal> which will result in a normal line distance.
201
+
</para>
202
+
</listitem>
203
+
</varlistentry>
204
+
<varlistentry>
205
+
<term>numindentlines (value)</term>
206
+
<listitem>
207
+
<para>
208
+
Number of lines from the start of the paragraph which will be indented.
209
+
Defaults to <literal>1</literal>.
210
+
</para>
211
+
</listitem>
212
+
</varlistentry>
213
+
<varlistentry>
214
+
<term>parindentskip (value)</term>
215
+
<listitem>
216
+
<para>
217
+
Number of paragraphs in the box whose first lines will not be indented.
218
+
This defaults to <literal>0</literal>. This is useful for paragraphs right after a section
219
+
heading or text being continued in a second box. In both case one would
220
+
set this to <literal>1</literal>.
221
+
</para>
222
+
</listitem>
223
+
</varlistentry>
224
+
<varlistentry>
225
+
<term>linenumbermode (parameter)</term>
226
+
<listitem>
227
+
<para>
228
+
Set how lines are to be numbered. Possible values are <literal>box</literal> for
229
+
numbering lines in the whole box or <literal>paragraph</literal> to number lines within
230
+
each paragraph.
231
+
</para>
232
+
</listitem>
233
+
</varlistentry>
234
+
<varlistentry>
235
+
<term>linenumberspace (value)</term>
236
+
<listitem>
237
+
<para>
238
+
The space for the column left of the numbered line containing the line
239
+
number. The line number will be right justified into this column.
240
+
Defaults to <literal>20</literal>.
241
+
</para>
242
+
</listitem>
243
+
</varlistentry>
244
+
<varlistentry>
245
+
<term>linenumbersep (value)</term>
246
+
<listitem>
247
+
<para>
248
+
The space between the column with line numbers and the line itself.
249
+
Defaults to <literal>5</literal>.
250
+
</para>
251
+
</listitem>
252
+
</varlistentry>
253
+
</variablelist>
254
+
</para>
255
+
</refsect2>
257
256

258
-
<refsect1>
259
-
<title>Hyphenation</title>
260
-
<para>
261
-
Text is hyphenated if the parameter <literal>hyphenation</literal> is set
262
-
to true and a valid hyphenation dictionary is set. pslib does not ship its own
263
-
hyphenation dictionary but uses one from openoffice, scribus or koffice.
264
-
You can find their dictionaries for different languages in one of the
265
-
following directories if the software is installed:
266
-
<simplelist>
267
-
<member>
268
-
<filename class="directory">/usr/share/apps/koffice/hyphdicts/</filename>
269
-
</member>
270
-
<member>
271
-
<filename class="directory">/usr/lib/scribus/dicts/</filename>
272
-
</member>
273
-
<member>
274
-
<filename class="directory">/usr/lib/openoffice/share/dict/ooo/</filename>
275
-
</member>
276
-
</simplelist>
277
-
Currently scribus appears to have the most complete hyphenation
278
-
dictionaries.
279
-
</para>
257
+
<refsect2>
258
+
<title>Hyphenation</title>
259
+
<para>
260
+
Text is hyphenated if the parameter <literal>hyphenation</literal> is set
261
+
to true and a valid hyphenation dictionary is set. pslib does not ship its own
262
+
hyphenation dictionary but uses one from openoffice, scribus or koffice.
263
+
You can find their dictionaries for different languages in one of the
264
+
following directories if the software is installed:
265
+
<simplelist>
266
+
<member>
267
+
<filename class="directory">/usr/share/apps/koffice/hyphdicts/</filename>
268
+
</member>
269
+
<member>
270
+
<filename class="directory">/usr/lib/scribus/dicts/</filename>
271
+
</member>
272
+
<member>
273
+
<filename class="directory">/usr/lib/openoffice/share/dict/ooo/</filename>
274
+
</member>
275
+
</simplelist>
276
+
Currently scribus appears to have the most complete hyphenation
277
+
dictionaries.
278
+
</para>
279
+
</refsect2>
280
280
</refsect1>
281
281

282
282
<refsect1 role="returnvalues">
283
283



Tools (Spanish Manual)