Provided by:
po4a_0.41-1ubuntu1_all 
NOMBRE
Locale::Po4a::Pod - Convierte datos POD desde/a ficheros PO
SINOPSIS
use Locale::Po4a::Pod;
my $parser = Locale::Po4a::Pod->new (sentence => 0, width => 78);
# Lee el POD por la entrada estandar y escribe por la salida estandar.
$parser->parse_from_filehandle;
# Lee POD desde <<fichero.pod>> y escribe en <<fichero.txt>>.
$parser->parse_from_file ('fichero.pod', 'fichero.txt');
DESCRIPCI'ON
Locale::Po4a::Pod es un modulo que asiste en la traduccion de
documentacion en formato POD (el lenguaje preferido para documentar
Perl) a otros lenguajes (humanos).
ESTADO DE ESTE MODULO
Opino que este modulo es muy estable, y solo hay un fallo conocido con
/usr/lib/perl5/Tk/MainWindow.pod (y algunas otras paginas, consulte mas
abajo) que contiene:
C<" #n">
Mala suerte, en la version de po4a esto se separo en el espacio debido
al justificado. Como resultado, en la version original la pagina de
manual contiene
" #n"
y el mio contiene
"" #n""
lo cual es logico ya que C<foobar> se reescribe como "foobar".
La lista completa de las paginas que dan este problema en mi maquina
(de 564 paginas; observe 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 es compatible con
los mismos metodos e interfaces. Consulte Pod::Parser para mas
detalles; brevemente, uno crea un nuevo analizador con
"Locale::Po4a::Pod->new()" y luego invoca <<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 tiene un valor verdadero (<<true>>), 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. Falso por omision.
code
Si tiene un valor verdadero, las partes no POD del fichero de
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 con el que sangrar texto regular, y el
sangrado por omision de los bloques =over. Por omision vale 4.
loose
Si toma valor verdadero, se imprime una linea en blanco despues de
las cabeceras =head1. De ser falso (predefinido), no se imprimen
lineas en blanco despues de =head1, pero si despues de =head2. Este
es el comportamiento predefinido porque este es el formato esperado
para las paginas de manual; si esta formateando documentos de texto
arbitrario, introducir esta opcion puede resultar en una salida mas
agradable.
quotes
Ajusta las marcas de cita C<> alrededor del 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
anadiran comillas alrededor del texto C<>.
sentence
Si se define como verdadero, Locale::Po4a::Pod asumira que cada
frase termina con dos espacios e intentara preservar este
espaciado. Si se define como falso, todos los espacios consecutivos
encontrados en un parrafo que no se deba mantener tal cual se
comprimiran a un unico espacio. Por omision tiene valor verdadero.
width
La columna a la cual se justifica el texto en el lado derecho. Por
omision tiene un valor de 76.
V'EASE TAMBI'EN
Pod::Parser, po4a(7), Locale::Po4a::TransTractor(3pm),
Locale::Po4a::Man(3pm),
AUTORES
Denis Barbier <barbier@linuxfr.org>
Martin Quinson (mquinson#debian.org)
DERECHO DE COPIA Y LICENCIA
Copyright 2002 por SPI, inc.
Esto es software libre; puede redistribuirlo y/o modificarlo bajo las
condiciones de la licencia GPL (consulte el fichero COPYING).