mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-24 04:48:55 +00:00
c030e2adf7
- All id attributes are now xml:id - Add docbook namespace to all root elements - Replace <ulink /> with <link xlink:href /> - Minor markup fixes here and there git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@238160 c90b9560-bf6c-de11-be94-00142212c4b1
134 lines
4.2 KiB
XML
134 lines
4.2 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.8 $ -->
|
|
<refentry xml:id="function.pspell-config-create" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>pspell_config_create</refname>
|
|
<refpurpose>Create a config used to open a dictionary</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<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>
|
|
<para>
|
|
Create a config used to open a dictionary.
|
|
</para>
|
|
<para>
|
|
<function>pspell_config_create</function> has a very similar syntax to
|
|
<function>pspell_new</function>. In fact, using
|
|
<function>pspell_config_create</function> immediately followed by
|
|
<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.
|
|
</para>
|
|
<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>language</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The language parameter is the language code which consists of the
|
|
two letter ISO 639 language code and an optional two letter ISO
|
|
3166 country code after a dash or underscore.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>spelling</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The spelling parameter is the requested spelling for languages
|
|
with more than one spelling such as English. Known values are
|
|
'american', 'british', and 'canadian'.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>jargon</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The jargon parameter contains extra information to distinguish
|
|
two different words lists that have the same language and
|
|
spelling parameters.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>encoding</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The encoding parameter is the encoding that words are expected to
|
|
be in. Valid values are 'utf-8', 'iso8859-*', 'koi8-r',
|
|
'viscii', 'cp1252', 'machine unsigned 16', 'machine unsigned
|
|
32'. This parameter is largely untested, so be careful when
|
|
using.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Retuns a pspell config identifier, or &false; on error.
|
|
</para>
|
|
</refsect1>
|
|
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>pspell_config_create</function></title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$pspell_config = pspell_config_create("en");
|
|
pspell_config_personal($pspell_config, "/var/dictionaries/custom.pws");
|
|
pspell_config_repl($pspell_config, "/var/dictionaries/custom.repl");
|
|
$pspell_link = pspell_new_personal($pspell_config, "en");
|
|
?>
|
|
]]>
|
|
</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:"../../../../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
|
|
-->
|