cvs: phpdoc /en/reference/pspell/functions pspell-add-to-personal.xml pspell-add-to-session.xml pspell-check.xml pspell-clear-session.xml
pspell-config-create.xml pspell-config-data-dir.xml pspell-config-dict-dir.xml pspell-config-ignore.xml pspell-config-mode.xml
pspell-config-personal.xml pspell-config-repl.xml pspell-config-runtogether.xml pspell-config-save-repl.xml pspell-new-config.xml
pspell-new-personal.xml pspell-new.xml pspell-save-wordlist.xml pspell-store-replacement.xml pspell-suggest.xml
| From: | Mehdi Achour | Date: | Sun, 10 Jun 2007 21:25:56 +0000 |
| Subject: | cvs: phpdoc /en/reference/pspell/functions pspell-add-to-personal.xml pspell-add-to-session.xml pspell-check.xml pspell-clear-session.xml pspell-config-create.xml pspell-config-data-dir.xml pspell-config-dict-dir.xml pspell-config-ignore.xml pspell-config-mode.xml pspell-config-personal.xml pspell-config-repl.xml pspell-config-runtogether.xml pspell-config-save-repl.xml pspell-new-config.xml pspell-new-personal.xml pspell-new.xml pspell-save-wordlist.xml pspell-store-replacement.xml pspell-suggest.xml |
||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969376625@lists.php.net to get a copy of this message | ||
didou Sun Jun 10 21:25:56 2007 UTC
Modified files:
/phpdoc/en/reference/pspell/functions pspell-add-to-personal.xml
pspell-add-to-session.xml
pspell-check.xml
pspell-clear-session.xml
pspell-config-create.xml
pspell-config-data-dir.xml
pspell-config-dict-dir.xml
pspell-config-ignore.xml
pspell-config-mode.xml
pspell-config-personal.xml
pspell-config-repl.xml
pspell-config-runtogether.xml
pspell-config-save-repl.xml
pspell-new-config.xml
pspell-new-personal.xml
pspell-new.xml
pspell-save-wordlist.xml
pspell-store-replacement.xml
pspell-suggest.xml
Log:
ref.pspell: switch to new doc style
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-add-to-personal.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-add-to-personal.xml diff -u phpdoc/en/reference/pspell/functions/pspell-add-to-personal.xml:1.6 phpdoc/en/reference/pspell/functions/pspell-add-to-personal.xml:1.7 --- phpdoc/en/reference/pspell/functions/pspell-add-to-personal.xml:1.6 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-add-to-personal.xml Sun Jun 10 21:25:55 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.pspell-add-to-personal"> <refnamediv> <refname>pspell_add_to_personal</refname> <refpurpose>Add the word to a personal wordlist</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pspell_add_to_personal</methodname> <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> @@ -18,9 +18,42 @@ wordlist. If you used <function>pspell_new_config</function> with <function>pspell_config_personal</function> to open the dictionary, you can save the wordlist later with - <function>pspell_save_wordlist</function>. Please, note that this function - will not work unless you have pspell .11.2 and aspell .32.5 or later. + <function>pspell_save_wordlist</function>. </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>dictionary_link</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>word</parameter></term> + <listitem> + <para> + The added word. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>pspell_add_to_personal</function></title> @@ -39,6 +72,17 @@ </example> </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + This function will not work unless you have pspell .11.2 and aspell .32.5 + or later. + </para> + </note> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-add-to-session.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-add-to-session.xml diff -u phpdoc/en/reference/pspell/functions/pspell-add-to-session.xml:1.4 phpdoc/en/reference/pspell/functions/pspell-add-to-session.xml:1.5 --- phpdoc/en/reference/pspell/functions/pspell-add-to-session.xml:1.4 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-add-to-session.xml Sun Jun 10 21:25:55 2007 @@ -1,14 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.pspell-add-to-session"> <refnamediv> <refname>pspell_add_to_session</refname> - <refpurpose>Add the word to the wordlist in the current session - </refpurpose> + <refpurpose>Add the word to the wordlist in the current session</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pspell_add_to_session</methodname> <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> @@ -20,6 +19,37 @@ <function>pspell_add_to_personal</function> </simpara> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>dictionary_link</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>word</parameter></term> + <listitem> + <para> + The added 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 http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-check.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-check.xml diff -u phpdoc/en/reference/pspell/functions/pspell-check.xml:1.5 phpdoc/en/reference/pspell/functions/pspell-check.xml:1.6 --- phpdoc/en/reference/pspell/functions/pspell-check.xml:1.5 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-check.xml Sun Jun 10 21:25:55 2007 @@ -1,25 +1,58 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.pspell-check"> <refnamediv> <refname>pspell_check</refname> <refpurpose>Check a word</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pspell_check</methodname> <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> <methodparam><type>string</type><parameter>word</parameter></methodparam> </methodsynopsis> <simpara> - <function>pspell_check</function> checks the spelling of a word - and returns &true; if the spelling is correct, &false; if not. + <function>pspell_check</function> checks the spelling of a word. </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>dictionary_link</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>word</parameter></term> + <listitem> + <para> + The tested word. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &true; if the spelling is correct, &false; if not. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> - <title><function>pspell_check</function></title> + <title><function>pspell_check</function> Example</title> <programlisting role="php"> <![CDATA[ <?php @@ -36,6 +69,7 @@ </example> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-clear-session.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-clear-session.xml diff -u phpdoc/en/reference/pspell/functions/pspell-clear-session.xml:1.6 phpdoc/en/reference/pspell/functions/pspell-clear-session.xml:1.7 --- phpdoc/en/reference/pspell/functions/pspell-clear-session.xml:1.6 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-clear-session.xml Sun Jun 10 21:25:55 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.pspell-clear-session"> <refnamediv> <refname>pspell_clear_session</refname> <refpurpose>Clear the current session</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pspell_clear_session</methodname> <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> @@ -17,9 +17,35 @@ The current wordlist becomes blank, and, for example, if you try to save it with <function>pspell_save_wordlist</function>, nothing happens. </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>dictionary_link</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> - <title><function>pspell_add_to_personal</function></title> + <title><function>pspell_add_to_personal</function> Example</title> <programlisting role="php"> <![CDATA[ <?php @@ -36,6 +62,7 @@ </example> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-config-create.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-config-create.xml diff -u phpdoc/en/reference/pspell/functions/pspell-config-create.xml:1.6 phpdoc/en/reference/pspell/functions/pspell-config-create.xml:1.7 --- phpdoc/en/reference/pspell/functions/pspell-config-create.xml:1.6 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-config-create.xml Sun Jun 10 21:25:55 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.pspell-config-create"> <refnamediv> <refname>pspell_config_create</refname> <refpurpose>Create a config used to open a dictionary</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>pspell_config_create</methodname> <methodparam><type>string</type><parameter>language</parameter></methodparam> @@ -15,7 +15,10 @@ <methodparam choice="opt"><type>string</type><parameter>jargon</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> - <simpara> + <para> + Create a config used to open a dictionary. + </para> + <para> <function>pspell_config_create</function> has a very similar syntax to <function>pspell_new</function>. In fact, using <function>pspell_config_create</function> immediately followed by @@ -24,56 +27,73 @@ <function>pspell_config_*</function> functions before calling <function>pspell_new_config</function> to take advantage of some advanced functionality. - </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. - </para> - <para> - The spelling parameter is the requested spelling for languages - with more than one spelling such as English. Known values are - 'american', 'british', and 'canadian'. - </para> - <para> - The jargon parameter contains extra information to distinguish - two different words lists that have the same language and - spelling parameters. - </para> - <para> - 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. - </para> - <para> - The mode parameter is the mode in which spellchecker will work. - There are several modes available: - <itemizedlist> - <listitem> - <simpara> - <constant>PSPELL_FAST</constant> - Fast mode (least number of - suggestions) - </simpara> - </listitem> - <listitem> - <simpara> - <constant>PSPELL_NORMAL</constant> - Normal mode (more suggestions) - </simpara> - </listitem> - <listitem> - <simpara> - <constant>PSPELL_BAD_SPELLERS</constant> - Slow mode (a lot of - suggestions) - </simpara> - </listitem> - </itemizedlist> </para> <para> For more information and examples, check out inline manual pspell website:<ulink url="&url.pspell;">&url.pspell;</ulink>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>language</parameter></term> + <listitem> + <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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>spelling</parameter></term> + <listitem> + <para> + The spelling parameter is the requested spelling for languages + with more than one spelling such as English. Known values are + 'american', 'british', and 'canadian'. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>jargon</parameter></term> + <listitem> + <para> + The jargon parameter contains extra information to distinguish + two different words lists that have the same language and + spelling parameters. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + <para> + 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. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Retuns a pspell config identifier, or &false; on error. + </para> + </refsect1> + + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>pspell_config_create</function></title> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-config-data-dir.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-config-data-dir.xml diff -u phpdoc/en/reference/pspell/functions/pspell-config-data-dir.xml:1.2 phpdoc/en/reference/pspell/functions/pspell-config-data-dir.xml:1.3 --- phpdoc/en/reference/pspell/functions/pspell-config-data-dir.xml:1.2 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-config-data-dir.xml Sun Jun 10 21:25:55 2007 @@ -1,21 +1,30 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.pspell-config-data-dir"> <refnamediv> <refname>pspell_config_data_dir</refname> <refpurpose>location of language data files</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pspell_config_data_dir</methodname> <methodparam><type>int</type><parameter>conf</parameter></methodparam> <methodparam><type>string</type><parameter>directory</parameter></methodparam> </methodsynopsis> - + <para> &warn.undocumented.func; + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-config-dict-dir.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-config-dict-dir.xml diff -u phpdoc/en/reference/pspell/functions/pspell-config-dict-dir.xml:1.2 phpdoc/en/reference/pspell/functions/pspell-config-dict-dir.xml:1.3 --- phpdoc/en/reference/pspell/functions/pspell-config-dict-dir.xml:1.2 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-config-dict-dir.xml Sun Jun 10 21:25:55 2007 @@ -1,21 +1,30 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.pspell-config-dict-dir"> <refnamediv> <refname>pspell_config_dict_dir</refname> <refpurpose>Location of the main word list</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pspell_config_dict_dir</methodname> <methodparam><type>int</type><parameter>conf</parameter></methodparam> <methodparam><type>string</type><parameter>directory</parameter></methodparam> </methodsynopsis> - + <para> &warn.undocumented.func; + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-config-ignore.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-config-ignore.xml diff -u phpdoc/en/reference/pspell/functions/pspell-config-ignore.xml:1.7 phpdoc/en/reference/pspell/functions/pspell-config-ignore.xml:1.8 --- phpdoc/en/reference/pspell/functions/pspell-config-ignore.xml:1.7 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-config-ignore.xml Sun Jun 10 21:25:55 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> +<!-- $Revision: 1.8 $ --> <refentry id="function.pspell-config-ignore"> <refnamediv> <refname>pspell_config_ignore</refname> <refpurpose>Ignore words less than N characters long</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pspell_config_ignore</methodname> <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> @@ -16,9 +16,42 @@ <simpara> <function>pspell_config_ignore</function> should be used on a config before calling <function>pspell_new_config</function>. This function - allows short words to be skipped by the spell checker. Words less than - <parameter>n</parameter> characters will be skipped. + allows short words to be skipped by the spell checker. </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>dictionary_link</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>n</parameter></term> + <listitem> + <para> + Words less than <parameter>n</parameter> characters will be skipped. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>pspell_config_ignore</function></title> @@ -35,6 +68,7 @@ </example> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-config-mode.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-config-mode.xml diff -u phpdoc/en/reference/pspell/functions/pspell-config-mode.xml:1.6 phpdoc/en/reference/pspell/functions/pspell-config-mode.xml:1.7 --- phpdoc/en/reference/pspell/functions/pspell-config-mode.xml:1.6 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-config-mode.xml Sun Jun 10 21:25:55 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.pspell-config-mode"> <refnamediv> <refname>pspell_config_mode</refname> <refpurpose>Change the mode number of suggestions returned</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pspell_config_mode</methodname> <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> @@ -19,32 +19,63 @@ determines how many suggestions will be returned by <function>pspell_suggest</function>. </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The mode parameter is the mode in which spellchecker will work. - There are several modes available: - <itemizedlist> - <listitem> - <simpara> - <constant>PSPELL_FAST</constant> - Fast mode (least number of - suggestions) - </simpara> - </listitem> - <listitem> - <simpara> - <constant>PSPELL_NORMAL</constant> - Normal mode (more suggestions) - </simpara> - </listitem> - <listitem> - <simpara> - <constant>PSPELL_BAD_SPELLERS</constant> - Slow mode (a lot of - suggestions) - </simpara> - </listitem> - </itemizedlist> + <variablelist> + <varlistentry> + <term><parameter>dictionary_link</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>mode</parameter></term> + <listitem> + <para> + The mode parameter is the mode in which spellchecker will work. + There are several modes available: + <itemizedlist> + <listitem> + <simpara> + <constant>PSPELL_FAST</constant> - Fast mode (least number of + suggestions) + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PSPELL_NORMAL</constant> - Normal mode (more suggestions) + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PSPELL_BAD_SPELLERS</constant> - Slow mode (a lot of + suggestions) + </simpara> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> - <title><function>pspell_config_mode</function></title> + <title><function>pspell_config_mode</function> Example</title> <programlisting role="php"> <![CDATA[ <?php @@ -58,6 +89,7 @@ </example> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-config-personal.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-config-personal.xml diff -u phpdoc/en/reference/pspell/functions/pspell-config-personal.xml:1.7 phpdoc/en/reference/pspell/functions/pspell-config-personal.xml:1.8 --- phpdoc/en/reference/pspell/functions/pspell-config-personal.xml:1.7 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-config-personal.xml Sun Jun 10 21:25:55 2007 @@ -1,29 +1,63 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> +<!-- $Revision: 1.8 $ --> <refentry id="function.pspell-config-personal"> <refnamediv> <refname>pspell_config_personal</refname> <refpurpose>Set a file that contains personal wordlist</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pspell_config_personal</methodname> <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> <methodparam><type>string</type><parameter>file</parameter></methodparam> </methodsynopsis> - <simpara> - <function>pspell_config_personal</function> should be used on a config - before calling <function>pspell_new_config</function>. The personal - wordlist will be loaded and used in addition to the standard one after - you call <function>pspell_new_config</function>. If the file does not - exist, it will be created. The file is also the file where + <para> + Set a file that contains personal wordlist. The personal wordlist will be + loaded and used in addition to the standard one after you call + <function>pspell_new_config</function>. The file is also the file where <function>pspell_save_wordlist</function> will save personal wordlist to. - The file should be writable by whoever PHP runs as (e.g. nobody). Please, - note that this function will not work unless you have pspell .11.2 and - aspell .32.5 or later. - </simpara> + </para> + <para> + <function>pspell_config_personal</function> should be used on a config + before calling <function>pspell_new_config</function>. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>dictionary_link</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>file</parameter></term> + <listitem> + <para> + The personal wordlist. If the file does not exist, it will be created. + The file should be writable by whoever PHP runs as (e.g. nobody). + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>pspell_config_personal</function></title> @@ -40,6 +74,17 @@ </example> </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + This function will not work unless you have pspell .11.2 and aspell .32.5 + or later. + </para> + </note> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-config-repl.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-config-repl.xml diff -u phpdoc/en/reference/pspell/functions/pspell-config-repl.xml:1.7 phpdoc/en/reference/pspell/functions/pspell-config-repl.xml:1.8 --- phpdoc/en/reference/pspell/functions/pspell-config-repl.xml:1.7 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-config-repl.xml Sun Jun 10 21:25:55 2007 @@ -1,30 +1,66 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> +<!-- $Revision: 1.8 $ --> <refentry id="function.pspell-config-repl"> <refnamediv> <refname>pspell_config_repl</refname> <refpurpose>Set a file that contains replacement pairs</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pspell_config_repl</methodname> <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> <methodparam><type>string</type><parameter>file</parameter></methodparam> </methodsynopsis> - <simpara> - <function>pspell_config_repl</function> should be used on a config - before calling <function>pspell_new_config</function>. The replacement - pairs improve the quality of the spellchecker. When a word is misspelled, - and a proper suggestion was not found in the list, + <para> + Set a file that contains replacement pairs. + </para> + <para> + The replacement pairs improve the quality of the spellchecker. When a word + is misspelled, and a proper suggestion was not found in the list, <function>pspell_store_replacement</function> can be used to store a replacement pair and then <function>pspell_save_wordlist</function> to - save the wordlist along with the replacement pairs. The file should be - writable by whoever PHP runs as (e.g. nobody). Please, note that this - function will not work unless you have pspell .11.2 and aspell .32.5 or - later. - </simpara> + save the wordlist along with the replacement pairs. + </para> + <para> + <function>pspell_config_repl</function> should be used on a config + before calling <function>pspell_new_config</function>. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>dictionary_link</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>file</parameter></term> + <listitem> + <para> + The file should be writable by whoever PHP runs as (e.g. nobody). + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>pspell_config_repl</function></title> @@ -42,6 +78,17 @@ </example> </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + This function will not work unless you have pspell .11.2 and aspell .32.5 + or later. + </para> + </note> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-config-runtogether.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-config-runtogether.xml diff -u phpdoc/en/reference/pspell/functions/pspell-config-runtogether.xml:1.7 phpdoc/en/reference/pspell/functions/pspell-config-runtogether.xml:1.8 --- phpdoc/en/reference/pspell/functions/pspell-config-runtogether.xml:1.7 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-config-runtogether.xml Sun Jun 10 21:25:55 2007 @@ -1,28 +1,64 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> +<!-- $Revision: 1.8 $ --> <refentry id="function.pspell-config-runtogether"> <refnamediv> <refname>pspell_config_runtogether</refname> <refpurpose>Consider run-together words as valid compounds</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pspell_config_runtogether</methodname> <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> <methodparam><type>bool</type><parameter>flag</parameter></methodparam> </methodsynopsis> - <simpara> - <function>pspell_config_runtogether</function> should be used on a config - before calling <function>pspell_new_config</function>. This function - determines whether run-together words will be treated as legal - compounds. That is, "thecat" will be a legal compound, - although there should be a space between the two - words. Changing this setting only affects the results returned - by <function>pspell_check</function>; + <para> + This function determines whether run-together words will be treated as + legal compounds. That is, "thecat" will be a legal compound, although + there should be a space between the two words. Changing this setting only + affects the results returned by <function>pspell_check</function>; <function>pspell_suggest</function> will still return suggestions. - </simpara> + </para> + <para> + <function>pspell_config_runtogether</function> should be used on a config + before calling <function>pspell_new_config</function>. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>dictionary_link</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>flag</parameter></term> + <listitem> + <para> + &true; if run-together words should be treated as legal compounds, + &false; otherwise. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>pspell_config_runtogether</function></title> @@ -39,6 +75,7 @@ </example> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-config-save-repl.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-config-save-repl.xml diff -u phpdoc/en/reference/pspell/functions/pspell-config-save-repl.xml:1.4 phpdoc/en/reference/pspell/functions/pspell-config-save-repl.xml:1.5 --- phpdoc/en/reference/pspell/functions/pspell-config-save-repl.xml:1.4 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-config-save-repl.xml Sun Jun 10 21:25:55 2007 @@ -1,31 +1,74 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.pspell-config-save-repl"> <refnamediv> <refname>pspell_config_save_repl</refname> <refpurpose>Determine whether to save a replacement pairs list along with the wordlist</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pspell_config_save_repl</methodname> <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> <methodparam><type>bool</type><parameter>flag</parameter></methodparam> </methodsynopsis> - <simpara> - <function>pspell_config_save_repl</function> should be used on a config - before calling <function>pspell_new_config</function>. It determines - whether <function>pspell_save_wordlist</function> will save the - replacement pairs along with the wordlist. Usually there is no need to use - this function because if <function>pspell_config_repl</function> is used, - the replacement pairs will be saved by + <para> + <function>pspell_config_save_repl</function> determines whether + <function>pspell_save_wordlist</function> will save the replacement pairs + along with the wordlist. Usually there is no need to use this function + because if <function>pspell_config_repl</function> is used, the + replacement pairs will be saved by <function>pspell_save_wordlist</function> anyway, and if it is not, - the replacement pairs will not be saved. Please, note that this function - will not work unless you have pspell .11.2 and aspell .32.5 or later. - </simpara> + the replacement pairs will not be saved. + </para> + <para> + <function>pspell_config_save_repl</function> should be used on a config + before calling <function>pspell_new_config</function>. + </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>dictionary_link</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>flag</parameter></term> + <listitem> + <para> + &true; if replacement pairs should be saved, &false; otherwise. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + This function will not work unless you have pspell .11.2 and aspell .32.5 + or later. + </para> + </note> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-new-config.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-new-config.xml diff -u phpdoc/en/reference/pspell/functions/pspell-new-config.xml:1.6 phpdoc/en/reference/pspell/functions/pspell-new-config.xml:1.7 --- phpdoc/en/reference/pspell/functions/pspell-new-config.xml:1.6 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-new-config.xml Sun Jun 10 21:25:55 2007 @@ -1,14 +1,14 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.pspell-new-config"> <refnamediv> <refname>pspell_new_config</refname> <refpurpose>Load a new dictionary with settings based on a given config </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>pspell_new_config</methodname> <methodparam><type>int</type><parameter>config</parameter></methodparam> @@ -22,10 +22,34 @@ <function>pspell_new</function> and <function>pspell_new_personal</function>. </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The config parameter is the one returned by - <function>pspell_config_create</function> when the config was created. + <variablelist> + <varlistentry> + <term><parameter>config</parameter></term> + <listitem> + <para> + The <parameter>config</parameter> parameter is the one returned by + <function>pspell_config_create</function> when the config was created. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a dictionary link identifier on success. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>pspell_new_config</function></title> @@ -42,6 +66,7 @@ </example> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-new-personal.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-new-personal.xml diff -u phpdoc/en/reference/pspell/functions/pspell-new-personal.xml:1.6 phpdoc/en/reference/pspell/functions/pspell-new-personal.xml:1.7 --- phpdoc/en/reference/pspell/functions/pspell-new-personal.xml:1.6 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-new-personal.xml Sun Jun 10 21:25:55 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.pspell-new-personal"> <refnamediv> <refname>pspell_new_personal</refname> <refpurpose>Load a new dictionary with personal wordlist</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>pspell_new_personal</methodname> <methodparam><type>string</type><parameter>personal</parameter></methodparam> @@ -19,8 +19,7 @@ </methodsynopsis> <simpara> <function>pspell_new_personal</function> opens up a new dictionary with - a personal wordlist and returns the dictionary link identifier for use - in other pspell functions. The wordlist can be modified and saved with + a personal wordlist. The wordlist can be modified and saved with <function>pspell_save_wordlist</function>, if desired. However, the replacement pairs are not saved. In order to save replacement pairs, you should create a config using <function>pspell_config_create</function>, @@ -31,75 +30,121 @@ <function>pspell_new_config</function>. </simpara> <para> - The personal parameter specifies the file where words added to the - personal list will be stored. It should be an absolute filename - beginning with '/' because otherwise it will be relative to $HOME, - which is "/root" for most systems, and is probably not what you want. - </para> - <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. - </para> - <para> - The spelling parameter is the requested spelling for languages - with more than one spelling such as English. Known values are - 'american', 'british', and 'canadian'. - </para> - <para> - The jargon parameter contains extra information to distinguish - two different words lists that have the same language and - spelling parameters. - </para> - <para> - 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> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The mode parameter is the mode in which spellchecker will work. - There are several modes available: - <itemizedlist> - <listitem> - <simpara> - <constant>PSPELL_FAST</constant> - Fast mode (least number of - suggestions) - </simpara> - </listitem> - <listitem> - <simpara> - <constant>PSPELL_NORMAL</constant> - Normal mode (more suggestions) - </simpara> - </listitem> - <listitem> - <simpara> - <constant>PSPELL_BAD_SPELLERS</constant> - Slow mode (a lot of - suggestions) - </simpara> - </listitem> - <listitem> - <simpara> - <constant>PSPELL_RUN_TOGETHER</constant> - Consider run-together words - as legal compounds. That is, "thecat" will be a legal compound, - although there should be a space between the two words. Changing this - setting only affects the results returned by - <function>pspell_check</function>; <function>pspell_suggest</function> - will still return suggestions. - </simpara> - </listitem> - </itemizedlist> - Mode is a bitmask constructed from different constants listed above. - However, <constant>PSPELL_FAST</constant>, - <constant>PSPELL_NORMAL</constant> and - <constant>PSPELL_BAD_SPELLERS</constant> are mutually exclusive, so you - should select only one of them. + <variablelist> + <varlistentry> + <term><parameter>personal</parameter></term> + <listitem> + <para> + The file where words added to the personal list will be stored. + It should be an absolute filename beginning with '/' because otherwise + it will be relative to $HOME, which is "/root" for most systems, and + is probably not what you want. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>language</parameter></term> + <listitem> + <para> + 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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>spelling</parameter></term> + <listitem> + <para> + The requested spelling for languages with more than one spelling such + as English. Known values are 'american', 'british', and 'canadian'. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>jargon</parameter></term> + <listitem> + <para> + Extra information to distinguish two different words lists that have + the same language and spelling parameters. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + <para> + The encoding that words are expected to be in. Valid values are + <literal>utf-8</literal>, <literal>iso8859-*</literal>, + <literal>koi8-r</literal>, <literal>viscii</literal>, + <literal>cp1252</literal>, <literal>machine unsigned 16</literal>, + <literal>machine unsigned 32</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>mode</parameter></term> + <listitem> + <para> + The mode in which spellchecker will work. There are several modes available: + <itemizedlist> + <listitem> + <simpara> + <constant>PSPELL_FAST</constant> - Fast mode (least number of + suggestions) + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PSPELL_NORMAL</constant> - Normal mode (more suggestions) + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PSPELL_BAD_SPELLERS</constant> - Slow mode (a lot of + suggestions) + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PSPELL_RUN_TOGETHER</constant> - Consider run-together words + as legal compounds. That is, "thecat" will be a legal compound, + although there should be a space between the two words. Changing this + setting only affects the results returned by + <function>pspell_check</function>; <function>pspell_suggest</function> + will still return suggestions. + </simpara> + </listitem> + </itemizedlist> + Mode is a bitmask constructed from different constants listed above. + However, <constant>PSPELL_FAST</constant>, + <constant>PSPELL_NORMAL</constant> and + <constant>PSPELL_BAD_SPELLERS</constant> are mutually exclusive, so you + should select only one of them. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - For more information and examples, check out inline manual pspell - website:<ulink url="&url.pspell;">&url.pspell;</ulink>. + Returns the dictionary link identifier for use in other pspell functions. </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>pspell_new_personal</function></title> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-new.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-new.xml diff -u phpdoc/en/reference/pspell/functions/pspell-new.xml:1.7 phpdoc/en/reference/pspell/functions/pspell-new.xml:1.8 --- phpdoc/en/reference/pspell/functions/pspell-new.xml:1.7 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-new.xml Sun Jun 10 21:25:55 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.1 --> +<!-- $Revision: 1.8 $ --> <refentry id="function.pspell-new"> <refnamediv> <refname>pspell_new</refname> <refpurpose>Load a new dictionary</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>pspell_new</methodname> <methodparam><type>string</type><parameter>language</parameter></methodparam> @@ -16,75 +16,119 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> </methodsynopsis> - <simpara> + <para> <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. - </para> - <para> - The spelling parameter is the requested spelling for languages - with more than one spelling such as English. Known values are - 'american', 'british', and 'canadian'. </para> <para> - The jargon parameter contains extra information to distinguish - two different words lists that have the same language and - spelling parameters. - </para> - <para> - 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> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The mode parameter is the mode in which spellchecker will work. - There are several modes available: - <itemizedlist> - <listitem> - <simpara> - <constant>PSPELL_FAST</constant> - Fast mode (least number of - suggestions) - </simpara> - </listitem> - <listitem> - <simpara> - <constant>PSPELL_NORMAL</constant> - Normal mode (more suggestions) - </simpara> - </listitem> - <listitem> - <simpara> - <constant>PSPELL_BAD_SPELLERS</constant> - Slow mode (a lot of - suggestions) - </simpara> - </listitem> - <listitem> - <simpara> - <constant>PSPELL_RUN_TOGETHER</constant> - Consider run-together words - as legal compounds. That is, "thecat" will be a legal compound, - although there should be a space between the two words. Changing this - setting only affects the results returned by - <function>pspell_check</function>; <function>pspell_suggest</function> - will still return suggestions. - </simpara> - </listitem> - </itemizedlist> - Mode is a bitmask constructed from different constants listed above. - However, <constant>PSPELL_FAST</constant>, - <constant>PSPELL_NORMAL</constant> and - <constant>PSPELL_BAD_SPELLERS</constant> are mutually exclusive, so you - should select only one of them. + <variablelist> + <varlistentry> + <term><parameter>language</parameter></term> + <listitem> + <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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>spelling</parameter></term> + <listitem> + <para> + The spelling parameter is the requested spelling for languages + with more than one spelling such as English. Known values are + 'american', 'british', and 'canadian'. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>jargon</parameter></term> + <listitem> + <para> + The jargon parameter contains extra information to distinguish + two different words lists that have the same language and + spelling parameters. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + <para> + 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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>mode</parameter></term> + <listitem> + <para> + The mode parameter is the mode in which spellchecker will work. + There are several modes available: + <itemizedlist> + <listitem> + <simpara> + <constant>PSPELL_FAST</constant> - Fast mode (least number of + suggestions) + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PSPELL_NORMAL</constant> - Normal mode (more suggestions) + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PSPELL_BAD_SPELLERS</constant> - Slow mode (a lot of + suggestions) + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PSPELL_RUN_TOGETHER</constant> - Consider run-together words + as legal compounds. That is, "thecat" will be a legal compound, + although there should be a space between the two words. Changing this + setting only affects the results returned by + <function>pspell_check</function>; <function>pspell_suggest</function> + will still return suggestions. + </simpara> + </listitem> + </itemizedlist> + Mode is a bitmask constructed from different constants listed above. + However, <constant>PSPELL_FAST</constant>, + <constant>PSPELL_NORMAL</constant> and + <constant>PSPELL_BAD_SPELLERS</constant> are mutually exclusive, so you + should select only one of them. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - For more information and examples, check out inline manual pspell - website:<ulink url="&url.pspell;">&url.pspell;</ulink>. + Returns the dictionary link identifier on success, or &false; on failure. </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>pspell_new</function></title> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-save-wordlist.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-save-wordlist.xml diff -u phpdoc/en/reference/pspell/functions/pspell-save-wordlist.xml:1.6 phpdoc/en/reference/pspell/functions/pspell-save-wordlist.xml:1.7 --- phpdoc/en/reference/pspell/functions/pspell-save-wordlist.xml:1.6 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-save-wordlist.xml Sun Jun 10 21:25:55 2007 @@ -1,26 +1,51 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.pspell-save-wordlist"> <refnamediv> <refname>pspell_save_wordlist</refname> <refpurpose>Save the personal wordlist to a file</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pspell_save_wordlist</methodname> <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> </methodsynopsis> <simpara> - <function>pspell_save_wordlist</function> saves the personal wordlist - from the current session. The dictionary has to be open with - <function>pspell_new_personal</function>, and the location of files to be - saved specified with <function>pspell_config_personal</function> and - (optionally) <function>pspell_config_repl</function>. Please, note that - this function will not work unless you have pspell .11.2 and aspell .32.5 - or later. + <function>pspell_save_wordlist</function> saves the personal wordlist from + the current session. The location of files to be saved specified with + <function>pspell_config_personal</function> and (optionally) + <function>pspell_config_repl</function>. </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>dictionary_link</parameter></term> + <listitem> + <para> + A dictionary link identifier opened with + <function>pspell_new_personal</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>pspell_add_to_personal</function></title> @@ -39,6 +64,17 @@ </example> </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + This function will not work unless you have pspell .11.2 and aspell .32.5 + or later. + </para> + </note> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-store-replacement.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-store-replacement.xml diff -u phpdoc/en/reference/pspell/functions/pspell-store-replacement.xml:1.6 phpdoc/en/reference/pspell/functions/pspell-store-replacement.xml:1.7 --- phpdoc/en/reference/pspell/functions/pspell-store-replacement.xml:1.6 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-store-replacement.xml Sun Jun 10 21:25:55 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.1 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.pspell-store-replacement"> <refnamediv> <refname>pspell_store_replacement</refname> <refpurpose>Store a replacement pair for a word</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pspell_store_replacement</methodname> <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> @@ -24,9 +24,52 @@ use <function>pspell_config_personal</function> and <function>pspell_config_repl</function> to set the path where to save your custom wordlists, and then use <function>pspell_save_wordlist</function> - for the changes to be written to disk. Please, note that this function - will not work unless you have pspell .11.2 and aspell .32.5 or later. + for the changes to be written to disk. </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>dictionary_link</parameter></term> + <listitem> + <para> + A dictionary link identifier, opened with + <function>pspell_new_personal</function> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>misspelled</parameter></term> + <listitem> + <para> + The misspelled word. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>correct</parameter></term> + <listitem> + <para> + The fixed spelling for the <parameter>misspelled</parameter> word. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>pspell_store_replacement</function></title> @@ -46,6 +89,17 @@ </example> </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + This function will not work unless you have pspell .11.2 and aspell .32.5 + or later. + </para> + </note> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-suggest.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-suggest.xml diff -u phpdoc/en/reference/pspell/functions/pspell-suggest.xml:1.5 phpdoc/en/reference/pspell/functions/pspell-suggest.xml:1.6 --- phpdoc/en/reference/pspell/functions/pspell-suggest.xml:1.5 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-suggest.xml Sun Jun 10 21:25:56 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.1 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.pspell-suggest"> <refnamediv> <refname>pspell_suggest</refname> <refpurpose>Suggest spellings of a word</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>pspell_suggest</methodname> <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> @@ -17,6 +17,40 @@ <function>pspell_suggest</function> returns an array of possible spellings for the given word. </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>dictionary_link</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>word</parameter></term> + <listitem> + <para> + The tested word. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an array of possible spellings. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>pspell_suggest</function> example</title> @@ -38,6 +72,7 @@ </example> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-add-to-personal.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-add-to-personal.xml diff -u phpdoc/en/reference/pspell/functions/pspell-add-to-personal.xml:1.6 phpdoc/en/reference/pspell/functions/pspell-add-to-personal.xml:1.7 --- phpdoc/en/reference/pspell/functions/pspell-add-to-personal.xml:1.6 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-add-to-personal.xml Sun Jun 10 21:25:55 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.pspell-add-to-personal"> <refnamediv> <refname>pspell_add_to_personal</refname> <refpurpose>Add the word to a personal wordlist</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pspell_add_to_personal</methodname> <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> @@ -18,9 +18,42 @@ wordlist. If you used <function>pspell_new_config</function> with <function>pspell_config_personal</function> to open the dictionary, you can save the wordlist later with - <function>pspell_save_wordlist</function>. Please, note that this function - will not work unless you have pspell .11.2 and aspell .32.5 or later. + <function>pspell_save_wordlist</function>. </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>dictionary_link</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>word</parameter></term> + <listitem> + <para> + The added word. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>pspell_add_to_personal</function></title> @@ -39,6 +72,17 @@ </example> </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + This function will not work unless you have pspell .11.2 and aspell .32.5 + or later. + </para> + </note> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-add-to-session.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-add-to-session.xml diff -u phpdoc/en/reference/pspell/functions/pspell-add-to-session.xml:1.4 phpdoc/en/reference/pspell/functions/pspell-add-to-session.xml:1.5 --- phpdoc/en/reference/pspell/functions/pspell-add-to-session.xml:1.4 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-add-to-session.xml Sun Jun 10 21:25:55 2007 @@ -1,14 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.pspell-add-to-session"> <refnamediv> <refname>pspell_add_to_session</refname> - <refpurpose>Add the word to the wordlist in the current session - </refpurpose> + <refpurpose>Add the word to the wordlist in the current session</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pspell_add_to_session</methodname> <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> @@ -20,6 +19,37 @@ <function>pspell_add_to_personal</function> </simpara> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>dictionary_link</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>word</parameter></term> + <listitem> + <para> + The added 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 http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-check.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-check.xml diff -u phpdoc/en/reference/pspell/functions/pspell-check.xml:1.5 phpdoc/en/reference/pspell/functions/pspell-check.xml:1.6 --- phpdoc/en/reference/pspell/functions/pspell-check.xml:1.5 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-check.xml Sun Jun 10 21:25:55 2007 @@ -1,25 +1,58 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.pspell-check"> <refnamediv> <refname>pspell_check</refname> <refpurpose>Check a word</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pspell_check</methodname> <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> <methodparam><type>string</type><parameter>word</parameter></methodparam> </methodsynopsis> <simpara> - <function>pspell_check</function> checks the spelling of a word - and returns &true; if the spelling is correct, &false; if not. + <function>pspell_check</function> checks the spelling of a word. </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>dictionary_link</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>word</parameter></term> + <listitem> + <para> + The tested word. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &true; if the spelling is correct, &false; if not. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> - <title><function>pspell_check</function></title> + <title><function>pspell_check</function> Example</title> <programlisting role="php"> <![CDATA[ <?php @@ -36,6 +69,7 @@ </example> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-clear-session.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-clear-session.xml diff -u phpdoc/en/reference/pspell/functions/pspell-clear-session.xml:1.6 phpdoc/en/reference/pspell/functions/pspell-clear-session.xml:1.7 --- phpdoc/en/reference/pspell/functions/pspell-clear-session.xml:1.6 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-clear-session.xml Sun Jun 10 21:25:55 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.pspell-clear-session"> <refnamediv> <refname>pspell_clear_session</refname> <refpurpose>Clear the current session</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pspell_clear_session</methodname> <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> @@ -17,9 +17,35 @@ The current wordlist becomes blank, and, for example, if you try to save it with <function>pspell_save_wordlist</function>, nothing happens. </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>dictionary_link</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> - <title><function>pspell_add_to_personal</function></title> + <title><function>pspell_add_to_personal</function> Example</title> <programlisting role="php"> <![CDATA[ <?php @@ -36,6 +62,7 @@ </example> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-config-create.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-config-create.xml diff -u phpdoc/en/reference/pspell/functions/pspell-config-create.xml:1.6 phpdoc/en/reference/pspell/functions/pspell-config-create.xml:1.7 --- phpdoc/en/reference/pspell/functions/pspell-config-create.xml:1.6 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-config-create.xml Sun Jun 10 21:25:55 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.pspell-config-create"> <refnamediv> <refname>pspell_config_create</refname> <refpurpose>Create a config used to open a dictionary</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>pspell_config_create</methodname> <methodparam><type>string</type><parameter>language</parameter></methodparam> @@ -15,7 +15,10 @@ <methodparam choice="opt"><type>string</type><parameter>jargon</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> - <simpara> + <para> + Create a config used to open a dictionary. + </para> + <para> <function>pspell_config_create</function> has a very similar syntax to <function>pspell_new</function>. In fact, using <function>pspell_config_create</function> immediately followed by @@ -24,56 +27,73 @@ <function>pspell_config_*</function> functions before calling <function>pspell_new_config</function> to take advantage of some advanced functionality. - </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. - </para> - <para> - The spelling parameter is the requested spelling for languages - with more than one spelling such as English. Known values are - 'american', 'british', and 'canadian'. - </para> - <para> - The jargon parameter contains extra information to distinguish - two different words lists that have the same language and - spelling parameters. - </para> - <para> - 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. - </para> - <para> - The mode parameter is the mode in which spellchecker will work. - There are several modes available: - <itemizedlist> - <listitem> - <simpara> - <constant>PSPELL_FAST</constant> - Fast mode (least number of - suggestions) - </simpara> - </listitem> - <listitem> - <simpara> - <constant>PSPELL_NORMAL</constant> - Normal mode (more suggestions) - </simpara> - </listitem> - <listitem> - <simpara> - <constant>PSPELL_BAD_SPELLERS</constant> - Slow mode (a lot of - suggestions) - </simpara> - </listitem> - </itemizedlist> </para> <para> For more information and examples, check out inline manual pspell website:<ulink url="&url.pspell;">&url.pspell;</ulink>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>language</parameter></term> + <listitem> + <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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>spelling</parameter></term> + <listitem> + <para> + The spelling parameter is the requested spelling for languages + with more than one spelling such as English. Known values are + 'american', 'british', and 'canadian'. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>jargon</parameter></term> + <listitem> + <para> + The jargon parameter contains extra information to distinguish + two different words lists that have the same language and + spelling parameters. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + <para> + 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. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Retuns a pspell config identifier, or &false; on error. + </para> + </refsect1> + + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>pspell_config_create</function></title> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-config-data-dir.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-config-data-dir.xml diff -u phpdoc/en/reference/pspell/functions/pspell-config-data-dir.xml:1.2 phpdoc/en/reference/pspell/functions/pspell-config-data-dir.xml:1.3 --- phpdoc/en/reference/pspell/functions/pspell-config-data-dir.xml:1.2 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-config-data-dir.xml Sun Jun 10 21:25:55 2007 @@ -1,21 +1,30 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.pspell-config-data-dir"> <refnamediv> <refname>pspell_config_data_dir</refname> <refpurpose>location of language data files</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pspell_config_data_dir</methodname> <methodparam><type>int</type><parameter>conf</parameter></methodparam> <methodparam><type>string</type><parameter>directory</parameter></methodparam> </methodsynopsis> - + <para> &warn.undocumented.func; + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-config-dict-dir.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-config-dict-dir.xml diff -u phpdoc/en/reference/pspell/functions/pspell-config-dict-dir.xml:1.2 phpdoc/en/reference/pspell/functions/pspell-config-dict-dir.xml:1.3 --- phpdoc/en/reference/pspell/functions/pspell-config-dict-dir.xml:1.2 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-config-dict-dir.xml Sun Jun 10 21:25:55 2007 @@ -1,21 +1,30 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.pspell-config-dict-dir"> <refnamediv> <refname>pspell_config_dict_dir</refname> <refpurpose>Location of the main word list</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pspell_config_dict_dir</methodname> <methodparam><type>int</type><parameter>conf</parameter></methodparam> <methodparam><type>string</type><parameter>directory</parameter></methodparam> </methodsynopsis> - + <para> &warn.undocumented.func; + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-config-ignore.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-config-ignore.xml diff -u phpdoc/en/reference/pspell/functions/pspell-config-ignore.xml:1.7 phpdoc/en/reference/pspell/functions/pspell-config-ignore.xml:1.8 --- phpdoc/en/reference/pspell/functions/pspell-config-ignore.xml:1.7 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-config-ignore.xml Sun Jun 10 21:25:55 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> +<!-- $Revision: 1.8 $ --> <refentry id="function.pspell-config-ignore"> <refnamediv> <refname>pspell_config_ignore</refname> <refpurpose>Ignore words less than N characters long</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pspell_config_ignore</methodname> <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> @@ -16,9 +16,42 @@ <simpara> <function>pspell_config_ignore</function> should be used on a config before calling <function>pspell_new_config</function>. This function - allows short words to be skipped by the spell checker. Words less than - <parameter>n</parameter> characters will be skipped. + allows short words to be skipped by the spell checker. </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>dictionary_link</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>n</parameter></term> + <listitem> + <para> + Words less than <parameter>n</parameter> characters will be skipped. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>pspell_config_ignore</function></title> @@ -35,6 +68,7 @@ </example> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-config-mode.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-config-mode.xml diff -u phpdoc/en/reference/pspell/functions/pspell-config-mode.xml:1.6 phpdoc/en/reference/pspell/functions/pspell-config-mode.xml:1.7 --- phpdoc/en/reference/pspell/functions/pspell-config-mode.xml:1.6 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-config-mode.xml Sun Jun 10 21:25:55 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.pspell-config-mode"> <refnamediv> <refname>pspell_config_mode</refname> <refpurpose>Change the mode number of suggestions returned</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pspell_config_mode</methodname> <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> @@ -19,32 +19,63 @@ determines how many suggestions will be returned by <function>pspell_suggest</function>. </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The mode parameter is the mode in which spellchecker will work. - There are several modes available: - <itemizedlist> - <listitem> - <simpara> - <constant>PSPELL_FAST</constant> - Fast mode (least number of - suggestions) - </simpara> - </listitem> - <listitem> - <simpara> - <constant>PSPELL_NORMAL</constant> - Normal mode (more suggestions) - </simpara> - </listitem> - <listitem> - <simpara> - <constant>PSPELL_BAD_SPELLERS</constant> - Slow mode (a lot of - suggestions) - </simpara> - </listitem> - </itemizedlist> + <variablelist> + <varlistentry> + <term><parameter>dictionary_link</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>mode</parameter></term> + <listitem> + <para> + The mode parameter is the mode in which spellchecker will work. + There are several modes available: + <itemizedlist> + <listitem> + <simpara> + <constant>PSPELL_FAST</constant> - Fast mode (least number of + suggestions) + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PSPELL_NORMAL</constant> - Normal mode (more suggestions) + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PSPELL_BAD_SPELLERS</constant> - Slow mode (a lot of + suggestions) + </simpara> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> - <title><function>pspell_config_mode</function></title> + <title><function>pspell_config_mode</function> Example</title> <programlisting role="php"> <![CDATA[ <?php @@ -58,6 +89,7 @@ </example> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-config-personal.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-config-personal.xml diff -u phpdoc/en/reference/pspell/functions/pspell-config-personal.xml:1.7 phpdoc/en/reference/pspell/functions/pspell-config-personal.xml:1.8 --- phpdoc/en/reference/pspell/functions/pspell-config-personal.xml:1.7 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-config-personal.xml Sun Jun 10 21:25:55 2007 @@ -1,29 +1,63 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> +<!-- $Revision: 1.8 $ --> <refentry id="function.pspell-config-personal"> <refnamediv> <refname>pspell_config_personal</refname> <refpurpose>Set a file that contains personal wordlist</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pspell_config_personal</methodname> <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> <methodparam><type>string</type><parameter>file</parameter></methodparam> </methodsynopsis> - <simpara> - <function>pspell_config_personal</function> should be used on a config - before calling <function>pspell_new_config</function>. The personal - wordlist will be loaded and used in addition to the standard one after - you call <function>pspell_new_config</function>. If the file does not - exist, it will be created. The file is also the file where + <para> + Set a file that contains personal wordlist. The personal wordlist will be + loaded and used in addition to the standard one after you call + <function>pspell_new_config</function>. The file is also the file where <function>pspell_save_wordlist</function> will save personal wordlist to. - The file should be writable by whoever PHP runs as (e.g. nobody). Please, - note that this function will not work unless you have pspell .11.2 and - aspell .32.5 or later. - </simpara> + </para> + <para> + <function>pspell_config_personal</function> should be used on a config + before calling <function>pspell_new_config</function>. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>dictionary_link</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>file</parameter></term> + <listitem> + <para> + The personal wordlist. If the file does not exist, it will be created. + The file should be writable by whoever PHP runs as (e.g. nobody). + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>pspell_config_personal</function></title> @@ -40,6 +74,17 @@ </example> </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + This function will not work unless you have pspell .11.2 and aspell .32.5 + or later. + </para> + </note> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-config-repl.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-config-repl.xml diff -u phpdoc/en/reference/pspell/functions/pspell-config-repl.xml:1.7 phpdoc/en/reference/pspell/functions/pspell-config-repl.xml:1.8 --- phpdoc/en/reference/pspell/functions/pspell-config-repl.xml:1.7 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-config-repl.xml Sun Jun 10 21:25:55 2007 @@ -1,30 +1,66 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> +<!-- $Revision: 1.8 $ --> <refentry id="function.pspell-config-repl"> <refnamediv> <refname>pspell_config_repl</refname> <refpurpose>Set a file that contains replacement pairs</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pspell_config_repl</methodname> <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> <methodparam><type>string</type><parameter>file</parameter></methodparam> </methodsynopsis> - <simpara> - <function>pspell_config_repl</function> should be used on a config - before calling <function>pspell_new_config</function>. The replacement - pairs improve the quality of the spellchecker. When a word is misspelled, - and a proper suggestion was not found in the list, + <para> + Set a file that contains replacement pairs. + </para> + <para> + The replacement pairs improve the quality of the spellchecker. When a word + is misspelled, and a proper suggestion was not found in the list, <function>pspell_store_replacement</function> can be used to store a replacement pair and then <function>pspell_save_wordlist</function> to - save the wordlist along with the replacement pairs. The file should be - writable by whoever PHP runs as (e.g. nobody). Please, note that this - function will not work unless you have pspell .11.2 and aspell .32.5 or - later. - </simpara> + save the wordlist along with the replacement pairs. + </para> + <para> + <function>pspell_config_repl</function> should be used on a config + before calling <function>pspell_new_config</function>. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>dictionary_link</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>file</parameter></term> + <listitem> + <para> + The file should be writable by whoever PHP runs as (e.g. nobody). + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>pspell_config_repl</function></title> @@ -42,6 +78,17 @@ </example> </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + This function will not work unless you have pspell .11.2 and aspell .32.5 + or later. + </para> + </note> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-config-runtogether.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-config-runtogether.xml diff -u phpdoc/en/reference/pspell/functions/pspell-config-runtogether.xml:1.7 phpdoc/en/reference/pspell/functions/pspell-config-runtogether.xml:1.8 --- phpdoc/en/reference/pspell/functions/pspell-config-runtogether.xml:1.7 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-config-runtogether.xml Sun Jun 10 21:25:55 2007 @@ -1,28 +1,64 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> +<!-- $Revision: 1.8 $ --> <refentry id="function.pspell-config-runtogether"> <refnamediv> <refname>pspell_config_runtogether</refname> <refpurpose>Consider run-together words as valid compounds</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pspell_config_runtogether</methodname> <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> <methodparam><type>bool</type><parameter>flag</parameter></methodparam> </methodsynopsis> - <simpara> - <function>pspell_config_runtogether</function> should be used on a config - before calling <function>pspell_new_config</function>. This function - determines whether run-together words will be treated as legal - compounds. That is, "thecat" will be a legal compound, - although there should be a space between the two - words. Changing this setting only affects the results returned - by <function>pspell_check</function>; + <para> + This function determines whether run-together words will be treated as + legal compounds. That is, "thecat" will be a legal compound, although + there should be a space between the two words. Changing this setting only + affects the results returned by <function>pspell_check</function>; <function>pspell_suggest</function> will still return suggestions. - </simpara> + </para> + <para> + <function>pspell_config_runtogether</function> should be used on a config + before calling <function>pspell_new_config</function>. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>dictionary_link</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>flag</parameter></term> + <listitem> + <para> + &true; if run-together words should be treated as legal compounds, + &false; otherwise. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>pspell_config_runtogether</function></title> @@ -39,6 +75,7 @@ </example> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-config-save-repl.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-config-save-repl.xml diff -u phpdoc/en/reference/pspell/functions/pspell-config-save-repl.xml:1.4 phpdoc/en/reference/pspell/functions/pspell-config-save-repl.xml:1.5 --- phpdoc/en/reference/pspell/functions/pspell-config-save-repl.xml:1.4 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-config-save-repl.xml Sun Jun 10 21:25:55 2007 @@ -1,31 +1,74 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.pspell-config-save-repl"> <refnamediv> <refname>pspell_config_save_repl</refname> <refpurpose>Determine whether to save a replacement pairs list along with the wordlist</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pspell_config_save_repl</methodname> <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> <methodparam><type>bool</type><parameter>flag</parameter></methodparam> </methodsynopsis> - <simpara> - <function>pspell_config_save_repl</function> should be used on a config - before calling <function>pspell_new_config</function>. It determines - whether <function>pspell_save_wordlist</function> will save the - replacement pairs along with the wordlist. Usually there is no need to use - this function because if <function>pspell_config_repl</function> is used, - the replacement pairs will be saved by + <para> + <function>pspell_config_save_repl</function> determines whether + <function>pspell_save_wordlist</function> will save the replacement pairs + along with the wordlist. Usually there is no need to use this function + because if <function>pspell_config_repl</function> is used, the + replacement pairs will be saved by <function>pspell_save_wordlist</function> anyway, and if it is not, - the replacement pairs will not be saved. Please, note that this function - will not work unless you have pspell .11.2 and aspell .32.5 or later. - </simpara> + the replacement pairs will not be saved. + </para> + <para> + <function>pspell_config_save_repl</function> should be used on a config + before calling <function>pspell_new_config</function>. + </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>dictionary_link</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>flag</parameter></term> + <listitem> + <para> + &true; if replacement pairs should be saved, &false; otherwise. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + This function will not work unless you have pspell .11.2 and aspell .32.5 + or later. + </para> + </note> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-new-config.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-new-config.xml diff -u phpdoc/en/reference/pspell/functions/pspell-new-config.xml:1.6 phpdoc/en/reference/pspell/functions/pspell-new-config.xml:1.7 --- phpdoc/en/reference/pspell/functions/pspell-new-config.xml:1.6 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-new-config.xml Sun Jun 10 21:25:55 2007 @@ -1,14 +1,14 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.pspell-new-config"> <refnamediv> <refname>pspell_new_config</refname> <refpurpose>Load a new dictionary with settings based on a given config </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>pspell_new_config</methodname> <methodparam><type>int</type><parameter>config</parameter></methodparam> @@ -22,10 +22,34 @@ <function>pspell_new</function> and <function>pspell_new_personal</function>. </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The config parameter is the one returned by - <function>pspell_config_create</function> when the config was created. + <variablelist> + <varlistentry> + <term><parameter>config</parameter></term> + <listitem> + <para> + The <parameter>config</parameter> parameter is the one returned by + <function>pspell_config_create</function> when the config was created. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a dictionary link identifier on success. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>pspell_new_config</function></title> @@ -42,6 +66,7 @@ </example> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-new-personal.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-new-personal.xml diff -u phpdoc/en/reference/pspell/functions/pspell-new-personal.xml:1.6 phpdoc/en/reference/pspell/functions/pspell-new-personal.xml:1.7 --- phpdoc/en/reference/pspell/functions/pspell-new-personal.xml:1.6 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-new-personal.xml Sun Jun 10 21:25:55 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.pspell-new-personal"> <refnamediv> <refname>pspell_new_personal</refname> <refpurpose>Load a new dictionary with personal wordlist</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>pspell_new_personal</methodname> <methodparam><type>string</type><parameter>personal</parameter></methodparam> @@ -19,8 +19,7 @@ </methodsynopsis> <simpara> <function>pspell_new_personal</function> opens up a new dictionary with - a personal wordlist and returns the dictionary link identifier for use - in other pspell functions. The wordlist can be modified and saved with + a personal wordlist. The wordlist can be modified and saved with <function>pspell_save_wordlist</function>, if desired. However, the replacement pairs are not saved. In order to save replacement pairs, you should create a config using <function>pspell_config_create</function>, @@ -31,75 +30,121 @@ <function>pspell_new_config</function>. </simpara> <para> - The personal parameter specifies the file where words added to the - personal list will be stored. It should be an absolute filename - beginning with '/' because otherwise it will be relative to $HOME, - which is "/root" for most systems, and is probably not what you want. - </para> - <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. - </para> - <para> - The spelling parameter is the requested spelling for languages - with more than one spelling such as English. Known values are - 'american', 'british', and 'canadian'. - </para> - <para> - The jargon parameter contains extra information to distinguish - two different words lists that have the same language and - spelling parameters. - </para> - <para> - 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> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The mode parameter is the mode in which spellchecker will work. - There are several modes available: - <itemizedlist> - <listitem> - <simpara> - <constant>PSPELL_FAST</constant> - Fast mode (least number of - suggestions) - </simpara> - </listitem> - <listitem> - <simpara> - <constant>PSPELL_NORMAL</constant> - Normal mode (more suggestions) - </simpara> - </listitem> - <listitem> - <simpara> - <constant>PSPELL_BAD_SPELLERS</constant> - Slow mode (a lot of - suggestions) - </simpara> - </listitem> - <listitem> - <simpara> - <constant>PSPELL_RUN_TOGETHER</constant> - Consider run-together words - as legal compounds. That is, "thecat" will be a legal compound, - although there should be a space between the two words. Changing this - setting only affects the results returned by - <function>pspell_check</function>; <function>pspell_suggest</function> - will still return suggestions. - </simpara> - </listitem> - </itemizedlist> - Mode is a bitmask constructed from different constants listed above. - However, <constant>PSPELL_FAST</constant>, - <constant>PSPELL_NORMAL</constant> and - <constant>PSPELL_BAD_SPELLERS</constant> are mutually exclusive, so you - should select only one of them. + <variablelist> + <varlistentry> + <term><parameter>personal</parameter></term> + <listitem> + <para> + The file where words added to the personal list will be stored. + It should be an absolute filename beginning with '/' because otherwise + it will be relative to $HOME, which is "/root" for most systems, and + is probably not what you want. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>language</parameter></term> + <listitem> + <para> + 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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>spelling</parameter></term> + <listitem> + <para> + The requested spelling for languages with more than one spelling such + as English. Known values are 'american', 'british', and 'canadian'. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>jargon</parameter></term> + <listitem> + <para> + Extra information to distinguish two different words lists that have + the same language and spelling parameters. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + <para> + The encoding that words are expected to be in. Valid values are + <literal>utf-8</literal>, <literal>iso8859-*</literal>, + <literal>koi8-r</literal>, <literal>viscii</literal>, + <literal>cp1252</literal>, <literal>machine unsigned 16</literal>, + <literal>machine unsigned 32</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>mode</parameter></term> + <listitem> + <para> + The mode in which spellchecker will work. There are several modes available: + <itemizedlist> + <listitem> + <simpara> + <constant>PSPELL_FAST</constant> - Fast mode (least number of + suggestions) + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PSPELL_NORMAL</constant> - Normal mode (more suggestions) + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PSPELL_BAD_SPELLERS</constant> - Slow mode (a lot of + suggestions) + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PSPELL_RUN_TOGETHER</constant> - Consider run-together words + as legal compounds. That is, "thecat" will be a legal compound, + although there should be a space between the two words. Changing this + setting only affects the results returned by + <function>pspell_check</function>; <function>pspell_suggest</function> + will still return suggestions. + </simpara> + </listitem> + </itemizedlist> + Mode is a bitmask constructed from different constants listed above. + However, <constant>PSPELL_FAST</constant>, + <constant>PSPELL_NORMAL</constant> and + <constant>PSPELL_BAD_SPELLERS</constant> are mutually exclusive, so you + should select only one of them. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - For more information and examples, check out inline manual pspell - website:<ulink url="&url.pspell;">&url.pspell;</ulink>. + Returns the dictionary link identifier for use in other pspell functions. </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>pspell_new_personal</function></title> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-new.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-new.xml diff -u phpdoc/en/reference/pspell/functions/pspell-new.xml:1.7 phpdoc/en/reference/pspell/functions/pspell-new.xml:1.8 --- phpdoc/en/reference/pspell/functions/pspell-new.xml:1.7 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-new.xml Sun Jun 10 21:25:55 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.1 --> +<!-- $Revision: 1.8 $ --> <refentry id="function.pspell-new"> <refnamediv> <refname>pspell_new</refname> <refpurpose>Load a new dictionary</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>pspell_new</methodname> <methodparam><type>string</type><parameter>language</parameter></methodparam> @@ -16,75 +16,119 @@ <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> </methodsynopsis> - <simpara> + <para> <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. - </para> - <para> - The spelling parameter is the requested spelling for languages - with more than one spelling such as English. Known values are - 'american', 'british', and 'canadian'. </para> <para> - The jargon parameter contains extra information to distinguish - two different words lists that have the same language and - spelling parameters. - </para> - <para> - 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> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The mode parameter is the mode in which spellchecker will work. - There are several modes available: - <itemizedlist> - <listitem> - <simpara> - <constant>PSPELL_FAST</constant> - Fast mode (least number of - suggestions) - </simpara> - </listitem> - <listitem> - <simpara> - <constant>PSPELL_NORMAL</constant> - Normal mode (more suggestions) - </simpara> - </listitem> - <listitem> - <simpara> - <constant>PSPELL_BAD_SPELLERS</constant> - Slow mode (a lot of - suggestions) - </simpara> - </listitem> - <listitem> - <simpara> - <constant>PSPELL_RUN_TOGETHER</constant> - Consider run-together words - as legal compounds. That is, "thecat" will be a legal compound, - although there should be a space between the two words. Changing this - setting only affects the results returned by - <function>pspell_check</function>; <function>pspell_suggest</function> - will still return suggestions. - </simpara> - </listitem> - </itemizedlist> - Mode is a bitmask constructed from different constants listed above. - However, <constant>PSPELL_FAST</constant>, - <constant>PSPELL_NORMAL</constant> and - <constant>PSPELL_BAD_SPELLERS</constant> are mutually exclusive, so you - should select only one of them. + <variablelist> + <varlistentry> + <term><parameter>language</parameter></term> + <listitem> + <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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>spelling</parameter></term> + <listitem> + <para> + The spelling parameter is the requested spelling for languages + with more than one spelling such as English. Known values are + 'american', 'british', and 'canadian'. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>jargon</parameter></term> + <listitem> + <para> + The jargon parameter contains extra information to distinguish + two different words lists that have the same language and + spelling parameters. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + <para> + 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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>mode</parameter></term> + <listitem> + <para> + The mode parameter is the mode in which spellchecker will work. + There are several modes available: + <itemizedlist> + <listitem> + <simpara> + <constant>PSPELL_FAST</constant> - Fast mode (least number of + suggestions) + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PSPELL_NORMAL</constant> - Normal mode (more suggestions) + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PSPELL_BAD_SPELLERS</constant> - Slow mode (a lot of + suggestions) + </simpara> + </listitem> + <listitem> + <simpara> + <constant>PSPELL_RUN_TOGETHER</constant> - Consider run-together words + as legal compounds. That is, "thecat" will be a legal compound, + although there should be a space between the two words. Changing this + setting only affects the results returned by + <function>pspell_check</function>; <function>pspell_suggest</function> + will still return suggestions. + </simpara> + </listitem> + </itemizedlist> + Mode is a bitmask constructed from different constants listed above. + However, <constant>PSPELL_FAST</constant>, + <constant>PSPELL_NORMAL</constant> and + <constant>PSPELL_BAD_SPELLERS</constant> are mutually exclusive, so you + should select only one of them. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - For more information and examples, check out inline manual pspell - website:<ulink url="&url.pspell;">&url.pspell;</ulink>. + Returns the dictionary link identifier on success, or &false; on failure. </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>pspell_new</function></title> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-save-wordlist.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-save-wordlist.xml diff -u phpdoc/en/reference/pspell/functions/pspell-save-wordlist.xml:1.6 phpdoc/en/reference/pspell/functions/pspell-save-wordlist.xml:1.7 --- phpdoc/en/reference/pspell/functions/pspell-save-wordlist.xml:1.6 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-save-wordlist.xml Sun Jun 10 21:25:55 2007 @@ -1,26 +1,51 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.pspell-save-wordlist"> <refnamediv> <refname>pspell_save_wordlist</refname> <refpurpose>Save the personal wordlist to a file</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pspell_save_wordlist</methodname> <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> </methodsynopsis> <simpara> - <function>pspell_save_wordlist</function> saves the personal wordlist - from the current session. The dictionary has to be open with - <function>pspell_new_personal</function>, and the location of files to be - saved specified with <function>pspell_config_personal</function> and - (optionally) <function>pspell_config_repl</function>. Please, note that - this function will not work unless you have pspell .11.2 and aspell .32.5 - or later. + <function>pspell_save_wordlist</function> saves the personal wordlist from + the current session. The location of files to be saved specified with + <function>pspell_config_personal</function> and (optionally) + <function>pspell_config_repl</function>. </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>dictionary_link</parameter></term> + <listitem> + <para> + A dictionary link identifier opened with + <function>pspell_new_personal</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>pspell_add_to_personal</function></title> @@ -39,6 +64,17 @@ </example> </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + This function will not work unless you have pspell .11.2 and aspell .32.5 + or later. + </para> + </note> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-store-replacement.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-store-replacement.xml diff -u phpdoc/en/reference/pspell/functions/pspell-store-replacement.xml:1.6 phpdoc/en/reference/pspell/functions/pspell-store-replacement.xml:1.7 --- phpdoc/en/reference/pspell/functions/pspell-store-replacement.xml:1.6 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-store-replacement.xml Sun Jun 10 21:25:55 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.1 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.pspell-store-replacement"> <refnamediv> <refname>pspell_store_replacement</refname> <refpurpose>Store a replacement pair for a word</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pspell_store_replacement</methodname> <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> @@ -24,9 +24,52 @@ use <function>pspell_config_personal</function> and <function>pspell_config_repl</function> to set the path where to save your custom wordlists, and then use <function>pspell_save_wordlist</function> - for the changes to be written to disk. Please, note that this function - will not work unless you have pspell .11.2 and aspell .32.5 or later. + for the changes to be written to disk. </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>dictionary_link</parameter></term> + <listitem> + <para> + A dictionary link identifier, opened with + <function>pspell_new_personal</function> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>misspelled</parameter></term> + <listitem> + <para> + The misspelled word. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>correct</parameter></term> + <listitem> + <para> + The fixed spelling for the <parameter>misspelled</parameter> word. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>pspell_store_replacement</function></title> @@ -46,6 +89,17 @@ </example> </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + This function will not work unless you have pspell .11.2 and aspell .32.5 + or later. + </para> + </note> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-suggest.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-suggest.xml diff -u phpdoc/en/reference/pspell/functions/pspell-suggest.xml:1.5 phpdoc/en/reference/pspell/functions/pspell-suggest.xml:1.6 --- phpdoc/en/reference/pspell/functions/pspell-suggest.xml:1.5 Sun Jun 10 21:25:29 2007 +++ phpdoc/en/reference/pspell/functions/pspell-suggest.xml Sun Jun 10 21:25:56 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/pspell.xml, last change in rev 1.1 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.pspell-suggest"> <refnamediv> <refname>pspell_suggest</refname> <refpurpose>Suggest spellings of a word</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>pspell_suggest</methodname> <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> @@ -17,6 +17,40 @@ <function>pspell_suggest</function> returns an array of possible spellings for the given word. </simpara> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>dictionary_link</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>word</parameter></term> + <listitem> + <para> + The tested word. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an array of possible spellings. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>pspell_suggest</function> example</title> @@ -38,6 +72,7 @@ </example> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file