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 aceitas são (no hash passado como parâmetro):

Manipulação de ficheiros de documentos

read($$)

Adiciona dados de outro documento de entrada ao final do vetor "@{$self->{TT}{doc_in}}" existente. O argumento é o nome de ficheiro a ler. Se um segundo argumento for fornecido, é o nome do ficheiro a ser usado nas referências.

Esse vetor "@{$self->{TT}{doc_in}}" detém os dados desse documento de entrada como um vetor e cadeias com significados alternativos.
* A cadeia $textline a deter cada linha de dados de texto de entrada.
* A cadeia "$filename:$linenum" a deter a localização dele 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 no vetor.

Manipulando ficheiros PO

readpo($)

Adicionar 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 ao 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 a impressa 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:

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

Manipulação da 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.

Obtenção de entrada, a fornecer 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 do vetor e solta-o do vetor.
* Perl unshift preenche um item no vetor como o primeiro item do vetor.
* Perl pop retorna o último item do vetor e solta-o do vetor.
* Perl push acrescenta um item ao vetor como o último item do vetor.

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 um vetor) do vetor "@{$self->{TT}{doc_in}}" e descarta estes 2 primeiros itens do vetor. Aqui, a referência é fornecida por uma cadeia "$filename:$linenum".

unshiftline($$)

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

pushline($)

Envia uma nova linha ao fim de "{$self->{TT}{doc_out}}".

popline()

Volta, do fim de "{$self->{TT}{doc_out}}", a linha anteriormente enviada.

Marcar 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 aprovada durante a criação do TransTractor.

debug()

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

detected_charset($)

Isto diz TransTractor que um conjunto de carateres novo (o primeiro argumento) foi detetado a partir do documento de entrada. Normalmente pode ser lido a partir do cabeçalho do documento. Apenas o primeiro conjunto de carateres permanecerá, a vir a partir dos argumentos de process() ou detetados a partir do documento.

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).

Ele vai usar o conjunto de carateres de saída especificado na linha de comando. Se não fosse especificado, será usado o conjunto de carateres 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.

recode_skipped_text($)

Esta função retorna o texto recodificado passado como argumento, a partir do conjunto de carácteres do documento para os do documento de saída. Isto não é necessário quando traduzir uma cadeia (translate() recodifica tudo em si), mas é para quando saltar uma cadeia do documento de entrada e quer que o documento de saída seja consistente com a codificação global.