mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 14:58:55 +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.
122 lines
2.9 KiB
XML
122 lines
2.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.pspell-add-to-personal" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>pspell_add_to_personal</refname>
|
|
<refpurpose>Add the word to a personal wordlist</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>pspell_add_to_personal</methodname>
|
|
<methodparam><type>PSpell\Dictionary</type><parameter>dictionary</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>.
|
|
</simpara>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>dictionary</parameter></term>
|
|
<listitem>
|
|
&pspell.parameter.pspell-dictionary;
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>word</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The added word.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
&pspell.changelog.pspell-dictionary;
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>pspell_add_to_personal</function></title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$pspell_config = pspell_config_create("en");
|
|
pspell_config_personal($pspell_config, "/var/dictionaries/custom.pws");
|
|
$pspell = pspell_new_config($pspell_config);
|
|
|
|
pspell_add_to_personal($pspell, "Vlad");
|
|
pspell_save_wordlist($pspell);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
<note>
|
|
<para>
|
|
This function will not work unless you have pspell .11.2 and aspell .32.5
|
|
or later.
|
|
</para>
|
|
</note>
|
|
</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
|
|
-->
|