pspell-config-personal.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 81b23db050ac0627b056585c16bfe95445ae174e Maintainer: hirokawa Status: ready -->
<refentry xml:id="function.pspell-config-personal" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pspell_config_personal</refname>
  <refpurpose>個人の単語リストを保持するファイルを設定する</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>pspell_config_personal</methodname>
   <methodparam><type>PSpell\Config</type><parameter>config</parameter></methodparam>
   <methodparam><type>string</type><parameter>filename</parameter></methodparam>
  </methodsynopsis>
  <para>
   個人の単語リストファイルを設定します。個人の単語リストは、
   <function>pspell_new_config</function>をコールした後にロードされ、
   標準的な単語リストに追加されて使用されます。このファイルは、
   <function>pspell_save_wordlist</function> により個人的な単語リスト
   が保存されるファイルでもあります。
  </para>
  <para>
   <function>pspell_config_personal</function> は、
   <function>pspell_new_config</function>
   をコールする前に設定を行うために使用する必要があります。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>config</parameter></term>
     <listitem>
      &pspell.parameter.pspell-config;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>filename</parameter></term>
     <listitem>
      <para>
       個人の単語リスト。存在しない場合は作成します。PHP
       の実行ユーザー (たとえば nobody) が書き込み可能である必要があります。
      </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-config;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>pspell_config_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_check($pspell, "thecat");
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    この関数は、
    pspell .11.2 および aspell .32.5
    以降でない限り動作しないことに注意してください。
   </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
-->