Construtor¶

process(%)

Essa função pode fazer tudo que você precisa fazer com um documento po4a em uma chamada. Seus argumentos devem ser empacotados como um hash. AÇÕES:

new(%)

Cria um novo documento de po4a. Opções aceitas são (mas devem estar em um hash):

Manipulação de arquivos de documento¶

read($$)

Adiciona dados de outro documento de entrada ao final do vetor "@{$self->{TT}{doc_in}}" existente. O argumento é o nome de arquivo para ler. Se um segundo argumento é fornecido, ele é o nome de arquivo para usar em referências.

Esse vetor "@{$self->{TT}{doc_in}}" detém os dados desse documento de entrada como um vetor e strings com significados alternativos.
* A string $textline detendo cada linha de dados de texto de entrada.
* A string "$filename:$linenum" detendo sua localização e chamada
como "referência" ("linenum" inicia com 1).

Por favor note que ele analisa nada. Você deveria usa a função parse() quando você acabar de empacotar os arquivos de entrada no documento.

write($)

Escreve o documento traduzido no nome de arquivo fornecido.

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

Manipulação de arquivos PO¶

readpo($)

Adiciona o conteúdo de um arquivo, cujo nome é passado como argumento, ao PO de entrada existente. O conteúdo antigo é descartado.

writepo($)

Escrever o arquivo PO extraído para o nome de arquivo fornecido.

stats()

Retorna algumas estatísticas sobre a tradução realizada até o mesmo. Por favor, note que não são as mesmas estatísticas mostradas pelo "msgfmt --statistic". Aqui, são as estatísticas sobre uso recente do arquivo PO, enquanto o msgfmt relata o status do arquivo. Ele é um wrapper da função Locale::Po4a::Po::stats_get aplicada ao arquivo PO de entrada. Exemplo de uso:

    [uso normal de um documento po4a...]
    ($percent,$hit,$queries) = $document->stats();
    print "Nós encontramos de $percent\%  ($hit de $queries) das strings.\n";
    

is_po_uptodate()

Retorna ($uptodate, $diagnostic), sendo que $uptodate é se o po de entrada e o po de saída coincidem (se não, significa que o po de entrada deve ser atualizado) e $diagnostic é uma string explicando por que o arquivo po não está atualizado, quando isso acontece.

Manipulando adendos¶

addendum($)

Por favor veja o po4a(7) para mais informações sobre o que são adendos e como tradutores deveriam escrevê-los. Para aplicar um adendo ao documento traduzido, simplesmente passe seu nome de arquivo para essa função e pronto ;)

Essa função retorna um inteiro não nulo quando há um erro.

Obtendo a entrada, fornecendo 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 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, você está interessada na primeira linha, que é o que o shift fornece, e na saída você quer adicionar seu resultado ao final, como o push faz.

shiftline()

Esta função retorna a primeira linha a ser analisada e a sua referência 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 string "$filename:$linenum".

unshiftline($$)

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

pushline($)

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

popline()

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

Marcando strings como traduzíveis¶

Uma função é fornecida para manipular o texto que deveria ser traduzido.

translate($$$)

Argumentos obrigatórios:

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

Funções miscelânea¶

verbose()

Retorna se a opção de detalhamento foi passada durante a criação do TransTractor.

debug()

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

detected_charset($)

Isso fala para o TransTractor que um novo conjunto de caracteres (o primeiro argumento) foi detectado no documento de entrada. Ele normalmente pode ser lido do cabeçalho do documento. Apenas o primeiro conjunto de caracteres restará, vindo com os argumentos de process() ou detectado do documento.

get_out_charset()

Essa função vai retornar o conjunto de caracteres que deveria ser usado no documento do entrada (normalmente útil para substituir o conjunto de caracteres detectado no documento de entrada, onde ele foi encontrado).

Ele vai usar o conjunto de caracteres de saída especificado na linha de comando. Se não tiver sido especificado, ele vai usar o conjunto de caracteres do PO de entrada, e se o PO de entrada possuir o "CHARSET" padrão, ele vai retornar o conjunto de caracteres do documento de entrada, de forma que nenhuma codificação é realizada.

recode_skipped_text($)

Essa função retorna o texto re-codificado passado como argumento, do conjunto de caracteres do documento de entrada para o do documento de saída. Isso não é necessário quando se está traduzindo uma string (o próprio translate() re-codifica tudo), mas é necessário quando você ignora uma string do documento de entrada e você deseja que o documento de saída seja consistente com a codificação global.