-
Notifications
You must be signed in to change notification settings - Fork 153
/
pspell-new-personal.xml
207 lines (202 loc) · 7.35 KB
/
pspell-new-personal.xml
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
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 81b23db050ac0627b056585c16bfe95445ae174e Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.pspell-new-personal" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>pspell_new_personal</refname>
<refpurpose>Charge un nouveau dictionnaire avec un dictionnaire personnel</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>PSpell\Dictionary</type><type>false</type></type><methodname>pspell_new_personal</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam><type>string</type><parameter>language</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>spelling</parameter><initializer>""</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>jargon</parameter><initializer>""</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>""</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<simpara>
<function>pspell_new_personal</function> charge un nouveau dictionnaire avec
un dictionnaire personnel. Ce dernier peut être modifié et sauvé avec
<function>pspell_save_wordlist</function>. Cependant, les paires de
remplacement ne seront pas sauvées. Pour ce faire, vous devez
créer une configuration qui utilise <function>pspell_config_create</function>,
choisir le fichier de destination du dictionnaire personnel avec
<function>pspell_config_personal</function>, choisir le fichier de paires
de remplacement avec
<function>pspell_config_repl</function> et ouvrir un nouveau dictionnaire avec
<function>pspell_new_config</function>.
</simpara>
<para>
Pour davantage d'information et d'exemples, jetez un oeil sur le manuel en ligne sur le site
web de pspell : <link xlink:href="&url.pspell;">&url.pspell;</link>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
Le fichier où seront ajoutés les mots du dictionnaire personnel.
Ce doit être un chemin absolu, qui commence par '/' car, sinon,
il sera relatif à $HOME, qui est "/root" sur la plupart des systèmes, et
probablement pas ce que vous souhaitez.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>language</parameter></term>
<listitem>
<para>
Le paramètre de langage <parameter>language</parameter> est le
code de langue ISO 639 en deux lettres, suivi de deux lettres optionnelles
ISO 3166, après un tiret ou un souligné (_).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>spelling</parameter></term>
<listitem>
<para>
Le paramètre d'orthographe <parameter>spelling</parameter> est nécessaire pour les langues
qui ont plus d'une orthographe, comme l'anglais. Les valeurs reconnues sont alors 'american'
(américain) , 'british' (anglais), et 'canadian' (canadien).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>jargon</parameter></term>
<listitem>
<para>
Informations supplémentaires pour distinguer deux dictionnaires distincts pour
la même langue et le même paramètre d'orthographe <parameter>spelling</parameter>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>encoding</parameter></term>
<listitem>
<para>
L'encodage attendu pour la réponse. Les valeurs valides sont :
<literal>utf-8</literal>, <literal>iso8859-*</literal>,
<literal>koi8-r</literal>, <literal>viscii</literal>,
<literal>cp1252</literal>, <literal>machine unsigned 16</literal>,
<literal>machine unsigned 32</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
Le mode de travail du vérificateur d'orthographe. Plusieurs modes sont disponibles :
<itemizedlist>
<listitem>
<simpara>
<constant>PSPELL_FAST</constant> - Mode rapide (moins de
suggestions)
</simpara>
</listitem>
<listitem>
<simpara>
<constant>PSPELL_NORMAL</constant> - Mode normal (plus de suggestions)
</simpara>
</listitem>
<listitem>
<simpara>
<constant>PSPELL_BAD_SPELLERS</constant> - Mode lent (beaucoup plus de
suggestions)
</simpara>
</listitem>
<listitem>
<simpara>
<constant>PSPELL_RUN_TOGETHER</constant> - Considère les mots
attachés comme légaux. De ce fait, "lechat" sera un mot composé légal,
bien qu'il devrait y avoir un espace entre les deux mots. Changer cette configuration
n'affecte que le résultat retourné par
<function>pspell_check</function>; <function>pspell_suggest</function>
continuera de retourner les suggestions.
</simpara>
</listitem>
</itemizedlist>
Le mode est un masque construit depuis les différentes constantes listées ci-dessous.
Cependant, les constantes <constant>PSPELL_FAST</constant>,
<constant>PSPELL_NORMAL</constant> et
<constant>PSPELL_BAD_SPELLERS</constant> sont mutuellement exclusives, donc
vous ne devez sélectionner qu'une seule d'entre elles.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retourne une instance de <classname>PSpell\Dictionary</classname> en cas de succès,&return.falseforfailure;.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.1.0</entry>
<entry>
Retourne désormais une instance de <classname>PSpell\Dictionary</classname> ;
auparavant, une &resource; était retournée.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>pspell_new_personal</function></title>
<programlisting role="php">
<![CDATA[
<?php
$pspell = pspell_new_personal ("/var/dictionaries/custom.pws",
"en", "", "", "", PSPELL_FAST|PSPELL_RUN_TOGETHER);
?>
]]>
</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:"~/.phpdoc/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
-->