| PO4A(7) | Ferramentas do Po4a | PO4A(7) |
po4a - framework para traduzir documentação e outros materiais
po4a (PO for anything) facilita a manutenção da tradução de documentação usando as ferramentas gettext clássicas. A principal característica do po4a é que ele dissocia a tradução do conteúdo de sua estrutura documental.
Este documento serve como uma introdução ao projeto po4a, com foco nos usuários em potencial, considerando a possibilidade de usar essa ferramenta e no desejo curioso de entender por que as coisas são do jeito que são.
A filosofia do software livre é tornar a tecnologia verdadeiramente disponível para todos. Mas o licenciamento não é a única consideração: o software livre não traduzido é inútil para quem não fala inglês. Portanto, ainda temos algum trabalho a fazer para disponibilizar o software para todos.
Essa situação é bem compreendida pela maioria dos projetos e agora todos estão convencidos da necessidade de traduzir tudo. No entanto, as traduções reais representam um enorme esforço de muitas pessoas, prejudicadas por pequenas dificuldades técnicas.
Felizmente, o software de código aberto é realmente muito bem traduzido usando o conjunto de ferramentas gettext. Essas ferramentas são usadas para extrair as strings a serem traduzidas de um programa e apresentar as strings em um formato padronizado (chamado de arquivos PO ou catálogos de tradução). Um ecossistema inteiro de ferramentas surgiu para ajudar os tradutores a traduzir esses arquivos PO. O resultado é usado pelo gettext no tempo de execução para exibir mensagens traduzidas para os usuários finais.
Em relação à documentação, no entanto, a situação ainda é um pouco decepcionante. No início, traduzir a documentação pode parecer mais fácil do que traduzir um programa, pois parece que você apenas precisa copiar o arquivo-fonte da documentação e começar a traduzir o conteúdo. No entanto, quando a documentação original é modificada, acompanhar as modificações rapidamente se transforma em um pesadelo para os tradutores. Se realizada manualmente, esta tarefa é desagradável e propensa a erros.
Traduções desatualizadas geralmente são piores do que nenhuma tradução. Os usuários finais podem ser enganados pela documentação que descreve um comportamento antigo do programa. Além disso, eles não podem interagir diretamente com os mantenedores, pois não falam inglês. Além disso, o mantenedor não pode resolver o problema, pois não conhece todos os idiomas em que sua documentação está traduzida. Essas dificuldades, muitas vezes causadas por ferramentas precárias, podem minar a motivação de tradutores voluntários, agravando ainda mais o problema.
O objetivo do projeto po4a é facilitar o trabalho dos tradutores de documentação. Em particular, ele torna possível manter traduções de documentações.
A ideia é reutilizar e adaptar a abordagem gettext a esse campo. Assim como o gettext, os textos são extraídos de seus locais originais e apresentados aos tradutores como catálogos de tradução de pedidos. Os tradutores podem aproveitar as ferramentas gettext clássicas para monitorar o trabalho a realizar, colaborar e organizar em equipe. O po4a injeta as traduções diretamente na estrutura da documentação para produzir arquivos de origem traduzidos que podem ser processados e distribuídos da mesma forma que os arquivos em inglês. Qualquer parágrafo que não seja traduzido é deixado em inglês no documento resultante, garantindo que os usuários finais nunca vejam uma tradução desatualizada na documentação.
Isso automatiza a maior parte do trabalho pesado da manutenção da tradução. A descoberta dos parágrafos que precisam de atualização se torna muito fácil e o processo é completamente automatizado quando os elementos são reordenados sem modificações adicionais. A verificação específica também pode ser usada para reduzir a chance de erros de formatação que resultariam em um documento quebrado.
Por favor, veja também o FAQ abaixo neste documento para uma lista mais completa de vantagens e desvantagens desta abordagem.
Atualmente, essa abordagem tem sido implementada com sucesso em vários formatos de formatação de texto:
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).
Veja Locale::Po4a::AsciiDoc para detalhes.
Veja Locale::Po4a::Pod para detalhes.
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.
O módulo Locale::Po4a::LaTeX(3pm) foi testado com a documentação do Python, um livro e algumas apresentações.
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.
Atualmente, o DocBook DTD (veja Locale::Po4a::Docbook(3pm) para mais detalhes) e XHTML são suportados pelo po4a.
Veja Locale::Po4a::BibTex para detalhes.
Veja Locale::Po4a:Docbook para mais detalhes.
Veja Locale::Po4a:Guide para mais detalhes.
Veja Locale::Po4a::Wml para mais detalhes.
Veja Locale::Po4a::Yaml para mais detalhes.
Veja Locale::Po4a::RubyDoc para mais detalhes.
Veja Locale::Po4a:Halibut para mais detalhes.
Veja Locale::Po4a::Ini para mais detalhes.
Historicamente, o po4a foi construído em torno de quatro scripts, cada um cumprindo uma tarefa específica. po4a-gettextize(1) ajuda na inicialização de traduções e, opcionalmente, na conversão de projetos de tradução existentes em po4a. po4a-updatepo(1) reflete as alterações na documentação original nos arquivos po correspondentes. po4a-translate(1) constrói o arquivo de origem traduzido a partir do arquivo original e do arquivo PO correspondente. Além disso, po4a-normalize(1) é principalmente útil para depurar os analisadores de po4a, pois produz um documento não traduzido do original. Torna mais fácil identificar as falhas introduzidas pelo processo de análise.
Most projects only require the features of po4a-updatepo(1) and po4a-translate(1), but these scripts proved to be cumbersome and error prone to use. If the documentation to translate is split over several source files, it is difficult to keep the PO files up to date and build the documentation files correctly. As an answer, a all-in-one tool was provided: po4a(1). This tool takes a configuration file describing the structure of the translation project: the location of the PO files, the list of files to translate, and the options to use, and it fully automates the process. When you invoke po4a(1), it both updates the PO files and regenerate the translation files that need to. If everything is already up to date, po4a(1) does not change any file.
O restante desta seção fornece uma visão geral de como usar a interface de scripts do po4a. A maioria dos usuários provavelmente preferirá usar a ferramenta multifuncional, descrita na documentação de po4a(1).
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.
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.
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.
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.
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
PO4A-HEADER: position=Sobre este documento; mode=after; beginboundary=<section>
PO4A-HEADER: position=Sobre este documento; mode=after; beginboundary=<section>
Exemplos de adendos
.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
PO4A-HEADER:mode=after;position=Copyright Grande Cara, 2004;beginboundary=^
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
Este capítulo dá a você uma visão geral da parte interna do po4a, de forma que você pode se sentir mais confiante para nos ajudar a manter e melhorá-lo. ele também pode ajudá-lo a entender o porquê de ele não funcionar da forma que você esperava, e como resolver seus problemas.
A arquitetura do po4a é orientada a objeto. A classe Locale::Po4a::TransTractor(3pm) é um antepassado comum para todos analisadores do po4a. Esse nome estranho vem do fato que ele é ao mesmo tempo o encarregado por tradução de documento e extração de strings.
Mais formalmente, ele pega um documento para traduzir mais um arquivo PO contendo as traduções para usar como entrada, enquanto produz duas saídas separadas: outro arquivo PO (resultante da extração das strings traduzíveis do documento de entrada) e um documento traduzido (com a mesma estrutura daquele de entrada, mas com todas as strings traduzíveis substituídas com o conteúdo do PO de entrada). Aqui está uma representação gráfica disso:
Doc. de entrada --\ /---> Doc. de saída
\ TransTractor:: / (traduzido)
+-->-- parse() --------+
/ \
PO de entrada ----/ \---> PO de saída
(extraído)
Esse pequeno osso é o núcleo de toda arquitetura do po4a. Se você omitir o PO de entrada e o documento de saída, você obtém po4a-gettextize. Se você fornecer ambos arquivos de entrada e desconsiderar o PO de saída, você obtém po4a-translate. O po4a chama o TransTractor duas vezes e chama msgmerge -U entre essas chamadas do TransTractor para fornecer uma solução completa com um único arquivo de configuração. Por favor, veja Locale::Po4a::TransTractor(3pm) para mais detalhes.
Aqui está uma lista bem parcial de projetos que usam po4a na produção para sua documentação. Se você quiser adicionar seu projeto à lista, basta nos enviar um e-mail (ou uma merge request).
Este projeto fornece uma infraestrutura para traduzir muitas páginas man para diferentes idiomas, prontas para integração em várias grandes distribuições (Arch Linux, Debian e derivados, Fedora).
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 :)
There are a few of them. Here is a possibly incomplete list, and more tools are coming at the horizon.
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.
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.
- 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.
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.
Denis Barbier <barbier,linuxfr.org> Martin Quinson (mquinson#debian.org)
| 2023-01-03 | Ferramentas do Po4a |