pspell-new.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.pspell-new" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>pspell_new</refname>
  <refpurpose>Load a new dictionary</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>pspell_new</methodname>
   <methodparam><type>string</type><parameter>language</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>spelling</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>jargon</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>pspell_new</function> opens up a new dictionary and
   returns the dictionary link identifier for use in other pspell
   functions.
  </para>
  <para>
   For more information and examples, check out inline manual pspell
   website:<link xlink:href="&url.pspell;">&url.pspell;</link>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>language</parameter></term>
     <listitem>
      <para>
       The language parameter is the language code which consists of the
       two letter ISO 639 language code and an optional two letter ISO
       3166 country code after a dash or underscore.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>spelling</parameter></term>
     <listitem>
      <para>
       The spelling parameter is the requested spelling for languages
       with more than one spelling such as English. Known values are
       'american', 'british', and 'canadian'.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>jargon</parameter></term>
     <listitem>
      <para>
       The jargon parameter contains extra information to distinguish
       two different words lists that have the same language and
       spelling parameters.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>encoding</parameter></term>
     <listitem>
      <para>
       The encoding parameter is the encoding that words are expected to
       be in.  Valid values are 'utf-8', 'iso8859-*', 'koi8-r',
       'viscii', 'cp1252', 'machine unsigned 16', 'machine unsigned
       32'. This parameter is largely untested, so be careful when
       using.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mode</parameter></term>
     <listitem>
      <para>
       The mode parameter is the mode in which spellchecker will work.
       There are several modes available:
       <itemizedlist>
        <listitem>
         <simpara>
          <constant>PSPELL_FAST</constant> - Fast mode (least number of
          suggestions)
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>PSPELL_NORMAL</constant> - Normal mode (more suggestions)
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>PSPELL_BAD_SPELLERS</constant> - Slow mode (a lot of
          suggestions)
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>PSPELL_RUN_TOGETHER</constant> - Consider run-together words
          as legal compounds.  That is, "thecat" will be a legal compound,
          although there should be a space between the two words. Changing this
          setting only affects the results returned by
          <function>pspell_check</function>; <function>pspell_suggest</function>
          will still return suggestions.
         </simpara>
        </listitem>
       </itemizedlist>
       Mode is a bitmask constructed from different constants listed above.
       However, <constant>PSPELL_FAST</constant>,
       <constant>PSPELL_NORMAL</constant> and
       <constant>PSPELL_BAD_SPELLERS</constant> are mutually exclusive, so you
       should select only one of them.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the dictionary link identifier on success&return.falseforfailure;.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>pspell_new</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$pspell_link = pspell_new("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
-->