pajoye Fri Aug 11 17:30:20 2006 UTC
Added files:
/phpdoc/en/reference/enchant functions.xml reference.xml
/phpdoc/en/reference/enchant/functions enchant-broker-describe.xml
enchant-broker-dict-exists.xml
enchant-broker-free-dict.xml
enchant-broker-free.xml
enchant-broker-get-error.xml
enchant-broker-init.xml
enchant-broker-list-dicts.xml
enchant-broker-request-dict.xml
enchant-broker-request-pwl-dict.xml
enchant-broker-set-ordering.xml
enchant-dict-add-to-personal.xml
enchant-dict-add-to-session.xml
enchant-dict-check.xml
enchant-dict-describe.xml
enchant-dict-get-error.xml
enchant-dict-is-in-session.xml
enchant-dict-quick-check.xml
enchant-dict-store-replacement.xml
enchant-dict-suggest.xml
Log:
- Initial pecl/enchant documentation
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/enchant/functions.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/enchant/functions.xml
+++ phpdoc/en/reference/enchant/functions.xml
&reference.enchant.functions.enchant-broker-describe;
&reference.enchant.functions.enchant-broker-dict-exists;
&reference.enchant.functions.enchant-broker-free-dict;
&reference.enchant.functions.enchant-broker-free;
&reference.enchant.functions.enchant-broker-get-error;
&reference.enchant.functions.enchant-broker-init;
&reference.enchant.functions.enchant-broker-list-dicts;
&reference.enchant.functions.enchant-broker-request-dict;
&reference.enchant.functions.enchant-broker-request-pwl-dict;
&reference.enchant.functions.enchant-broker-set-ordering;
&reference.enchant.functions.enchant-dict-add-to-personal;
&reference.enchant.functions.enchant-dict-add-to-session;
&reference.enchant.functions.enchant-dict-check;
&reference.enchant.functions.enchant-dict-describe;
&reference.enchant.functions.enchant-dict-get-error;
&reference.enchant.functions.enchant-dict-is-in-session;
&reference.enchant.functions.enchant-dict-quick-check;
&reference.enchant.functions.enchant-dict-store-replacement;
&reference.enchant.functions.enchant-dict-suggest;
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/enchant/reference.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/enchant/reference.xml
+++ phpdoc/en/reference/enchant/reference.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- Purpose: -->
<!-- Membership: -->
<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> library 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
-->
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/enchant/functions/enchant-broker-describe.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/enchant/functions/enchant-broker-describe.xml
+++ phpdoc/en/reference/enchant/functions/enchant-broker-describe.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.enchant-broker-describe">
<refnamediv>
<refname>enchant_broker_describe</refname>
<refpurpose>Enumerates the Enchant providers and tells</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>enchant_broker_describe</methodname>
<methodparam><type>resource</type><parameter>broker</parameter></methodparam>
</methodsynopsis>
<para>
Enumerates the Enchant providers and tells you some rudimentary
information about them. The same info is provided through phpinfo().
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>broker</parameter></term>
<listitem>
<para>
Broker resource
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>List the backends provided by the given broker</title>
<programlisting role="php">
<![CDATA[
<?php
$r = enchant_broker_init();
$bprovides = enchant_broker_describe($r);
echo "Current broker provides the following backend(s):\n";
print_r($bprovides);
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Current broker provides the following backend(s):
Array
(
[0] => Array
(
[name] => aspell
[desc] => Aspell Provider
[file] => /usr/lib/enchant/libenchant_aspell.so
)
[1] => Array
(
[name] => hspell
[desc] => Hspell Provider
[file] => /usr/lib/enchant/libenchant_hspell.so
)
[2] => Array
(
[name] => ispell
[desc] => Ispell Provider
[file] => /usr/lib/enchant/libenchant_ispell.so
)
[3] => Array
(
[name] => myspell
[desc] => Myspell Provider
[file] => /usr/lib/enchant/libenchant_myspell.so
)
)
]]>
</screen>
</example>
</para>
</refsect1>
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
</simplelist>
</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:"../../../../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
-->
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/enchant/functions/enchant-broker-dict-exists.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/enchant/functions/enchant-broker-dict-exists.xml
+++ phpdoc/en/reference/enchant/functions/enchant-broker-dict-exists.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.enchant-broker-dict-exists">
<refnamediv>
<refname>enchant_broker_dict_exists</refname>
<refpurpose>Wether a dictionary exists or not. Using non-empty
tag</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>enchant_broker_dict_exists</methodname>
<methodparam><type>resource</type><parameter>broker</parameter></methodparam>
<methodparam><type>string</type><parameter>tag</parameter></methodparam>
</methodsynopsis>
<para>
Tells if a dictionary exists or not, using a non-empty tags
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>broker</parameter></term>
<listitem>
<para>
Broker resource
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>tag</parameter></term>
<listitem>
<para>
non-empty tag in the LOCALE format, ex: us_US, ch_DE, etc.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; when the tag exist or &false; when not.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>enchant_broker_dict_exists</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$tag = 'en_US';
$r = enchant_broker_init();
if (enchant_broker_dict_exists($r,$tag)) {
echo $tag . "dictinary found\n.";
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>enchant_broker_describe</function></member>
</simplelist>
</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:"../../../../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
-->
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/enchant/functions/enchant-broker-free-dict.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/enchant/functions/enchant-broker-free-dict.xml
+++ phpdoc/en/reference/enchant/functions/enchant-broker-free-dict.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.enchant-broker-free-dict">
<refnamediv>
<refname>enchant_broker_free_dict</refname>
<refpurpose>Free a dictionary resource</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>enchant_broker_free_dict</methodname>
<methodparam><type>resource</type><parameter>dict</parameter></methodparam>
</methodsynopsis>
<para>
Free a dictinary resource.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>dict</parameter></term>
<listitem>
<para>
Dictionary resource.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>enchant_broker_request_dict</function></member>
<member><function>enchant_broker_request_pwl_dict</function></member>
</simplelist>
</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:"../../../../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
-->
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/enchant/functions/enchant-broker-free.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/enchant/functions/enchant-broker-free.xml
+++ phpdoc/en/reference/enchant/functions/enchant-broker-free.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.enchant-broker-free">
<refnamediv>
<refname>enchant_broker_free</refname>
<refpurpose>Free the broker resource and its dictionnaries</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>boolean</type><methodname>enchant_broker_free</methodname>
<methodparam><type>resource</type><parameter>broker</parameter></methodparam>
</methodsynopsis>
<para>
Free a broker resource with all its dictinaries.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>broker</parameter></term>
<listitem>
<para>
Broker resource
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>enchant_broker_init</function></member>
</simplelist>
</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:"../../../../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
-->
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/enchant/functions/enchant-broker-get-error.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/enchant/functions/enchant-broker-get-error.xml
+++ phpdoc/en/reference/enchant/functions/enchant-broker-get-error.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.enchant-broker-get-error">
<refnamediv>
<refname>enchant_broker_get_error</refname>
<refpurpose>Returns the last error of the broker</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>enchant_broker_get_error</methodname>
<methodparam><type>resource</type><parameter>broker</parameter></methodparam>
</methodsynopsis>
<para>
Returns the last error which occured in this broker.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>broker</parameter></term>
<listitem>
<para>
Broker resource.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Return the msg string if an error was found or &false;
</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:"../../../../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
-->
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/enchant/functions/enchant-broker-init.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/enchant/functions/enchant-broker-init.xml
+++ phpdoc/en/reference/enchant/functions/enchant-broker-init.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.enchant-broker-init">
<refnamediv>
<refname>enchant_broker_init</refname>
<refpurpose>create a new broker object capable of requesting</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>enchant_broker_init</methodname>
<void/>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a broker resource on success or &false;.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>enchant_broker_free</function></member>
</simplelist>
</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:"../../../../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
-->
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/enchant/functions/enchant-broker-list-dicts.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/enchant/functions/enchant-broker-list-dicts.xml
+++ phpdoc/en/reference/enchant/functions/enchant-broker-list-dicts.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.enchant-broker-list-dicts">
<refnamediv>
<refname>enchant_broker_list_dicts</refname>
<refpurpose>Returns the last error of the broker</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>enchant_broker_list_dicts</methodname>
<methodparam><type>resource</type><parameter>broker</parameter></methodparam>
</methodsynopsis>
<para>
Returns a list of available dictionaries with their details.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>broker</parameter></term>
<listitem>
<para>
Broker resource
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>List all available dictionaries for one broker</title>
<programlisting role="php">
<![CDATA[
<?php
$r = enchant_broker_init();
$dicts = enchant_broker_list_dicts($r);
print_r($dicts);
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Array
(
[0] => Array
(
[lang_tag] => de
[provider_name] => aspell
[provider_desc] => Aspell Provider
[provider_file] => /usr/lib/enchant/libenchant_aspell.so
)
[1] => Array
(
[lang_tag] => de_DE
[provider_name] => aspell
[provider_desc] => Aspell Provider
[provider_file] => /usr/lib/enchant/libenchant_aspell.so
)
[3] => Array
(
[lang_tag] => en
[provider_name] => aspell
[provider_desc] => Aspell Provider
[provider_file] => /usr/lib/enchant/libenchant_aspell.so
)
[4] => Array
(
[lang_tag] => en_GB
[provider_name] => aspell
[provider_desc] => Aspell Provider
[provider_file] => /usr/lib/enchant/libenchant_aspell.so
)
[5] => Array
(
[lang_tag] => en_US
[provider_name] => aspell
[provider_desc] => Aspell Provider
[provider_file] => /usr/lib/enchant/libenchant_aspell.so
)
[6] => Array
(
[lang_tag] => hi_IN
[provider_name] => myspell
[provider_desc] => Myspell Provider
[provider_file] => /usr/lib/enchant/libenchant_myspell.so
)
)
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>enchant_broker_describe </function></member>
</simplelist>
</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:"../../../../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
-->
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/enchant/functions/enchant-broker-request-dict.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/enchant/functions/enchant-broker-request-dict.xml
+++ phpdoc/en/reference/enchant/functions/enchant-broker-request-dict.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.enchant-broker-request-dict">
<refnamediv>
<refname>enchant_broker_request_dict</refname>
<refpurpose>create a new dictionary using a tag</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>enchant_broker_request_dict</methodname>
<methodparam><type>resource</type><parameter>broker</parameter></methodparam>
<methodparam><type>string</type><parameter>tag</parameter></methodparam>
</methodsynopsis>
<para>
create a new dictionary using tag, the non-empty language tag you
wish to request a dictionary for ("en_US", "de_DE", ...)
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>broker</parameter></term>
<listitem>
<para>
Broker resource
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>tag</parameter></term>
<listitem>
<para>
A tag describing the locale, for example en_US, de_DE
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a dictionary resource on success or &false; on failure.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>enchant_broker_request_dict</function> example</title>
<para>
Check if a dictionary exists using
<function>enchant_broker_dict_exists</function> and request it.
</para>
<programlisting role="php">
<![CDATA[
<?php
$tag = 'en_US';
$broker = enchant_broker_init();
if (enchant_broker_dict_exists($broker,$tag)) {
$dict = enchant_broker_request_dict($r, $tag);
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>enchant_dict_describe</function></member>
<member><function>enchant_broker_dict_exists</function></member>
<member><function>enchant_broker_dict_free</function></member>
</simplelist>
</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:"../../../../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
-->
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/enchant/functions/enchant-broker-request-pwl-dict.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/enchant/functions/enchant-broker-request-pwl-dict.xml
+++ phpdoc/en/reference/enchant/functions/enchant-broker-request-pwl-dict.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.enchant-broker-request-pwl-dict">
<refnamediv>
<refname>enchant_broker_request_pwl_dict</refname>
<refpurpose>creates a dictionary using a PWL file. A PWL file is personal
word file one word per line.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>enchant_broker_request_pwl_dict</methodname>
<methodparam><type>resource</type><parameter>broker</parameter></methodparam>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
creates a dictionary using a PWL file. A PWL file is personal word file one
word per line.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>broker</parameter></term>
<listitem>
<para>
Dict
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
Path to the PWL file.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a dictionary resource on success or &false; on failure.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>enchant_dict_describe</function></member>
<member><function>enchant_broker_dict_exists</function></member>
<member><function>enchant_broker_dict_free</function></member>
</simplelist>
</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:"../../../../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
-->
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/enchant/functions/enchant-broker-set-ordering.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/enchant/functions/enchant-broker-set-ordering.xml
+++ phpdoc/en/reference/enchant/functions/enchant-broker-set-ordering.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.enchant-broker-set-ordering">
<refnamediv>
<refname>enchant_broker_set_ordering</refname>
<refpurpose>Declares a preference of dictionaries to use for the
language</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>enchant_broker_set_ordering</methodname>
<methodparam><type>resource</type><parameter>broker</parameter></methodparam>
<methodparam><type>string</type><parameter>tag</parameter></methodparam>
<methodparam><type>string</type><parameter>ordering</parameter></methodparam>
</methodsynopsis>
<para>
Declares a preference of dictionaries to use for the language
described/referred to by 'tag'. The ordering is a comma delimited
list of provider names. As a special exception, the "*" tag can
be used as a language tag to declare a default ordering for any
language that does not explictly declare an ordering.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>broker</parameter></term>
<listitem>
<para>
Broker resource
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>tag</parameter></term>
<listitem>
<para>
Language tag. The special "*" tag can be used as a language tag
to declare a default ordering for any language that does not
explictly declare an ordering.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>ordering</parameter></term>
<listitem>
<para>
Comma delimited list of provider names
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</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:"../../../../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
-->
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/enchant/functions/enchant-dict-add-to-personal.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/enchant/functions/enchant-dict-add-to-personal.xml
+++ phpdoc/en/reference/enchant/functions/enchant-dict-add-to-personal.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.enchant-dict-add-to-personal">
<refnamediv>
<refname>enchant_dict_add_to_personal</refname>
<refpurpose>add a word to personal word list</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>enchant_dict_add_to_personal</methodname>
<methodparam><type>resource</type><parameter>dict</parameter></methodparam>
<methodparam><type>string</type><parameter>word</parameter></methodparam>
</methodsynopsis>
<para>
Add a word to personal word list of the given dictionary.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>dict</parameter></term>
<listitem>
<para>
Dictionary resource
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>word</parameter></term>
<listitem>
<para>
The word to add
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>enchant_broker_request_pwl_dict</function></member>
<member><function>enchant_broker_request_dict</function></member>
</simplelist>
</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:"../../../../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
-->
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/enchant/functions/enchant-dict-add-to-session.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/enchant/functions/enchant-dict-add-to-session.xml
+++ phpdoc/en/reference/enchant/functions/enchant-dict-add-to-session.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.enchant-dict-add-to-session">
<refnamediv>
<refname>enchant_dict_add_to_session</refname>
<refpurpose>add 'word' to this spell-checking session</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>enchant_dict_add_to_session</methodname>
<methodparam><type>resource</type><parameter>dict</parameter></methodparam>
<methodparam><type>string</type><parameter>word</parameter></methodparam>
</methodsynopsis>
<para>
Add a word to the given dictionaray. It will be added only for the
active spell-checking session.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>dict</parameter></term>
<listitem>
<para>
Dictionary resource
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>word</parameter></term>
<listitem>
<para>
The word to add
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>enchant_broker_request_dict</function></member>
</simplelist>
</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:"../../../../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
-->
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/enchant/functions/enchant-dict-check.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/enchant/functions/enchant-dict-check.xml
+++ phpdoc/en/reference/enchant/functions/enchant-dict-check.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.enchant-dict-check">
<refnamediv>
<refname>enchant_dict_check</refname>
<refpurpose>Check whether a word is correctly spelled or not.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>enchant_dict_check</methodname>
<methodparam><type>resource</type><parameter>dict</parameter></methodparam>
<methodparam><type>string</type><parameter>word</parameter></methodparam>
</methodsynopsis>
<para>
If the word is correctly spelled return &true;, otherwise return &false;
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>dict</parameter></term>
<listitem>
<para>
Dictionary resource
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>word</parameter></term>
<listitem>
<para>
The word to check
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if the word is spelled correctly, &false; if not.
</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:"../../../../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
-->
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/enchant/functions/enchant-dict-describe.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/enchant/functions/enchant-dict-describe.xml
+++ phpdoc/en/reference/enchant/functions/enchant-dict-describe.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.enchant-dict-describe">
<refnamediv>
<refname>enchant_dict_describe</refname>
<refpurpose>Describes an individual dictionary</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>enchant_dict_describe</methodname>
<methodparam><type>resource</type><parameter>dict</parameter></methodparam>
</methodsynopsis>
<para>
Returns the details of the dictionary.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>dict</parameter></term>
<listitem>
<para>
Dictinaray resource
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>enchant_broker_request_dict</function> example</title>
<para>
Check if a dictionary exists using
<function>enchant_broker_dict_exists</function> and request it.
</para>
<programlisting role="php">
<![CDATA[
<?php
$tag = 'en_US';
$broker = enchant_broker_init();
if (enchant_broker_dict_exists($broker,$tag)) {
$dict = enchant_broker_request_dict($r, $tag);
$dict_details = enchant_broker_dict_describe($dict);
print_r($dict_details);
}
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Array
(
[lang] => en_US
[name] => aspell
[desc] => Aspell Provider
[file] => /usr/lib/enchant/libenchant_aspell.so
)
]]>
</screen>
</example>
</para>
</refsect1>
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></member>
</simplelist>
</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:"../../../../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
-->
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/enchant/functions/enchant-dict-get-error.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/enchant/functions/enchant-dict-get-error.xml
+++ phpdoc/en/reference/enchant/functions/enchant-dict-get-error.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.enchant-dict-get-error">
<refnamediv>
<refname>enchant_dict_get_error</refname>
<refpurpose>Returns the last error of the current
spelling-session</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>enchant_dict_get_error</methodname>
<methodparam><type>resource</type><parameter>dict</parameter></methodparam>
</methodsynopsis>
<para>
Returns the last error of the current spelling-session
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>dict</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the error message as string or &false; if no error occured.
</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:"../../../../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
-->
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/enchant/functions/enchant-dict-is-in-session.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/enchant/functions/enchant-dict-is-in-session.xml
+++ phpdoc/en/reference/enchant/functions/enchant-dict-is-in-session.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.enchant-dict-is-in-session">
<refnamediv>
<refname>enchant_dict_is_in_session</refname>
<refpurpose>whether or not 'word' exists in this spelling-session</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>enchant_dict_is_in_session</methodname>
<methodparam><type>resource</type><parameter>dict</parameter></methodparam>
<methodparam><type>string</type><parameter>word</parameter></methodparam>
</methodsynopsis>
<para>
Tells whether or not a word already exists in the current session.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>dict</parameter></term>
<listitem>
<para>
Dictionary resource
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>word</parameter></term>
<listitem>
<para>
The word to lookup
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if the word exists or &false;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>enchant_dict_add_to_session</function></member>
</simplelist>
</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:"../../../../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
-->
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/enchant/functions/enchant-dict-quick-check.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/enchant/functions/enchant-dict-quick-check.xml
+++ phpdoc/en/reference/enchant/functions/enchant-dict-quick-check.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.enchant-dict-quick-check">
<refnamediv>
<refname>enchant_dict_quick_check</refname>
<refpurpose>Check the word is correctly spelled and provide
suggestions</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>enchant_dict_quick_check</methodname>
<methodparam><type>resource</type><parameter>dict</parameter></methodparam>
<methodparam><type>string</type><parameter>word</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter
role="reference">suggestions</parameter></methodparam>
</methodsynopsis>
<para>
If the word is correctly spelled return &true;, otherwise return &false;, if
suggestions variable
is provided, fill it with spelling alternatives.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>dict</parameter></term>
<listitem>
<para>
Dictionary resource
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>word</parameter></term>
<listitem>
<para>
The word to check
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>suggestions</parameter></term>
<listitem>
<para>
If the workd is not correctly spelled, this variable will
contain an array of suggestions.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if the word is correctly spelled or &false;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>enchant_dict_quick_check</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$tag = 'en_US';
$r = enchant_broker_init();
if (enchant_broker_dict_exists($r,$tag)) {
$d = enchant_broker_request_dict($r, $tag);
enchant_dict_quick_check($d, 'soong', $suggs);
print_r($suggs);
}
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Array
(
[0] => song
[1] => snog
[2] => soon
[3] => Sang
[4] => Sung
[5] => sang
[6] => sung
[7] => sponge
[8] => spongy
[9] => snag
[10] => snug
[11] => sonic
[12] => sing
[13] => songs
[14] => Son
[15] => Sonja
[16] => Synge
[17] => son
[18] => Sejong
[19] => sarong
[20] => sooner
[21] => Sony
[22] => sown
[23] => scone
[24] => song's
)
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>enchant_dict_check</function></member>
<member><function>enchant_dict_suggest</function></member>
</simplelist>
</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:"../../../../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
-->
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/enchant/functions/enchant-dict-store-replacement.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/enchant/functions/enchant-dict-store-replacement.xml
+++ phpdoc/en/reference/enchant/functions/enchant-dict-store-replacement.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.enchant-dict-store-replacement">
<refnamediv>
<refname>enchant_dict_store_replacement</refname>
<refpurpose>add a correction for a word.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>enchant_dict_store_replacement</methodname>
<methodparam><type>resource</type><parameter>dict</parameter></methodparam>
<methodparam><type>string</type><parameter>mis</parameter></methodparam>
<methodparam><type>string</type><parameter>cor</parameter></methodparam>
</methodsynopsis>
<para>
Add a correction for 'mis' using 'cor'.
Notes that you replaced @mis with @cor, so it's possibly more likely
that future occurrences of @mis will be replaced with @cor. So it might
bump @cor up in the suggestion list.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>dict</parameter></term>
<listitem>
<para>
Dictionary resource
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mis</parameter></term>
<listitem>
<para>
The work to fix
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>cor</parameter></term>
<listitem>
<para>
The correct word
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</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:"../../../../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
-->
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/enchant/functions/enchant-dict-suggest.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/enchant/functions/enchant-dict-suggest.xml
+++ phpdoc/en/reference/enchant/functions/enchant-dict-suggest.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.enchant-dict-suggest">
<refnamediv>
<refname>enchant_dict_suggest</refname>
<refpurpose>Will return a list of values if any of those pre-conditions are
not met.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>enchant_dict_suggest</methodname>
<methodparam><type>resource</type><parameter>dict</parameter></methodparam>
<methodparam><type>string</type><parameter>word</parameter></methodparam>
</methodsynopsis>
<para>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>dict</parameter></term>
<listitem>
<para>
Dictionary resource
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>word</parameter></term>
<listitem>
<para>
Word to use for the suggestions.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Will returns an array of suggestions if the word is bad spelled.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>enchant_dict_suggest</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$tag = 'en_US';
$r = enchant_broker_init();
if (enchant_broker_dict_exists($r,$tag)) {
$d = enchant_broker_request_dict($r, $tag);
$spellerrors = enchant_dict_check($d, "soong");
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);
}
enchant_broker_free($r);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>enchant_dict_check</function></member>
<member><function>enchant_dict_quick_check</function></member>
</simplelist>
</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:"../../../../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
-->
