php-doc-en/reference/pspell/functions/pspell-store-replacement.xml
2003-12-15 16:55:22 +00:00

70 lines
2.5 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.1 -->
<refentry id="function.pspell-store-replacement">
<refnamediv>
<refname>pspell_store_replacement</refname>
<refpurpose>Store a replacement pair for a word</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>pspell_store_replacement</methodname>
<methodparam><type>int</type><parameter>dictionary_link</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> stores a replacement pair for
a word, so that replacement can be returned by
<function>pspell_suggest</function> later. In order to be able to take
advantage of this function, you have to use
<function>pspell_new_personal</function> to open the dictionary. In order
to permanently save the replacement pair, you have to
use <function>pspell_config_personal</function> and
<function>pspell_config_repl</function> to set the path where to save your
custom wordlists, and then use <function>pspell_save_wordlist</function>
for the changes to be written to disk. Please, note that this function
will not work unless you have pspell .11.2 and aspell .32.5 or later.
</simpara>
<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_link = pspell_new_config($pspell_config);
pspell_store_replacement($pspell_link, $misspelled, $correct);
pspell_save_wordlist($pspell_link);
?>
]]>
</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
-->