diff --git a/reference/pspell/functions/pspell-add-to-personal.xml b/reference/pspell/functions/pspell-add-to-personal.xml
index 2951e8b8fc..58fd7ce69e 100644
--- a/reference/pspell/functions/pspell-add-to-personal.xml
+++ b/reference/pspell/functions/pspell-add-to-personal.xml
@@ -1,30 +1,30 @@
-
+
-
-
- pspell_add_to_personal
- Add the word to a personal wordlist
-
-
- Description
-
- boolpspell_add_to_personal
- intdictionary_link
- stringword
-
-
- pspell_add_to_personal adds a word to the personal
- wordlist. If you used pspell_new_config with
- pspell_config_personal to open the dictionary,
- you can save the wordlist later with
- pspell_save_wordlist. Please, note that this function
- will not work unless you have pspell .11.2 and aspell .32.5 or later.
-
-
-
- <function>pspell_add_to_personal</function>
-
+
+
+ pspell_add_to_personal
+ Add the word to a personal wordlist
+
+
+ Description
+
+ boolpspell_add_to_personal
+ intdictionary_link
+ stringword
+
+
+ pspell_add_to_personal adds a word to the personal
+ wordlist. If you used pspell_new_config with
+ pspell_config_personal to open the dictionary,
+ you can save the wordlist later with
+ pspell_save_wordlist. Please, note that this function
+ will not work unless you have pspell .11.2 and aspell .32.5 or later.
+
+
+
+ <function>pspell_add_to_personal</function>
+
]]>
-
-
-
-
-
+
+
+
+
+
+
-
-
- pspell_add_to_session
- Add the word to the wordlist in the current session
-
-
-
- Description
-
- boolpspell_add_to_session
- intdictionary_link
- stringword
-
-
- pspell_add_to_session adds a word to the wordlist
- associated with the current session. It is very similar to
- pspell_add_to_personal
-
-
-
+
+
+ pspell_add_to_session
+ Add the word to the wordlist in the current session
+
+
+
+ Description
+
+ boolpspell_add_to_session
+ intdictionary_link
+ stringword
+
+
+ pspell_add_to_session adds a word to the wordlist
+ associated with the current session. It is very similar to
+ pspell_add_to_personal
+
+
+
+
-
-
- pspell_check
- Check a word
-
-
- Description
-
- boolpspell_check
- intdictionary_link
- stringword
-
-
- pspell_check checks the spelling of a word
- and returns &true; if the spelling is correct, &false; if not.
-
-
-
- <function>pspell_check</function>
-
+
+
+ pspell_check
+ Check a word
+
+
+ Description
+
+ boolpspell_check
+ intdictionary_link
+ stringword
+
+
+ pspell_check checks the spelling of a word
+ and returns &true; if the spelling is correct, &false; if not.
+
+
+
+ <function>pspell_check</function>
+
]]>
-
-
-
-
-
+
+
+
+
+
+
-
-
- pspell_clear_session
- Clear the current session
-
-
- Description
-
- boolpspell_clear_session
- intdictionary_link
-
-
- pspell_clear_session clears the current session.
- The current wordlist becomes blank, and, for example, if you try to save
- it with pspell_save_wordlist, nothing happens.
-
-
-
- <function>pspell_add_to_personal</function>
-
+
+
+ pspell_clear_session
+ Clear the current session
+
+
+ Description
+
+ boolpspell_clear_session
+ intdictionary_link
+
+
+ pspell_clear_session clears the current session.
+ The current wordlist becomes blank, and, for example, if you try to save
+ it with pspell_save_wordlist, nothing happens.
+
+
+
+ <function>pspell_add_to_personal</function>
+
]]>
-
-
-
-
-
+
+
+
+
+
+
-
-
- pspell_config_create
- Create a config used to open a dictionary
-
-
- Description
-
- intpspell_config_create
- stringlanguage
- string
- spelling
-
- string
- jargon
-
- string
- encoding
-
-
-
- pspell_config_create has a very similar syntax to
- pspell_new. In fact, using
- pspell_config_create immediately followed by
- pspell_new_config will produce the exact same result.
- However, after creating a new config, you can also use
- pspell_config_* functions before calling
- pspell_new_config to take advantage of some
- advanced functionality.
-
-
- 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.
-
-
- The spelling parameter is the requested spelling for languages
- with more than one spelling such as English. Known values are
- 'american', 'british', and 'canadian'.
-
-
- The jargon parameter contains extra information to distinguish
- two different words lists that have the same language and
- spelling parameters.
-
-
- 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.
-
-
- The mode parameter is the mode in which spellchecker will work.
- There are several modes available:
-
-
-
- PSPELL_FAST - Fast mode (least number of
- suggestions)
-
-
-
-
- PSPELL_NORMAL - Normal mode (more suggestions)
-
-
-
-
- PSPELL_BAD_SPELLERS - Slow mode (a lot of
- suggestions)
-
-
-
-
-
- For more information and examples, check out inline manual pspell
- website:&url.pspell;.
-
-
-
- <function>pspell_config_create</function>
-
+
+
+ pspell_config_create
+ Create a config used to open a dictionary
+
+
+ Description
+
+ intpspell_config_create
+ stringlanguage
+ stringspelling
+ stringjargon
+ stringencoding
+
+
+ pspell_config_create has a very similar syntax to
+ pspell_new. In fact, using
+ pspell_config_create immediately followed by
+ pspell_new_config will produce the exact same result.
+ However, after creating a new config, you can also use
+ pspell_config_* functions before calling
+ pspell_new_config to take advantage of some
+ advanced functionality.
+
+
+ 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.
+
+
+ The spelling parameter is the requested spelling for languages
+ with more than one spelling such as English. Known values are
+ 'american', 'british', and 'canadian'.
+
+
+ The jargon parameter contains extra information to distinguish
+ two different words lists that have the same language and
+ spelling parameters.
+
+
+ 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.
+
+
+ The mode parameter is the mode in which spellchecker will work.
+ There are several modes available:
+
+
+
+ PSPELL_FAST - Fast mode (least number of
+ suggestions)
+
+
+
+
+ PSPELL_NORMAL - Normal mode (more suggestions)
+
+
+
+
+ PSPELL_BAD_SPELLERS - Slow mode (a lot of
+ suggestions)
+
+
+
+
+
+ For more information and examples, check out inline manual pspell
+ website:&url.pspell;.
+
+
+
+ <function>pspell_config_create</function>
+
]]>
-
-
-
-
-
+
+
+
+
+
+
pspell_config_data_dir
-
- location of language data files
-
+ location of language data files
Description
diff --git a/reference/pspell/functions/pspell-config-dict-dir.xml b/reference/pspell/functions/pspell-config-dict-dir.xml
index 43fdeaf520..b49ea50d9a 100644
--- a/reference/pspell/functions/pspell-config-dict-dir.xml
+++ b/reference/pspell/functions/pspell-config-dict-dir.xml
@@ -1,11 +1,9 @@
-
+
pspell_config_dict_dir
-
- Location of the main word list
-
+ Location of the main word list
Description
diff --git a/reference/pspell/functions/pspell-config-ignore.xml b/reference/pspell/functions/pspell-config-ignore.xml
index 44545b1199..4983e206c0 100644
--- a/reference/pspell/functions/pspell-config-ignore.xml
+++ b/reference/pspell/functions/pspell-config-ignore.xml
@@ -1,28 +1,28 @@
-
+
-
-
- pspell_config_ignore
- Ignore words less than N characters long
-
-
- Description
-
- boolpspell_config_ignore
- intdictionary_link
- intn
-
-
- pspell_config_ignore should be used on a config
- before calling pspell_new_config. This function
- allows short words to be skipped by the spell checker. Words less than
- n characters will be skipped.
-
-
-
- <function>pspell_config_ignore</function>
-
+
+
+ pspell_config_ignore
+ Ignore words less than N characters long
+
+
+ Description
+
+ boolpspell_config_ignore
+ intdictionary_link
+ intn
+
+
+ pspell_config_ignore should be used on a config
+ before calling pspell_new_config. This function
+ allows short words to be skipped by the spell checker. Words less than
+ n characters will be skipped.
+
+
+
+ <function>pspell_config_ignore</function>
+
]]>
-
-
-
-
-
+
+
+
+
+
+
-
-
- pspell_config_mode
- Change the mode number of suggestions returned
-
-
- Description
-
- boolpspell_config_mode
- intdictionary_link
- intmode
-
-
- pspell_config_mode should be used on a config
- before calling pspell_new_config. This function
- determines how many suggestions will be returned by
- pspell_suggest.
-
-
- The mode parameter is the mode in which spellchecker will work.
- There are several modes available:
-
-
-
- PSPELL_FAST - Fast mode (least number of
- suggestions)
-
-
-
-
- PSPELL_NORMAL - Normal mode (more suggestions)
-
-
-
-
- PSPELL_BAD_SPELLERS - Slow mode (a lot of
- suggestions)
-
-
-
-
-
-
- <function>pspell_config_mode</function>
-
+
+
+ pspell_config_mode
+ Change the mode number of suggestions returned
+
+
+ Description
+
+ boolpspell_config_mode
+ intdictionary_link
+ intmode
+
+
+ pspell_config_mode should be used on a config
+ before calling pspell_new_config. This function
+ determines how many suggestions will be returned by
+ pspell_suggest.
+
+
+ The mode parameter is the mode in which spellchecker will work.
+ There are several modes available:
+
+
+
+ PSPELL_FAST - Fast mode (least number of
+ suggestions)
+
+
+
+
+ PSPELL_NORMAL - Normal mode (more suggestions)
+
+
+
+
+ PSPELL_BAD_SPELLERS - Slow mode (a lot of
+ suggestions)
+
+
+
+
+
+
+ <function>pspell_config_mode</function>
+
]]>
-
-
-
-
-
+
+
+
+
+
+
-
-
- pspell_config_personal
- Set a file that contains personal wordlist
-
-
- Description
-
- boolpspell_config_personal
- intdictionary_link
- stringfile
-
-
- pspell_config_personal should be used on a config
- before calling pspell_new_config. The personal
- wordlist will be loaded and used in addition to the standard one after
- you call pspell_new_config. If the file does not
- exist, it will be created. The file is also the file where
- pspell_save_wordlist 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.
-
-
-
- <function>pspell_config_personal</function>
-
+
+
+ pspell_config_personal
+ Set a file that contains personal wordlist
+
+
+ Description
+
+ boolpspell_config_personal
+ intdictionary_link
+ stringfile
+
+
+ pspell_config_personal should be used on a config
+ before calling pspell_new_config. The personal
+ wordlist will be loaded and used in addition to the standard one after
+ you call pspell_new_config. If the file does not
+ exist, it will be created. The file is also the file where
+ pspell_save_wordlist 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.
+
+
+
+ <function>pspell_config_personal</function>
+
]]>
-
-
-
-
-
+
+
+
+
+
+
-
-
- pspell_config_repl
- Set a file that contains replacement pairs
-
-
- Description
-
- boolpspell_config_repl
- intdictionary_link
- stringfile
-
-
- pspell_config_repl should be used on a config
- before calling pspell_new_config. The replacement
- pairs improve the quality of the spellchecker. When a word is misspelled,
- and a proper suggestion was not found in the list,
- pspell_store_replacement can be used to store a
- replacement pair and then pspell_save_wordlist 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.
-
-
-
- <function>pspell_config_repl</function>
-
+
+
+ pspell_config_repl
+ Set a file that contains replacement pairs
+
+
+ Description
+
+ boolpspell_config_repl
+ intdictionary_link
+ stringfile
+
+
+ pspell_config_repl should be used on a config
+ before calling pspell_new_config. The replacement
+ pairs improve the quality of the spellchecker. When a word is misspelled,
+ and a proper suggestion was not found in the list,
+ pspell_store_replacement can be used to store a
+ replacement pair and then pspell_save_wordlist 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.
+
+
+
+ <function>pspell_config_repl</function>
+
]]>
-
-
-
-
-
+
+
+
+
+
+
-
-
- pspell_config_runtogether
- Consider run-together words as valid compounds
-
-
- Description
-
- boolpspell_config_runtogether
- intdictionary_link
- boolflag
-
-
- pspell_config_runtogether should be used on a config
- before calling pspell_new_config. 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 pspell_check;
- pspell_suggest will still return suggestions.
-
-
-
- <function>pspell_config_runtogether</function>
-
+
+
+ pspell_config_runtogether
+ Consider run-together words as valid compounds
+
+
+ Description
+
+ boolpspell_config_runtogether
+ intdictionary_link
+ boolflag
+
+
+ pspell_config_runtogether should be used on a config
+ before calling pspell_new_config. 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 pspell_check;
+ pspell_suggest will still return suggestions.
+
+
+
+ <function>pspell_config_runtogether</function>
+
]]>
-
-
-
-
-
+
+
+
+
+
+
-
-
- pspell_config_save_repl
- Determine whether to save a replacement pairs list
- along with the wordlist
-
-
- Description
-
- boolpspell_config_save_repl
- intdictionary_link
- boolflag
-
-
- pspell_config_save_repl should be used on a config
- before calling pspell_new_config. It determines
- whether pspell_save_wordlist will save the
- replacement pairs along with the wordlist. Usually there is no need to use
- this function because if pspell_config_repl is used,
- the replacement pairs will be saved by
- pspell_save_wordlist 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.
-
-
-
+
+
+ pspell_config_save_repl
+ Determine whether to save a replacement pairs list
+ along with the wordlist
+
+
+ Description
+
+ boolpspell_config_save_repl
+ intdictionary_link
+ boolflag
+
+
+ pspell_config_save_repl should be used on a config
+ before calling pspell_new_config. It determines
+ whether pspell_save_wordlist will save the
+ replacement pairs along with the wordlist. Usually there is no need to use
+ this function because if pspell_config_repl is used,
+ the replacement pairs will be saved by
+ pspell_save_wordlist 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.
+
+
+
+
-
-
- pspell_new_config
- Load a new dictionary with settings based on a given config
-
-
-
- Description
-
- intpspell_new_config
- intconfig
-
-
- pspell_new_config opens up a new dictionary with
- settings specified in a config, created with
- pspell_config_create and modified with
- pspell_config_* functions. This method provides you
- with the most flexibility and has all the functionality provided by
- pspell_new and
- pspell_new_personal.
-
-
- The config parameter is the one returned by
- pspell_config_create when the config was created.
-
-
-
- <function>pspell_new_config</function>
-
+
+
+ pspell_new_config
+ Load a new dictionary with settings based on a given config
+
+
+
+ Description
+
+ intpspell_new_config
+ intconfig
+
+
+ pspell_new_config opens up a new dictionary with
+ settings specified in a config, created with
+ pspell_config_create and modified with
+ pspell_config_* functions. This method provides you
+ with the most flexibility and has all the functionality provided by
+ pspell_new and
+ pspell_new_personal.
+
+
+ The config parameter is the one returned by
+ pspell_config_create when the config was created.
+
+
+
+ <function>pspell_new_config</function>
+
]]>
-
-
-
-
-
+
+
+
+
+
+
-
-
- pspell_new_personal
- Load a new dictionary with personal wordlist
-
-
- Description
-
- intpspell_new_personal
- stringpersonal
- stringlanguage
- string
- spelling
-
- string
- jargon
-
- string
- encoding
-
- int
- mode
-
-
-
- pspell_new_personal 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
- pspell_save_wordlist, if desired. However, the
- replacement pairs are not saved. In order to save replacement pairs, you
- should create a config using pspell_config_create,
- set the personal wordlist file with
- pspell_config_personal,
- set the file for replacement pairs with
- pspell_config_repl, and open a new dictionary with
- pspell_new_config.
-
-
- 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.
-
-
- 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.
-
-
- The spelling parameter is the requested spelling for languages
- with more than one spelling such as English. Known values are
- 'american', 'british', and 'canadian'.
-
-
- The jargon parameter contains extra information to distinguish
- two different words lists that have the same language and
- spelling parameters.
-
-
- 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.
-
-
- The mode parameter is the mode in which spellchecker will work.
- There are several modes available:
-
-
-
- PSPELL_FAST - Fast mode (least number of
- suggestions)
-
-
-
-
- PSPELL_NORMAL - Normal mode (more suggestions)
-
-
-
-
- PSPELL_BAD_SPELLERS - Slow mode (a lot of
- suggestions)
-
-
-
-
- PSPELL_RUN_TOGETHER - 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
- pspell_check; pspell_suggest
- will still return suggestions.
-
-
-
- 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.
-
-
- For more information and examples, check out inline manual pspell
- website:&url.pspell;.
-
-
-
- <function>pspell_new_personal</function>
-
+
+
+ pspell_new_personal
+ Load a new dictionary with personal wordlist
+
+
+ Description
+
+ intpspell_new_personal
+ stringpersonal
+ stringlanguage
+ stringspelling
+ stringjargon
+ stringencoding
+ intmode
+
+
+ pspell_new_personal 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
+ pspell_save_wordlist, if desired. However, the
+ replacement pairs are not saved. In order to save replacement pairs, you
+ should create a config using pspell_config_create,
+ set the personal wordlist file with
+ pspell_config_personal,
+ set the file for replacement pairs with
+ pspell_config_repl, and open a new dictionary with
+ pspell_new_config.
+
+
+ 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.
+
+
+ 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.
+
+
+ The spelling parameter is the requested spelling for languages
+ with more than one spelling such as English. Known values are
+ 'american', 'british', and 'canadian'.
+
+
+ The jargon parameter contains extra information to distinguish
+ two different words lists that have the same language and
+ spelling parameters.
+
+
+ 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.
+
+
+ The mode parameter is the mode in which spellchecker will work.
+ There are several modes available:
+
+
+
+ PSPELL_FAST - Fast mode (least number of
+ suggestions)
+
+
+
+
+ PSPELL_NORMAL - Normal mode (more suggestions)
+
+
+
+
+ PSPELL_BAD_SPELLERS - Slow mode (a lot of
+ suggestions)
+
+
+
+
+ PSPELL_RUN_TOGETHER - 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
+ pspell_check; pspell_suggest
+ will still return suggestions.
+
+
+
+ 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.
+
+
+ For more information and examples, check out inline manual pspell
+ website:&url.pspell;.
+
+
+
+ <function>pspell_new_personal</function>
+
]]>
-
-
-
-
-
+
+
+
+
+
+
-
-
- pspell_new
- Load a new dictionary
-
-
- Description
-
- intpspell_new
-
- stringlanguage
- string
- spelling
-
- string
- jargon
-
- string
- encoding
-
- int
- mode
-
-
-
- pspell_new opens up a new dictionary and
- returns the dictionary link identifier for use in other pspell
- functions.
-
-
- 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.
-
-
- The spelling parameter is the requested spelling for languages
- with more than one spelling such as English. Known values are
- 'american', 'british', and 'canadian'.
-
-
- The jargon parameter contains extra information to distinguish
- two different words lists that have the same language and
- spelling parameters.
-
-
- 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.
-
-
- The mode parameter is the mode in which spellchecker will work.
- There are several modes available:
-
-
-
- PSPELL_FAST - Fast mode (least number of
- suggestions)
-
-
-
-
- PSPELL_NORMAL - Normal mode (more suggestions)
-
-
-
-
- PSPELL_BAD_SPELLERS - Slow mode (a lot of
- suggestions)
-
-
-
-
- PSPELL_RUN_TOGETHER - 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
- pspell_check; pspell_suggest
- will still return suggestions.
-
-
-
- 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.
-
-
- For more information and examples, check out inline manual pspell
- website:&url.pspell;.
-
-
-
- <function>pspell_new</function>
-
+
+
+ pspell_new
+ Load a new dictionary
+
+
+ Description
+
+ intpspell_new
+ stringlanguage
+ stringspelling
+ stringjargon
+ stringencoding
+ intmode
+
+
+ pspell_new opens up a new dictionary and
+ returns the dictionary link identifier for use in other pspell
+ functions.
+
+
+ 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.
+
+
+ The spelling parameter is the requested spelling for languages
+ with more than one spelling such as English. Known values are
+ 'american', 'british', and 'canadian'.
+
+
+ The jargon parameter contains extra information to distinguish
+ two different words lists that have the same language and
+ spelling parameters.
+
+
+ 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.
+
+
+ The mode parameter is the mode in which spellchecker will work.
+ There are several modes available:
+
+
+
+ PSPELL_FAST - Fast mode (least number of
+ suggestions)
+
+
+
+
+ PSPELL_NORMAL - Normal mode (more suggestions)
+
+
+
+
+ PSPELL_BAD_SPELLERS - Slow mode (a lot of
+ suggestions)
+
+
+
+
+ PSPELL_RUN_TOGETHER - 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
+ pspell_check; pspell_suggest
+ will still return suggestions.
+
+
+
+ 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.
+
+
+ For more information and examples, check out inline manual pspell
+ website:&url.pspell;.
+
+
+
+ <function>pspell_new</function>
+
]]>
-
-
-
-
-
+
+
+
+
+
+
-
-
- pspell_save_wordlist
- Save the personal wordlist to a file
-
-
- Description
-
- boolpspell_save_wordlist
- intdictionary_link
-
-
- pspell_save_wordlist saves the personal wordlist
- from the current session. The dictionary has to be open with
- pspell_new_personal, and the location of files to be
- saved specified with pspell_config_personal and
- (optionally) pspell_config_repl. Please, note that
- this function will not work unless you have pspell .11.2 and aspell .32.5
- or later.
-
-
-
- <function>pspell_add_to_personal</function>
-
+
+
+ pspell_save_wordlist
+ Save the personal wordlist to a file
+
+
+ Description
+
+ boolpspell_save_wordlist
+ intdictionary_link
+
+
+ pspell_save_wordlist saves the personal wordlist
+ from the current session. The dictionary has to be open with
+ pspell_new_personal, and the location of files to be
+ saved specified with pspell_config_personal and
+ (optionally) pspell_config_repl. Please, note that
+ this function will not work unless you have pspell .11.2 and aspell .32.5
+ or later.
+
+
+
+ <function>pspell_add_to_personal</function>
+
]]>
-
-
-
-
-
+
+
+
+
+
+
-
-
- pspell_store_replacement
- Store a replacement pair for a word
-
-
- Description
-
- boolpspell_store_replacement
- intdictionary_link
- stringmisspelled
- stringcorrect
-
-
- pspell_store_replacement stores a replacement pair for
- a word, so that replacement can be returned by
- pspell_suggest later. In order to be able to take
- advantage of this function, you have to use
- pspell_new_personal to open the dictionary. In order
- to permanently save the replacement pair, you have to
- use pspell_config_personal and
- pspell_config_repl to set the path where to save your
- custom wordlists, and then use pspell_save_wordlist
- 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.
-
-
-
- <function>pspell_store_replacement</function>
-
+
+
+ pspell_store_replacement
+ Store a replacement pair for a word
+
+
+ Description
+
+ boolpspell_store_replacement
+ intdictionary_link
+ stringmisspelled
+ stringcorrect
+
+
+ pspell_store_replacement stores a replacement pair for
+ a word, so that replacement can be returned by
+ pspell_suggest later. In order to be able to take
+ advantage of this function, you have to use
+ pspell_new_personal to open the dictionary. In order
+ to permanently save the replacement pair, you have to
+ use pspell_config_personal and
+ pspell_config_repl to set the path where to save your
+ custom wordlists, and then use pspell_save_wordlist
+ 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.
+
+
+
+ <function>pspell_store_replacement</function>
+
]]>
-
-
-
-
-
+
+
+
+
+
+
-
-
- pspell_suggest
- Suggest spellings of a word
-
-
- Description
-
- arraypspell_suggest
- intdictionary_link
- stringword
-
-
- pspell_suggest returns an array of possible
- spellings for the given word.
-
-
-
- <function>pspell_suggest</function> example
-
+
+
+ pspell_suggest
+ Suggest spellings of a word
+
+
+ Description
+
+ arraypspell_suggest
+ intdictionary_link
+ stringword
+
+
+ pspell_suggest returns an array of possible
+ spellings for the given word.
+
+
+
+ <function>pspell_suggest</function> example
+
";
+ echo "Possible spelling: $suggestion
";
}
}
?>
]]>
-
-
-
-
-
+
+
+
+
+