Construtor¶

process(%)

Esta função pode fazer tudo o que precisa fazer com um documento po4a numa invocação. Os argumentos dela devem ser empacotados como uma 'hash'. AÇÕES:

new(%)

Cria um novo documento de po4a. Opções aceites (no hash passado como parâmetro):

Manipulando ficheiros de documentos¶

read($$$)

Adiciona outros dados do documento de entrada no final da array existente "@{$self->{TT}{doc_in}}".

Esta função recebe dois argumentos obrigatórios e um opcional.
* O nome do ficheiro a ser lido no disco;
* O nome a ser usado como nome do ficheiro ao construir a referência no ficheiro PO;
* O conjunto de caracteres a ser usado para ler esse ficheiro (UTF-8 por predefinição)

Esta matriz "@{$self->{TT}{doc_in}}" detém os dados desse documento de entrada como uma matriz de cadeias com significados alternativos.
* A cadeia $textline que detém cada linha de dados de texto de entrada.
* A cadeia "$filename:$linenum" que detém a sua localização e chamada
como "referência" ("linenum" starts with 1)..

Por favor, note que ele não analisa nada. Deve usar a função parse() quando está feito com o empacotamento de ficheiros de entrada no documento.

escrever($)

Escreva o documento traduzido no nome do ficheiro dado.

Os dados desse documento traduzido são fornecidos por:
* "$self->docheader()" a deter o texto de cabeçalho para o plugin e
* "@{$self->{TT}{doc_out}}" a deter cada linha do principal texto traduzido na matriz.

Manipulando ficheiros PO¶

readpo($)

Adiciona o conteúdo dum ficheiro (que o nome é passado como argumento) para o actual PO de entrada. O conteúdo antigo não é descartado.

writepo($)

Gravar o ficheiro PO extraído no nome do ficheiro dado.

stats()

Retorna algumas estatísticas sobre a tradução feita até agora. Note que não é a mesma estatística que aquela escrita por msgfmt--statistic. Aqui, são estatísticas sobre o uso recente do ficheiro PO, enquanto msgfmt relata o estado do ficheiro. Ele é um envolvido para função Locale::Po4a::Po::stats_get aplicada ao ficheiro de entrada PO. Exemplo de uso:

    [uso normal do documento po4a...]
    ($percent,$hit,$queries) = $document->stats();
    print "Encontramos traduções para $percent\%  ($hit from $queries) de cadeias.\n";
    

Manipulando a adenda¶

addendum($)

Por favor, consulte po4a(7) para obter mais informações sobre o que são adendas e como os tradutores devem escrevê-las. Para aplicar uma adenda ao documento traduzido, basta passar o nome do ficheiro para esta função e está feito ;)

Esta função retorna um inteiro não nulo em caso de erro.

Obter a entrada, fornecer a saída¶

Quatro funções são fornecidas para obter entrada e retornar a saída. Elas são muito parecidas com shift/unshift e push/pop de Perl.

 * Perl shift retorna o primeiro item da matriz e solta-o da matriz.
* Perl unshift preenche um item da matriz como o primeiro item da matriz.
* Perl pop retorna o último item da matriz e solta-o da matriz.
* Perl push acrescenta um item da matriz como o último item da matriz.

O primeiro par é sobre entrada, enquanto ao segundo é sobre saída. Mnemônico: na entrada, está interessada na primeira linha, que é o que o shift fornece e na saída quer adicionar o seu resultado ao final, como o push faz.

shiftline()

Esta função retorna a primeira linha a ser analisada e a referência dele correspondente (empacotada como uma matriz) da matriz "@{$self->{TT}{doc_in}}" e descarta estes 2 primeiros itens da matriz. Aqui, a referência é fornecida por uma cadeia "$filename:$linenum".

unshiftline($$)

Desloca a última linha deslocada do documento de entrada e a referência dele correspondente de volta ao cabeçalho de "{$self->{TT}{doc_in}}".

pushline($)

Força uma nova linha no fim de "{$self->{TT}{doc_out}}".

popline()

Estoira a última linha forçada do final de "{$self->{TT}{doc_out}}".

Marcando cadeias como traduzíveis¶

Uma função é fornecida para lidar com o texto que deve ser traduzido.

translate($$$)

Argumentos obrigatórios:

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

Funções diversas¶

verbose()

Retorna se a opção 'verbose' foi passada durante a criação do TransTractor.

debug()

Retorna se a opção de depuração foi passada durante a criação doTransTractor.

get_in_charset()

Esta função retorna o charset que foi fornecido como o conjunto de caracteres mestre

get_out_charset()

Esta função irá retornar o conjunto de carácteres, que deviam ser usados na saída (em geral, útil para substituir os conjuntos de carácteres detetados à entrada do documento onde foi encontrado).

Vai usar o conjunto de caracteres de saída especificado na linha de comando. Se não fosse especificado, seria usado o conjunto de caracteres do PO de entrada e, se a entrada de PO tem o "CHARSET" predefinido, irá retornar um conjunto de carácteres do documento de entrada, de modo a que nenhuma codificação é realizada.