Files
doc-fr/reference/pspell/functions/pspell-store-replacement.xml
George Peter Banyard 4a13066fbe Apply commit 81b23db050ac0627b056585c16bfe95445ae174e (#111)
Use an Pspell\[Dictionary|Config] instance instead of a resource
2021-10-08 10:58:54 +01:00

139 lines
3.8 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 81b23db050ac0627b056585c16bfe95445ae174e Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.pspell-store-replacement" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>pspell_store_replacement</refname>
<refpurpose>Enregistre une paire de remplacement pour un mot</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pspell_store_replacement</methodname>
<methodparam><type>PSpell\Dictionary</type><parameter>dictionary</parameter></methodparam>
<methodparam><type>string</type><parameter>misspelled</parameter></methodparam>
<methodparam><type>string</type><parameter>correct</parameter></methodparam>
</methodsynopsis>
<simpara>
<function>pspell_store_replacement</function> enregistre une paire de remplacement pour
un mot de façon à ce que cette suggestion soit retournée par
<function>pspell_suggest</function> plus tard. Pour pouvoir utiliser cette fonction,
vous devez utiliser
<function>pspell_new_personal</function> pour ouvrir le dictionnaire.
Pour pouvoir sauver tout le temps les paires de remplacement, vous devez
utiliser <function>pspell_config_personal</function> et
<function>pspell_config_repl</function> pour indiquer le lieu de
sauvegarde des dictionnaires personnels, et <function>pspell_save_wordlist</function>
pour enregistrer les modifications sur le disque.
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>dictionary</parameter></term>
<listitem>
&pspell.parameter.pspell-dictionary;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>misspelled</parameter></term>
<listitem>
<para>
Le mot mal orthographié.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>correct</parameter></term>
<listitem>
<para>
La bonne orthographe du mot <parameter>misspelled</parameter>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pspell.changelog.pspell-dictionary;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>pspell_store_replacement</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 = pspell_new_config($pspell_config);
pspell_store_replacement($pspell, $misspelled, $correct);
pspell_save_wordlist($pspell);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
Cette fonction ne marchera qu'avec pspell .11.2 et aspell .32.5
ou ultérieurs.
</para>
</note>
</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
-->