.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Locale::Po4a::Pod 3pm" .TH Locale::Po4a::Pod 3pm "2023-01-03" "Herramientas de po4a" "Herramientas de po4a" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NOMBRE" .IX Header "NOMBRE" Locale::Po4a::Pod \- Convierte datos \s-1POD\s0 desde/a ficheros \s-1PO\s0 .SH "SINOPSIS" .IX Header "SINOPSIS" .Vb 2 \& use Locale::Po4a::Pod; \& my $parser = Locale::Po4a::Pod\->new (sentence => 0, width => 78); \& \& # Lee el POD por la entrada estándar y escribe por la salida estándar. \& $parser\->parse_from_filehandle; \& \& # Lee POD desde «fichero.pod» y escribe en «fichero.txt». \& $parser\->parse_from_file (\*(Aqfichero.pod\*(Aq, \*(Aqfichero.txt\*(Aq); .Ve .SH "DESCRIPCIÓN" .IX Header "DESCRIPCIÓN" Locale::Po4a::Pod es un módulo que asiste en la traducción de documentación en formato \s-1POD\s0 (el lenguaje preferido para documentar Perl) a otros lenguajes (humanos). .SH "ESTADO DE ESTE MODULO" .IX Header "ESTADO DE ESTE MODULO" Opino que este módulo es muy estable, y sólo hay un fallo conocido con \fI/usr/lib/perl5/Tk/MainWindow.pod\fR (y algunas otras páginas, consulte más abajo) que contiene: .PP .Vb 1 \& C<" #n"> .Ve .PP Mala suerte, en la versión de po4a esto se separó en el espacio debido al justificado. Como resultado, en la versión original la página de manual contiene .PP .Vb 1 \& " #n" .Ve .PP y el mio contiene .PP .Vb 1 \& "" #n"" .Ve .PP lo cual es lógico ya que C se reescribe como \*(L"foobar\*(R". .PP La lista completa de las páginas que dan este problema en mi máquina (de 564 páginas; observe 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 .SH "FUNCIONAMIENTO INTERNO" .IX Header "FUNCIONAMIENTO INTERNO" Como clase derivada de Pod::Parser, Locale::Po4a::Pod es compatible con los mismos métodos e interfaces. Consulte Pod::Parser para más detalles; brevemente, uno crea un nuevo analizador con \f(CW\*(C`Locale::Po4a::Pod\->new()\*(C'\fR y luego invoca «\fBparse_from_filehandle()\fR» o bien «\fBparse_from_file()\fR». .PP \&\fBnew()\fR 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: .IP "\fBalt\fR" 4 .IX Item "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 \fB=item\fR con dos puntos en el margen izquierdo. Falso por omisión. .IP "\fBcode\fR" 4 .IX Item "code" Si tiene un valor verdadero, las partes no \s-1POD\s0 del fichero de entrada se incluirán en la salida. Esto es útil para visualizar código documentado con bloques \s-1POD,\s0 con el \s-1POD\s0 tratado y el código dejado intacto. .IP "\fBindent\fR" 4 .IX Item "indent" El número de espacios con el que sangrar texto regular, y el sangrado por omisión de los bloques \fB=over\fR. Por omisión vale 4. .IP "\fBloose\fR" 4 .IX Item "loose" Si toma valor verdadero, se imprime una línea en blanco después de las cabeceras \fB=head1\fR. De ser falso (predefinido), no se imprimen líneas en blanco después de \fB=head1\fR, pero sí después de \fB=head2\fR. Este es el comportamiento predefinido porque éste es el formato esperado para las páginas de manual; si está formateando documentos de texto arbitrario, introducir ésta opción puede resultar en una salida más agradable. .IP "\fBquotes\fR" 4 .IX Item "quotes" Ajusta las marcas de cita C<> alrededor del texto. Si el valor es un único carácter, se utilizará para las marcas izquierda y derecha; si son dos caracteres, se utilizará el primero para la marca izquierda, y el segundo para la derecha; y si son cuatro caracteres, los dos primeros se utilizarán como marca izquierda, y los dos últimos como marca derecha. .Sp También se le puede dar el valor especial \fBnone\fR, en cuyo caso no se añadirán comillas alrededor del texto C<>. .IP "\fBsentence\fR" 4 .IX Item "sentence" Si se define como verdadero, Locale::Po4a::Pod asumirá que cada frase termina con dos espacios e intentará preservar éste espaciado. Si se define como falso, todos los espacios consecutivos encontrados en un párrafo que no se deba mantener tal cual se comprimirán a un único espacio. Por omisión tiene valor verdadero. .IP "\fBwidth\fR" 4 .IX Item "width" La columna a la cual se justifica el texto en el lado derecho. Por omisión tiene un valor de 76. .SH "VÉASE TAMBIÉN" .IX Header "VÉASE TAMBIÉN" Pod::Parser, \fBLocale::Po4a::Man\fR\|(3pm), \fBLocale::Po4a::TransTractor\fR\|(3pm), \fBpo4a\fR\|(7) .SH "AUTORES" .IX Header "AUTORES" .Vb 2 \& Denis Barbier \& Martin Quinson (mquinson#debian.org) .Ve .SH "TRADUCCION" .IX Header "TRADUCCION" .Vb 2 \& Jordi Vilalta \& Omar Campagne .Ve .SH "DERECHO DE COPIA Y LICENCIA" .IX Header "DERECHO DE COPIA Y LICENCIA" Copyright © 2002 \s-1SPI,\s0 Inc. .PP Esto es software libre; puede redistribuirlo y/o modificarlo bajo las condiciones de la licencia \s-1GPL\s0 (consulte el fichero \s-1COPYING\s0).