NOME¶

Locale::Po4a::AsciiDoc - converte documentos AsciiDoc de/para ficheiros PO

DESCRIÇÃO¶

O objetivo do projeto po4a (PO for anything: PO para qualquer coisa) é facilitar traduções (e o mais interessante, a manutenção das traduções) a usar as ferramentas do gettext em áreas em que não se esperava, como na documentação.

Locale::Po4a::AsciiDoc é um módulo para ajudar a tradução de documentação no formato AsciiDoc.

OPÇÕES ACEITES POR ESTE MÓDULO¶

Estas são as opções particulares deste módulo:

definitions

O nome de um ficheiro que contém as definições para po4a, como definido na secção INLINE CUSTOMIZATION. Pode usar esta opção se não é possível pôr as definições no documento a ser traduzido.

Num ficheiro de definições, as linhas não podem começar com duas barras e sim diretamente pelo po4a:.

entry

Lista separada por espaços das entradas de atributos que deseja traduzir. Por predefinição, nenhuma entrada de atributo é traduzida.

macro

Lista separada por espaço das definições de macro.

style

Lista separada por espaço das definições de estilos.

forcewrap

Ativar a quebra de linha automática em blocos não verbais, mesmo que o resultado possa ser mal interpretado pelos formatadores AsciiDoc.

Por predefinição, o po4a não quebra os ficheiros AsciiDoc produzidos, porque uma inspeção manual é necessária para garantir que a quebra não altera a formatação. Considere, por exemplo, o seguinte item da lista:

 * uma frase comprida, que termina com um número 1. Uma segunda frase.
    

Se este envolver levar à seguinte apresentação, o item é dividido numa sub-lista numerada. Para piorar a situação, apenas os falantes do idioma utilizado na tradução podem inspecionar a situação.

 * uma frase comprida que termina com um número
   1. Uma segunda frase.
    

Note que não embrulhar os ficheiros produzidos pelo po4a não deve ser um problema, uma vez que esses ficheiros devem ser processados automaticamente. Eles não devem ser considerados como ficheiros fonte de qualquer forma.

Com esta opção, o po4a produzirá ficheiros AsciiDoc mais apresentáveis, mas pode levar a saídas com formatação possivelmente errônea.

noimagetargets

Por predefinição, os alvos das imagens de bloco são traduzíveis para dar oportunidade de fazer com que o conteúdo aponte para imagens traduzidas. Isso pode ser impedido ao configurar esta opção.

tablecells

Esta opção é um sinalizador que permite a segmentação de sub-tabelas em conteúdo das células. A segmentação é limitada ao conteúdo da célula, sem qualquer análise dentro dele.

compat

Muda as regras de análise para compatibilidade com ferramentas diferentes. As opções disponíveis são "asciidoc" ou "asciidoctor". O Asciidoctor possui regras de análise mais rígidas, como a igualdade do comprimento das aberturas dos blocos de abertura e fecho.

nolinting

Desativa mensagens em fiapos. Quando o código-fonte não pode ser corrigido para uma estrutura de documento mais clara, essas mensagens são inúteis.

cleanspaces

Remove espaços extras dos segmentos da fonte no modo no-wrap. Isto é útil quando as ferramentas de tradução são sensíveis ao número de espaços.

yfm_keys

Lista separada por vírgula de chaves para processar para tradução na secção YAML Front Matter. Todas as outras chaves são ignoradas. As chaves são combinadas com uma correspondência que diferencia maiúsculas de minúsculas. Se yfm_paths e yfm_keys forem usadas juntas, os valores serão incluídos se forem correspondidos por pelo menos uma das opções. Os valores das matrizes sempre são traduzidos, a menos que a opção yfm_skip_array seja fornecida.

yfm_skip_array

Não traduz os valores de vetor na secção YAML Front Matter.

yfm_paths

Lista separada por vírgulas de caminhos hash para processar para extração na secção YAML Front Matter; todos os outros caminhos são ignorados. Os caminhos são combinados com uma correspondência que diferencia maiúsculas de minúsculas. Se yfm_paths e yfm_keys forem usadas juntas, os valores serão incluídos se forem correspondidos por pelo menos uma das opções. Os valores das matrizes sempre são retornados, a menos que a opção yfm_skip_array seja fornecida.

PERSONALIZAÇÃO EM LINHA¶

O módulo AsciiDoc pode ser personalizado com linhas a começar com //po4a:. Estas linhas são interpretadas como comandos para analisar. Os seguintes comandos são reconhecidos:

//po4a: macro nome[lista de atributos]

Isso descreve em detalhe os parâmetros de uma macro; nome deve ser um nome de macro válida e termina com um sublinhado se o alvo deve ser traduzido.

O argumento lista de argumentos é uma lista separada por vírgulas que contém informações sobre argumentos traduzíveis. Esta lista contém números, para definir parâmetros posicionais, ou atributos nomeados.

Se um sinal de mais (+) é prefixado ao nome, então a macro e os argumentos dele são traduzidos como um todo. Não há necessidade de definir uma lista de atributos neste caso, mas colchetes devem estar presentes.

//po4a: style [lista de atributos]

Isso descreve em detalhe quais atributos de um estilo devem ser traduzidos.

O argumento lista de atributos é uma lista separada por vírgulas que contém informações sobre argumentos traduzíveis. Esta lista contém números, para definir parâmetros posicionais, ou atributos nomeados. O primeiro atributo é o nome do estilo e não será traduzido.

Se um sinal de mais (+) for prefixado ao nome do estilo, então a lista de atributos é traduzida como um todo. Não há necessidade de definir atributos traduzíveis.

Se um sinal de menos (-) for prefixado ao nome do estilo, então este atributo não é traduzido.

Se um sinal de percentagem (%) for acrescentado ao nome do estilo, então o estilo é processado como literalmente. As linhas em parágrafo ou bloco de tal estilo são apresentadas nos ficheiros po e as entras correspondentes são marcadas como no-wrap.

//po4a: entry nome

Isso declara uma entrada de atributo como sendo traduzível. Por predefinição não estão traduzidos.

ESTADO DESTE MÓDULO¶

Testado com sucesso em ficheiros AsciiDoc simples.

AUTORES¶

 Nicolas François <nicolas.francois@centraliens.net>
 Denis Barbier <barbier@linuxfr.org>

DIREITOS DE AUTOR E LICENÇA¶

 Copyright © 2005-2008 Nicolas FRANÇOIS <nicolas.francois@centraliens.net>.
 Copyright © 2012 Denis BARBIER <barbier@linuxfr.org>.
 Copyright © 2017 Martin Quinson <mquinson@debian.org>.

Este programa é um software livre; pode redistribuí-lo e/ou modificá-lo sob os termos da GPL v2.0 ou posterior (veja o ficheiro COPYING).