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: Date: Sun, 10 Jun 2007 21:25:29 +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-969376624@lists.php.net to get a copy of this message
didou Sun Jun 10 21:25:29 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: WS, prepare for new doc style

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-add-to-personal.xml?r1=1.5&r2=1.6&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.5 phpdoc/en/reference/pspell/functions/pspell-add-to-personal.xml:1.6 --- phpdoc/en/reference/pspell/functions/pspell-add-to-personal.xml:1.5 Fri Jun 24 09:11:45 2005 +++ phpdoc/en/reference/pspell/functions/pspell-add-to-personal.xml Sun Jun 10 21:25:29 2007 @@ -1,30 +1,30 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> - <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> - <methodsynopsis> - <type>bool</type><methodname>pspell_add_to_personal</methodname> - <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> - <methodparam><type>string</type><parameter>word</parameter></methodparam> - </methodsynopsis> - <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. - </simpara> - <para> - <example> - <title><function>pspell_add_to_personal</function></title> - <programlisting role="php"> +<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> + <methodsynopsis> + <type>bool</type><methodname>pspell_add_to_personal</methodname> + <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> + <methodparam><type>string</type><parameter>word</parameter></methodparam> + </methodsynopsis> + <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. + </simpara> + <para> + <example> + <title><function>pspell_add_to_personal</function></title> + <programlisting role="php"> <![CDATA[ <?php $pspell_config = pspell_config_create("en"); @@ -35,11 +35,11 @@ pspell_save_wordlist($pspell_link); ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-add-to-session.xml?r1=1.3&r2=1.4&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.3 phpdoc/en/reference/pspell/functions/pspell-add-to-session.xml:1.4 --- phpdoc/en/reference/pspell/functions/pspell-add-to-session.xml:1.3 Fri Jun 24 09:11:45 2005 +++ phpdoc/en/reference/pspell/functions/pspell-add-to-session.xml Sun Jun 10 21:25:29 2007 @@ -1,26 +1,26 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> - <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> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>pspell_add_to_session</methodname> - <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> - <methodparam><type>string</type><parameter>word</parameter></methodparam> - </methodsynopsis> - <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> - </simpara> - </refsect1> - </refentry> +<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> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>pspell_add_to_session</methodname> + <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> + <methodparam><type>string</type><parameter>word</parameter></methodparam> + </methodsynopsis> + <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> + </simpara> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-check.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-check.xml diff -u phpdoc/en/reference/pspell/functions/pspell-check.xml:1.4 phpdoc/en/reference/pspell/functions/pspell-check.xml:1.5 --- phpdoc/en/reference/pspell/functions/pspell-check.xml:1.4 Mon Dec 15 16:52:56 2003 +++ phpdoc/en/reference/pspell/functions/pspell-check.xml Sun Jun 10 21:25:29 2007 @@ -1,26 +1,26 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> - <refentry id="function.pspell-check"> - <refnamediv> - <refname>pspell_check</refname> - <refpurpose>Check a word</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <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. - </simpara> - <para> - <example> - <title><function>pspell_check</function></title> - <programlisting role="php"> +<refentry id="function.pspell-check"> + <refnamediv> + <refname>pspell_check</refname> + <refpurpose>Check a word</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <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. + </simpara> + <para> + <example> + <title><function>pspell_check</function></title> + <programlisting role="php"> <![CDATA[ <?php $pspell_link = pspell_new("en"); @@ -32,11 +32,11 @@ } ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-clear-session.xml?r1=1.5&r2=1.6&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.5 phpdoc/en/reference/pspell/functions/pspell-clear-session.xml:1.6 --- phpdoc/en/reference/pspell/functions/pspell-clear-session.xml:1.5 Fri Jun 24 09:11:45 2005 +++ phpdoc/en/reference/pspell/functions/pspell-clear-session.xml Sun Jun 10 21:25:29 2007 @@ -1,26 +1,26 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> - <refentry id="function.pspell-clear-session"> - <refnamediv> - <refname>pspell_clear_session</refname> - <refpurpose>Clear the current session</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>pspell_clear_session</methodname> - <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> - </methodsynopsis> - <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. - </simpara> - <para> - <example> - <title><function>pspell_add_to_personal</function></title> - <programlisting role="php"> +<refentry id="function.pspell-clear-session"> + <refnamediv> + <refname>pspell_clear_session</refname> + <refpurpose>Clear the current session</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>pspell_clear_session</methodname> + <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> + </methodsynopsis> + <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. + </simpara> + <para> + <example> + <title><function>pspell_add_to_personal</function></title> + <programlisting role="php"> <![CDATA[ <?php $pspell_config = pspell_config_create("en"); @@ -32,11 +32,11 @@ pspell_save_wordlist($pspell_link); //"Vlad" will not be saved ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-config-create.xml?r1=1.5&r2=1.6&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.5 phpdoc/en/reference/pspell/functions/pspell-config-create.xml:1.6 --- phpdoc/en/reference/pspell/functions/pspell-config-create.xml:1.5 Fri Dec 19 15:49:47 2003 +++ phpdoc/en/reference/pspell/functions/pspell-config-create.xml Sun Jun 10 21:25:29 2007 @@ -1,89 +1,83 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> - <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> - <methodsynopsis> - <type>int</type><methodname>pspell_config_create</methodname> - <methodparam><type>string</type><parameter>language</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter> - spelling - </parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter> - jargon - </parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter> - encoding - </parameter></methodparam> - </methodsynopsis> - <simpara> - <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 - <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 - 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> - <para> - <example> - <title><function>pspell_config_create</function></title> - <programlisting role="php"> +<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> + <methodsynopsis> + <type>int</type><methodname>pspell_config_create</methodname> + <methodparam><type>string</type><parameter>language</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>spelling</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>jargon</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> + </methodsynopsis> + <simpara> + <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 + <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 + 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> + <para> + <example> + <title><function>pspell_config_create</function></title> + <programlisting role="php"> <![CDATA[ <?php $pspell_config = pspell_config_create("en"); @@ -92,11 +86,11 @@ $pspell_link = pspell_new_personal($pspell_config, "en"); ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-config-data-dir.xml?r1=1.1&r2=1.2&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.1 phpdoc/en/reference/pspell/functions/pspell-config-data-dir.xml:1.2 --- phpdoc/en/reference/pspell/functions/pspell-config-data-dir.xml:1.1 Sun May 2 18:05:47 2004 +++ phpdoc/en/reference/pspell/functions/pspell-config-data-dir.xml Sun Jun 10 21:25:29 2007 @@ -1,11 +1,9 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.pspell-config-data-dir"> <refnamediv> <refname>pspell_config_data_dir</refname> - <refpurpose> - location of language data files - </refpurpose> + <refpurpose>location of language data files</refpurpose> </refnamediv> <refsect1> <title>Description</title> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-config-dict-dir.xml?r1=1.1&r2=1.2&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.1 phpdoc/en/reference/pspell/functions/pspell-config-dict-dir.xml:1.2 --- phpdoc/en/reference/pspell/functions/pspell-config-dict-dir.xml:1.1 Sun May 2 18:05:47 2004 +++ phpdoc/en/reference/pspell/functions/pspell-config-dict-dir.xml Sun Jun 10 21:25:29 2007 @@ -1,11 +1,9 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.pspell-config-dict-dir"> <refnamediv> <refname>pspell_config_dict_dir</refname> - <refpurpose> - Location of the main word list - </refpurpose> + <refpurpose>Location of the main word list</refpurpose> </refnamediv> <refsect1> <title>Description</title> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-config-ignore.xml?r1=1.6&r2=1.7&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.6 phpdoc/en/reference/pspell/functions/pspell-config-ignore.xml:1.7 --- phpdoc/en/reference/pspell/functions/pspell-config-ignore.xml:1.6 Fri Jun 24 09:11:45 2005 +++ phpdoc/en/reference/pspell/functions/pspell-config-ignore.xml Sun Jun 10 21:25:29 2007 @@ -1,28 +1,28 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> - <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> - <methodsynopsis> - <type>bool</type><methodname>pspell_config_ignore</methodname> - <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> - <methodparam><type>int</type><parameter>n</parameter></methodparam> - </methodsynopsis> - <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. - </simpara> - <para> - <example> - <title><function>pspell_config_ignore</function></title> - <programlisting role="php"> +<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> + <methodsynopsis> + <type>bool</type><methodname>pspell_config_ignore</methodname> + <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> + <methodparam><type>int</type><parameter>n</parameter></methodparam> + </methodsynopsis> + <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. + </simpara> + <para> + <example> + <title><function>pspell_config_ignore</function></title> + <programlisting role="php"> <![CDATA[ <?php $pspell_config = pspell_config_create("en"); @@ -31,11 +31,11 @@ pspell_check($pspell_link, "abcd"); //will not result in an error ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-config-mode.xml?r1=1.5&r2=1.6&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.5 phpdoc/en/reference/pspell/functions/pspell-config-mode.xml:1.6 --- phpdoc/en/reference/pspell/functions/pspell-config-mode.xml:1.5 Fri Jun 24 09:11:45 2005 +++ phpdoc/en/reference/pspell/functions/pspell-config-mode.xml Sun Jun 10 21:25:29 2007 @@ -1,51 +1,51 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> - <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> - <methodsynopsis> - <type>bool</type><methodname>pspell_config_mode</methodname> - <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> - <methodparam><type>int</type><parameter>mode</parameter></methodparam> - </methodsynopsis> - <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> - 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> - <example> - <title><function>pspell_config_mode</function></title> - <programlisting role="php"> +<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> + <methodsynopsis> + <type>bool</type><methodname>pspell_config_mode</methodname> + <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> + <methodparam><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> + <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> + 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> + <example> + <title><function>pspell_config_mode</function></title> + <programlisting role="php"> <![CDATA[ <?php $pspell_config = pspell_config_create("en"); @@ -54,11 +54,11 @@ pspell_check($pspell_link, "thecat"); ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-config-personal.xml?r1=1.6&r2=1.7&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.6 phpdoc/en/reference/pspell/functions/pspell-config-personal.xml:1.7 --- phpdoc/en/reference/pspell/functions/pspell-config-personal.xml:1.6 Fri Jun 24 09:11:45 2005 +++ phpdoc/en/reference/pspell/functions/pspell-config-personal.xml Sun Jun 10 21:25:29 2007 @@ -1,33 +1,33 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> - <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> - <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 - <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> - <title><function>pspell_config_personal</function></title> - <programlisting role="php"> +<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> + <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 + <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> + <title><function>pspell_config_personal</function></title> + <programlisting role="php"> <![CDATA[ <?php $pspell_config = pspell_config_create("en"); @@ -36,11 +36,11 @@ pspell_check($pspell_link, "thecat"); ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-config-repl.xml?r1=1.6&r2=1.7&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.6 phpdoc/en/reference/pspell/functions/pspell-config-repl.xml:1.7 --- phpdoc/en/reference/pspell/functions/pspell-config-repl.xml:1.6 Fri Jun 24 09:11:45 2005 +++ phpdoc/en/reference/pspell/functions/pspell-config-repl.xml Sun Jun 10 21:25:29 2007 @@ -1,34 +1,34 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> - <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> - <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, - <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> - <title><function>pspell_config_repl</function></title> - <programlisting role="php"> +<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> + <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, + <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> + <title><function>pspell_config_repl</function></title> + <programlisting role="php"> <![CDATA[ <?php $pspell_config = pspell_config_create("en"); @@ -38,11 +38,11 @@ pspell_check($pspell_link, "thecat"); ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-config-runtogether.xml?r1=1.6&r2=1.7&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.6 phpdoc/en/reference/pspell/functions/pspell-config-runtogether.xml:1.7 --- phpdoc/en/reference/pspell/functions/pspell-config-runtogether.xml:1.6 Fri Jun 24 09:11:45 2005 +++ phpdoc/en/reference/pspell/functions/pspell-config-runtogether.xml Sun Jun 10 21:25:29 2007 @@ -1,32 +1,32 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> - <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> - <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>; - <function>pspell_suggest</function> will still return suggestions. - </simpara> - <para> - <example> - <title><function>pspell_config_runtogether</function></title> - <programlisting role="php"> +<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> + <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>; + <function>pspell_suggest</function> will still return suggestions. + </simpara> + <para> + <example> + <title><function>pspell_config_runtogether</function></title> + <programlisting role="php"> <![CDATA[ <?php $pspell_config = pspell_config_create("en"); @@ -35,11 +35,11 @@ pspell_check($pspell_link, "thecat"); ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-config-save-repl.xml?r1=1.3&r2=1.4&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.3 phpdoc/en/reference/pspell/functions/pspell-config-save-repl.xml:1.4 --- phpdoc/en/reference/pspell/functions/pspell-config-save-repl.xml:1.3 Fri Jun 24 09:11:45 2005 +++ phpdoc/en/reference/pspell/functions/pspell-config-save-repl.xml Sun Jun 10 21:25:29 2007 @@ -1,32 +1,32 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> - <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> - <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 - <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> +<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> + <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 + <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> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-new-config.xml?r1=1.5&r2=1.6&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.5 phpdoc/en/reference/pspell/functions/pspell-new-config.xml:1.6 --- phpdoc/en/reference/pspell/functions/pspell-new-config.xml:1.5 Fri Apr 15 12:13:38 2005 +++ phpdoc/en/reference/pspell/functions/pspell-new-config.xml Sun Jun 10 21:25:29 2007 @@ -1,35 +1,35 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> - <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> - <methodsynopsis> - <type>int</type><methodname>pspell_new_config</methodname> - <methodparam><type>int</type><parameter>config</parameter></methodparam> - </methodsynopsis> - <simpara> - <function>pspell_new_config</function> opens up a new dictionary with - settings specified in a config, created 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. - </para> - <para> - <example> - <title><function>pspell_new_config</function></title> - <programlisting role="php"> +<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> + <methodsynopsis> + <type>int</type><methodname>pspell_new_config</methodname> + <methodparam><type>int</type><parameter>config</parameter></methodparam> + </methodsynopsis> + <simpara> + <function>pspell_new_config</function> opens up a new dictionary with + settings specified in a config, created 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. + </para> + <para> + <example> + <title><function>pspell_new_config</function></title> + <programlisting role="php"> <![CDATA[ <?php $pspell_config = pspell_config_create("en"); @@ -38,11 +38,11 @@ $pspell_link = pspell_new_config($pspell_config); ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-new-personal.xml?r1=1.5&r2=1.6&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.5 phpdoc/en/reference/pspell/functions/pspell-new-personal.xml:1.6 --- phpdoc/en/reference/pspell/functions/pspell-new-personal.xml:1.5 Fri Dec 19 15:49:47 2003 +++ phpdoc/en/reference/pspell/functions/pspell-new-personal.xml Sun Jun 10 21:25:29 2007 @@ -1,128 +1,120 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> - <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> - <methodsynopsis> - <type>int</type><methodname>pspell_new_personal</methodname> - <methodparam><type>string</type><parameter>personal</parameter></methodparam> - <methodparam><type>string</type><parameter>language</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter> - spelling - </parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter> - jargon - </parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter> - encoding - </parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter> - mode - </parameter></methodparam> - </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 - <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. - </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. - </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> - <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> - <para> - For more information and examples, check out inline manual pspell - website:<ulink url="&url.pspell;">&url.pspell;</ulink>. - </para> - <para> - <example> - <title><function>pspell_new_personal</function></title> - <programlisting role="php"> +<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> + <methodsynopsis> + <type>int</type><methodname>pspell_new_personal</methodname> + <methodparam><type>string</type><parameter>personal</parameter></methodparam> + <methodparam><type>string</type><parameter>language</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>spelling</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>jargon</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> + </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 + <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. + </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. + </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> + <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> + <para> + For more information and examples, check out inline manual pspell + website:<ulink url="&url.pspell;">&url.pspell;</ulink>. + </para> + <para> + <example> + <title><function>pspell_new_personal</function></title> + <programlisting role="php"> <![CDATA[ <?php -$pspell_link = pspell_new_personal ("/var/dictionaries/custom.pws", +$pspell_link = pspell_new_personal ("/var/dictionaries/custom.pws", "en", "", "", "", PSPELL_FAST|PSPELL_RUN_TOGETHER); ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-new.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-new.xml diff -u phpdoc/en/reference/pspell/functions/pspell-new.xml:1.6 phpdoc/en/reference/pspell/functions/pspell-new.xml:1.7 --- phpdoc/en/reference/pspell/functions/pspell-new.xml:1.6 Wed Jan 7 14:58:03 2004 +++ phpdoc/en/reference/pspell/functions/pspell-new.xml Sun Jun 10 21:25:29 2007 @@ -1,114 +1,105 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/pspell.xml, last change in rev 1.1 --> - <refentry id="function.pspell-new"> - <refnamediv> - <refname>pspell_new</refname> - <refpurpose>Load a new dictionary</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>pspell_new</methodname> - - <methodparam><type>string</type><parameter>language</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter> - spelling - </parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter> - jargon - </parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter> - encoding - </parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter> - mode - </parameter></methodparam> - </methodsynopsis> - <simpara> - <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. - </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> - <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> - <para> - For more information and examples, check out inline manual pspell - website:<ulink url="&url.pspell;">&url.pspell;</ulink>. - </para> - <para> - <example> - <title><function>pspell_new</function></title> - <programlisting role="php"> +<refentry id="function.pspell-new"> + <refnamediv> + <refname>pspell_new</refname> + <refpurpose>Load a new dictionary</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>pspell_new</methodname> + <methodparam><type>string</type><parameter>language</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>spelling</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>jargon</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> + </methodsynopsis> + <simpara> + <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. + </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> + <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> + <para> + For more information and examples, check out inline manual pspell + website:<ulink url="&url.pspell;">&url.pspell;</ulink>. + </para> + <para> + <example> + <title><function>pspell_new</function></title> + <programlisting role="php"> <![CDATA[ <?php -$pspell_link = pspell_new("en", "", "", "", +$pspell_link = pspell_new("en", "", "", "", (PSPELL_FAST|PSPELL_RUN_TOGETHER)); ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-save-wordlist.xml?r1=1.5&r2=1.6&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.5 phpdoc/en/reference/pspell/functions/pspell-save-wordlist.xml:1.6 --- phpdoc/en/reference/pspell/functions/pspell-save-wordlist.xml:1.5 Fri Jun 24 09:11:45 2005 +++ phpdoc/en/reference/pspell/functions/pspell-save-wordlist.xml Sun Jun 10 21:25:29 2007 @@ -1,30 +1,30 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/pspell.xml, last change in rev 1.6 --> - <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> - <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. - </simpara> - <para> - <example> - <title><function>pspell_add_to_personal</function></title> - <programlisting role="php"> +<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> + <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. + </simpara> + <para> + <example> + <title><function>pspell_add_to_personal</function></title> + <programlisting role="php"> <![CDATA[ <?php $pspell_config = pspell_config_create("en"); @@ -35,11 +35,11 @@ pspell_save_wordlist($pspell_link); ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-store-replacement.xml?r1=1.5&r2=1.6&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.5 phpdoc/en/reference/pspell/functions/pspell-store-replacement.xml:1.6 --- phpdoc/en/reference/pspell/functions/pspell-store-replacement.xml:1.5 Fri Jun 24 09:11:45 2005 +++ phpdoc/en/reference/pspell/functions/pspell-store-replacement.xml Sun Jun 10 21:25:29 2007 @@ -1,36 +1,36 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/pspell.xml, last change in rev 1.1 --> - <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> - <methodsynopsis> - <type>bool</type><methodname>pspell_store_replacement</methodname> - <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> - <methodparam><type>string</type><parameter>misspelled</parameter></methodparam> - <methodparam><type>string</type><parameter>correct</parameter></methodparam> - </methodsynopsis> - <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. - </simpara> - <para> - <example> - <title><function>pspell_store_replacement</function></title> - <programlisting role="php"> +<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> + <methodsynopsis> + <type>bool</type><methodname>pspell_store_replacement</methodname> + <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> + <methodparam><type>string</type><parameter>misspelled</parameter></methodparam> + <methodparam><type>string</type><parameter>correct</parameter></methodparam> + </methodsynopsis> + <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. + </simpara> + <para> + <example> + <title><function>pspell_store_replacement</function></title> + <programlisting role="php"> <![CDATA[ <?php $pspell_config = pspell_config_create("en"); @@ -42,11 +42,11 @@ pspell_save_wordlist($pspell_link); ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pspell/functions/pspell-suggest.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/pspell/functions/pspell-suggest.xml diff -u phpdoc/en/reference/pspell/functions/pspell-suggest.xml:1.4 phpdoc/en/reference/pspell/functions/pspell-suggest.xml:1.5 --- phpdoc/en/reference/pspell/functions/pspell-suggest.xml:1.4 Mon Dec 15 16:52:56 2003 +++ phpdoc/en/reference/pspell/functions/pspell-suggest.xml Sun Jun 10 21:25:29 2007 @@ -1,26 +1,26 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/pspell.xml, last change in rev 1.1 --> - <refentry id="function.pspell-suggest"> - <refnamediv> - <refname>pspell_suggest</refname> - <refpurpose>Suggest spellings of a word</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>pspell_suggest</methodname> - <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> - <methodparam><type>string</type><parameter>word</parameter></methodparam> - </methodsynopsis> - <simpara> - <function>pspell_suggest</function> returns an array of possible - spellings for the given word. - </simpara> - <para> - <example> - <title><function>pspell_suggest</function> example</title> - <programlisting role="php"> +<refentry id="function.pspell-suggest"> + <refnamediv> + <refname>pspell_suggest</refname> + <refpurpose>Suggest spellings of a word</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>pspell_suggest</methodname> + <methodparam><type>int</type><parameter>dictionary_link</parameter></methodparam> + <methodparam><type>string</type><parameter>word</parameter></methodparam> + </methodsynopsis> + <simpara> + <function>pspell_suggest</function> returns an array of possible + spellings for the given word. + </simpara> + <para> + <example> + <title><function>pspell_suggest</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $pspell_link = pspell_new("en"); @@ -29,16 +29,16 @@ $suggestions = pspell_suggest($pspell_link, "testt"); foreach ($suggestions as $suggestion) { - echo "Possible spelling: $suggestion<br />"; + echo "Possible spelling: $suggestion<br />"; } } ?> ]]> - </programlisting> - </example> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables:
« previous php.doc (#969376624) next »