php/archived-doc-en
1
0
Fork 0
mirror of https://github.com/php/doc-en.git synced 2026-03-23 23:32:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

enchant: fix XML by converting para to simpara tags via script (#5146)

Browse Source
This commit is contained in:
Gina Peter Banyard
2026-01-18 22:23:35 +00:00
committed by GitHub
parent b4fbf4434a
commit a6b55f8de6
26 changed files with 164 additions and 171 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
reference/enchant/book.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<book xml:id="book.enchant" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="book.enchant">
<?phpdoc extension-membership="bundledexternal" ?>
<title>Enchant spelling library</title>
<titleabbrev>Enchant</titleabbrev>
@@ -9,52 +8,52 @@
<!-- {{{ preface -->
<preface xml:id="intro.enchant">
&reftitle.intro;
<para>
<simpara>
Enchant is the PHP binding for the
<link xlink:href="&url.enchant;">Enchant library</link>. 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>
</simpara>
<para>
Enchant supports the following backends:
<itemizedlist>
<listitem>
<para>
<simpara>
<literal>Aspell/Pspell (intends to replace Ispell)</literal>
</para>
</simpara>
</listitem>
<listitem>
<para>
<simpara>
<literal>Ispell (old as sin, could be interpreted as a defacto standard)</literal>
</para>
</simpara>
</listitem>
<listitem>
<para>
<simpara>
<literal>MySpell/Hunspell (an OOo projects, also used by Mozilla)</literal>
</para>
</simpara>
</listitem>
<listitem>
<para>
<simpara>
<literal>Uspell (primarily Yiddish, Hebrew, and Eastern European languages - hosted in AbiWord's CVS under the module "uspell")</literal>
</para>
</simpara>
</listitem>
<listitem>
<para>
<simpara>
<literal>Hspell (Hebrew)</literal>
</para>
</simpara>
</listitem>
<listitem>
<para>
<simpara>
<literal>AppleSpell (Mac OSX)</literal>
</para>
</simpara>
</listitem>
</itemizedlist>
</para>
</preface>
<!-- }}} -->
&reference.enchant.setup;
&reference.enchant.constants;
&reference.enchant.examples;
@@ -63,7 +62,6 @@
&reference.enchant.enchantdictionary;
</book>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -84,4 +82,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

19
reference/enchant/configure.xml
View File

@@ -1,27 +1,27 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<section xml:id="enchant.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="enchant.installation">
&reftitle.install;
<para>
<simpara>
Provided the
<link linkend="enchant.requirements">required libraries</link> are
installed, users may enable enchant by adding the
<option role="configure">--with-enchant[=dir]</option> option when compiling
PHP.
</para>
<para>
</simpara>
<simpara>
Windows users must enable <filename>php_enchant.dll</filename>
in order to use this extension.
</para>
</simpara>
<note>
<title>Additional setup on Windows</title>
<para>
<simpara>
&ext.windows.path.dll;
<filename>libenchant.dll</filename>,
<filename>glib-2.dll</filename>,
<filename>gmodule-2.dll</filename>.
</para>
<para>
</simpara>
<simpara>
Furthermore, it is necessary to copy at least one of the shipped providers in
<filename>lib\enchant</filename> to <filename>\usr\local\lib\enchant-2</filename>
(which is an absolute path from the root of the <emphasis>current drive</emphasis>).
@@ -30,10 +30,9 @@
where this path could be customized by creating the registry value
<literal>HKEY_CURRENT_USER\SOFTWARE\Enchant\Config\Module_Dir</literal>
and setting it to the desired path.
</para>
</simpara>
</note>
</section>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

6
reference/enchant/enchantbroker.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.enchantbroker" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.enchantbroker" role="class">
<title>The EnchantBroker class</title>
<titleabbrev>EnchantBroker</titleabbrev>
@@ -10,9 +10,9 @@
<!-- {{{ EnchantBroker intro -->
<section xml:id="enchantbroker.intro">
&reftitle.intro;
<para>
<simpara>
A fully opaque class which replaces <literal>enchant_broker</literal> resources as of PHP 8.0.0.
</para>
</simpara>
</section>
<!-- }}} -->

6
reference/enchant/enchantdictionary.xml
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.enchantdictionary" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.enchantdictionary" role="class">
<title>The EnchantDictionary class</title>
<titleabbrev>EnchantDictionary</titleabbrev>
@@ -10,9 +10,9 @@
<!-- {{{ EnchantDictionary intro -->
<section xml:id="enchantdictionary.intro">
&reftitle.intro;
<para>
<simpara>
A fully opaque class which replaces <literal>enchant_dict</literal> resources as of PHP 8.0.0.
</para>
</simpara>
</section>
<!-- }}} -->

8
reference/enchant/functions/enchant-broker-describe.xml
View File

@@ -11,10 +11,10 @@
<type>array</type><methodname>enchant_broker_describe</methodname>
<methodparam><type>EnchantBroker</type><parameter>broker</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Enumerates the Enchant providers and tells you some rudimentary
information about them. The same info is provided through phpinfo().
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,9 +26,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns an &array; of available Enchant providers with their details.
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

12
reference/enchant/functions/enchant-broker-dict-exists.xml
View File

@@ -12,9 +12,9 @@
<methodparam><type>EnchantBroker</type><parameter>broker</parameter></methodparam>
<methodparam><type>string</type><parameter>tag</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Tells if a dictionary exists or not, using a non-empty tags
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -23,9 +23,9 @@
<varlistentry>
<term><parameter>tag</parameter></term>
<listitem>
<para>
<simpara>
non-empty tag in the LOCALE format, ex: us_US, ch_DE, etc.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -33,9 +33,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns &true; when the tag exist or &false; when not.
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

8
reference/enchant/functions/enchant-broker-free-dict.xml
View File

@@ -17,10 +17,10 @@
<type>bool</type><methodname>enchant_broker_free_dict</methodname>
<methodparam><type>EnchantDictionary</type><parameter>dictionary</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Free a dictionary.
As of PHP 8.0.0, it is recommended to unset the object instead of calling this function.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -31,9 +31,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

8
reference/enchant/functions/enchant-broker-free.xml
View File

@@ -17,10 +17,10 @@
<type>bool</type><methodname>enchant_broker_free</methodname>
<methodparam><type>EnchantBroker</type><parameter>broker</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Free a broker with all its dictionaries.
As of PHP 8.0.0, it is recommended to unset the object instead of calling this function.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -32,9 +32,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

16
reference/enchant/functions/enchant-broker-get-dict-path.xml
View File

@@ -18,9 +18,9 @@
<methodparam><type>EnchantBroker</type><parameter>broker</parameter></methodparam>
<methodparam><type>int</type><parameter>type</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Get the directory path for a given backend.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -30,10 +30,10 @@
<varlistentry>
<term><parameter>type</parameter></term>
<listitem>
<para>
<simpara>
The type of the dictionaries, i.e. <constant>ENCHANT_MYSPELL</constant>
or <constant>ENCHANT_ISPELL</constant>.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -41,10 +41,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the path of the dictionary directory on
success&return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">
@@ -73,9 +73,9 @@
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
<simpara>
This function is only available if the extension has been compiled with Enchant v1.
</para>
</simpara>
</note>
</refsect1>

8
reference/enchant/functions/enchant-broker-get-error.xml
View File

@@ -11,9 +11,9 @@
<type class="union"><type>string</type><type>false</type></type><methodname>enchant_broker_get_error</methodname>
<methodparam><type>EnchantBroker</type><parameter>broker</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Returns the last error which occurred in this broker.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,9 +24,9 @@
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Return the msg string if an error was found or &false;
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

8
reference/enchant/functions/enchant-broker-init.xml
View File

@@ -15,14 +15,14 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
</para>
<simpara>
</simpara>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns a broker resource on success or &false;.
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

8
reference/enchant/functions/enchant-broker-list-dicts.xml
View File

@@ -11,9 +11,9 @@
<type>array</type><methodname>enchant_broker_list_dicts</methodname>
<methodparam><type>EnchantBroker</type><parameter>broker</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Returns a list of available dictionaries with their details.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,9 +25,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns an &array; of available dictionaries with their details.
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

16
reference/enchant/functions/enchant-broker-request-dict.xml
View File

@@ -12,10 +12,10 @@
<methodparam><type>EnchantBroker</type><parameter>broker</parameter></methodparam>
<methodparam><type>string</type><parameter>tag</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
create a new dictionary using tag, the non-empty language tag you
wish to request a dictionary for ("en_US", "de_DE", ...)
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -24,9 +24,9 @@
<varlistentry>
<term><parameter>tag</parameter></term>
<listitem>
<para>
<simpara>
A tag describing the locale, for example en_US, de_DE
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -34,9 +34,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns a dictionary resource on success&return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">
@@ -67,10 +67,10 @@
&reftitle.examples;
<example>
<title>A <function>enchant_broker_request_dict</function> example</title>
<para>
<simpara>
Check if a dictionary exists using
<function>enchant_broker_dict_exists</function> and request it.
</para>
</simpara>
<programlisting role="php">
<![CDATA[
<?php

12
reference/enchant/functions/enchant-broker-request-pwl-dict.xml
View File

@@ -12,9 +12,9 @@
<methodparam><type>EnchantBroker</type><parameter>broker</parameter></methodparam>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Creates a dictionary using a PWL file. A PWL file is personal word file one word per line.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,10 +24,10 @@
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
<simpara>
Path to the PWL file.
If there is no such file, a new one will be created if possible.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -35,9 +35,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns a dictionary resource on success&return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

20
reference/enchant/functions/enchant-broker-set-dict-path.xml
View File

@@ -19,9 +19,9 @@
<methodparam><type>int</type><parameter>type</parameter></methodparam>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Set the directory path for a given backend.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -31,18 +31,18 @@
<varlistentry>
<term><parameter>type</parameter></term>
<listitem>
<para>
<simpara>
The type of the dictionaries, i.e. <constant>ENCHANT_MYSPELL</constant>
or <constant>ENCHANT_ISPELL</constant>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
<para>
<simpara>
The path of the dictionary directory.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -50,9 +50,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">
@@ -81,9 +81,9 @@
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
<simpara>
This function is only available if the extension has been compiled with Enchant v1.
</para>
</simpara>
</note>
</refsect1>

16
reference/enchant/functions/enchant-broker-set-ordering.xml
View File

@@ -13,13 +13,13 @@
<methodparam><type>string</type><parameter>tag</parameter></methodparam>
<methodparam><type>string</type><parameter>ordering</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
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 explicitly declare an ordering.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -29,28 +29,28 @@
<varlistentry>
<term><parameter>tag</parameter></term>
<listitem>
<para>
<simpara>
Language tag. The special "*" tag can be used as a language tag
to declare a default ordering for any language that does not
explicitly declare an ordering.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>ordering</parameter></term>
<listitem>
<para>
<simpara>
Comma delimited list of provider names
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

12
reference/enchant/functions/enchant-dict-add-to-session.xml
View File

@@ -12,10 +12,10 @@
<methodparam><type>EnchantDictionary</type><parameter>dictionary</parameter></methodparam>
<methodparam><type>string</type><parameter>word</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Add a word to the given dictionary. It will be added only for the
active spell-checking session.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,9 +25,9 @@
<varlistentry>
<term><parameter>word</parameter></term>
<listitem>
<para>
<simpara>
The word to add
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -35,9 +35,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.void;
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

12
reference/enchant/functions/enchant-dict-add.xml
View File

@@ -12,9 +12,9 @@
<methodparam><type>EnchantDictionary</type><parameter>dictionary</parameter></methodparam>
<methodparam><type>string</type><parameter>word</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Add a word to personal word list of the given dictionary.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -23,18 +23,18 @@
<varlistentry>
<term><parameter>word</parameter></term>
<listitem>
<para>
<simpara>
The word to add
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

12
reference/enchant/functions/enchant-dict-check.xml
View File

@@ -12,9 +12,9 @@
<methodparam><type>EnchantDictionary</type><parameter>dictionary</parameter></methodparam>
<methodparam><type>string</type><parameter>word</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
If the word is correctly spelled return &true;, otherwise return &false;
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,18 +24,18 @@
<varlistentry>
<term><parameter>word</parameter></term>
<listitem>
<para>
<simpara>
The word to check
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns &true; if the word is spelled correctly, &false; if not.
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

12
reference/enchant/functions/enchant-dict-describe.xml
View File

@@ -11,9 +11,9 @@
<type>array</type><methodname>enchant_dict_describe</methodname>
<methodparam><type>EnchantDictionary</type><parameter>dictionary</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Returns the details of the dictionary.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,9 +25,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">
@@ -57,10 +57,10 @@
&reftitle.examples;
<example>
<title>A <function>enchant_dict_describe</function> example</title>
<para>
<simpara>
Check if a dictionary exists using
<function>enchant_broker_dict_exists</function> and show the detail of it.
</para>
</simpara>
<programlisting role="php">
<![CDATA[
<?php

8
reference/enchant/functions/enchant-dict-get-error.xml
View File

@@ -11,9 +11,9 @@
<type class="union"><type>string</type><type>false</type></type><methodname>enchant_dict_get_error</methodname>
<methodparam><type>EnchantDictionary</type><parameter>dictionary</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Returns the last error of the current spelling-session
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,9 +24,9 @@
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the error message as string or &false; if no error occurred.
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

12
reference/enchant/functions/enchant-dict-is-added.xml
View File

@@ -12,9 +12,9 @@
<methodparam><type>EnchantDictionary</type><parameter>dictionary</parameter></methodparam>
<methodparam><type>string</type><parameter>word</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Tells whether or not a word already exists in the current session.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -23,18 +23,18 @@
<varlistentry>
<term><parameter>word</parameter></term>
<listitem>
<para>
<simpara>
The word to lookup
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns &true; if the word exists or &false;
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

16
reference/enchant/functions/enchant-dict-quick-check.xml
View File

@@ -13,10 +13,10 @@
<methodparam><type>string</type><parameter>word</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter role="reference">suggestions</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
If the word is correctly spelled return &true;, otherwise return &false;, if suggestions variable
is provided, fill it with spelling alternatives.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -25,27 +25,27 @@
<varlistentry>
<term><parameter>word</parameter></term>
<listitem>
<para>
<simpara>
The word to check
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>suggestions</parameter></term>
<listitem>
<para>
<simpara>
If the word is not correctly spelled, this variable will
contain an array of suggestions.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns &true; if the word is correctly spelled or &false;
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

16
reference/enchant/functions/enchant-dict-store-replacement.xml
View File

@@ -13,12 +13,12 @@
<methodparam><type>string</type><parameter>misspelled</parameter></methodparam>
<methodparam><type>string</type><parameter>correct</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
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>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -27,26 +27,26 @@
<varlistentry>
<term><parameter>misspelled</parameter></term>
<listitem>
<para>
<simpara>
The work to fix
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>correct</parameter></term>
<listitem>
<para>
<simpara>
The correct word
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="changelog">

12
reference/enchant/functions/enchant-dict-suggest.xml
View File

@@ -12,8 +12,8 @@
<methodparam><type>EnchantDictionary</type><parameter>dictionary</parameter></methodparam>
<methodparam><type>string</type><parameter>word</parameter></methodparam>
</methodsynopsis>
<para>
</para>
<simpara>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -22,18 +22,18 @@
<varlistentry>
<term><parameter>word</parameter></term>
<listitem>
<para>
<simpara>
Word to use for the suggestions.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Will returns an array of suggestions if the word is bad spelled.
</para>
</simpara>
</refsect1>

17
reference/enchant/setup.xml
View File

@@ -1,23 +1,22 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<chapter xml:id="enchant.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="enchant.setup">
&reftitle.setup;
<!-- {{{ Requirements -->
<section xml:id="enchant.requirements">
&reftitle.required;
<para>
<simpara>
This version uses the functions of the
<link xlink:href="&url.enchant;">Enchant library</link> by
Dom Lachowicz. You need Enchant 1.2.4 or later.
Enchant 2.0.0 or later is only supported as of PHP 8.0.0.
</para>
<para>
</simpara>
<simpara>
Enchant also requires <link xlink:href="&url.glib;">Glib 2.6</link> or greater.
Pre-compiled Windows libraries are available from
<link xlink:href="&url.glib.windows;">&url.glib.windows;</link>.
</para>
</simpara>
</section>
<!-- }}} -->
@@ -28,16 +27,15 @@
<!-- {{{ Resources -->
<section xml:id="enchant.resources">
&reftitle.resources;
<para>
<simpara>
Prior to PHP 8.0.0, 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>
</simpara>
</section>
<!-- }}} -->
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -58,4 +56,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->