blib::man::Pod(3pm)

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 modulo para ayudar en la traduccion de documentacion en el formato POD (el lenguaje preferido para documentar Perl) a otros lenguajes [humanos].

ESTADO DE ESTE MODULO
Me parece que este modulo es muy estable, y solo hay un fallo conocido:

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

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

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

 " #n"

y el mio contiene

 "" #n""

lo cual es logico ya que "foobar" se reescribe como "foobar"

La lista completa de las paginas que dan este problema en mi maquina (de 564 paginas ; date cuenta de que esto depende de la puntuacion 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 metodos e interfaces. Consulte Pod::Parser para mas 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 incluiran en la salida. Esto es util para visualizar codigo documentado con bloques POD, con el POD tratado y el codigo dejado intacto.

indent
    El numero de espacios para indentar texto regular, y la indentacion por defecto de los bloques "=over". Por defecto vale 4.

loose
    Si toma valor cierto, se imprime una linea en blanco despues de las cabeceras "=head1". Si se pone a falso (por defecto), no se imprimen lineas en blanco despues de "=head1", pero si despues de "=head2". Este es el comportamiento por defecto porque este es el formateo esperado para las paginas de manual; si esta formateando documentos de texto arbitrario, poniendo esta opcion puede resultar en una salida mas agradable.

quotes
    Ajusta las marcas de cita C<> alrededor de texto. Si el valor es un unico caracter, se utilizara para las marcas izquierda y derecha; si son dos caracteres, se utilizara el primero para la marca izquierda, y el segundo para la derecha; y si son cuatro caracteres, los dos primeros se utilizaran como marca izquierda, y los dos ultimos como marca derecha.

    Tambien se le puede dar el valor especial "none", en cuyo caso no se an~adiran comillas alrededor del texto C<>.

sentence
    Si toma el valor cierto, Locale::Po4a::Pod asumira que cada frase termina con dos espacios, e intentara preservar este espaciado. Si se pone a falso, todos los espacios consecutivos encontrados en un parrafo que no se deba mantener tal cual, seran comprimidos a un unico 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).