cvs: phpdoc /en/functions pspell.xml
| From: | Jeroen van Wolffelaar | Date: | Mon, 13 Aug 2001 22:36:05 +0000 |
| Subject: | cvs: phpdoc /en/functions pspell.xml | ||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969337082@lists.php.net to get a copy of this message | ||
jeroen Mon Aug 13 18:36:05 2001 EDT
Modified files:
/phpdoc/en/functions pspell.xml
Log:
Minor improvements
Index: phpdoc/en/functions/pspell.xml diff -u phpdoc/en/functions/pspell.xml:1.15 phpdoc/en/functions/pspell.xml:1.16 --- phpdoc/en/functions/pspell.xml:1.15 Thu Aug 2 13:37:25 2001 +++ phpdoc/en/functions/pspell.xml Mon Aug 13 18:36:05 2001 @@ -1,4 +1,6 @@ -<!-- $Revision: 1.15 $ --> +<!-- $Revision: 1.16 $ --> + +<!-- pspell currently (2001-08-14) doesn't use resources --> <reference id="ref.pspell"> <title>Pspell Functions</title> <titleabbrev>Pspell</titleabbrev> @@ -6,7 +8,7 @@ <partintro> <simpara> These functions allow you to check the spelling of a word and offer - suggestions. + suggestions. </simpara> <simpara> You need the aspell and pspell libraries, available from <ulink @@ -20,7 +22,7 @@ <refentry id="function.pspell-add-to-personal"> <refnamediv> <refname>pspell_add_to_personal</refname> - <refpurpose>Add the word to a personal wordlist.</refpurpose> + <refpurpose>Add the word to a personal wordlist</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -33,11 +35,11 @@ </funcsynopsis> <simpara> <function>pspell_add_to_personal</function> adds a word to the personal - 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. + 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. </simpara> <para> <example> @@ -58,8 +60,8 @@ <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> @@ -72,8 +74,8 @@ </funcsynopsis> <simpara> <function>pspell_add_to_session</function> adds a word to the wordlist - associated with the current session. It is very similar to - <function>pspell_add_to_personal</function> + associated with the current session. It is very similar to + <function>pspell_add_to_personal</function> </simpara> </refsect1> </refentry> @@ -116,7 +118,7 @@ <refentry id="function.pspell-clear-session"> <refnamediv> <refname>pspell_clear_session</refname> - <refpurpose>Clear the current session.</refpurpose> + <refpurpose>Clear the current session</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -128,8 +130,8 @@ </funcsynopsis> <simpara> <function>pspell_clear_session</function> clears the current session. - The current wordlist becomes blank, and, for example, if you try to save - it with <function>pspell_save_wordlist</function>, nothing happens. + The current wordlist becomes blank, and, for example, if you try to save + it with <function>pspell_save_wordlist</function>, nothing happens. </simpara> <para> <example> @@ -141,7 +143,7 @@ pspell_add_to_personal ($pspell_link, "Vlad"); pspell_clear_session ($pspell_link); -pspell_save_wordlist ($pspell_link); //"Vlad" will not be saved +pspell_save_wordlist ($pspell_link); //"Vlad" will not be saved </programlisting> </example> </para> @@ -151,7 +153,7 @@ <refentry id="function.pspell-config-create"> <refnamediv> <refname>pspell_config_create</refname> - <refpurpose>Create a config used to open a dictionary.</refpurpose> + <refpurpose>Create a config used to open a dictionary</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -178,13 +180,13 @@ </funcsynopsis> <simpara> <function>pspell_config_create</function> has a very similar syntax to - <function>pspell_new</function>. In fact, using - <function>pspell_config_create</function> immediatelly followed by - <function>pspell_new_config</function> will produce the exact same result. - However, after creating a new config, you can also use - <function>pspell_config_*</function> functions before calling - <function>pspell_new_config</function> to take advantage of some - advanced functionality. + <function>pspell_new</function>. In fact, using + <function>pspell_config_create</function> immediatelly followed by + <function>pspell_new_config</function> will produce the exact same result. + However, after creating a new config, you can also use + <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 @@ -214,17 +216,19 @@ <itemizedlist> <listitem> <simpara> - PSPELL_FAST - Fast mode (least number of suggestions) + <constant>PSPELL_FAST</constant> - Fast mode (least number of + suggestions) </simpara> </listitem> <listitem> <simpara> - PSPELL_NORMAL - Normal mode (more suggestions) + <constant>PSPELL_NORMAL</constant> - Normal mode (more suggestions) </simpara> </listitem> <listitem> <simpara> - PSPELL_BAD_SPELLERS - Slow mode (a lot of suggestions) + <constant>PSPELL_BAD_SPELLERS</constant> - Slow mode (a lot of + suggestions) </simpara> </listitem> </itemizedlist> @@ -250,7 +254,7 @@ <refentry id="function.pspell-config-ignore"> <refnamediv> <refname>pspell_config_ignore</refname> - <refpurpose>Ignore words less than N characters long.</refpurpose> + <refpurpose>Ignore words less than N characters long</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -263,9 +267,9 @@ </funcsynopsis> <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 spellchecker. Words less then - n characters will be skipped. + before calling <function>pspell_new_config</function>. This function + allows short words to be skipped by the spellchecker. Words less then + n characters will be skipped. </simpara> <para> <example> @@ -274,7 +278,7 @@ $pspell_config = pspell_config_create ("en"); pspell_config_ignore($pspell_config, 5); $pspell_link = pspell_new_config($pspell_config); -pspell_check($pspell_link, "abcd"); //will not result in an error +pspell_check($pspell_link, "abcd"); //will not result in an error </programlisting> </example> </para> @@ -284,7 +288,7 @@ <refentry id="function.pspell-config-mode"> <refnamediv> <refname>pspell_config_mode</refname> - <refpurpose>Change the mode number of suggestions returned.</refpurpose> + <refpurpose>Change the mode number of suggestions returned</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -297,27 +301,29 @@ </funcsynopsis> <simpara> <function>pspell_config_mode</function> should be used on a config - before calling <function>pspell_new_config</function>. This function - determines how many suggestions will be returned by - <function>pspell_suggest</function>. - </simpara> - <para> + before calling <function>pspell_new_config</function>. This function + determines how many suggestions will be returned by + <function>pspell_suggest</function>. + </simpara> + <para> The mode parameter is the mode in which spellchecker will work. There are several modes available: <itemizedlist> <listitem> <simpara> - PSPELL_FAST - Fast mode (least number of suggestions) + <constant>PSPELL_FAST</constant> - Fast mode (least number of + suggestions) </simpara> </listitem> <listitem> <simpara> - PSPELL_NORMAL - Normal mode (more suggestions) + <constant>PSPELL_NORMAL</constant> - Normal mode (more suggestions) </simpara> </listitem> <listitem> <simpara> - PSPELL_BAD_SPELLERS - Slow mode (a lot of suggestions) + <constant>PSPELL_BAD_SPELLERS</constant> - Slow mode (a lot of + suggestions) </simpara> </listitem> </itemizedlist> @@ -339,7 +345,7 @@ <refentry id="function.pspell-config-personal"> <refnamediv> <refname>pspell_config_personal</refname> - <refpurpose>Set a file that contains personal wordlist.</refpurpose> + <refpurpose>Set a file that contains personal wordlist</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -352,14 +358,14 @@ </funcsynopsis> <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 - <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. + 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 + <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> <example> @@ -378,7 +384,7 @@ <refentry id="function.pspell-config-repl"> <refnamediv> <refname>pspell_config_repl</refname> - <refpurpose>Set a file that contains replacement pairs.</refpurpose> + <refpurpose>Set a file that contains replacement pairs</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -391,15 +397,15 @@ </funcsynopsis> <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, - <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. + 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, + <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> <para> <example> @@ -419,7 +425,7 @@ <refentry id="function.pspell-config-runtogether"> <refnamediv> <refname>pspell_config_runtogether</refname> - <refpurpose>Consider run-together words as valid compounds.</refpurpose> + <refpurpose>Consider run-together words as valid compounds</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -432,13 +438,13 @@ </funcsynopsis> <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, - athough 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. + 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, + athough 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> <example> @@ -458,7 +464,7 @@ <refnamediv> <refname>pspell_config_save_repl</refname> <refpurpose>Determine whether to save a replacement pairs list - along with the wordlist.</refpurpose> + along with the wordlist</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -471,14 +477,14 @@ </funcsynopsis> <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 - <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. + 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 + <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> </refsect1> </refentry> @@ -493,6 +499,7 @@ <funcsynopsis> <funcprototype> <funcdef>int <function>pspell_new</function></funcdef> + <!-- not yet resource... --> <paramdef>string <parameter>language</parameter></paramdef> <paramdef>string <parameter> @@ -549,35 +556,37 @@ <itemizedlist> <listitem> <simpara> - PSPELL_FAST - Fast mode (least number of suggestions) + <constant>PSPELL_FAST</constant> - Fast mode (least number of + suggestions) </simpara> </listitem> <listitem> <simpara> - PSPELL_NORMAL - Normal mode (more suggestions) + <constant>PSPELL_NORMAL</constant> - Normal mode (more suggestions) </simpara> </listitem> <listitem> <simpara> - PSPELL_BAD_SPELLERS - Slow mode (a lot of suggestions) + <constant>PSPELL_BAD_SPELLERS</constant> - Slow mode (a lot of + suggestions) </simpara> </listitem> <listitem> <simpara> - PSPELL_RUN_TOGETHER - Consider run-together words as legal - compounds. That is, "thecat" will be a legal compound, - athough 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. + <constant>PSPELL_RUN_TOGETHER</constant> - Consider run-together words + as legal compounds. That is, "thecat" will be a legal compound, + athough 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, PSPELL_FAST, PSPELL_NORMAL and - PSPELL_BAD_SPELLERS are mutually exclusive, so you should select - only one of them. + 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> <para> For more information and examples, check out inline manual pspell @@ -599,7 +608,7 @@ <refnamediv> <refname>pspell_new_config</refname> <refpurpose>Load a new dictionary with settings based on a given config - </refpurpose> + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -611,16 +620,16 @@ </funcsynopsis> <simpara> <function>pspell_new_config</function> opens up a new dictionary with - settings specified in a config, created with with - <function>pspell_config_create</function> and modified with - <function>pspell_config_*</function> functions. This method provides you - with the most flexibility and has all the functionality provided by - <function>pspell_new</function> and - <function>pspell_new_personal</function>. + settings specified in a config, created with with + <function>pspell_config_create</function> and modified with + <function>pspell_config_*</function> functions. This method provides you + with the most flexibility and has all the functionality provided by + <function>pspell_new</function> and + <function>pspell_new_personal</function>. </simpara> <para> The config parameter is the one returned by - <function>pspell_config_create</function> when the config was created. + <function>pspell_config_create</function> when the config was created. </para> <para> <example> @@ -672,22 +681,22 @@ </funcsynopsis> <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 - <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>, - set the personal wordlist file with - <function>pspell_config_personal</function>, - set the file for replacement pairs with - <function>pspell_config_repl</function>, and open a new dictionary with - <function>pspell_new_config</function>. + a personal wordlist and returns the dictionary link identifier for use + in other pspell functions. 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>, + set the personal wordlist file with + <function>pspell_config_personal</function>, + set the file for replacement pairs with + <function>pspell_config_repl</function>, and open a new dictionary with + <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. + 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 @@ -717,35 +726,37 @@ <itemizedlist> <listitem> <simpara> - PSPELL_FAST - Fast mode (least number of suggestions) + <constant>PSPELL_FAST</constant> - Fast mode (least number of + suggestions) </simpara> </listitem> <listitem> <simpara> - PSPELL_NORMAL - Normal mode (more suggestions) + <constant>PSPELL_NORMAL</constant> - Normal mode (more suggestions) </simpara> </listitem> <listitem> <simpara> - PSPELL_BAD_SPELLERS - Slow mode (a lot of suggestions) + <constant>PSPELL_BAD_SPELLERS</constant> - Slow mode (a lot of + suggestions) </simpara> </listitem> <listitem> <simpara> - PSPELL_RUN_TOGETHER - Consider run-together words as legal - compounds. That is, "thecat" will be a legal compound, - athough 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. + <constant>PSPELL_RUN_TOGETHER</constant> - Consider run-together words + as legal compounds. That is, "thecat" will be a legal compound, + athough 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, PSPELL_FAST, PSPELL_NORMAL and - PSPELL_BAD_SPELLERS are mutually exclusive, so you should select - only one of them. + 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> <para> For more information and examples, check out inline manual pspell @@ -756,7 +767,7 @@ <title><function>pspell_new_personal</function></title> <programlisting role="php"> $pspell_link = pspell_new_personal ("/var/dictionaries/custom.pws", - "en", "", "", "", PSPELL_FAST|PSPELL_RUN_TOGETHER)); + "en", "", "", "", PSPELL_FAST|PSPELL_RUN_TOGETHER)); </programlisting> </example> </para> @@ -766,7 +777,7 @@ <refentry id="function.pspell-save-wordlist"> <refnamediv> <refname>pspell_save_wordlist</refname> - <refpurpose>Save the personal wordlist to a file.</refpurpose> + <refpurpose>Save the personal wordlist to a file</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -778,12 +789,12 @@ </funcsynopsis> <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. + 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. </simpara> <para> <example> @@ -818,16 +829,16 @@ </funcsynopsis> <simpara> <function>pspell_store_replacement</function> stores a replacement pair for - a word, so that replacement can be returned by - <function>pspell_suggest</function> later. In order to be able to take - advantage of this function, you have to use - <function>pspell_new_personal</function> to open the dictionary. In order - to permanently save the replacement pair, you have to - 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. + a word, so that replacement can be returned by + <function>pspell_suggest</function> later. In order to be able to take + advantage of this function, you have to use + <function>pspell_new_personal</function> to open the dictionary. In order + to permanently save the replacement pair, you have to + 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. </simpara> <para> <example> @@ -873,8 +884,8 @@ if (!pspell_check ($pspell_link, "testt")) { $suggestions = pspell_suggest ($pspell_link, "testt"); - for ($i=0; $i < count ($suggestions); $i++) { - echo "Possible spelling: " . $suggestions[$i] . "<br>"; + foreach ($suggestions as $suggestion) { + echo "Possible spelling: $suggestion<br>"; } } </programlisting> @@ -900,4 +911,5 @@ sgml-local-catalogs:nil sgml-local-ecat-files:nil End: +vi: et:ts=1:sw=1:textwidth=78:syntax=sgml -->
Index: phpdoc/en/functions/pspell.xml diff -u phpdoc/en/functions/pspell.xml:1.15 phpdoc/en/functions/pspell.xml:1.16 --- phpdoc/en/functions/pspell.xml:1.15 Thu Aug 2 13:37:25 2001 +++ phpdoc/en/functions/pspell.xml Mon Aug 13 18:36:05 2001 @@ -1,4 +1,6 @@ -<!-- $Revision: 1.15 $ --> +<!-- $Revision: 1.16 $ --> + +<!-- pspell currently (2001-08-14) doesn't use resources --> <reference id="ref.pspell"> <title>Pspell Functions</title> <titleabbrev>Pspell</titleabbrev> @@ -6,7 +8,7 @@ <partintro> <simpara> These functions allow you to check the spelling of a word and offer - suggestions. + suggestions. </simpara> <simpara> You need the aspell and pspell libraries, available from <ulink @@ -20,7 +22,7 @@ <refentry id="function.pspell-add-to-personal"> <refnamediv> <refname>pspell_add_to_personal</refname> - <refpurpose>Add the word to a personal wordlist.</refpurpose> + <refpurpose>Add the word to a personal wordlist</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -33,11 +35,11 @@ </funcsynopsis> <simpara> <function>pspell_add_to_personal</function> adds a word to the personal - 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. + 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. </simpara> <para> <example> @@ -58,8 +60,8 @@ <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> @@ -72,8 +74,8 @@ </funcsynopsis> <simpara> <function>pspell_add_to_session</function> adds a word to the wordlist - associated with the current session. It is very similar to - <function>pspell_add_to_personal</function> + associated with the current session. It is very similar to + <function>pspell_add_to_personal</function> </simpara> </refsect1> </refentry> @@ -116,7 +118,7 @@ <refentry id="function.pspell-clear-session"> <refnamediv> <refname>pspell_clear_session</refname> - <refpurpose>Clear the current session.</refpurpose> + <refpurpose>Clear the current session</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -128,8 +130,8 @@ </funcsynopsis> <simpara> <function>pspell_clear_session</function> clears the current session. - The current wordlist becomes blank, and, for example, if you try to save - it with <function>pspell_save_wordlist</function>, nothing happens. + The current wordlist becomes blank, and, for example, if you try to save + it with <function>pspell_save_wordlist</function>, nothing happens. </simpara> <para> <example> @@ -141,7 +143,7 @@ pspell_add_to_personal ($pspell_link, "Vlad"); pspell_clear_session ($pspell_link); -pspell_save_wordlist ($pspell_link); //"Vlad" will not be saved +pspell_save_wordlist ($pspell_link); //"Vlad" will not be saved </programlisting> </example> </para> @@ -151,7 +153,7 @@ <refentry id="function.pspell-config-create"> <refnamediv> <refname>pspell_config_create</refname> - <refpurpose>Create a config used to open a dictionary.</refpurpose> + <refpurpose>Create a config used to open a dictionary</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -178,13 +180,13 @@ </funcsynopsis> <simpara> <function>pspell_config_create</function> has a very similar syntax to - <function>pspell_new</function>. In fact, using - <function>pspell_config_create</function> immediatelly followed by - <function>pspell_new_config</function> will produce the exact same result. - However, after creating a new config, you can also use - <function>pspell_config_*</function> functions before calling - <function>pspell_new_config</function> to take advantage of some - advanced functionality. + <function>pspell_new</function>. In fact, using + <function>pspell_config_create</function> immediatelly followed by + <function>pspell_new_config</function> will produce the exact same result. + However, after creating a new config, you can also use + <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 @@ -214,17 +216,19 @@ <itemizedlist> <listitem> <simpara> - PSPELL_FAST - Fast mode (least number of suggestions) + <constant>PSPELL_FAST</constant> - Fast mode (least number of + suggestions) </simpara> </listitem> <listitem> <simpara> - PSPELL_NORMAL - Normal mode (more suggestions) + <constant>PSPELL_NORMAL</constant> - Normal mode (more suggestions) </simpara> </listitem> <listitem> <simpara> - PSPELL_BAD_SPELLERS - Slow mode (a lot of suggestions) + <constant>PSPELL_BAD_SPELLERS</constant> - Slow mode (a lot of + suggestions) </simpara> </listitem> </itemizedlist> @@ -250,7 +254,7 @@ <refentry id="function.pspell-config-ignore"> <refnamediv> <refname>pspell_config_ignore</refname> - <refpurpose>Ignore words less than N characters long.</refpurpose> + <refpurpose>Ignore words less than N characters long</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -263,9 +267,9 @@ </funcsynopsis> <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 spellchecker. Words less then - n characters will be skipped. + before calling <function>pspell_new_config</function>. This function + allows short words to be skipped by the spellchecker. Words less then + n characters will be skipped. </simpara> <para> <example> @@ -274,7 +278,7 @@ $pspell_config = pspell_config_create ("en"); pspell_config_ignore($pspell_config, 5); $pspell_link = pspell_new_config($pspell_config); -pspell_check($pspell_link, "abcd"); //will not result in an error +pspell_check($pspell_link, "abcd"); //will not result in an error </programlisting> </example> </para> @@ -284,7 +288,7 @@ <refentry id="function.pspell-config-mode"> <refnamediv> <refname>pspell_config_mode</refname> - <refpurpose>Change the mode number of suggestions returned.</refpurpose> + <refpurpose>Change the mode number of suggestions returned</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -297,27 +301,29 @@ </funcsynopsis> <simpara> <function>pspell_config_mode</function> should be used on a config - before calling <function>pspell_new_config</function>. This function - determines how many suggestions will be returned by - <function>pspell_suggest</function>. - </simpara> - <para> + before calling <function>pspell_new_config</function>. This function + determines how many suggestions will be returned by + <function>pspell_suggest</function>. + </simpara> + <para> The mode parameter is the mode in which spellchecker will work. There are several modes available: <itemizedlist> <listitem> <simpara> - PSPELL_FAST - Fast mode (least number of suggestions) + <constant>PSPELL_FAST</constant> - Fast mode (least number of + suggestions) </simpara> </listitem> <listitem> <simpara> - PSPELL_NORMAL - Normal mode (more suggestions) + <constant>PSPELL_NORMAL</constant> - Normal mode (more suggestions) </simpara> </listitem> <listitem> <simpara> - PSPELL_BAD_SPELLERS - Slow mode (a lot of suggestions) + <constant>PSPELL_BAD_SPELLERS</constant> - Slow mode (a lot of + suggestions) </simpara> </listitem> </itemizedlist> @@ -339,7 +345,7 @@ <refentry id="function.pspell-config-personal"> <refnamediv> <refname>pspell_config_personal</refname> - <refpurpose>Set a file that contains personal wordlist.</refpurpose> + <refpurpose>Set a file that contains personal wordlist</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -352,14 +358,14 @@ </funcsynopsis> <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 - <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. + 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 + <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> <example> @@ -378,7 +384,7 @@ <refentry id="function.pspell-config-repl"> <refnamediv> <refname>pspell_config_repl</refname> - <refpurpose>Set a file that contains replacement pairs.</refpurpose> + <refpurpose>Set a file that contains replacement pairs</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -391,15 +397,15 @@ </funcsynopsis> <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, - <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. + 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, + <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> <para> <example> @@ -419,7 +425,7 @@ <refentry id="function.pspell-config-runtogether"> <refnamediv> <refname>pspell_config_runtogether</refname> - <refpurpose>Consider run-together words as valid compounds.</refpurpose> + <refpurpose>Consider run-together words as valid compounds</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -432,13 +438,13 @@ </funcsynopsis> <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, - athough 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. + 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, + athough 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> <example> @@ -458,7 +464,7 @@ <refnamediv> <refname>pspell_config_save_repl</refname> <refpurpose>Determine whether to save a replacement pairs list - along with the wordlist.</refpurpose> + along with the wordlist</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -471,14 +477,14 @@ </funcsynopsis> <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 - <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. + 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 + <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> </refsect1> </refentry> @@ -493,6 +499,7 @@ <funcsynopsis> <funcprototype> <funcdef>int <function>pspell_new</function></funcdef> + <!-- not yet resource... --> <paramdef>string <parameter>language</parameter></paramdef> <paramdef>string <parameter> @@ -549,35 +556,37 @@ <itemizedlist> <listitem> <simpara> - PSPELL_FAST - Fast mode (least number of suggestions) + <constant>PSPELL_FAST</constant> - Fast mode (least number of + suggestions) </simpara> </listitem> <listitem> <simpara> - PSPELL_NORMAL - Normal mode (more suggestions) + <constant>PSPELL_NORMAL</constant> - Normal mode (more suggestions) </simpara> </listitem> <listitem> <simpara> - PSPELL_BAD_SPELLERS - Slow mode (a lot of suggestions) + <constant>PSPELL_BAD_SPELLERS</constant> - Slow mode (a lot of + suggestions) </simpara> </listitem> <listitem> <simpara> - PSPELL_RUN_TOGETHER - Consider run-together words as legal - compounds. That is, "thecat" will be a legal compound, - athough 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. + <constant>PSPELL_RUN_TOGETHER</constant> - Consider run-together words + as legal compounds. That is, "thecat" will be a legal compound, + athough 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, PSPELL_FAST, PSPELL_NORMAL and - PSPELL_BAD_SPELLERS are mutually exclusive, so you should select - only one of them. + 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> <para> For more information and examples, check out inline manual pspell @@ -599,7 +608,7 @@ <refnamediv> <refname>pspell_new_config</refname> <refpurpose>Load a new dictionary with settings based on a given config - </refpurpose> + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -611,16 +620,16 @@ </funcsynopsis> <simpara> <function>pspell_new_config</function> opens up a new dictionary with - settings specified in a config, created with with - <function>pspell_config_create</function> and modified with - <function>pspell_config_*</function> functions. This method provides you - with the most flexibility and has all the functionality provided by - <function>pspell_new</function> and - <function>pspell_new_personal</function>. + settings specified in a config, created with with + <function>pspell_config_create</function> and modified with + <function>pspell_config_*</function> functions. This method provides you + with the most flexibility and has all the functionality provided by + <function>pspell_new</function> and + <function>pspell_new_personal</function>. </simpara> <para> The config parameter is the one returned by - <function>pspell_config_create</function> when the config was created. + <function>pspell_config_create</function> when the config was created. </para> <para> <example> @@ -672,22 +681,22 @@ </funcsynopsis> <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 - <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>, - set the personal wordlist file with - <function>pspell_config_personal</function>, - set the file for replacement pairs with - <function>pspell_config_repl</function>, and open a new dictionary with - <function>pspell_new_config</function>. + a personal wordlist and returns the dictionary link identifier for use + in other pspell functions. 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>, + set the personal wordlist file with + <function>pspell_config_personal</function>, + set the file for replacement pairs with + <function>pspell_config_repl</function>, and open a new dictionary with + <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. + 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 @@ -717,35 +726,37 @@ <itemizedlist> <listitem> <simpara> - PSPELL_FAST - Fast mode (least number of suggestions) + <constant>PSPELL_FAST</constant> - Fast mode (least number of + suggestions) </simpara> </listitem> <listitem> <simpara> - PSPELL_NORMAL - Normal mode (more suggestions) + <constant>PSPELL_NORMAL</constant> - Normal mode (more suggestions) </simpara> </listitem> <listitem> <simpara> - PSPELL_BAD_SPELLERS - Slow mode (a lot of suggestions) + <constant>PSPELL_BAD_SPELLERS</constant> - Slow mode (a lot of + suggestions) </simpara> </listitem> <listitem> <simpara> - PSPELL_RUN_TOGETHER - Consider run-together words as legal - compounds. That is, "thecat" will be a legal compound, - athough 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. + <constant>PSPELL_RUN_TOGETHER</constant> - Consider run-together words + as legal compounds. That is, "thecat" will be a legal compound, + athough 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, PSPELL_FAST, PSPELL_NORMAL and - PSPELL_BAD_SPELLERS are mutually exclusive, so you should select - only one of them. + 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> <para> For more information and examples, check out inline manual pspell @@ -756,7 +767,7 @@ <title><function>pspell_new_personal</function></title> <programlisting role="php"> $pspell_link = pspell_new_personal ("/var/dictionaries/custom.pws", - "en", "", "", "", PSPELL_FAST|PSPELL_RUN_TOGETHER)); + "en", "", "", "", PSPELL_FAST|PSPELL_RUN_TOGETHER)); </programlisting> </example> </para> @@ -766,7 +777,7 @@ <refentry id="function.pspell-save-wordlist"> <refnamediv> <refname>pspell_save_wordlist</refname> - <refpurpose>Save the personal wordlist to a file.</refpurpose> + <refpurpose>Save the personal wordlist to a file</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -778,12 +789,12 @@ </funcsynopsis> <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. + 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. </simpara> <para> <example> @@ -818,16 +829,16 @@ </funcsynopsis> <simpara> <function>pspell_store_replacement</function> stores a replacement pair for - a word, so that replacement can be returned by - <function>pspell_suggest</function> later. In order to be able to take - advantage of this function, you have to use - <function>pspell_new_personal</function> to open the dictionary. In order - to permanently save the replacement pair, you have to - 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. + a word, so that replacement can be returned by + <function>pspell_suggest</function> later. In order to be able to take + advantage of this function, you have to use + <function>pspell_new_personal</function> to open the dictionary. In order + to permanently save the replacement pair, you have to + 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. </simpara> <para> <example> @@ -873,8 +884,8 @@ if (!pspell_check ($pspell_link, "testt")) { $suggestions = pspell_suggest ($pspell_link, "testt"); - for ($i=0; $i < count ($suggestions); $i++) { - echo "Possible spelling: " . $suggestions[$i] . "<br>"; + foreach ($suggestions as $suggestion) { + echo "Possible spelling: $suggestion<br>"; } } </programlisting> @@ -900,4 +911,5 @@ sgml-local-catalogs:nil sgml-local-ecat-files:nil End: +vi: et:ts=1:sw=1:textwidth=78:syntax=sgml -->