The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NOMBRE

POD2::ES - Documentación de Perl en español

SINOPSIS

  %> perldoc POD2::ES::<nombre_de_pod>  

  use POD2::ES;
  print_pods();
  print_pod('pod_foo', 'pod_baz', ...); 

  %> perl -MPOD2::ES -e print_pods
  %> perl -MPOD2::ES -e print_pod <nombre_de_pod1> <nombre_de_pod2> ...

DESCRIPCIÓN

pod2es es el proyecto de traducción al español de la documentación básica de Perl. Por su dimensión, es un proyecto a largo plazo.

Vea http://github.com/zipf/perldoc-es para obtener más información.

Cuando haya instalado el paquete, puede utilizar el siguiente comando para consultar la documentación:

  %> perldoc POD2::ES::<nombre_de_pod>

ACTUALIZACIÓN DE perldoc

Por desgracia, los útiles modificadores -f y -q de perldoc no funcionan con la documentación traducida.

Por esta razón, hemos creado una revisión de Pod/Perldoc.pm 3.14 que permite utilizar la siguiente sintaxis:

  %> perldoc -L ES <nombre_pod>
  %> perldoc -L ES -f <función>
  %> perldoc -L ES -q <expresión regular P+F>

La revisión agrega el modificador -L, que permite definir el código de idioma para la traducción deseada. Si el paquete POD2::<idioma> no existe, no se aplicará el modificador.

Los más perezosos pueden agregar un alias del sistema:

  perldoc-es="perldoc -L ES "

para no tener que escribir el modificador -L cada vez:

  %> perldoc-es -f map 
 

Puede aplicar la revisión con la línea siguiente:

  %> patch -p0 `/ruta_de_perl -MPod::Perldoc -e 'print $INC{"Pod/Perldoc.pm"}'` < /ruta/Perldoc.pm-3.14-patch

La revisión se incluye con esta distribución y se encuentra en ./patches/Perldoc.pm-3.14-patch.

Tenga en cuenta que la revisión es para la versión 3.14 de Pod::Perldoc (incluida en Perl 5.8.7 y en Perl 5.8.8). Si tiene una distribución de Perl anterior (salvo la >= 5.8.1) y está impaciente por aplicar la revisión, actualice el módulo Pod::Perldoc a la versión 3.14.

Consulte la API search_perlfunc_re para obtener más información.

Nota: Perl 5.10 ya contiene esta funcionalidad, por lo que no es necesario aplicar la revisión.

API

El paquete exporta las siguientes funciones:

  • new

    Se ha agregado por compatibilidad con la función perldoc de Perl 5.10.1. Pod::Perldoc la utiliza para devolver el nombre del paquete de traducción.

  • pod_dirs

    Se ha agregado por compatibilidad con la función perldoc de Perl 5.10.1. Pod::Perldoc la utiliza para determinar dónde debe buscar los pods traducidos.

  • print_pods

    Imprime en pantalla todos los pods traducidos y la versión original de Perl correspondiente.

  • print_pod

    Imprime en pantalla la versión original de Perl correspondiente a todos los pods pasados como argumentos.

  • search_perlfunc_re

    Como el método search_perlfunc de Pod/Perldoc.pm utiliza la cadena "Lista de funciones de Perl en orden alfabético" incluida en el código (como una expresión regular) para omitir la introducción, a fin de que el archivo de revisión funcione con otros idiomas con la opción -L, hemos utilizado un mecanismo sencillo, similar a un complemento.

    El paquete de idioma POD2::<idioma> debe exportar search_perlfunc_re para devolver una traducción de la cadena mencionada en el párrafo anterior. Esta cadena se usará para omitir la introducción de perlfunc.pod. Si POD2::<idioma>->search_perlfunc_re genera un error (o no existe), se restablece el comportamiento predeterminado. Este mecanismo permite agregar traducciones de POD2::* adicionales sin necesidad de aplicar cada vez la revisión de Pod/Perldoc.pm.

PROYECTO

Encontrará más información sobre el proyecto en http://github.com/zipf/perldoc-es.

AUTORES

  • Joaquín Ferrero, explorer at joaquinferrero.com

  • Enrique Nell, blas.gordon at gmail.com

NOTAS SOBRE LA TRADUCCIÓN

Para este proyecto hemos tomado las siguientes decisiones:

  • No utilizar caracteres acentuados en los nombres de variables y funciones de los ejemplos de código

    Es perfectamente posible utilizarlos (solo hay que codificar el programa como UTF-8 y agregar "use utf8;" al principio), pero teniendo en mente a ese programador más impulsivo, que valora su tiempo y no quiere perderse en reflexiones ni verse encorsetado por las normas de la lengua, creemos que así resultará más fácil probar el código de los ejemplos.

    Por otra parte, en aquellos sistemas que cuenten con un sistema antiguo de visualización de texto, como los terminales de línea de comandos, es posible que se pierdan los acentos. En la mayor parte de los casos será debido a la presencia de una versión de groff (programa utilizado por los comandos man y perldoc) que no admite dichos caracteres. En la documentación HTML no debería haber problemas.

  • No traducir los términos "array" y "hash"

    Si tenemos en cuenta que Perl tiene más de 20 años y que la inmensa mayoría de los libros disponibles sobre este lenguaje están en inglés, a nadie extrañará que la comunidad de habla hispana se refiera a estos tipos de datos por su nombre en inglés. Existen posibles traducciones, como "matriz", "lista" o "arreglo" para "array", o "diccionario" para "hash", pero su uso no se ha extendido, por lo que hemos preferido utilizar su nombre original. Creemos que esto facilitará la lectura de la documentación.

  • Utilizar "español neutro"

    El "español neutro" es un español controlado que pretende evitar el uso de términos ofensivos o de construcciones poco frecuentes en determinados países de habla hispana, con el objetivo de lograr traducciones válidas para España y Latinoamérica.

VEA TAMBIÉN

POD2::PT_BR, POD2::IT, POD2::FR, POD2::LT, perl.

ERRORES

Puede notificar errores (bugs) o solicitar funcionalidad a través de la dirección de correo electrónico bug-pod2-esd at rt.cpan.org o de la interfaz web en http://rt.cpan.org/NoAuth/ReportBug.html?Queue=POD2-ES. Se le comunicarán automáticamente los cambios relacionados con los errores notificados o la funcionalidad solicitada.

ASISTENCIA

Para ver la documentación de este módulo, utilice el comando perldoc.

    perldoc POD2::ES

También puede buscar información en:

AGRADECIMIENTOS

Los autores desean expresar su gratitud al equipo de desarrollo de OmegaT, la herramienta utilizada para la traducción.

REFERENCIAS

Proyecto OmegaT: http://omegat.org/

DONATIVOS

Por el elevado volumen de trabajo que representa y su larga duración, el proyecto de traducción de la documentación de Perl requiere un esfuerzo sostenido que sólo está al alcance de los espíritus más sólidos y altruistas. Los autores no exigen, pero tampoco rechazarán, compensaciones en forma de dinero, libros, quesos y productos derivados del cerdo (o chancho), o incluso viajes a la Polinesia, destinadas a reducir la fatiga del equipo y a mantener alta la moral. Todo será bienvenido.

LICENCIA Y COPYRIGHT

Copyright 2011 Equipo de Perl en Español.

Este programa es software libre; puede redistribuirlo o modificarlo bajo los términos de la licencia GNU General Public License publicada por la Free Software Foundation, o los de la licencia Artistic.

Consulte http://dev.perl.org/licenses/ para obtener más información.

1 POD Error

The following errors were encountered while parsing the POD:

Around line 45:

Non-ASCII character seen before =encoding in 'Documentación'. Assuming CP1252