File: function.pspell-new-personal.html

package info (click to toggle)
php3 3%3A3.0.18-0potato1.1
  • links: PTS
  • area: main
  • in suites: potato
  • size: 17,736 kB
  • ctags: 11,198
  • sloc: ansic: 108,120; sh: 2,512; php: 2,024; yacc: 1,887; makefile: 1,038; perl: 537; pascal: 238; awk: 90; cpp: 28; sql: 11
file content (343 lines) | stat: -rw-r--r-- 6,307 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
<HTML
><HEAD
><TITLE
>pspell_new_personal</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.57"><LINK
REL="HOME"
TITLE="PHP Manual"
HREF="manual.html"><LINK
REL="UP"
TITLE="Pspell Functions"
HREF="ref.pspell.html"><LINK
REL="PREVIOUS"
TITLE="pspell_new_config"
HREF="function.pspell-new-config.html"><LINK
REL="NEXT"
TITLE="pspell_save_wordlist"
HREF="function.pspell-save-wordlist.html"><META
NAME="HTTP_EQUIV"
CONTENT="text/html; charset=ISO-8859-1"></HEAD
><BODY
CLASS="refentry"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>PHP Manual</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="function.pspell-new-config.html"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="function.pspell-save-wordlist.html"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="function.pspell-new-personal"
>pspell_new_personal</A
></H1
><DIV
CLASS="refnamediv"
><A
NAME="AEN32496"
></A
><P
>    (PHP4 &#62;= 4.0.2)</P
>pspell_new_personal&nbsp;--&nbsp;Load a new dictionary with personal wordlist</DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN32499"
></A
><H2
>Description</H2
><DIV
CLASS="funcsynopsis"
><A
NAME="AEN32501"
></A
><P
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>int <B
CLASS="function"
>pspell_new_personal</B
></CODE
> (string personal, string language [, string 
       spelling [, string 
       jargon [, string 
       encoding [, int 
       mode]]]])</CODE
></P
><P
></P
></DIV
><P
>&#13;     <B
CLASS="function"
>Pspell_new_personal()</B
> opens up a new dictionary with
	 a personal wordlist and returns the dictionary link identifier for use
	 in other pspell functions. The wordlist can be modified and saved with
	 <A
HREF="function.pspell-save-wordlist.html"
><B
CLASS="function"
>pspell_save_wordlist()</B
></A
>, if desired. However, the
	 replacement pairs are not saved. In order to save replacement pairs, you
	 should create a config using <A
HREF="function.pspell-config-create.html"
><B
CLASS="function"
>pspell_config_create()</B
></A
>,
	 set the personal wordlist file with <B
CLASS="function"
>pspell_config_personal
	 ()</B
>, set the file for replacement pairs with 
	 <A
HREF="function.pspell-config-repl.html"
><B
CLASS="function"
>pspell_config_repl()</B
></A
>, and open a new dictionary with
	 <A
HREF="function.pspell-new-config.html"
><B
CLASS="function"
>pspell_new_config()</B
></A
>.
    </P
><P
>&#13;     The personal parameter specifies the file where words added to the
	 personal list will be stored. It should be an absolute filename
	 beginning with '/' because otherwise it will be relative to $HOME,
	 which is "/root" for most systems, and is probably not what you want.
    </P
><P
>&#13;     The language parameter is the language code which consists of the
     two letter ISO 639 language code and an optional two letter ISO
     3166 country code after a dash or underscore. 
    </P
><P
>&#13;     The spelling parameter is the requested spelling for languages
     with more than one spelling such as English. Known values are
     'american', 'british', and 'canadian'.
    </P
><P
>&#13;     The jargon parameter contains extra information to distinguish
     two different words lists that have the same language and
     spelling parameters.
    </P
><P
>&#13;     The encoding parameter is the encoding that words are expected to
     be in.  Valid values are 'utf-8', 'iso8859-*', 'koi8-r',
     'viscii', 'cp1252', 'machine unsigned 16', 'machine unsigned
     32'. This parameter is largely untested, so be careful when
     using.
    </P
><P
>&#13;     The mode parameter is the mode in which spellchecker will work.
     There are several modes available:
     <P
></P
><UL
><LI
><P
>&#13;	PSPELL_FAST - Fast mode (least number of suggestions)
       </P
></LI
><LI
><P
>&#13;	PSPELL_NORMAL - Normal mode (more suggestions)
       </P
></LI
><LI
><P
>&#13;	PSPELL_BAD_SPELLERS - Slow mode (a lot of suggestions)
       </P
></LI
><LI
><P
>&#13;	PSPELL_RUN_TOGETHER - Consider run-together words as legal
	compounds.  That is, "thecat" will be a legal compound,
	athough there should be a space between the two
	words. Changing this setting only affects the results returned
	by <A
HREF="function.pspell-check.html"
><B
CLASS="function"
>pspell_check()</B
></A
>;
	<A
HREF="function.pspell-suggest.html"
><B
CLASS="function"
>pspell_suggest()</B
></A
> will still return
	suggestions.
       </P
></LI
></UL
>
     Mode is a bitmask constructed from different constants listed
     above.  However, PSPELL_FAST, PSPELL_NORMAL and
     PSPELL_BAD_SPELLERS are mutually exclusive, so you should select
     only one of them.
    </P
><P
>&#13;     For more information and examples, check out inline manual pspell
     website:<A
HREF="http://pspell.sourceforge.net/"
TARGET="_top"
>http://pspell.sourceforge.net/</A
>.
    </P
><P
>&#13;     <TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
CLASS="EXAMPLE"
><TR
><TD
><DIV
CLASS="example"
><A
NAME="AEN32548"
></A
><P
><B
>Example 1. <B
CLASS="function"
>Pspell_new_personal()</B
></B
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="programlisting"
>&#13;$pspell_link = pspell_new_personal ("/var/dictionaries/custom.pws", 
		"en", "", "", "", PSPELL_FAST|PSPELL_RUN_TOGETHER));
      </PRE
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
>
    </P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="function.pspell-new-config.html"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="manual.html"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="function.pspell-save-wordlist.html"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>pspell_new_config</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="ref.pspell.html"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>pspell_save_wordlist</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>