mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 06:48:56 +00:00
81b23db050
* add pspell related object class. * changed resource list description. * changes pspell function signature and parameters, changelog. * use pspell.parameter.pspell-dictionary snippet.
205 lines
6.8 KiB
XML
205 lines
6.8 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.pspell-new-personal" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>pspell_new_personal</refname>
|
|
<refpurpose>Load a new dictionary with personal wordlist</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type class="union"><type>PSpell\Dictionary</type><type>false</type></type><methodname>pspell_new_personal</methodname>
|
|
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>language</parameter></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>spelling</parameter><initializer>""</initializer></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>jargon</parameter><initializer>""</initializer></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>""</initializer></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer>0</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<simpara>
|
|
<function>pspell_new_personal</function> opens up a new dictionary with
|
|
a personal wordlist. The wordlist can be modified and saved with
|
|
<function>pspell_save_wordlist</function>, if desired. However, the
|
|
replacement pairs are not saved. In order to save replacement pairs, you
|
|
should create a config using <function>pspell_config_create</function>,
|
|
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>
|
|
For more information and examples, check out inline manual pspell
|
|
website:<link xlink:href="&url.pspell;">&url.pspell;</link>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>filename</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The file where words added to the personal list will be stored.
|
|
It should be an absolute filename beginning with '/' because otherwise
|
|
it will be relative to $HOME, which is "/root" for most systems, and
|
|
is probably not what you want.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>language</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The language code which consists of the two letter ISO 639 language
|
|
code and an optional two letter ISO 3166 country code after a dash
|
|
or underscore.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>spelling</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The requested spelling for languages with more than one spelling such
|
|
as English. Known values are 'american', 'british', and 'canadian'.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>jargon</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Extra information to distinguish two different words lists that have
|
|
the same language and spelling parameters.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>encoding</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The encoding that words are expected to be in. Valid values are
|
|
<literal>utf-8</literal>, <literal>iso8859-*</literal>,
|
|
<literal>koi8-r</literal>, <literal>viscii</literal>,
|
|
<literal>cp1252</literal>, <literal>machine unsigned 16</literal>,
|
|
<literal>machine unsigned 32</literal>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>mode</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The mode in which spellchecker will work. There are several modes available:
|
|
<itemizedlist>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>PSPELL_FAST</constant> - Fast mode (least number of
|
|
suggestions)
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>PSPELL_NORMAL</constant> - Normal mode (more suggestions)
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>PSPELL_BAD_SPELLERS</constant> - Slow mode (a lot of
|
|
suggestions)
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>PSPELL_RUN_TOGETHER</constant> - Consider run-together words
|
|
as legal compounds. That is, "thecat" will be a legal compound,
|
|
although there should be a space between the two words. Changing this
|
|
setting only affects the results returned by
|
|
<function>pspell_check</function>; <function>pspell_suggest</function>
|
|
will still return suggestions.
|
|
</simpara>
|
|
</listitem>
|
|
</itemizedlist>
|
|
Mode is a bitmask constructed from different constants listed above.
|
|
However, <constant>PSPELL_FAST</constant>,
|
|
<constant>PSPELL_NORMAL</constant> and
|
|
<constant>PSPELL_BAD_SPELLERS</constant> are mutually exclusive, so you
|
|
should select only one of them.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns an <classname>PSpell\Dictionary</classname> instance on success,&return.falseforfailure;.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>8.1.0</entry>
|
|
<entry>
|
|
Returns an <classname>PSpell\Dictionary</classname> instance now;
|
|
previously, a &resource; was returned.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>pspell_new_personal</function></title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$pspell = pspell_new_personal ("/var/dictionaries/custom.pws",
|
|
"en", "", "", "", PSPELL_FAST|PSPELL_RUN_TOGETHER);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|