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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 -->
<refentry id="function.pspell-config-create">
<refnamediv>
<refname>pspell_config_create</refname>
<refpurpose>Create a config used to open a dictionary</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>pspell_config_create</methodname>
<methodparam><type>string</type><parameter>language</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>
spelling
</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>
jargon
</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>
encoding
</parameter></methodparam>
</methodsynopsis>
<simpara>
<function>pspell_config_create</function> has a very similar syntax to
<function>pspell_new</function>. In fact, using
<function>pspell_config_create</function> immediately followed by
<function>pspell_new_config</function> will produce the exact same result.
However, after creating a new config, you can also use
<function>pspell_config_*</function> functions before calling
<function>pspell_new_config</function> to take advantage of some
advanced functionality.
</simpara>
<para>
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.
</para>
<para>
The spelling parameter is the requested spelling for languages
with more than one spelling such as English. Known values are
'american', 'british', and 'canadian'.
</para>
<para>
The jargon parameter contains extra information to distinguish
two different words lists that have the same language and
spelling parameters.
</para>
<para>
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.
</para>
<para>
The mode parameter is the mode in which spellchecker will work.
There are several modes available:
<itemizedlist>
<listitem>
<simpara>
<constant>PSPELL_FAST</constant> - Fast mode (least number of
suggestions)
</simpara>
</listitem>
<listitem>
<simpara>
<constant>PSPELL_NORMAL</constant> - Normal mode (more suggestions)
</simpara>
</listitem>
<listitem>
<simpara>
<constant>PSPELL_BAD_SPELLERS</constant> - Slow mode (a lot of
suggestions)
</simpara>
</listitem>
</itemizedlist>
</para>
<para>
For more information and examples, check out inline manual pspell
website:<ulink url="&url.pspell;">&url.pspell;</ulink>.
</para>
<para>
<example>
<title><function>pspell_config_create</function></title>
<programlisting role="php">
<![CDATA[
<?php
$pspell_config = pspell_config_create("en");
pspell_config_personal($pspell_config, "/var/dictionaries/custom.pws");
pspell_config_repl($pspell_config, "/var/dictionaries/custom.repl");
$pspell_link = pspell_new_personal($pspell_config, "en");
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
