Formatos suportados¶

Atualmente, essa abordagem tem sido implementada com sucesso em vários formatos de formatação de texto:

man (analisador maduro)

O bom e velho formato de páginas de manual, usado por muitos programas por aí. Suporte do po4a é muito bem-vindo, considerando que esse formato é de certa forma difícil de usar e não exatamente amigável para novatos.

O módulo Locale::Po4a::Man(3pm) também possui suporte ao formato mdoc usado pelas páginas man do BSD (elas também são bastante comuns no Linux).

AsciiDoc (analisador maduro)

Esse formato é um formato de marcação leve, destinado a facilitar a criação da documentação. Por exemplo, é usado para documentar o sistema git. Essas páginas man são traduzidas usando po4a.

Veja Locale::Po4a::AsciiDoc para detalhes.

pod (analisador maduro)

Esse é o formato da documentação online de Perl, ou Perl Online Documentation. A própria linguagem e extensões são documentadas usando este formato além da maioria dos scripts Perl existentes. Isso facilita a manter a documentação ferto do real código embutindo-os no mesmo arquivo. Isso torna a vida dos programadores mais fácil, mas infelizmente, não a do tradutor, até você usar o po4a.

Veja Locale::Po4a::Pod para detalhes.

sgml (analisador maduro)

Mesmo que substituído pelo XML hoje em dia, esse formato ainda é usado para documentos que têm mais de algumas telas. Pode até ser usado para livros completos. Documentos deste comprimento podem ser muito desafiadores para atualizar. diff muitas vezes revela inútil quando o texto original era recuado novamente após a atualização. Felizmente, po4a pode lhe ajudar depois desse processo.

Atualmente, há suporte apenas ao DebianDoc e o DocBook DTD, mas a adição de suporte a um novo é realmente fácil. É possível até mesmo usar po4a em um SGML DTD desconhecido sem alterar o código, desde que sejam fornecidas as informações necessárias na linha de comando. Veja Locale::Po4a::Sgml(3pm) para mais detalhes.

TeX / LaTeX (analisador maduro)

O formato LaTeX é um formato de documentação mais usado no mundo de software livre e para publicações.

O módulo Locale::Po4a::LaTeX(3pm) foi testado com a documentação do Python, um livro e algumas apresentações.

text (analisador maduro)

O formato Text é of formato base para muitos formatos que incluem longos blocos de texto, incluindo Markdown, fortunes, seção de página de rotos YAML, debian/changelog e debian/control.

Este possui suporte ao formato comum usado em geradores de sites estáticos, READMEs e outros sistemas de documentação. Consulte Locale::Po4a::Text(3pm) para detalhes.

xml e XHMTL (analisador provavelmente maduro)

O formato XML é um formato base para muitos formatos de documentação.

Atualmente, o DocBook DTD (veja Locale::Po4a::Docbook(3pm) para mais detalhes) e XHTML são suportados pelo po4a.

BibTex (analisador provavelmente maduro)

O formato BibTex é usado junto com o LaTex para formatar listas de referências (bibliografias).

Veja Locale::Po4a::BibTex para detalhes.

Docbook (analisador provavelmente maduro)

Uma linguagem de marcação baseada em XML que usa tags semânticas para descrever documentos.

Veja Locale::Po4a:Docbook para mais detalhes.

Guide XML (analisador provavelmente maduro)

Um formato de documentação XML. Este módulo foi desenvolvido especificamente para ajudar no suporte e manutenção de traduções da documentação do Gentoo Linux até pelo menos março de 2016 (baseado na máquina Wayback). Desde então, o Gentoo mudou para o formato DevBook XML.

Veja Locale::Po4a:Guide para mais detalhes.

Wml (analisador provavelmente maduro)

A Web Markup Language, não confunda WML com o material WAP usado em telefones celulares. Este módulo depende do módulo Xhtml, que por sua vez depende do módulo XmL.

Veja Locale::Po4a::Wml para mais detalhes.

Yaml (analisador provavelmente maduro)

Um superconjunto estrito de JSON. YAML é frequentemente usado como sistemas ou projetos de configuração. YAML está no cerne do Ansible da Red Hat.

Veja Locale::Po4a::Yaml para mais detalhes.

RubyDoc (analisador provavelmente maduro)

O formato Ruby Document (RD), originalmente o formato de documentação padrão para Ruby e projetos Ruby antes de ser convertido para RDoc em 2002. Embora aparentemente a versão japonesa do Manual de Referência Ruby ainda use RD.

Veja Locale::Po4a::RubyDoc para mais detalhes.

Halibut (analisador altamente experimental)

Um sistema de produção de documentação, com elementos semelhantes ao TeX, debiandoc-sgml, TeXinfo e outros, desenvolvido por Simon Tatham, o desenvolvedor do PuTTY.

Veja Locale::Po4a:Halibut para mais detalhes.

Ini (analisador altamente experimental)

Formato de arquivo de configuração popularizado pelo MS-DOS.

Veja Locale::Po4a::Ini para mais detalhes.

texinfo (analisador altamente experimental)

Toda a documentação do GNU é escrita neste formato (esse é até mesmo um dos requisitos para se tornar um projeto GNU oficial). O suporte a Locale::Po4a::Texinfo(3pm) no po4a ainda está nas fases iniciais. Por favor relate eventuais erros e requisição por recursos.

Outros formatos com suporte

Po4a também pode manipular alguns formatos mais raros ou especializados, como a documentação de opções de compilação dos kernels Linux 2.4+ (Locale::Po4a::KernelHelp) ou diagramas produzidos pela ferramenta Dia (Locale::Po4a:Dia). A adição de um novo formato é normalmente muito fácil e a tarefa principal é fazer um analisador para seu formato alvo. Veja Locale::Po4a::TransTractor(3pm) para mais informações sobre isso.

Formatos sem suporte

Infelizmente, po4a ainda carece de suporte para vários formatos de documentação. Muitos deles seriam fáceis de dar suporte no po4a. Isso inclui formatos não apenas usados para documentação, como, descrições de pacotes (deb e rpm), perguntas sobre scripts de instalação de pacotes, changelogs de pacotes e todos os formatos de arquivo especializados usados por programas como cenários de jogos ou arquivos de recursos de vinho.

Visão geral gráfica dos scripts do po4a¶

O esquema a seguir fornece uma visão geral de como cada script po4a pode ser usado. Aqui, master.doc é um nome de exemplo para a documentação a ser traduzida; XX.doc é o mesmo documento traduzido no idioma XX, enquanto doc.XX.po é o catálogo de traduções desse documento no idioma XX. Os autores da documentação se preocuparão principalmente com master.doc (que pode ser uma página man, um documento XML, um arquivo asciidoc ou semelhante); os tradutores se preocuparão principalmente com o arquivo PO, enquanto os usuários finais verão apenas o arquivo XX.doc.

                                   mestre.doc
                                       |
                                       V
     +<-----<----+<-----<-----<--------+------->-------->-------+
     :           |                     |                        :
 {tradução}      |       { atualização de mestre.doc }          :
     :           |                     |                        :
   XX.doc        |                     V                        V
 (opcional)      |                 mestre.doc ->-------->------>+
     :           |                  (novo)                      |
     V           V                     |                        |
  [po4a-gettextize]  doc.XX.po---->+   |                        |
          |           (velho)      |   |                        |
          |              ^         V   V                        |
          |              |     [po4a-updatepo]                  |
          V              |           |                          V
     tradução.pot        ^           V                          |
          |              |       doc.XX.po                      |
          |              |       (incerto)                      |
     { tradução }        |           |                          |
          |              ^           V                          V
          |              |    {edição manual}                   |
          |              |           |                          |
          V              |           V                          V
      doc.XX.po --->---->+<---<-- doc.XX.po    adendo      mestre.doc
      (inicial)                 (atualizado)  (opcional)  (atualizado)
          :                          |            |             |
          :                          V            |             |
          +----->----->----->------> +            |             |
                                     |            |             |
                                     V            V             V
                                     +------>-----+------<------+
                                                  |
                                                  V
                                           [po4a-translate]
                                                  |
                                                  V
                                                XX.doc
                                            (atualizado)

Esse esquema é complicado, mas na prática apenas a parte correta (envolvendo po4a-updatepo(1) e po4a-translate(1)) é usada depois que o projeto é instalado e configurado.

A parte esquerda mostra como po4a-gettextize(1) pode ser usado para converter um projeto de tradução existente para a infraestrutura do po4a. Este script pega um documento original e seu equivalente traduzido, e tenta construir o arquivo PO correspondente. Tal conversão manual é um pouco trabalhosa (veja a documentação po4a-gettextize(1) para mais detalhes), mas só é necessária uma vez para converter suas traduções existentes. Se você não tem nenhuma tradução para converter, você pode esquecer isso e focar na parte certa do esquema.

Na parte superior direita, a ação do autor original está descrita, atualização da documentação. A parte do meio, à direita, representa as ações automáticas do po4a-updatepo(1). Os novos materiais são extraídos e comparados com a tradução existente. A tradução anterior é usado para as partes que não foram alteradas, enquanto partes parcialmente modificadas também são conectadas à tradução anterior com uma marcação "fuzzy" indicando que a tradução deve ser atualizada. Material novo ou muito modificado é deixado sem tradução.

Então, a edição manual relatada representa a ação dos tradutores, que modificam os arquivo PO para fornecer traduções para toda string e parágrafo originais. Isso pode ser feito usando um editor específico, como o Editor de Tradução do GNOME, o Lokalize do KDE ou poedit, ou usando uma plataforma de localização online como o weblate ou pootle. O resultado da tradução é um conjunto de arquivos PO, um por idioma. Consulte a documentação gettext para mais detalhes.

A parte inferior da figura mostra como po4a-translate(1) cria um documento fonte traduzido do documento original master.doc e do catálogo de traduções doc.XX.po que foram atualizados pelos tradutores . A estrutura do documento é reutilizada, enquanto o conteúdo original é substituído por sua contraparte traduzida. Opcionalmente, um adendo pode ser usado para adicionar um texto extra à tradução. Isso geralmente é usado para adicionar o nome do tradutor ao documento final. Veja abaixo os detalhes.

Como observado anteriormente, o programa po4a(1) combina os efeitos dos scripts separados, atualizando os arquivos PO e o documento traduzido em uma chamada. A lógica subjacente permanece a mesma.

Iniciando uma nova tradução¶

Se você usar po4a(1), não há etapa específica para iniciar uma tradução. Você apenas precisa listar os idiomas no arquivo de configuração, e os arquivos PO ausentes são criados automaticamente. Naturalmente, o tradutor deve fornecer traduções para todos os conteúdos usados em seus documentos. po4a(1) também cria um arquivo POT, que é um arquivo de modelo de PO. Tradutores em potencial podem traduzir seu projeto para um novo idioma renomeando esse arquivo e fornecendo as traduções no idioma deles.

Se você preferir usar os scripts individuais separadamente, use po4a-gettextize(1) da seguinte maneira para criar o arquivo POT. Este arquivo pode ser copiado em XX.po para iniciar uma nova tradução.

  $ po4a-gettextize --format <formato> --master <mestre.doc> --po <tradução.pot>

O documento mestre é usado na entrada, enquanto o arquivo PO é a saída deste processo.

Integrando alterações ao documento original¶

O script a ser usado para isso é po4a-updatepo(1) (consulte a documentação para obter detalhes):

  $ po4a-updatepo --format <formato> --master <novo_mestre.doc> --po <doc_antigo.XX.po>

O documento mestre é usado na entrada, enquanto o arquivo PO é atualizado: ele é usado tanto na entrada quanto na saída.

Gerando um documento traduzido¶

Assim que você finalizar com a tradução, você quer pegar a documentação traduzida e distribuí-la para os usuários junto com o original. Para isso, use o programa po4a-translate(1) da seguinte forma:

  $ po4a-translate --format <formato> --master <mestre.doc> --po <doc.XX.po> --localized <XX.doc>

Os arquivos mestre e PO são usados na entrada, enquanto o arquivo localizado é a saída desse processo.

Usando adendos para adicionar texto extra às traduções¶

Adicionar novo texto à tradução é provavelmente a única coisa mais fácil a longo prazo quando você traduz arquivos manualmente :). Isso acontece quando você deseja adicionar uma seção extra ao documento traduzido, que não corresponde a nenhum conteúdo no documento original. O caso de uso clássico é dar créditos à equipe de tradução e indicar como relatar problemas específicos da tradução.

Com o po4a, é necessário especificar os arquivos addendum, que podem ser vistos conceitualmente como patches aplicados ao documento localizado após o processamento. Cada adendo deve ser fornecido como um arquivo separado, cujo formato é, no entanto, muito diferente dos patches clássicos. A primeira linha é uma linha de cabeçalho, definindo o ponto de inserção do adendo (com uma sintaxe infelizmente enigmática -- veja abaixo) enquanto o restante do arquivo é adicionado literalmente na posição determinada.

A linha do cabeçalho deve começar com a string PO4A-HEADER:, seguida por uma lista separada por ponto e vírgula dos campos chave=valor.

Por exemplo, o cabeçalho a seguir declara um adendo que deve ser colocado bem no final da tradução.

 PO4A-HEADER: mode=eof

As coisas ficam mais complexas quando você deseja adicionar seu conteúdo extra no meio do documento. O cabeçalho a seguir declara um adendo que deve ser colocado após a seção XML que contém a string "Sobre este documento" na tradução.

 PO4A-HEADER: position=Sobre este documento; mode=after; endboundary=</section>

Na prática, ao tentar aplicar um adendo, o po4a pesquisa a primeira linha correspondente ao argumento "position" (isso pode ser um regexp). Não esqueça que o po4a considera o documento translated aqui. Esta documentação está em inglês, mas sua linha provavelmente deve ser a seguinte, se você pretende que seu adendo se aplique à tradução em francês do documento.

 PO4A-HEADER: position=À propos de ce document; mode=after; endboundary=</section>

Depois que a "position" é encontrada no documento de destino, o po4a procura a próxima linha após a "position" que corresponde ao "endboundary" fornecido. O adendo é adicionado à direita after essa linha (porque fornecemos um endboundary, ou seja, um limite que termina a seção atual).

O exato mesmo efeito pode ser obtido com o seguinte cabeçalho, que é equivalente:

 PO4A-HEADER: position=About this document; mode=after; beginboundary=<section>

Aqui, o po4a pesquisa a primeira linha correspondente a "<section"> após a linha correspondente a "About this document" na tradução e adicione o adendo before dessa linha, pois fornecemos um beginboundary, ou seja, um limite que marca o início da próxima seção. Portanto, essa linha de cabeçalho exige a inserção do adendo após a seção que contém "About this document" e instrui o po4a que uma seção começa com uma linha que contém a tag "<section">. Isso é equivalente ao exemplo anterior, porque o que você realmente deseja é adicionar este adendo após "/section"> ou antes de "<section">.

Você também pode definir a inserção modo como o valor "before", com uma semântica semelhante: a combinação de "mode=before" com um "endboundary" colocará o adendo apenas after o limite correspondente, que a última linha limite potencial antes da "position". Combinar "mode=before" com um "beginboundary" colocará o adendo apenas before do limite correspondente, que é a última linha limite potencial antes da "position".

  Modo   | Tipo de limite |       Limite usado         | Ponto de inserção am comparação ao limite
 ========|================|============================|==========================================
 'before'| 'endboundary'  | último antes de 'position' | Logo após o limite selecionado
 'before'|'beginboundary' | último antes de 'position' | Logo antes do limite selecionado
 'after' | 'endboundary'  |  primeiro após 'position'  | Logo após o limite selecionado
 'after' |'beginboundary' |  primeiro após 'position'  | Logo antes do limite selecionado
 'eof'   |   (none)       |  n/d                       | Fim do arquivo

Dicas e truques sobre adendos

• Lembre-se de que estes são regexp. Por exemplo, se você deseja combinar o final de uma seção nroff que termina com a linha ".fi", não use ".fi" como endboundary porque ele vai corresponder a "the[ fi]le", o que obviamente não é o que está esperando. O endboundary correto neste caso é: "^\.fi$".
• Espaços em branco SÃO importantes no conteúdo da "position" e limites. Portanto, as duas linhas seguintes são diferentes. O segundo só será encontrado se houver espaços à direita suficientes no documento traduzido.

   PO4A-HEADER: position=Sobre este documento; mode=after; beginboundary=<section>
   PO4A-HEADER: position=Sobre este documento; mode=after; beginboundary=<section>
      

• Embora essa pesquisa de contexto possa ser considerada como operando aproximadamente em cada linha do documento traduzido, ela realmente opera na cadeia de dados interna do documento traduzido. Essa cadeia de dados interna pode ser um texto abrangendo um parágrafo contendo várias linhas ou pode ser uma tag XML sozinha. O exato ponto de inserção do adendo deve ser anterior ou posterior à sequência de dados interna e não pode estar dentro da cadeia de dados interna.
• Passe o argumento -vv para po4a para entender como os adendos são adicionados à tradução. Também pode ajudar a executar po4a no modo de depuração para ver a string de dados interna real quando o seu adendo não se aplica.

Exemplos de adendos

• Se você quiser adicionar alguma coisa após a seção nroff a seguir:

    .SH "AUTHORS"
      

  Você deve selecionar uma abordagem em duas etapas configurando mode=after. Em seguida, você deve restringir a pesquisa à linha após AUTHORS com a regex de argumento position. Então, você deve combinar o início da próxima seção (isto é, ^ \. SH) com a regex de argumento beginboundary. Isso é para dizer:

   PO4A-HEADER:mode=after;position=AUTHORS;beginboundary=\.SH
      

• Se você quiser adicionar alguma coisa após a linha dada (ex,. após a linha "Copyright Grande Cara") use um position correspondendo a esta linha, mode=after e forneça um beginboundary correspondendo a qualquer linha.

   PO4A-HEADER:mode=after;position=Copyright Grande Cara, 2004;beginboundary=^
      

• Se você quiser adicionar alguma coisa ao final do documento, forneça um position correspondendo a qualquer linha do seu documento (mas apenas uma linha. Po4a não vai proceder se ela não for única), e forneça um endboundary correspondendo a nada. Não use strings simples aqui como "EOF", e sim prefira aquelas que possuem menos chance de estar no seu documento.

   PO4A-HEADER:mode=after;position=Sobre este documento;beginboundary=FakePo4aBoundary
      

Exemplo mais detalhado

Documento original (formatado em POD):

 |=head1 NAME
 |
 |dummy - a dummy program
 |
 |=head1 AUTHOR
 |
 |me

Então, o adendo a seguir vai assegurar que a seção (em Francês) sobre o tradutor seja adicionado ao final do arquivo (em Francês, "TRADUCTEUR" significa "TRADUTOR", e "moi" significa "eu").

 |PO4A-HEADER:mode=after;position=AUTEUR;beginboundary=^=head
 |
 |=head1 TRADUCTEUR
 |
 |moi
 |

Para colocar seu adendo antes do AUTHOR, use o seguinte cabeçalho:

 PO4A-HEADER:mode=after;position=NOM;beginboundary=^=head1

Isso funciona porque a próxima linha correspondendo ao beginboundary /^=head1/ após a seção "NAME" (traduzido para "NOM" em Francês) é aquela declarando os autores. Então, o adendo será colocado entre as duas seções. Note que se outra seção for adicionada entre as seções NAME e AUTHOR posteriormente, po4a colocará o adendo equivocadamente antes da nova seção.

Para evitar isto, você pode realizar o mesmo usando mode=before:

 PO4A-HEADER:mode=before;position=^=head1 AUTEUR

Como você pronuncia po4a?¶

Eu pessoalmente vocalizo-o como pouah <https://en.wiktionary.org/wiki/pouah>, que é um onomatopoético francês que usamos no lugar de "eca" :) eu posso ter um senso de humor estranho :)

E as outras ferramentas de tradução para documentação usando gettext?¶

There are a few of them. Here is a possibly incomplete list, and more tools are coming at the horizon.

poxml

Essa é a ferramenta desenvolvida pelo pessoal do KDE para manipular DocBook XML. Até onde eu sei, esse foi o primeiro programa a extrair strings para traduzir de documentação para arquivos PO, e a injetá-las de volta após a tradução.

Ela só consegue manipular XML e apenas um DTD em particular. Eu fico, particularmente, não gosto das listas de manipulação, que acabam com um grande msgid. Quando a lista fica grande, o fragmento se torna mais difícil de engolir.

po-debiandoc

Esse problema desenvolvido por Denis Barbier é uma espécie de precursor do módulo de SGML do po4a, o qual meio que torna-o (po-debiandoc) obsoleto. Como o nome já diz, ele linda apenas o DebianDoc DTD, o qual é meio que um DTD obsoleto.

xml2po.py

Used by the GIMP Documentation Team since 2004, works quite well even if, as the name suggests, only with XML files and needs specially configured makefiles.

Sphinx

The Sphinx Documentation Project also uses gettext extensively to manage its translations. Unfortunately, it works only for a few text formats, rest and markdown, although it is perhaps the only tool that does this managing the whole translation process.

As principais vantagens do po4a sobre eles é a facilidade de adição de conteúdo extra (o que é bem pior lá) e a habilidade de alcançar gettextização.

RESUMO das vantagens da abordagem baseada em gettext¶

• As traduções não são armazenadas junto do original, o que possibilita detectar se as traduções estão desatualizadas.
• As traduções são armazenadas em arquivos separados um dos outros, o que previne tradutores de idiomas diferentes interferir tanto quando da submissão do patch quanto a nível de codificação do arquivo.
• Ele é internamente baseado no gettext (mas po4a oferece uma interface bem simples, de forma que você não precisa entender as especificidades para usá-lo). Dessa forma, nós não temos que reinventar a roda e, por causa do seu amplo uso, nós podemos pensar que essas ferramentas meio que não tem erros.
• Nada mudou para o usuário final (além do fato de traduções estarem melhor mantidas, espero). o arquivo de documentação resultante distribuído é exatamente o mesmo.
• Não há necessidade de tradutores aprenderem um novo arquivo de sintaxe e seu editor de arquivos PO (como o modo PO do Emacs, Lokalize ou Gtranslator) vão funcionar muito bem.
• gettext oferece uma forma simples de obter estatísticas sobre o que está feito, o que deveria ser revisto e atualizado e o que ainda deve ser feito. Alguns exemplos podem ser encontrados nesses endereços:

   - https://docs.kde.org/stable5/pt_BR/kdesdk/lokalize/project-view.html
   - http://www.debian.org/intl/l10n/
      

Mas tudo tem seu lado negativo, e essa abordagem tem algumas desvantagens com as quais nós temos que lidar.

• Adendos são… estranhos à primeira vista.
• Você não pode adaptar o texto traduzido às suas preferências, com divisão de um parágrafo aqui e juntar outros dois ali. Mas de certa forma, se há um problema com o original, isso deveria ser relatado como um erro.
• Até mesmo com uma interface fácil, ainda é uma nova ferramenta que as pessoas precisam aprender.

  Um dos meus sonhos seria integrar de alguma forma po4a ao Gtranslator ou Lokalize. Quando um arquivo de documento fosse aberto, as strings seriam automaticamente extraídas e um arquivo traduzido + arquivo po poderia ser gravado no disco. Se nós conseguirmos fazer um módulo para MS Word (TM) (ou pelo menos RTF), tradutores profissionais podem até mesmo usá-lo.