php-doc-en/reference/pspell/functions/pspell-config-personal.xml
Jakub Vrana 2bed4f6ded Fix return types (2/2)
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@189137 c90b9560-bf6c-de11-be94-00142212c4b1
2005-06-24 09:11:47 +00:00

64 lines
2.2 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 -->
<refentry id="function.pspell-config-personal">
<refnamediv>
<refname>pspell_config_personal</refname>
<refpurpose>Set a file that contains personal wordlist</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>pspell_config_personal</methodname>
<methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam>
<methodparam><type>string</type><parameter>file</parameter></methodparam>
</methodsynopsis>
<simpara>
<function>pspell_config_personal</function> should be used on a config
before calling <function>pspell_new_config</function>. The personal
wordlist will be loaded and used in addition to the standard one after
you call <function>pspell_new_config</function>. If the file does not
exist, it will be created. The file is also the file where
<function>pspell_save_wordlist</function> will save personal wordlist to.
The file should be writable by whoever PHP runs as (e.g. nobody). 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_config_personal</function></title>
<programlisting role="php">
<![CDATA[
<?php
$pspell_config = pspell_config_create("en");
pspell_config_personal($pspell_config, "/var/dictionaries/custom.pws");
$pspell_link = pspell_new_config($pspell_config);
pspell_check($pspell_link, "thecat");
?>
]]>
</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
-->