mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 08:58:56 +00:00
Added documentation for PSPELL module
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@28312 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Vlad Krupin
parent
882c0b3a3a
commit
d7bdfb74b2
2 changed files with 250 additions and 0 deletions
|
|
@ -76,6 +76,7 @@
|
|||
<!ENTITY reference.recode SYSTEM "functions/recode.xml">
|
||||
<!ENTITY reference.info SYSTEM "functions/info.xml">
|
||||
<!ENTITY reference.pgsql SYSTEM "functions/pgsql.xml">
|
||||
<!ENTITY reference.pspell SYSTEM "functions/pspell.xml">
|
||||
<!ENTITY reference.regex SYSTEM "functions/regex.xml">
|
||||
<!ENTITY reference.sem SYSTEM "functions/sem.xml">
|
||||
<!ENTITY reference.session SYSTEM "functions/session.xml">
|
||||
|
|
|
|||
249
functions/pspell.xml
Normal file
249
functions/pspell.xml
Normal file
|
|
@ -0,0 +1,249 @@
|
|||
<reference id="ref.pspell">
|
||||
<title>Pspell functions</title>
|
||||
<titleabbrev>Pspell</titleabbrev>
|
||||
|
||||
<partintro>
|
||||
<simpara>
|
||||
The <function>pspell</function> functions allows you to check the
|
||||
spelling on a word and offer suggestions.
|
||||
</simpara>
|
||||
<simpara>
|
||||
You need the aspell and pspell libraries, available from: <ulink
|
||||
url="&url.pspell;">&url.pspell;</ulink>.
|
||||
</simpara>
|
||||
</partintro>
|
||||
|
||||
<refentry id="function.pspell_new">
|
||||
<refnamediv>
|
||||
<refname>pspell_new</refname>
|
||||
<refpurpose>Load a new dictionary</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>pspell_new</function></funcdef>
|
||||
<paramdef>string <parameter>language</parameter></paramdef>
|
||||
<paramdef>string
|
||||
<parameter>
|
||||
<optional>spelling</optional>
|
||||
</parameter>
|
||||
</paramdef>
|
||||
<paramdef>string
|
||||
<parameter>
|
||||
<optional>jargon</optional>
|
||||
</parameter>
|
||||
</paramdef>
|
||||
<paramdef>string
|
||||
<parameter>
|
||||
<optional>encoding</optional>
|
||||
</parameter>
|
||||
</paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
<simpara>
|
||||
<function>Pspell_new</function> opens up a new dictionary and
|
||||
returns the dictionary link identifier for use in other pspell
|
||||
functions.</simpara>
|
||||
<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. The spelling parameter is the requested
|
||||
spelling for languages with more than one spelling such as English. Known
|
||||
values are ``american'', ``britsh'', and ``canadian''. The jargon parameter
|
||||
contains extra information two distinguish two different words lists that
|
||||
have the same language-tag and spelling. 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. For more information and examples, check out inline manual pspell
|
||||
website:<ulink url="&url.pspell;">&url.pspell;</ulink>.
|
||||
</para>
|
||||
<para>
|
||||
<example>
|
||||
<title><function>Pspell_new</function></title>
|
||||
<programlisting role="php">
|
||||
$pspell_link = pspell_new("english");
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.pspell_mode">
|
||||
<refnamediv>
|
||||
<refname>pspell_mode</refname>
|
||||
<refpurpose>Change spellchecking mode</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>boolean <function>pspell_mode</function></funcdef>
|
||||
<paramdef>int <parameter>dictionary_link</parameter></paramdef>
|
||||
<paramdef>int <parameter>mode</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
<simpara>
|
||||
<function>pspell_mode</function> changes the spellchecking mode.
|
||||
</simpara>
|
||||
<para>There are three modes available:
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<simpara>
|
||||
PSPELL_FAST - Fast mode (least number of suggestions)
|
||||
</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<simpara>
|
||||
PSPELL_NORMAL - Normal mode (more suggestions)
|
||||
</simpara>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<simpara>
|
||||
PSPELL_BAD_SPELLERS - Slow mode (a lot of suggestions)
|
||||
</simpara>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</para>
|
||||
<para>
|
||||
<example>
|
||||
<title><function>Pspell_mode</function></title>
|
||||
<programlisting>
|
||||
$pspell_link = pspell_new("english");
|
||||
pspell_mode(PSPELL_FAST);
|
||||
|
||||
if(!pspell_check ($pspell_link, "testt")){
|
||||
$suggestions = pspell_suggest($pspell_link, "testt");
|
||||
}
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.pspell_runtogether">
|
||||
<refnamediv>
|
||||
<refname>pspell_runtogether</refname>
|
||||
<refpurpose>Consider run-together words as legal compounds</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>boolean <function>pspell_runtogether</function></funcdef>
|
||||
<paramdef>int <parameter>dictionary_link</parameter></paramdef>
|
||||
<paramdef>int <parameter>mode</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
<simpara>
|
||||
<function>pspell_runtogether</function> 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 pspell_check(); pspell_suggest()
|
||||
will still return suggestions, and they are not affected by the calls
|
||||
to php_runtogether().
|
||||
</simpara>
|
||||
<para>
|
||||
<example>
|
||||
<title><function>Pspell_runtogether</function></title>
|
||||
<programlisting>
|
||||
$pspell_link = pspell_new("english");
|
||||
pspell_runtogether(true);
|
||||
echo pspell_runtogether($pspell_link, "thecat") ? "correct" : "wrong";
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.pspell-check">
|
||||
<refnamediv>
|
||||
<refname>pspell_check</refname>
|
||||
<refpurpose>Check a word</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>boolean <function>pspell_check</function></funcdef>
|
||||
<paramdef>int <parameter>dictionary_link</parameter></paramdef>
|
||||
<paramdef>string <parameter>word</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
<simpara>
|
||||
<function>pspell_check</function> checks the spelling of a word
|
||||
and returns true if the spelling is correct, false if not.
|
||||
</simpara>
|
||||
<para>
|
||||
<example>
|
||||
<title><function>Pspell_check</function></title>
|
||||
<programlisting>
|
||||
$pspell_link = pspell_new("english");
|
||||
|
||||
if(pspell_check($pspell_link, "testt")){
|
||||
echo "This is a valid spelling";
|
||||
}else{
|
||||
echo "Sorry, wrong spelling";
|
||||
}
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.pspell-suggest">
|
||||
<refnamediv>
|
||||
<refname>pspell_suggest</refname>
|
||||
<refpurpose>Suggest spellings of a word</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>array <function>pspell_suggest</function></funcdef>
|
||||
<paramdef>int <parameter>dictionary_link</parameter></paramdef>
|
||||
<paramdef>string <parameter>word</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
<simpara>
|
||||
<function>Pspell_suggest</function> returns an array of possible
|
||||
spellings for the given word.
|
||||
</simpara>
|
||||
<para>
|
||||
<example>
|
||||
<title><function>Pspell_suggest</function></title>
|
||||
<programlisting role="php">
|
||||
$pspell_link = pspell_new("english");
|
||||
|
||||
if(!pspell_check ($pspell_link, "testt")){
|
||||
$suggestions = pspell_suggest($pspell_link, "testt");
|
||||
|
||||
for($i=0; $i < count ($suggestions); $i++){
|
||||
echo "Possible spelling: " . $suggestions[$i] . "<br>";
|
||||
}
|
||||
}
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
</reference>
|
||||
|
||||
<!-- 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
|
||||
sgml-parent-document:nil
|
||||
sgml-default-dtd-file:"../../manual.ced"
|
||||
sgml-exposed-tags:nil
|
||||
sgml-local-catalogs:nil
|
||||
sgml-local-ecat-files:nil
|
||||
End:
|
||||
-->
|
||||
Loading…
Reference in a new issue