pspell-config-personal.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.pspell-config-personal" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pspell_config_personal</refname>
  <refpurpose>Set a file that contains personal wordlist</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <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>
  <para>
   Set a file that contains personal wordlist. The personal wordlist will be
   loaded and used in addition to the standard one after you call
   <function>pspell_new_config</function>. The file is also the file where
   <function>pspell_save_wordlist</function> will save personal wordlist to.
  </para>
  <para>
   <function>pspell_config_personal</function> should be used on a config
   before calling <function>pspell_new_config</function>. 
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>dictionary_link</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>file</parameter></term>
     <listitem>
      <para>
       The personal wordlist. If the file does not exist, it will be created.
       The file should be writable by whoever PHP runs as (e.g. nobody).    
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <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>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    This function will not work unless you have pspell .11.2 and aspell .32.5
    or later.
   </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
-->