Manpages

NOME

po4a - atualizar ambos os ficheiros PO e documentos traduzidos numa só vez

SINOPSE

po4a [options] config_file

DESCRIÇÃO

po4a ( PO for anything) facilita a manutenção de tradução da documentação usando as ferramentas clássicas do gettext. A característica principal 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 executa o programa po4a pela primeira vez, com apenas um ficheiro de configuração e os documentos para traduzir (chamados de documentos mestres), ele produz um ficheiro POT (também chamado de modelo de tradução) que contém todas as cadeias traduzíveis no documento de uma forma que facilita o trabalho dos tradutores.

Esses ficheiros 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 ficheiros PO, um por idioma.

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

Se os documentos mestre forem alterados, o po4a atualizará os ficheiros 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 ficheiro PO ).

Por predefeiniçã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 utilizadores finais.

Visão geral gráfica

 master documents ---+---->-------->---------+
  (doc authoring)    |                       |
                     V   (po4a executions)   >-----+--> translations
                     |                       |     |
 existing PO files -->--> updated PO files >-+     |
      ^                            |               |
      |                            V               |
      +----------<---------<-------+               ^
       (manual translation process)                |
                                                   |
 addendum -->--------------------------------------+

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

OPÇÕES

-k, --keep

Minimal threshold for translation percentage to keep (i.e. write) the resulting file (default: 80). I.e. by default, files have to be translated at least at 80% to be written on disk.

-h, --help

Mostrar uma pequena mensagem de ajuda.

-M, --master-charset

Charset of the files containing the documents to translate. Note that all master documents must use the same charset.

-L, --localized-charset

Charset of the files containing the localized documents. Note that all translated documents will use the same charset.

-A, --addendum-charset

Conjunto de carateres da adenda. Note-se que todas as adendas devem estar no mesmo conjnto de carateres.

-V, --version

Mostrar a versão do script e sair

-v, --verbose

Aumentar o detalhe do programa.

-q, --quiet

Diminuir o detalhe do programa.

-d, --debug

Saída de alguma informação de depuração.

-o, --option

Extra option(s) to pass to the format plugin. See the documentation of each plugin for more information about the valid options and their meanings. For example, you could pass ’-o tablecells’ to the AsciiDoc parser, while the text parser would accept ’-o tabs=split’.

-f, --force

Gera sempre os ficheiros POT e PO, mesmo se po4a considera que não é necessário.

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

If the POT file already exists, it is regenerated if a master document or the configuration file is more recent (unless --no-update is provided). The POT file is also written in a temporary document and po4a verifies that the changes are really needed.

Além disso, uma tradução é regenerada somente se o seu documento mestre, o ficheiro PO, uma das suas adendas ou o ficheiro de configuração é mais recente. Para evitar tentar regenerar traduções que não passam no teste de limite (ver --keep), um ficheiro com a extensão .po4a-stamp pode ser criado (ver --stamp).

Se um documento mestre inclui ficheiros, você deve usar a flag --force porque o tempo de modificação dos ficheiros incluídos não são tomados emconta.

Os ficheiros PO são sempre regenerados com base em POT com msgmerge -U.

--stamp

Diz po4a para criar ficheiros de informação quando uma tradução não é gerada porque não atingiu o limiar. Esses ficheiros de informação são nomeados de acordo com o documento traduzido esperado, com a extensão .po4a-stamp.

Nota: Isso só ativa a criação dos ficheiros .po4a-stamp. Os ficheiros de informação são sempre utilizados se existirem, e são removidos com --rm-translations ou quando o ficheiro é finalmente traduzido.

--no-translations

Não gerar os documentos traduzidos, apenas atualizar os ficheiros POT e PO.

--no-update

Não altere os ficheiros POT e PO, apenas a tradução pode ser atualizada.

--keep-translations

Keeps the existing translation files even if the translation doesn’t meet the threshold specified by --keep. This option does not create new translation files with few content, but it will save existing translations which decay because of changes to the master files.

ATENÇÃO: Esta opção muda o comportamento do po4a de uma maneira bastante drástica: seus ficheiros 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

Remover os ficheiros traduzidos (implica --no-translations).

--no-backups

Esta flag não faz nada desde 0.41, e pode ser removida em versões posteriores.

--rm-backups

Esta flag não faz nada desde 0.41, e pode ser removida em versões posteriores.

--translate-only translated-file

Traduzir apenas o ficheiro especificado. Pode ser útil para acelerar o processamento se um ficheiro de configuração contém muitos ficheiros. Note que o que esta opção faz não é possível atualizar ficheiros PO e POT. Esta opção pode ser usada várias vezes.

--variable var=value

Definir uma variável que será expandida no ficheiro de configuração po4a.Cada ocorrência de $(var) será substituída por value. Esta opção pode ser usada várias vezes.

--srcdir SRCDIR

Set the base directory for all input documents specified in the po4a configuration file.

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

--destdir DESTDIR

Set the base directory for all the output documents specified in the po4a configuration file (see --srcdir above).

Opções que modificam o cabeçalho do POT
--porefs type

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 ficheiro 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 (predefinição: 76)

Especifica como o ficheiro po deve ter sua quebra de linha. Isso permite escolher entre ficheiros que tem boa quebra de linha, mas que podem levar a conflitos de git ou ficheiros que são mais fáceis de manipular automaticamente, mas mais difíceis de ler para humanos.

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

Language of the source files containing the documents to translate. Note that all master documents must use the same language.

--msgid-bugs-address email@address

Definir o endereço do relatório para msgid bugs. Por padrão, os ficheiros POT criados não têm campos Report-Msgid-bugs-To.

--copyright-holder string

Definir o titular dos direitos de autor no cabeçalho POT. O valor padrão é " Free Software Foundation, Inc."

--package-name string

Definir o nome do pacote para o cabeçalho POT. O padrão é " PACOTE".

--package-version string

Definir o nome do pacote para o cabeçalho POT. O padrão é "VERSÃO".

Opções para modificar os ficheiros PO
--msgmerge-opt options

Opções extra para msgmerge(1).

Nota: $lang será estendida para o idioma atual.

--no-previous

Esta opção remove --previous a partir das opções passadas para B <msgmerge> Isto permite suportar versões do gettext mais cedo do que 0.16.

--previous

Esta opção acrescenta --previous ás opções passadas para msgmerge. Isso requer gettext 0.16 ou posterior, e é ativado por padrão.

CONFIGURATION FILE

po4a espera um ficheiro de configuração como argumento. Este ficheiro deve conter os elementos seguintes:

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

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

 [po_directory] man/po/

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

Se preferir, 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

Isto especifica o caminho para o ficheiro POT primeiro e, em seguida, os caminhos para os ficheiros PO alemães e francêses.

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

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

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

Ficheiros PO centralizados ou divididos?

Por predefinição, o po4a produz um único ficheiro PO por idioma de destino, contendo todo o conteúdo do seu projeto de tradução. Conforme o seu projeto cresce, o tamanho desses ficheiros pode tornar-se 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 equipas de tradução preferem dividir o conteúdo em vários ficheiros.

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

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

Se há conflitos no nome porque vários ficheiros possuem o mesmo nome de ficheiro, o nome do ficheiro 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

In split mode, po4a builds a temporary compendium during the PO update, to share the translations between all the PO files. If two PO files have different translations for the same string, po4a will mark this string as fuzzy and will submit both translations in all the PO files containing this string. When unfuzzied by the translator, the translation is automatically used in every PO files.

Especificando os documentos para traduzir
Também deve listar os documentos que devem ser traduzidos. Para cada ficheiro mestre, deve especificar o analisador de formato a ser usado, o local do documento traduzido a ser produzido e, opcionalmente, uma 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 maneira seguinte:

 [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

Specifying options
Há dois tipos de opções: opções do po4a são valores predefinidos 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, pode, por exemplo, especificar no seu ficheiro de configuração que o valor predefinido 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). Pode, por exemplo, passar nostrip para o analisador XML para não remover os espaços ao redor das cadeias extraídas.

Pode passar essas opções para um ficheiro mestre específico ou mesmo para uma tradução específica desse ficheiro, 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 ficheiros 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 cadeias. 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 ficheiro POT. Por exemplo, é impossível passar nostrip para o analisador apenas ao criar a tradução em francês, porque o mesmo ficheiro 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".

Configuration aliases

Para passar as mesmas opções para vários ficheiros, o melhor é definir um alias de tipo da maneira seguinte. 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

Também pode estender um tipo existente de reutilizar o mesmo nome para o alias da forma seguinte. 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 predefinidas globais

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

  [options] --keep 20 --option nostrip

Como nas opções da linha de comando, pode abreviar os parâmetros passados no ficheiro 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 predefinidos possam ser facilmente substituídos por opções mais específicas. A ordem é a seguinte:

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

Addendum: Adding extra content in the translation
Se deseja adicionar uma secção adicional à tradução, por exemplo, para dar mérito ao tradutor, é necessário definir um adendo à linha que define o seu ficheiro mestre. Consulte a página po4a(7) para obter mais detalhes sobre a sintaxe dos ficheiros de adendo.

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

Também pode usar modelos de idioma da maneira seguinte:

 [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 ficheiro 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 ficheiro.

O seguinte inclui um adendo em qualquer idioma, mas só 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

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

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

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

CONFIGURATION EXAMPLE
A FAZER: Esta secção é realmente útil?

Vamos supor que você mantém um programa chamado foo que tem uma página do manual man/foo.1 que naturalmente, é mantida apenas em Inglês. Agora você como gestor do upstream ou downstream quer criar e manter a tradução. Primeiro precisa criar o ficheiro POT necessário para enviar para 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ê teria então que enviar este ficheiro para as listas de idiomas adequadas ou oferecê-lo para descarregar em algum lugar do seu site.

Agora, vamos supor que você recebeu três traduções antes do seu próximo lançamento: de.po (incluindo uma adenda de.add), sv.po e pt.po. Desde que não queira mudar o seu Makefile(s) sempre que uma nova tradução chega, pode usar po4a com um ficheiro de configuração apropriado no seu Makefile. Vamos chamá-lo po4a.cfg. No nosso exemplo seria algo como 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, vamos supor que suas páginas de manual geradas (e todos ficheiros PO e adendas) devem ser armazenadas em man/translated/$lang/ (respectivamente em man/po4a/po/ e man/po4a/add_$lang/) abaixo do diretório atual. No nosso exemplo o diretório man/po4a/po/ incluiria de.po, pt.po e sv.po, e o diretório man/po4a/add_de/ incluiria F <de.add>.

Observe o uso do modificador ? apenas como a tradução alemã (de.po) é acompanhado por uma adenda.

Para realmente construir as páginas do manual traduzidas você então (uma vez!) adiciona a seguinte linha no ponto 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 precisa de um destino apropriado para instalar páginas do manual localizadas em Inglês.

Finalmente, se você não armazenar ficheiros gerados no seu sistema de controlo de versão, vai precisar de uma linha no seu ponto clean bem como:
-rm -rf man/translated

VER TAMBÉM

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

AUTORES

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

DIREITOS DE AUTOR E LICENÇA

Direitos de Autor 2002-2020 por SPI, inc.

Este programa é software livre, você pode redistribuí-lo e/ou modificá-lo sob os termos da GPL (consulte o ficheiro CÓPIA).