pspell-config-create.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 549aa1c4f045e8331b944626b35f3336262f5c14 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<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>Crée une configuration utilisée pour ouvrir un dictionnaire</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>PSpell\Config</type><methodname>pspell_config_create</methodname>
   <methodparam><type>string</type><parameter>language</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>spelling</parameter><initializer>""</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>jargon</parameter><initializer>""</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>encoding</parameter><initializer>""</initializer></methodparam>
  </methodsynopsis>
  <para>
   Crée une configuration utilisée pour ouvrir un dictionnaire.
  </para>
  <para>
   <function>pspell_config_create</function> a une syntaxe similaire à
   celle de <function>pspell_new</function>. En fait, utiliser
   <function>pspell_config_create</function> suivi immédiatement
   par <function>pspell_new_config</function> produira exactement le
   même résultat. Cependant, après avoir créé
   une nouvelle configuration, vous pouvez aussi utiliser les fonctions
   <function>pspell_config_*</function>  avant d'appeler 
   <function>pspell_new_config</function>
   pour tirer profit des fonctionnalités avancées.
  </para>
  <para>
   Pour davantage d'information et d'exemples, jetez un oeil au manuel en ligne sur le site
   de pspell : <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>
       Le paramètre de langage <parameter>language</parameter> est le code 
       de langue en deux lettres,
       défini dans la norme ISO 639, et deux lettres optionnelles
       ISO 3166, après un tiret ou un souligné (_).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>spelling</parameter></term>
     <listitem>
      <para>
       Le paramètre d'orthographe <parameter>spelling</parameter> est
       nécessaire pour les langues qui ont plus d'une orthographe,
       comme l'anglais. Les valeurs reconnues sont alors 'american'
       (américain) , 'british' (anglais), et 'canadian' (canadien).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>jargon</parameter></term>
     <listitem>
      <para>
       Le paramètre de jargon <parameter>jargon</parameter> contient
       des informations supplémentaires pour distinguer deux dictionnaires
       distincts pour la même langue et le même paramètre
       d'orthographe <parameter>spelling</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>encoding</parameter></term>
     <listitem>
      <para>
       Le paramètre d'encodage <parameter>encoding</parameter> indique 
       l'encodage attendu pour la réponse.
       Les valeurs valides sont : 'utf-8', 'iso8859-*', 'koi8-r',
       'viscii', 'cp1252', 'machine unsigned 16', 'machine unsigned 32'.
       Ce paramètre n'a pas été testé de
       manière exhaustive, alors soyez prudent.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne une instance de <classname>PSpell\Config</classname>.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.1.0</entry>
      <entry>
       Retourne désormais une instance de <classname>PSpell\Config</classname> ;
       auparavant, une &resource; était retournée.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </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("fr");
pspell_config_personal($pspell_config, "/var/dictionaries/custom.pws");
pspell_config_repl($pspell_config, "/var/dictionaries/custom.repl");
$pspell = pspell_new_personal($pspell_config, "fr");
?>
]]>
    </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
-->