File: function.pspell-new.html

package info (click to toggle)
php3 3%3A3.0.18-0potato1.1
links: PTS
area: main
in suites: potato
size: 17,736 kB
ctags: 11,198
sloc: ansic: 108,120; sh: 2,512; php: 2,024; yacc: 1,887; makefile: 1,038; perl: 537; pascal: 238; awk: 90; cpp: 28; sql: 11
file content (303 lines) | stat: -rw-r--r-- 5,148 bytes
parent folder | download | duplicates (3)
<HTML
><HEAD
><TITLE
>pspell_new</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.57"><LINK
REL="HOME"
TITLE="PHP Manual"
HREF="manual.html"><LINK
REL="UP"
TITLE="Pspell Functions"
HREF="ref.pspell.html"><LINK
REL="PREVIOUS"
TITLE="pspell_config_save_repl"
HREF="function.pspell-config-save-repl.html"><LINK
REL="NEXT"
TITLE="pspell_new_config"
HREF="function.pspell-new-config.html"><META
NAME="HTTP_EQUIV"
CONTENT="text/html; charset=ISO-8859-1"></HEAD
><BODY
CLASS="refentry"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>PHP Manual</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="function.pspell-config-save-repl.html"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="function.pspell-new-config.html"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="function.pspell-new"
>pspell_new</A
></H1
><DIV
CLASS="refnamediv"
><A
NAME="AEN32422"
></A
><P
>    (PHP4 &#62;= 4.0.2)</P
>pspell_new&nbsp;--&nbsp;Load a new dictionary</DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN32425"
></A
><H2
>Description</H2
><DIV
CLASS="funcsynopsis"
><A
NAME="AEN32427"
></A
><P
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>int <B
CLASS="function"
>pspell_new</B
></CODE
> (string language [, string 
       spelling [, string 
       jargon [, string 
       encoding [, int 
       mode]]]])</CODE
></P
><P
></P
></DIV
><P
>&#13;     <B
CLASS="function"
>Pspell_new()</B
> opens up a new dictionary and
     returns the dictionary link identifier for use in other pspell
     functions.
    </P
><P
>&#13;     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. 
    </P
><P
>&#13;     The spelling parameter is the requested spelling for languages
     with more than one spelling such as English. Known values are
     'american', 'british', and 'canadian'.
    </P
><P
>&#13;     The jargon parameter contains extra information to distinguish
     two different words lists that have the same language and
     spelling parameters.
    </P
><P
>&#13;     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.
    </P
><P
>&#13;     The mode parameter is the mode in which spellchecker will work.
     There are several modes available:
     <P
></P
><UL
><LI
><P
>&#13;	PSPELL_FAST - Fast mode (least number of suggestions)
       </P
></LI
><LI
><P
>&#13;	PSPELL_NORMAL - Normal mode (more suggestions)
       </P
></LI
><LI
><P
>&#13;	PSPELL_BAD_SPELLERS - Slow mode (a lot of suggestions)
       </P
></LI
><LI
><P
>&#13;	PSPELL_RUN_TOGETHER - Consider run-together words as legal
	compounds.  That is, "thecat" will be a legal compound,
	athough there should be a space between the two
	words. Changing this setting only affects the results returned
	by <A
HREF="function.pspell-check.html"
><B
CLASS="function"
>pspell_check()</B
></A
>;
	<A
HREF="function.pspell-suggest.html"
><B
CLASS="function"
>pspell_suggest()</B
></A
> will still return
	suggestions.
       </P
></LI
></UL
>
     Mode is a bitmask constructed from different constants listed
     above.  However, PSPELL_FAST, PSPELL_NORMAL and
     PSPELL_BAD_SPELLERS are mutually exclusive, so you should select
     only one of them.
    </P
><P
>&#13;     For more information and examples, check out inline manual pspell
     website:<A
HREF="http://pspell.sourceforge.net/"
TARGET="_top"
>http://pspell.sourceforge.net/</A
>.
    </P
><P
>&#13;     <TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
CLASS="EXAMPLE"
><TR
><TD
><DIV
CLASS="example"
><A
NAME="AEN32466"
></A
><P
><B
>Example 1. <B
CLASS="function"
>Pspell_new()</B
></B
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="programlisting"
>&#13;$pspell_link = pspell_new ("en", "", "", "", 
                           (PSPELL_FAST|PSPELL_RUN_TOGETHER));
      </PRE
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
>
    </P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="function.pspell-config-save-repl.html"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="manual.html"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="function.pspell-new-config.html"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>pspell_config_save_repl</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="ref.pspell.html"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>pspell_new_config</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>