Constructor¶

process(%)

Esta función puede hacer todo lo que quiera hacer con un documento po4a en una invocación:. Sus argumentos deben estar empaquetados como una tabla de elementos asociativos («hash»). ACCIONES:

new(%)

Crea un nuevo documento po4a. Las opciones aceptadas (en la tabla «hash» pasada como parámetro):

Manipulación de ficheros de documentos¶

leer($$$)

Agregue otros datos del documento de entrada al final de la matriz existente "@{$self->{TT}{doc_in}}".

This function takes two mandatory arguments and an optional one.
* The filename to read on disk;
* The name to use as filename when building the reference in the PO file;
* The charset to use to read that file (UTF-8 by default)

This array "@{$self->{TT}{doc_in}}" holds this input document data as an array of strings with alternating meanings.
* The string $textline holding each line of the input text data.
* The string "$filename:$linenum" holding its location and called as
"reference" ("linenum" starts with 1).

Cabe destacar que esto no analiza nada. Debe usar la función «parse()» cuando haya terminado de cargar los ficheros de entrada en el documento.

write($)

Escribe el documento traducido al fichero dado.

This translated document data are provided by:
* "$self->docheader()" holding the header text for the plugin, and
* "@{$self->{TT}{doc_out}}" holding each line of the main translated text in the array.

Manipula ficheros PO¶

readpo($)

Añade el contenido de un fichero (cuyo nombre se introduce como argumento) al PO de entrada existente. El contenido anterior no se desecha.

writepo($)

Escribe el fichero PO extraído al nombre de fichero dado.

stats()

Devuelve algunas estadísticas sobre el punto actual de la traducción en curso. Estas no son las mismas estadísticas que las que muestra «msgfmt --statistic». Aquí las estadísticas son sobre el uso reciente del fichero PO, mientras que msgfmt informa del estado del fichero. Esto es un «wrapper» (patrón de diseño) de la función Locale::Po4a::Po::stats_get aplicada al fichero PO de entrada. Ejemplo de uso:

    [normal use of the po4a document...]
    ($percent,$hit,$queries) = $document->stats();
    print "We found translations for $percent\%  ($hit from $queries) of strings.\n";
    

Manipulación de apéndices¶

addendum($)

Consulte po4a(7) para más información acerca de los apéndices, y cómo los traductores deben escribirlos. Para aplicar un apéndice a un documento traducido, simplemente introduzca su nombre de fichero en ésta función y ya está ;)

Esta función devuelve un entero no nulo en caso de error.

Obtener entrada, proporcionar salida¶

Se proporcionan cuatro funciones para obtener la entrada y salida de vuelta. Son muy similares a shift/unshift y push/pop de Perl.

 * Perl shift returns the first array item and drop it from the array.
 * Perl unshift prepends an item to the array as the first array item.
 * Perl pop returns the last array item and drop it from the array.
 * Perl push appends an item to the array as the last array item.

El primer par trata la entrada, mientras que el segundo trata la salida. Truco mnemoténico: en la entrada, está interesado en la primera línea, lo que ofrece shift, y en la salida desea insertar el resultado al final, como hace push.

shiftline()

Esta función devuelve la primera línea para su análisis y la referencia correspondiente (en forma de matriz), de la matriz "@{$self->{TT}{doc_in}}", y elimina estos dos primeros elementos de matriz. Aquí, la referencia es proporcionada por la cadena "$filename:$linenum".

unshiftline($$)

Devuelve la modificación «shift» de la última línea «shifted» del documento de entrada y su referencia a la cabecera de "{$self->{TT}{doc_in}}".

pushline($)

Inserta una línea nueva al final de "{$self->{TT}{doc_out}}".

popline()

Extrae la últma línea insertada al final de "{$self->{TT}{doc_out}}".

Marcar cadenas como traducibles¶

Se proporciona una función para tratar el texto que se debe traducir.

translate($$$)

Argumentos obligatorios:

  $self->translate("string","ref","type",
                   'wrap' => 1);

Funciones varias¶

verbose()

Devuelve si se pasó la opción de verbosidad durante la creación del TransTractor.

debug()

Devuelve si se pasó la opción de depuración de fallos durante la creación del TransTractor.

get_in_charset()

Esta función devuelve el conjunto de caracteres que se proporcionó como conjunto de caracteres maestro

get_out_charset()

Esta función devuelve el juego de caracteres que se debe usar en el documento de salida (normalmente es útil para sustituir el juego de caracteres detectado en el documento de entrada donde se encontró).

Utilizará el juego de caracteres especificado en la linea de órdenes. Si no se ha especificado, utilizará el juego de caracteres del PO de entrada, y si el PO de entrada aún tiene el «CHARSET» predefinido, devolverá el juego de caracteres del documento de entrada, para que no se realice ninguna codificación.