<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Load a new dictionary with personal wordlist</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.pspell-new-config.html">pspell_new_config</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.pspell-new.html">pspell_new</a></div>
<div class="up"><a href="ref.pspell.html">Pspell Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.pspell-new-personal" class="refentry">
<div class="refnamediv">
<h1 class="refname">pspell_new_personal</h1>
<p class="verinfo">(PHP 4 >= 4.0.2, PHP 5)</p><p class="refpurpose"><span class="refname">pspell_new_personal</span> — <span class="dc-title">Load a new dictionary with personal wordlist</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.pspell-new-personal-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>pspell_new_personal</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$personal</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$language</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$spelling</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$jargon</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$encoding</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$mode</code><span class="initializer"> = 0</span></span>
]]]] )</div>
<p class="simpara">
<span class="function"><strong>pspell_new_personal()</strong></span> opens up a new dictionary with
a personal wordlist. The wordlist can be modified and saved with
<span class="function"><a href="function.pspell-save-wordlist.html" class="function">pspell_save_wordlist()</a></span>, if desired. However, the
replacement pairs are not saved. In order to save replacement pairs, you
should create a config using <span class="function"><a href="function.pspell-config-create.html" class="function">pspell_config_create()</a></span>,
set the personal wordlist file with
<span class="function"><a href="function.pspell-config-personal.html" class="function">pspell_config_personal()</a></span>,
set the file for replacement pairs with
<span class="function"><a href="function.pspell-config-repl.html" class="function">pspell_config_repl()</a></span>, and open a new dictionary with
<span class="function"><a href="function.pspell-new-config.html" class="function">pspell_new_config()</a></span>.
</p>
<p class="para">
For more information and examples, check out inline manual pspell
website:<a href="http://aspell.net/" class="link external">» http://aspell.net/</a>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.pspell-new-personal-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">personal</code></em></span>
<dd>
<p class="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.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">language</code></em></span>
<dd>
<p class="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.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">spelling</code></em></span>
<dd>
<p class="para">
The requested spelling for languages with more than one spelling such
as English. Known values are 'american', 'british', and 'canadian'.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">jargon</code></em></span>
<dd>
<p class="para">
Extra information to distinguish two different words lists that have
the same language and spelling parameters.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">encoding</code></em></span>
<dd>
<p class="para">
The encoding that words are expected to be in. Valid values are
<em>utf-8</em>, <em>iso8859-*</em>,
<em>koi8-r</em>, <em>viscii</em>,
<em>cp1252</em>, <em>machine unsigned 16</em>,
<em>machine unsigned 32</em>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">mode</code></em></span>
<dd>
<p class="para">
The mode in which spellchecker will work. There are several modes available:
<ul class="itemizedlist">
<li class="listitem">
<span class="simpara">
<strong><code>PSPELL_FAST</code></strong> - Fast mode (least number of
suggestions)
</span>
</li>
<li class="listitem">
<span class="simpara">
<strong><code>PSPELL_NORMAL</code></strong> - Normal mode (more suggestions)
</span>
</li>
<li class="listitem">
<span class="simpara">
<strong><code>PSPELL_BAD_SPELLERS</code></strong> - Slow mode (a lot of
suggestions)
</span>
</li>
<li class="listitem">
<span class="simpara">
<strong><code>PSPELL_RUN_TOGETHER</code></strong> - 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
<span class="function"><a href="function.pspell-check.html" class="function">pspell_check()</a></span>; <span class="function"><a href="function.pspell-suggest.html" class="function">pspell_suggest()</a></span>
will still return suggestions.
</span>
</li>
</ul>
Mode is a bitmask constructed from different constants listed above.
However, <strong><code>PSPELL_FAST</code></strong>,
<strong><code>PSPELL_NORMAL</code></strong> and
<strong><code>PSPELL_BAD_SPELLERS</code></strong> are mutually exclusive, so you
should select only one of them.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.pspell-new-personal-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the dictionary link identifier for use in other pspell functions.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.pspell-new-personal-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2735">
<p><strong>Example #1 <span class="function"><strong>pspell_new_personal()</strong></span></strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$pspell_link </span><span style="color: #007700">= </span><span style="color: #0000BB">pspell_new_personal </span><span style="color: #007700">(</span><span style="color: #DD0000">"/var/dictionaries/custom.pws"</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">"en"</span><span style="color: #007700">, </span><span style="color: #DD0000">""</span><span style="color: #007700">, </span><span style="color: #DD0000">""</span><span style="color: #007700">, </span><span style="color: #DD0000">""</span><span style="color: #007700">, </span><span style="color: #0000BB">PSPELL_FAST</span><span style="color: #007700">|</span><span style="color: #0000BB">PSPELL_RUN_TOGETHER</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.pspell-new-config.html">pspell_new_config</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.pspell-new.html">pspell_new</a></div>
<div class="up"><a href="ref.pspell.html">Pspell Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
