archived-doc-es/reference/pspell/functions/pspell-new.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: seros Status: ready -->
<refentry xml:id="function.pspell-new" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>pspell_new</refname>
  <refpurpose>Cargar un nuevo diccionario</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>pspell_new</methodname>
   <methodparam><type>string</type><parameter>language</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>spelling</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>jargon</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>pspell_new</function> abre un nuevo diccionario y
   devuelve el identificador de vínculo de diccionario para usarlo en otras funciones
   pspell.
  </para>
  <para>
   Para más información y ejemplos, verifique el sitio web de pspell del manual
   en línea:<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>
       El parámetro language es el código de lenguaje que consiste en el
       código de lenguaje ISO 639 de dos letras y un código de país ISO
       3166 de dos letras opcional después de un guión o guión de subrayado.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>spelling</parameter></term>
     <listitem>
      <para>
       El parámetro spelling es la ortografía solicitada para lenguajes
       con más de una ortografía, como el inglés. Valores conocidos son
       'american', 'british', y 'canadian'.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>jargon</parameter></term>
     <listitem>
      <para>
       El parámetro jargon contiene información extra para distinguir
       dos listas de palabras diferentes que tienen el mismo lenguaje y
       parámetros de ortografía.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>encoding</parameter></term>
     <listitem>
      <para>
       El parámetro encoding es la codificación que se espera que tengan esas
       palabras. Los valores válidos son 'utf-8', 'iso8859-*', 'koi8-r',
       'viscii', 'cp1252', 'machine unsigned 16', 'machine unsigned
       32'. Este parámetro no está en gran parte comprobado, por lo que, tenga cuidado al
       usarlo.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mode</parameter></term>
     <listitem>
      <para>
       El parámetro mode es el modo en el que trabajará el corrector ortográfico.
       Hay varios modos disponibles:
       <itemizedlist>
        <listitem>
         <simpara>
          <constant>PSPELL_FAST</constant> - Modo rápido (menor númeo de
          sugerencias)
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>PSPELL_NORMAL</constant> - Modo normal (más sugerencias)
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>PSPELL_BAD_SPELLERS</constant> - Modo lento (un montón de
          sugerencias)
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>PSPELL_RUN_TOGETHER</constant> - Considerar palabras unidas
          como compuestos legales. Es decir, "elgao" será un compuesto legal,
          aunque debería haber un espacio entre las dos palabras. Cambiar esta
          configuración solo afecta a los resultados devueltos por
          <function>pspell_check</function>; <function>pspell_suggest</function>
          seguirá devolviendo sugerencias.
         </simpara>
        </listitem>
       </itemizedlist>
       El modo es una máscara de bits construida a partir de diferentes constantes antes listadas.
       Sin embargo, <constant>PSPELL_FAST</constant>,
       <constant>PSPELL_NORMAL</constant> y
       <constant>PSPELL_BAD_SPELLERS</constant> son mutuamente exclusivas, por lo que
       debería seleccionar únicamente una de ellas.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve el identificador de vínculo de diccionario en caso de éxito &return.falseforfailure;.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>pspell_new</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$pspell_link = pspell_new("en", "", "", "",
                           (PSPELL_FAST|PSPELL_RUN_TOGETHER));
?>
]]>
    </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
-->