NOME¶

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

DESCRIÇÃO¶

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

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

OPÇÕES ACEITAS POR ESTE MÓDULO¶

Estas são as opções específicas deste módulo:

definitions

O nome de um arquivo contendo definições para o po4a, como definido na seção PERSONALIZAÇÃO INTEGRADA. Você pode usar esta opção se não for possível colocar as definições no documento que está sendo traduzido.

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

entry

Lista separada por espaço das entradas de atributos que você deseja traduzir. Por padrã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

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

Por padrão, po4a não aplicará a quebra os arquivos AsciiDoc produzidos porque uma inspeção manual é obrigatória para garantir que o quebra não altere a formatação. Considere, por exemplo, o seguinte item da lista:

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

Se a quebra levar à apresentação a seguir, o item será dividido em uma sub-lista numerada. Para piorar as coisas, apenas os falantes do idioma usado na tradução podem inspecionar a situação.

 * uma longa frase que está terminando com um número
   1. Uma segunda frase.
    

Observe que não fazer quebra os arquivos produzidos pelo po4a não deve ser um problema, uma vez que esses arquivos devem ser processados automaticamente. Eles não devem ser considerados como arquivos fonte de qualquer maneira.

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

noimagetargets

Por padrã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 configurando essa opção.

tablecells

Essa é uma opção que permite segmentação de uma subtabela em conteúdo de célula. A segmentação está limitada a conteúdo de célula, sem qualquer análise de que está dentro.

compat

Muda as regras de análise para compatibilidade com diferentes ferramentas. 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 fechamento.

nolinting

Desativa mensagens lintagem. 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 extra spaces from the source segments in no-wrap mode. This is useful when the translation tools are sensitive to the number of spaces.

yfm_keys

Lista separada por vírgula de chaves para processar para tradução na seçã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 seção YAML Front Matter.

yfm_paths

Lista separada por vírgula de caminhos hash para processar para extração na seçã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 INTEGRADA¶

O módulo AsciiDoc pode ser personalizado com linhas começando 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 (+) é prefixo de nome, então a macro e seus argumentos são traduzidos como um todo. Não há necessidade de definir uma lista de atributos neste caso, mas colchetes devem estar presentes.

//po4a: estilo [lista de atributos]

Isso descreve em detalhe quais atributos de um estilo 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. O primeiro atributo é o nome do estilo e não será traduzido.

Se um sinal de mais (+) é prefixo do 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 (-) é prefixo do nome do estilo, então este atributo não é traduzido.

//po4a: entrada nome

Isso declara uma entrada de atributo como sendo traduzível. Por padrão, eles não estão traduzidos.

ESTADO DESTE MÓDULO¶

Testado com sucesso em arquivos AsciiDoc simples.

AUTORES¶

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

COPYRIGHT 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>.

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