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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- Purpose: international -->
<!-- Membership: pecl, external -->
<reference id="ref.enchant">
<title>enchant Functions</title>
<titleabbrev>enchant</titleabbrev>
<partintro>
<section id="enchant.intro">
&reftitle.intro;
<para>
Enchant is the PHP binding for the
<ulink url="&url.enchant;">Enchant library</ulink>. Enchant steps
in to provide uniformity and conformity on top of all spelling
libraries, and implement certain features that may be lacking in
any individual provider library. Everything should "just work"
for any and every definition of "just working."
</para>
<para>
Enchat supports the following backends:
<itemizedlist>
<listitem>
<para>
<literal>Aspell/Pspell (intends to replace Ispell)</literal>
</para>
</listitem>
<listitem>
<para>
<literal>Ispell (old as sin, could be interpreted as a defacto standard)</literal>
</para>
</listitem>
<listitem>
<para>
<literal>MySpell/Hunspell (an OOo projects, also used by Mozilla)</literal>
</para>
</listitem>
<listitem>
<para>
<literal>Uspell (primarily Yiddish, Hebrew, and Eastern European languages - hosted in AbiWord's CVS under the module "uspell")</literal>
</para>
</listitem>
<listitem>
<para>
<literal>Hspell (Hebrew)</literal>
</para>
</listitem>
<listitem>
<para>
<literal>AppleSpell (Mac OSX)</literal>
</para>
</listitem>
</itemizedlist>
</para>
</section>
<section id="enchant.requirements">
&reftitle.required;
<para>
This version uses the functions of the
<ulink url="&url.enchant;">Enchant library</ulink> by
Dom Lachowicz. You need Enchant 1.2.4 or later.
</para>
</section>
<section id="enchant.installation">
&reftitle.install;
<para>
&pecl.info;
<ulink url="&url.pecl.package;enchant">&url.pecl.package;enchant</ulink>.
</para>
</section>
<!-- Information found in configure.xml -->
<!-- reference.enchant.configure; -->
<!-- Information found in ini.xml -->
<!-- reference.enchant.ini; -->
<section id="enchant.configuration">
&reftitle.runtime;
&no.config;
</section>
<section id="enchant.resources">
&reftitle.resources;
<para>
There are two types of resources in this extension. The first
one is the broker (backends manager) and the second is for the
dictionary.
</para>
</section>
<section id="enchant.examples">
&reftitle.examples;
<example>
<title>Enchant Usage Example</title>
<programlisting role="php">
<![CDATA[
<?php
$tag = 'en_US';
$r = enchant_broker_init();
$bprovides = enchant_broker_describe($r);
echo "Current broker provides the following backend(s):\n";
print_r($bprovides);
$dicts = enchant_broker_list_dicts($r);
print_r($dicts);
if (enchant_broker_dict_exists($r,$tag)) {
$d = enchant_broker_request_dict($r, $tag);
$dprovides = enchant_dict_describe($d);
echo "dictionary $tag provides:\n";
$spellerrors = enchant_dict_check($d, "soong");
print_r($dprovides);
echo "found $spellerrors spell errors\n";
if ($spellerrors) {
$suggs = enchant_dict_suggest($d, "soong");
echo "Suggestions for 'soong':";
print_r($suggs);
}
enchant_broker_free_dict($d);
} else {
}
enchant_broker_free($r);
?>
]]>
</programlisting>
</example>
</section>
</partintro>
&reference.enchant.functions;
</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
-->
|