NAME

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

SINOPSIS

$ perldoc POD2::ES::<nombre_pod>

$ perl -MPOD2::ES -e print_pods
$ perl -MPOD2::ES -e print_pod <nombre_pod1> [<nombre_pod2> ...]

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

use POD2::ES;
my $pod2 = POD2::ES->new();
$pod2->print_pods();
$pod2->print_pod('perlfunc');
                                                                                        

DESCRIPCIÓN

Este módulo contiene los documentos revisados hasta la fecha del proyecto de traducción al español de la documentación básica de Perl, que se aloja en http://github.com/zipf/perldoc-es.

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

$ perldoc POD2::ES::<nombre_pod>

A partir de la versión 3.14 de Pod::Perldoc se 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>

El modificador -L permite definir el código de idioma para la traducción deseada. Si el paquete POD2::<idioma> no existe, no se aplicará el modificador, perldoc informará de que no encuentra la documentación requerida.

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 perlre
$ perldoc-es -f map

Con la versión 3.15 de Pod::Perldoc se puede usar la variable de entorno PERLDOC_POD2. Si se establece esta variable en '1', perldoc buscará en la documentación pod según el idioma indicado en las variables LC_ALL, LC_LANG o LANG. O bien, se puede establecer en el valor 'es', con lo que buscará directamente en la documentación en español. Por ejemplo:

export PERLDOC_POD2="es"
perldoc perl

Tenga en cuenta que fue en la revisión 3.14 de Pod::Perldoc (incluida en Perl 5.8.7 y en Perl 5.8.8) donde se incluyó la opción -L. Si tiene una distribución de Perl anterior (salvo la >= 5.8.1), actualice el módulo Pod::Perldoc a la versión 3.14. Perl 5.10 ya contiene esta funcionalidad.

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

    Pod/Perldoc.pm llama a este método para determinar qué cadena debe buscar en perlfunc.pod, a fin de omitir la introducción y localizar la posición donde comienza la definición de la función que el usuario solicita a perldoc mediante la opción -f.

NOTAS ACERCA DE 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.

AUTOR

  • Joaquín Ferrero (Tech Lead), explorer + POD2ES at joaquinferrero.com

  • Enrique Nell (Language Lead), blas.gordon + POD2ES at gmail.com

  • Jennifer Maldonado, jcmm986 + POD2ES at gmail.com

  • Manuel Gómez Olmedo, mgomez + POD2ES at decsai.ugr.es

REPOSITORIO

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

VEA TAMBIÉN

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

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.

ERRORES

Puede notificar errores (bugs) o solicitar funcionalidad a través de la dirección de correo electrónico bug-pod2-es 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.

AYUDA

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.

Proyecto OmegaT: http://omegat.org/

LICENCIA Y COPYRIGHT

Copyright (C) 2011-2016 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.