pspell-config-runtogether.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.pspell-config-runtogether" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pspell_config_runtogether</refname>
  <refpurpose>Consider run-together words as valid compounds</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>pspell_config_runtogether</methodname>
   <methodparam><type>PSpell\Config</type><parameter>config</parameter></methodparam>
   <methodparam><type>bool</type><parameter>allow</parameter></methodparam>
  </methodsynopsis>
  <para>
   This function determines whether run-together words will be treated 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.
  </para>
  <para>
   <function>pspell_config_runtogether</function> should be used on a config
   before calling <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>allow</parameter></term>
     <listitem>
      <para>
       &true; if run-together words should be treated as legal compounds,
       &false; otherwise.
      </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_runtogether</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$pspell_config = pspell_config_create("en");
pspell_config_runtogether($pspell_config, true);
$pspell = pspell_new_config($pspell_config);
pspell_check($pspell, "thecat");
?>
]]>
    </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
-->