Scroll to navigation

PO4A(1p) Ferramentas do Po4a PO4A(1p)

NOME

po4a - atualiza ambos arquivos PO e documentações traduzidas em um tiro

SINOPSE

po4a [opções] arquivo_config

DESCRIÇÃO

po4a (PO for anything) facilita a manutenção de tradução da documentação usando as ferramentas clássicas do gettext. A principal característica do po4a é que ele dissocia a tradução do conteúdo da estrutura documental. Consulte a página po4a(7) para uma introdução suave a este projeto.

Quando você executa o programa po4a pela primeira vez, com apenas um arquivo de configuração e os documentos para traduzir (chamados de documentos mestres), ele produz um arquivo POT (também chamado de modelo de tradução) que contém todas as strings traduzíveis no documento de uma forma que facilita o trabalho dos tradutores.

Esses arquivos POT podem ser traduzidos com um editor específico, como o Editor de Tradução do GNOME, o Lokalize do KDE ou poedit, ou podem ser integrados a uma plataforma de localização online, como weblate ou pootle. O resultado da tradução é um conjunto de arquivos PO, um por idioma.

Quando você executa o programa po4a com os documentos mestre e os arquivos PO, ele produz os documentos traduzidos injetando a tradução do conteúdo (encontrada nos arquivos PO) na estrutura do documento mestre original.

Se os documentos mestre forem alterados, o po4a atualizará os arquivos PO e POT adequadamente, para que os tradutores possam detectar facilmente as modificações e atualizar seu trabalho. Dependendo das configurações, o po4a descartará os documentos parcialmente traduzidos ou produzirá um documento misturando inglês (para os parágrafos novos ou modificados) e o idioma de destino (para os parágrafos cuja tradução já está no arquivo PO).

Por padrão, os documentos traduzidos são produzidos quando pelo menos 80% de seu conteúdo é traduzido (consulte a opção --keep abaixo). Descartar traduções assim que elas não forem 100% pode ser desanimador para os tradutores, enquanto mostrar "tradução" muito incompletas pode ser preocupante para os usuários finais.

Visão geral gráfica

 documentos mestres -+----->-------->---------+
  (criação de docs)  |                        |
                     V  (execuções do po4a)   >----+--> traduções
                     |                        |    |
  arquivos PO ------->-----> arquivos PO -->--+    |
   existentes                atualizados           |
     ^                             |               |
     |                             V               ^
     +----------<---------<--------+               |
      (processo de tradução manual)                |
                                                   |
 adendo ---->--------------------------------------+

Os documentos principais são de autoria de quem escreve a documentação. Quaisquer alterações são automaticamente refletidas pelo po4a nos arquivos PO, que são depois atualizados pelos tradutores. Todas as alterações nos arquivos PO (seja manual ou por po4a) são automaticamente refletidas nos documentos traduzidos. Você pode imitar este comportamento usando os scripts po4a-updatepo(1) e po4a-translate(1) em makefiles, mas isto rapidamente se torna incômodo e repetitivo (veja po4a(7)). É altamente recomendável usar o programa po4a em seu processo de compilação.

OPÇÕES

-k, --keep
Limite mínimo de porcentagem de tradução para manter (i.e. escrever) o arquivo resultante (padrão: 80). Isto é, por padrão, arquivos têm que estar traduzidos em pelo menos 80% para serem escritos no disco.
-h, --help
Mostra uma mensagem de ajuda.
-M, --master-charset
Conjunto de caracteres dos arquivos contendo os documentos para traduzir. Note que todos os documentos mestres devem usar o mesmo conjunto de caracteres.
-L, --localized-charset
Conjunto de caracteres dos arquivos contendo os documentos localizados. Note que todos os documentos traduzidos devem usar o mesmo conjunto de caracteres.
-A, --addendum-charset
Conjunto de caracteres dos adendos. Note que todos os adendos deveriam ser do mesmo conjunto de caracteres.
-V, --version
Exibe a versão do script e sai.
-v, --verbose
Aumenta o nível de detalhamento do programa.
-q, --quiet
Reduz o nível de detalhamento do programa.
-d, --debug
Imprime algumas informações de depuração.
-o, --option
Opções extras para passar o plug-in de formato. Veja a documentação de cada plug-in para mais informações sobre as opções válidas e seus significados. Por exemplo, você poderia passar "-o tablecells" para o analisador AsciiDoc, enquanto o analisador de texto aceitaria "-o tabs=split".
-f, --force
Sempre gera os aquivos POT e PO, mesmo se po4a considera isso desnecessário.

O comportamento padrão (quando --force não é especificado) é o seguinte:

Se o arquivo POT já existe, ele é regerado se uma documentação mestre ou arquivo de configuração for mais recente (a menos --no-update seja fornecido). O POT também é escrito em um documento temporário e po4a certifica-se de que as alterações são realmente necessárias.

Também, uma tradução é gerada novamente apenas se seu documento mestre, o arquivo PO, um desses adendos ou arquivo de configuração é mais recente. Para evitar tentativa de gerar traduções que não passam no teste de limite (veja --keep), um arquivo com a extensão .po4a-stamp pode ser criada (veja --stamp).

Se um documento mestre inclui arquivos, você deveria usar a opção --force porque o horário de modificação desses arquivos incluídos não são levados em consideração.

Os arquivos PO são gerados novamente baseados no POT com msgmerge -U.

--stamp
Informa ao po4a para criar arquivos stamp quando uma tradução não é gerada porque ela não atingiu o limite. Esses arquivos stamp são nomeados de acordo com o documento de tradução esperado, com a extensão .po4a-stamp.

Nota: Isso somente ativa a criação dos arquivos .po4a-stamp. Os arquivos stamp são sempre usados se existirem e eles são removidos com --rm-translations ou quando o arquivo é finalmente traduzido.

--no-translations
Não gera os documentos traduzidos, apenas atualiza os arquivos POT e PO.
--no-update
Não altere os arquivos POT e PO, apenas a tradução pode ser atualizada.
--keep-translations
Mantém os arquivos de tradução existentes mesmo se a tradução não atender o limite especificado por --keep. Essa opção não cria novos arquivos de tradução com pouco conteúdo, mas vai salvar traduções existentes que cujo nível decai por causa de alterações nos arquivos de mestre.

ATENÇÃO: Esta opção muda o comportamento do po4a de uma maneira bastante drástica: seus arquivos traduzidos não serão atualizados até que a tradução melhore. Use esta opção somente se você preferir enviar uma documentação traduzida desatualizada em vez de enviar apenas uma documentação não traduzida precisa.

--rm-translations
Remove os arquivos de tradução (implica em --no-translations).
--no-backups
Essa opção não faz nada desde 0.41 e pode ser removida em versões posteriores.
--rm-backups
Essa opção não faz nada desde 0.41 e pode ser removida em versões posteriores.
--translate-only arquivo-traduzido
Traduz apenas o arquivo especificado. Pode ser útil para agilizar o processamento se um arquivo de configuração contém muitos arquivos. Note que essa opção não atualiza arquivos POT e PO. Essa opção pode ser usada múltiplas vezes.
--variable var=valor
Define uma variável que vai ser expandida no arquivo de configuração do po4a. Toda ocorrência de $(var) vai ser substituída por valor. Essa opção pode ser usada múltiplas vezes.
--srcdir SRCDIR
Define o diretório base para todos os documentos de entradas especificados no arquivo de configuração do po4a.

Se destdir e srcdir forem especificados, os arquivos de entrada serão pesquisados nos seguintes diretórios, em ordem: destdir, o diretório atual e srcdir. Os arquivos de saída são gravados em destdir, se especificado, ou no diretório atual.

--destdir DESTDIR
Define o diretório base para todos os documentos de saída especificados no arquivo de configuração do po4a (veja --srcdir acima).

Opções que modificam o cabeçalho do POT

--porefs tipo
Especifica o formato de referência. O argumento tipo pode ser um de: never para não produzir qualquer referência, file para especificar o arquivo sem o número de linha, counter para substituir os números de linha aumentando o contador e full para incluir referências completas. (padrão: full).
--wrap-po no|newlines|number (padrão: 76)
Especifica como o arquivo po deve ter sua quebra de linha. Isso permite escolher entre arquivos que tem boa quebra de linha, mas que podem levar a conflitos de git, ou arquivos que são mais fáceis de manipular automaticamente, mas mais difíceis de ler para humanos.

Historicamente, o pacote gettext reformatou os arquivos po na 77ª coluna para questões cosméticas. Esta opção especifica o comportamento de po4a. Se definido como um valor numérico, o po4a quebrará linha do arquivo po após esta coluna e após novas linhas no conteúdo. Se definido como newlines, o po4a dividirá apenas o msgid e o msgstr após as novas linhas no conteúdo. Se definido como no, o po4a não quebrará linha do arquivo po. Os comentários de referência têm sempre as linhas quebradas pelas ferramentas do gettext que nós usamos internamente.

Observe que esta opção não afeta a maneira como o msgid e o msgstr sofrem quebra de linhas, ou seja, como os caracteres de nova linha são adicionados ao conteúdo dessas strings.

--master-language
Idioma dos arquivos fonte contendo os documentos para traduzir. Note que todos os documentos mestres devem usar o mesmo idioma.
--msgid-bugs-address e-mail@endereço
Define o endereço para relatórios de erros em msgids. Por padrão, os arquivos POT criados possuem nenhum campo Report-Msgid-Bugs-To.
--copyright-holder string
Define o detentor do copyright no cabeçalho do POT. O valor padrão é "Free Software Foundation, Inc."
--package-name string
Define o nome do pacote para o cabeçalho do POT. O padrão é "PACKAGE".
--package-version string
Define a versão do pacote do cabeçalho do POT. O padrão é "VERSION".

Opções para modificar os arquivos PO

--msgmerge-opt opções
Opções extras para msgmerge(1).

Nota: $lang vai estar estendida do idioma atual.

--no-previous
Essa opção remove --previous das opções passadas ao msgmerge. Isso permite Isso permite o suporte a versões do gettext antes de 0.16.
--previous
Essa opção adiciona --previous às opções passadas ao msgmerge. Isso requer gettext 0.16 ou posterior, e é ativada por padrão.

ARQUIVO DE CONFIGURAÇÃO

po4a espera um arquivo de configuração como argumento. Este arquivo deve conter os seguintes elementos:
  • O caminho para os arquivos PO e a lista de idiomas existentes no projeto;
  • Opcionalmente, algumas opções globais e os chamados aliases de configuração que são usados como modelos para configurar arquivos mestres individuais ;
  • A lista de cada arquivo mestre a traduzir, juntamente com parâmetros específicos.

Todas as linhas contêm um comando entre colchetes, seguido dos seus parâmetros. Os comentários começam com o caractere "#" e correm até ao fim da linha. Você pode escapar do fim da linha para espalhar um comando por várias linhas.

Encontrando os arquivos PO e POT

A solução mais simples é fornecer o caminho para o diretório que contém o seu projeto de tradução da seguinte maneira.

 [po_directory] man/po/

O diretório fornecido deve conter um conjunto de arquivos PO, cada um chamado XX.po com "XX" o ISO 631-1 do idioma utilizado neste arquivo. O diretório deve conter também um único arquivo POT, com a extensão ".pot" file.

Se preferir, você pode dar as mesmas informações explicitamente como a seguir:

 [po4a_paths] man/po/project.pot de:man/po/de.po fr:man/po/fr.po

Isso especifica o caminho para o arquivo POT primeiro e, em seguida, os caminhos para os arquivos PO alemão e francês.

Finalmente, a mesma informação pode ser escrita da seguinte maneira:

 [po4a_langs] fr de
 [po4a_paths] man/po/project.pot $lang:man/po/$lang.po

O componente $lang é gasto automaticamente usando a lista de idiomas fornecidos, reduzindo o risco de erro de copiar/colar quando um novo idioma é adicionado.

Arquivos PO centralizados ou divididos?

Por padrão, o po4a produz um único arquivo PO por idioma de destino, contendo todo o conteúdo do seu projeto de tradução. Conforme o seu projeto cresce, o tamanho desses arquivos pode se tornar problemático. Ao utilizar weblate, é possível especificar prioridades para cada segmento de tradução (isto é, msgid), de modo que os importantes sejam traduzidos primeiro. Mesmo assim, algumas equipes de tradução preferem dividir o conteúdo em vários arquivos.

Para ter um arquivo PO por arquivo mestre, basta usar a string $master no nome dos arquivos PO na linha "[po4a_paths]", da seguinte maneira.

 [po4a_paths] doc/$master/$master.pot $lang:doc/$master/$lang.po

Se há conflitos no nome porque vários arquivos possuem o mesmo nome de arquivo, o nome do arquivo mestre pode ser especificado adicionando uma opção "master:file="name:

 [po4a_langs] de fr ja
 [po4a_paths] l10n/po/$master.pot $lang:l10n/po/$master.$lang.po
 [type: xml] foo/gui.xml $lang:foo/gui.$lang.xml master:file=foo-gui
 [type: xml] bar/gui.xml $lang:bar/gui.$lang.xml master:file=bar-gui

No modo de divisão, po4a cria um compêndio temporário durante a atualização do PO, para compartilhar as traduções entre todos os arquivos do pedido. Se dois arquivos PO tiverem traduções diferentes para a mesma string, po4a marcará essa string como difusa e enviará ambas as traduções em todos os arquivos PO que contêm essa string. Quando não é confundida pelo tradutor, a tradução é usada em todos os arquivos PO automaticamente.

Especificando os documentos para traduzir

Você também deve listar os documentos que devem ser traduzidos. Para cada arquivo mestre, você deve especificar o analisador de formato a ser usado, o local do documento traduzido a ser produzido e, opcionalmente, alguma configuração. Aqui está um exemplo:

 [type: sgml] doc/my_stuff.sgml fr:doc/fr/mon_truc.sgml \
              de:doc/de/mein_kram.sgml
 [type: man] script fr:doc/fr/script.1 de:doc/de/script.1
 [type: docbook] doc/script.xml fr:doc/fr/script.xml \
             de:doc/de/script.xml

Mas, novamente, essas linhas complexas são difíceis de ler e modificar, por exemplo, ao adicionar um novo idioma. É muito mais simples reorganizar as coisas usando o modelo $lang da seguinte maneira:

 [type: sgml]    doc/my_stuff.sgml $lang:doc/$lang/my_stuff.sgml
 [type: man]     script.1          $lang:po/$lang/script.1
 [type: docbook] doc/script.xml    $lang:doc/$lang/script.xml

Especificando opções

Há dois tipos de opções: opções do po4a são valores padrão para as opções de linha de comando po4a enquanto opções de formato são usadas para alterar o comportamento dos analisadores de formato. Como uma opções do po4a, você pode, por exemplo, especificar em seu arquivo de configuração que o valor padrão do parâmetro de linha de comando --keep é de 50% em vez de 80%. Opções de formato estão documentadas na página específica de cada módulo de análise, por exemplo, Locale::Po4a::Xml(3pm). Você pode, por exemplo, passar nostrip para o analisador XML para não remover os espaços ao redor das strings extraídas.

Você pode passar essas opções para um arquivo mestre específico, ou mesmo para uma tradução específica desse arquivo, usando "opt:" e "opt_XX:" para o idioma "XX". No exemplo a seguir, a opção nostrip é passada para o analisador XML (para todos os idiomas), enquanto o limite será reduzido para 0% para a tradução em francês (que, portanto, é sempre mantida).

 [type:xml] toto.xml $lang:toto.$lang.xml opt:"-o nostrip" opt_fr:"--keep 0"

De qualquer forma, esses blocos de configuração devem estar localizados no final da linha. A declaração dos arquivos deve vir primeiro, depois o adendo, se houver (veja abaixo), e somente as opções. O agrupamento de pedaços de configuração não é muito importante, pois os elementos são internamente concatenados como strings. Os exemplos a seguir são todos equivalentes:

  [type:xml] toto.xml $lang:toto.$lang.xml opt:"--keep 20" opt:"-o nostrip" opt_fr:"--keep 0"
  [type:xml] toto.xml $lang:toto.$lang.xml opt:"--keep 20 -o nostrip" opt_fr:"--keep 0"
  [type:xml] toto.xml $lang:toto.$lang.xml opt:--keep opt:20 opt:-o opt:nostrip opt_fr:--keep opt_fr:0

Observe que as opções específicas do idioma não são usadas ao criar o arquivo POT. Por exemplo, é impossível passar nostrip para o analisador apenas ao criar a tradução em francês, porque o mesmo arquivo POT é usado para atualizar todos os idiomas. Portanto, as únicas opções que podem ser específicas do idioma são as usadas na produção da tradução, como a opção "--keep".

Aliases de configuração

Para passar as mesmas opções para vários arquivos, o melhor é definir um alias de tipo da seguinte maneira. No próximo exemplo, "--keep 0" é passado para todas as traduções em italiano usando este tipo "test", que é uma extensão do tipo "man".

  [po4a_alias:test] man opt_it:"--keep 0"
  [type: test] man/page.1 $lang:man/$lang/page.1

Você também pode estender um tipo existente de reutilizar o mesmo nome para o alias da seguinte forma. Este não é interpretada como uma errônea definição recursiva.

  [po4a_alias:man] man opt_it:"--keep 0"
  [type: man] man/page.1 $lang:man/$lang/page.1

Opções padrão globais

Você também pode usar as linhas "[options]" para definir opções que devem ser usadas para todos os arquivos, independentemente do seu tipo.

  [options] --keep 20 --option nostrip

Como nas opções da linha de comando, você pode abreviar os parâmetros passados no arquivo de configuração:

  [options] -k 20 -o nostrip

Prioridades das opções

As opções de todas as fontes são concatenadas, garantindo que os valores padrão possam ser facilmente substituídos por opções mais específicas. A ordem é a seguinte:

  • As linhas "[options]" fornecem valores padrão que podem ser substituídos por qualquer outra fonte.
  • Os aliases de tipo são então usados. As configurações específicas do idioma substituem as aplicáveis a todos os idiomas.
  • As configurações específicas de um determinado arquivo mestre substituem as padrão e as provenientes do alias de tipo. Também neste caso, as configurações específicas do idioma substituem as globais.
  • Finalmente, os parâmetros fornecidos na linha de comando po4a substituem quaisquer configurações do arquivo de configuração.

Exemplo

Aqui está um exemplo mostrando como citar os espaços e aspas:

 [po_directory] man/po/
 
 [options] --master-charset UTF-8
 
 [po4a_alias:man] man opt:"-o \"mdoc=NAME,SEE ALSO\""
 [type:man] t-05-config/test02_man.1 $lang:tmp/test02_man.$lang.1 \
            opt:"-k 75" opt_it:"-L UTF-8" opt_fr:--verbose

Adendo: Acréscimo de conteúdo extra na tradução

Se você deseja adicionar uma seção extra à tradução, por exemplo, para dar crédito ao tradutor, é necessário definir um adendo à linha que define seu arquivo mestre. Consulte a página po4a(7) para obter mais detalhes sobre a sintaxe dos arquivos de adendo.

 [type: pod] script fr:doc/fr/script.1 \
             add_fr:doc/l10n/script.fr.add

Você também pode usar modelos de idioma da seguinte maneira:

 [type: pod] script $lang:doc/$lang/script.1 \
             add_$lang:doc/l10n/script.$lang.add

Se um adendo não se aplicar, a tradução será descartada.

Modificadores para a declaração de adendo

Os modificadores de adendo podem simplificar o arquivo de configuração no caso em que nem todos os idiomas fornecem um adendo ou quando a lista de adendos muda de um idioma para o outro. O modificador é um único caractere localizado antes do nome do arquivo.

?
Inclua addendum_path se esse arquivo não existir, do contrário nada para fazer.
@
addendum_path não é um adendo regular, mas um arquivo contendo uma lista de adendos, uma por linha. Cada adendo pode ser precedido por modificadores.
!
addendum_path está descartado, ele não é carregado e não vai ser carregado por qualquer uma especificação de adendo.

O seguinte inclui um adendo em qualquer idioma, mas se existir. Nenhum erro será relatado se o adendo não existir.

 [type: pod] script $lang:doc/$lang/script.1  add_$lang:?doc/l10n/script.$lang.add

O seguinte inclui uma lista de adendos para cada idioma:

 [type: pod] script $lang:doc/$lang/script.1  add_$lang:@doc/l10n/script.$lang.add

Filtrando as strings traduzidas

Às vezes, você deseja ocultar algumas strings do processo de tradução. Nesse sentido, você pode atribuir um parâmetro "pot_in" ao seu arquivo mestre para especificar o nome do arquivo a ser usado em vez do mestre real ao criar o arquivo POT. Aqui está um exemplo:

  [type:docbook] book.xml          \
          pot_in:book-filtered.xml \
          $lang:book.$lang.xml

Com essa configuração, as strings a serem traduzidas serão extraídas do book-filter.xml (que deve ser produzido antes da chamada de po4a) enquanto os arquivos traduzidos serão compilados a partir do book.xml. Como resultado, qualquer string que faça parte de book.xml, mas não em book-filter.xml não será incluída nos arquivos PO, impedindo que os tradutores forneçam uma tradução para eles. Portanto, essas strings não serão modificadas ao produzir os documentos traduzidos. Isso naturalmente diminui o nível de tradução, portanto, você pode precisar da opção "--keep" para garantir que o documento seja produzido de qualquer maneira.

EXEMPLO DE CONFIGURAÇÃO

A Fazer: Esta seção é realmente útil?

Vamos presumir que você mantém um programa chamado foo, o qual possui uma página man man/foo.1, a qual naturalmente é mantida em inglês somente. Agora você, como o mantenedor upstream ou downstream, quer criar e manter a tradução. Primeiro você precisa criar o arquivo POT necessário para enviar os tradutores usando po4a-gettextize(1).

Então, para o nosso caso, chamaríamos

 cd man && po4a-gettextize -f man -m foo.1 -p foo.pot

Você iria, então, enviar esse arquivo para as listas de idiomas apropriadas ou oferecê-lo para download em algum lugar na sua página web.

Agora, vamos presumir que você recebeu três traduções antes de seu próximo lançamento: de.po (includindo um adendo de.add), sv.po e pt.po. Considerando que você não quer alterar seu Makefile(s) quando uma nova tradução aparece, você pode usar o po4a com um arquivo de configuração apropriada em seu Makefile. Vamos chamá-lo de po4a.cfg. Em nosso exemplo, ele se pareceria com o seguinte:

 [po_directory] man/po4a/po/

 [type: man] man/foo.1 $lang:man/translated/$lang/foo.1 \
            add_$lang:?man/po4a/add_$lang/$lang.add opt:"-k 80"

Neste exemplo, nós presumimos que suas páginas man geradas (e todos os arquivos PO e de adendos) deveriam estar armazenadas em man/translated/$lang/ (respectivamente em man/po4a/po/ e man/po4a/add_$lang/) abaixo do diretório atual. Em nosso exemplo, o diretório de man/po4a/po/ iria incluir de.po, pt.po e sv.po, e o diretório de man/po4a/add_de/ iria incluir de.add.

Note que o uso do modificador ? em apenas tradução em alemão (de.po) é acompanhada por um adendo.

Para atualmente compilar as páginas man traduzidas você iria, então, adicionar (uma só vez!) a seguinte linha no alvo build do Makefile apropriado:

        po4a po4a.cfg

Assim que isso estiver sido configurado, você não precisa tocar no Makefile quando uma nova tradução aparecer , i.e. se o time francês enviar a você fr.po e fr.add, você iria simplesmente colocá-las respectivamente em man/po4a/po/ e man/po4a/add_fr/ e o a próxima vez que o programa for compilado, a tradução em francês também será compilada automaticamente em man/translated/fr/.

Note que você ainda precisaria de um alvo apropriado para instalar páginas de manuais localizados com os em inglês.

Finalmente, se você não armazena arquivos gerados em seu sistema de controle de versão, você vai precisar de uma linha em seu alvo clean também: -rm -rf man/translated

VEJA TAMBÉM

po4a-gettextize(1), po4a-normalize(1), po4a-translate(1), po4a-updatepo(1), po4a(7).

AUTORES

 Denis Barbier <barbier@linuxfr.org>
 Nicolas François <nicolas.francois@centraliens.net>
 Martin Quinson (mquinson#debian.org)

COPYRIGHT E LICENÇA

Copyright 2002-2020 por SPI, inc.

Esse programa é um software livre; você pode redistribuí-lo e/ou modificá-lo sob os termos da GPL (veja o arquivo COPYING).

2020-08-05 Ferramentas do Po4a