Provided by: po4a_0.23-1_all bug

NOMBRE

       Locale::Po4a::Pod - Convierte datos POD desde/a archivos PO

SINOPSIS

           use Locale::Po4a::Pod;
           my $parser = Locale::Po4a::Pod->new (sentence => 0, width => 78);

           # Leer el POD de STDIN y escribir en STDOUT.
           $parser->parse_from_filehandle;

           # Leer el  POD de archivo.pod y escribir en archivo.txt.
           $parser->parse_from_file (’archivo.pod’, ’archivo.txt’);

DESCRIPCION

       Locale::Po4a::Pod es un módulo para ayudar en la traducción de
       documentación en el formato POD (el lenguaje preferido para documentar
       Perl) a otros lenguajes [humanos].

ESTADO DE ESTE MODULO

       Me parece que este módulo es muy estable, y sólo hay un fallo conocido:

       Tengo otro problema con /usr/lib/perl5/Tk/MainWindow.pod (y algunas
       otras páginas, ver abajo) que contiene:

         CE<lt>" #n"E<gt>

       Por mala suerte, en la versión de po4a, esto se ha separado en el
       espacio por el justificado. Como resultado, en la versión original, el
       man contiene

        " #n"

       y el mio contiene

        "" #n""

       lo cual es lógico ya que "foobar" se reescribe como "foobar"

       La lista completa de las páginas que dan este problema en mi máquina
       (de 564 páginas ; date cuenta de que esto depende de la puntuación
       elegida para el justificado): /usr/lib/perl5/Tk/MainWindow.pod
       /usr/share/perl/5.8.0/overload.pod
       /usr/share/perl/5.8.0/pod/perlapi.pod
       /usr/share/perl/5.8.0/pod/perldelta.pod
       /usr/share/perl/5.8.0/pod/perlfaq5.pod
       /usr/share/perl/5.8.0/pod/perlpod.pod
       /usr/share/perl/5.8.0/pod/perlre.pod
       /usr/share/perl/5.8.0/pod/perlretut.pod

FUNCIONAMIENTO INTERNO

       Como clase derivada de Pod::Parser, Locale::Po4a::Pod soporta los
       mismos métodos e interfaces.  Consulte Pod::Parser para más detalles;
       brevemente, uno crea un nuevo analizador con "Locale::Po4a::Pod->new()"
       y luego llama parse_from_filehandle() o bien parse_from_file().

       new() puede tomar opciones, en forma de pares llave/valor, que
       controlan el comportamiento del analizador.  Las opciones comunes
       reconocidas por todos los hijos de Pod::Parser son:

       alt Si se pone su valor a cierto, selecciona un formato alternativo de
           salida que, entre otras cosas, utiliza un estilo de cabecera
           diferente y marca las entradas "=item" con dos puntos en el margen
           izquierdo.  Por defecto vale falso.

       code
           Si toma valor cierto, las partes no-POD de la entrada se incluirán
           en la salida.  Esto es util para visualizar código documentado con
           bloques POD, con el POD tratado y el código dejado intacto.

       indent
           El número de espacios para indentar texto regular, y la indentación
           por defecto de los bloques "=over".  Por defecto vale 4.

       loose
           Si toma valor cierto, se imprime una línea en blanco después de las
           cabeceras "=head1".  Si se pone a falso (por defecto), no se
           imprimen líneas en blanco después de "=head1", pero sí después de
           "=head2".  Este es el comportamiento por defecto porque éste es el
           formateo esperado para las páginas de manual; si está formateando
           documentos de texto arbitrario, poniendo ésta opción puede resultar
           en una salida más agradable.

       quotes
           Ajusta las marcas de cita C<> alrededor de texto.  Si el valor es
           un único carácter, se utilizará para las marcas izquierda y
           derecha; si son dos carácteres, se utilizará el primero para la
           marca izquierda, y el segundo para la derecha; y si son cuatro
           carácteres, los dos primeros se utilizarán como marca izquierda, y
           los dos últimos como marca derecha.

           También se le puede dar el valor especial "none", en cuyo caso no
           se añadirán comillas alrededor del texto C<>.

       sentence
           Si toma el valor cierto, Locale::Po4a::Pod asumirá que cada frase
           termina con dos espacios, e intentará preservar éste espaciado.  Si
           se pone a falso, todos los espacios consecutivos encontrados en un
           párrafo que no se deba mantener tal cual, serán comprimidos a un
           único espacio.  Por defecto vale cierto.

       width
           La columna a la cual se justifica el texto en el lado derecho.  Por
           defecto vale 76.

VER TAMBIEN

       Pod::Parser, po4a(7), Locale::Po4a::TransTractor(3pm),
       Locale::Po4a::Man(3pm),

AUTORES

        Denis Barbier <barbier@linuxfr.org>
        Martin Quinson (mquinson#debian.org)

TRADUCCION

        Jordi Vilalta <jvprat@gmail.com>

DERECHO DE COPIA Y LICENCIA

       Copyright 2002 por SPI, inc.

       Esto es software libre; puedes redistribuirlo y/o modificarlo bajo las
       condiciones de la GPL (ver el archivo COPYING).