1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.22 $ -->
<reference id="ref.aspell">
<title>Aspell functions [deprecated]</title>
<titleabbrev>Aspell</titleabbrev>
<partintro>
<simpara>
The <function>aspell</function> functions allows you to check the
spelling on a word and offer suggestions.
</simpara>
<note>
<simpara>
aspell works only with very old (up to .27.* or so) versions of
aspell library. Neither this module, nor those versions of aspell
library are supported any longer. If you want to use
spell-checking capabilities in php, use <link
linkend="ref.pspell">pspell</link> instead. It uses pspell
library and works with newer versions of aspell.
</simpara>
</note>
<simpara>
You need the aspell library, available from: <ulink
url="&url.aspell;">&url.aspell;</ulink>.
</simpara>
</partintro>
<refentry id="function.aspell-new">
<refnamediv>
<refname>aspell_new</refname>
<refpurpose>Load a new dictionary [deprecated]</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>aspell_new</methodname>
<methodparam><type>string</type><parameter>master</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>personal</parameter></methodparam>
</methodsynopsis>
<!-- TODO: personal??? -->
<simpara>
<function>aspell_new</function> opens up a new dictionary and
returns the dictionary link identifier for use in other aspell
functions. Returns &false; on error.
</simpara>
<para>
<example>
<title><function>aspell_new</function></title>
<programlisting role="php">
<![CDATA[
$aspell_link = aspell_new("english");
]]>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
<refentry id="function.aspell-check">
<refnamediv>
<refname>aspell_check</refname>
<refpurpose>Check a word [deprecated]</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>aspell_check</methodname>
<methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam>
<methodparam><type>string</type><parameter>word</parameter></methodparam>
</methodsynopsis>
<simpara>
<function>aspell_check</function> checks the spelling of a word
and returns &true; if the spelling is correct, &false; if not.
</simpara>
<para>
<example>
<title><function>aspell_check</function></title>
<programlisting>
<![CDATA[
$aspell_link = aspell_new("english");
if (aspell_check($aspell_link, "testt")) {
echo "This is a valid spelling";
} else {
echo "Sorry, wrong spelling";
}
]]>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
<refentry id="function.aspell-check-raw">
<refnamediv>
<refname>aspell_check_raw</refname>
<refpurpose>
Check a word without changing its case or trying to trim it [deprecated]
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>aspell_check_raw</methodname>
<methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam>
<methodparam><type>string</type><parameter>word</parameter></methodparam>
</methodsynopsis>
<simpara>
<function>aspell_check_raw</function> checks the spelling of a
word, without changing its case or trying to trim it in any way
and returns &true; if the spelling is correct, &false; if not.
</simpara>
<para>
<example>
<title><function>aspell_check_raw</function></title>
<programlisting role="php">
<![CDATA[
$aspell_link = aspell_new("english");
if (aspell_check_raw($aspell_link, "test")) {
echo "This is a valid spelling";
} else {
echo "Sorry, wrong spelling";
}
]]>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
<refentry id="function.aspell-suggest">
<refnamediv>
<refname>aspell_suggest</refname>
<refpurpose>Suggest spellings of a word [deprecated]</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>aspell_suggest</methodname>
<methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam>
<methodparam><type>string</type><parameter>word</parameter></methodparam>
</methodsynopsis>
<simpara>
<function>aspell_suggest</function> returns an array of possible
spellings for the given word.
</simpara>
<para>
<example>
<title><function>aspell_suggest</function></title>
<programlisting role="php">
<![CDATA[
$aspell_link = aspell_new("english");
if (!aspell_check($aspell_link, "test")) {
$suggestions = aspell_suggest($aspell_link, "test");
foreach ($suggestions as $suggestion) {
echo "Possible spelling: $suggestion<br>\n";
}
}
]]>
</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
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
-->
|