2. EL 7
  3. po4a
  4. po4a-build.conf(5)

Scroll to navigation

PO4A-BUILD.CONF(5) Ferramentas Po4a PO4A-BUILD.CONF(5)

NOME

po4a build.conf - ficheiro de configuração para a construção de conteúdo traduzido

Introdução

po4a-build.conf descreve como "po4a-build" deve ser construida documentação traduzida e não traduzida a partir de um conjunto de documentos de origem não traduzidos e correspondentes ficheiros PO.

Todos os formatos suportados, em todas as combinações suportadas, podem ser tratados num simples ficheiro de configuração po4a-build.conf e numa única invocação para "po4a-build". No entanto, você também pode optar por separar os diretórios po/ e ter um ficheiro de configuração para cada arranque. (Invocar "po4a-build-f FILE" para cada um.)

Note-se que embora po4a-build inclua suporte para adição de suporte gettextpara a tradução do script de mensagens de saída, po4a-build.conf em si não tem relação com tais traduções. po4a-build.conf refere-se apenas a tradução de conteúdo estático como páginas de manual.

Para suporte po4a-build de tradução de mensagens em tempo de execução, consulte po4a-runtime(7).

Formatos Suportados

Actualmente, "po4a-build" suporta as seguintes combinações:

Normalmente usado para páginas de manual, para scripts da shell ou outros intérpretes que não têm o sua própria documentação formatada como POD. XML adequado pode ser gerado diretamente de uma página de manual existente usando "doclifter" e "po4a-build" que irá gerar um ficheiro POT sem trabalho extra. O ficheiro POT pode ser oferecido para a tradução e os ficheiros PO adicionados ao diretório relevante po/. "po4a-build" irá então, preparar não apenas as páginas de manual não traduzidas do "doclifter" XML mas também usar "po4a" para preparar XML traduzido a partir dos ficheiros PO e então construir páginas de manual traduzidas a partir do XML.

Páginas de manual são geradas usando o suporte padrão em docbook-xsl - o estilo utilizado pode ser substituído usando a configuração "XSLFILE" no ficheiro de configuração "po4a-build".

O estilo padrão usado para preparar o HTML final pode ser substituído usando a configuração "HTMLXSL" no ficheiro de configuração "po4a-build".
pod2man é usado para converter o conteúdo POD para cada uma das secções suportadas.

Use "PODFILE" para a secção 1, "PODMODULES" para a secção 3, "POD5FILES" para a secção 5 e "POD7FILES" para a secção 7.

Para o conteúdo nas secções 5 ou 7 (o que tende a precisar de um nome de ficheiro que é também utilizado para o conteúdo da secção 1), se o nome do ficheiro inclui a 5 ou 7 como parte do nome do ficheiro, este (e qualquer extensão do ficheiro) será automaticamente despojado.

por exemplo para preparar F </ usr/share/man/man7/po4a.7.gz>:

 # Ficheiros POD para a secção 7
 POD7FILES="doc/po4a.7.pod"

Conteúdo dos ficheiros

Valores de configuração podem aparecer em qualquer ordem no ficheiro de configuração.

Qualquer conteúdo depois de um '#' é ignorado.

Qualquer valor que seria sempre vazio pode ser eliminado do ficheiro.

São necessárias algumas configurações de campos - po4a-build pode acabar sem nada a fazer se os campos obrigatórios estiverem vazios.

Requerido

Nome e localização do ficheiro de configuração (temporária) "po4a" que "po4a-build" irá gerar e manter. Este ficheiro não precisa de viver no seu sistema de controle de versão e pode ser seguramente limpo durante a construção do pacote.

 # nome e localização do ficheiro de configuração
 CONFIG="_build/po4a.config"
Requerido

Diretório contendo os ficheiros PO para todas as traduções manipuladas por este ficheiro de configuração. Todas as sequências serão fundidas num ficheiro POT neste diretório e todos os ficheiros PO fundirão com esse ficheiro POT. Qualquer limite GUARDADO (veja abaixo) será aplicado em todas as sequências de todos os ficheiros de entrada especificado neste ficheiro e todos os ficheiros PO neste diretório. O diretório não precisa de ser chamado 'po'. Observe, porém, que algumas ferramentas de estatística esperam que o nome seja 'po', pelo que é recomendado para manter este nome.

 # Diretório po para páginas do manual/docs
 PODIR="po/pod"
Requerido

Caminho para o ficheiro POT (em relação à localização do ficheiro de configuração) que será gerado, mantido e atualizado por "po4a-build" para estas traduções.

 # Caminho do ficheiro POT
 POTFILE="po/pod/po4a-pod.pot"
Requerido

Diretório base para escrever o conteúdo traduzido.

 # Diretório base para os ficheiros gerados, por exemplo, doc
 BASEDIR="_build"
Requerido

Mesmo se é construído apenas um pacote, um valor é necessário aqui, pelo menos.

A sequência é em si arbitrária, mas geralmente consiste no nome do pacote. O conteúdo gerado irá aparecer em subdiretórios do BASEDIR/BINARIES:

 _build/po4a/man/man1/foo.1

Se o pacote constrói mais do que um pacote binário (ou seja, um pacote de origem e múltiplos ficheiros .deb ou .rpm), este campo pode ajudar a isolar o conteúdo destinado para cada ponto, tornando mais fácil para automatizar o processo de criação.

Sequências separadas por um espaço.

 # Pacotes binários que irão conter páginas de manual geradas
 BINARIES="po4a"
O valor a ser passado diretamente para "po4a -k" para especificar o limite para conteúdo corretamente traduzido antes de uma tradução em particular é omitido a construir. Deixe em branco ou remova o padrão a usar (80%), ou especificar zero para forçar a inclusão de todo o conteúdo, mesmo se completamente sem tradução.

Para o controlo total sobre o comportamento, analise com cuidado quais os ficheiros que são atribuídos a cada ficheiro de configuração po4a-build.conf.

Note-se que ter muitos ficheiros num ficheiro POT pode ser mais conveniente para tradutores, especialmente se os ficheiros têm sequências em comum. Inversamente ficheiros POT com milhares de longas sequências são assustadores para tradutores, levando à paragem da sequência longa.

 # Limiar mínimo para a percentagem de tradução a manter
 KEEP=
Ficheiros DocBook XML para gerar páginas de manual na secção 1. Nomes de ficheiros separados com espaços. Todos os ficheiros precisam de estar no diretório XMLDIR.

É prática comum envolver múltiplos ficheiros XML num livro, a fim de fornecer uma tabela de conteúdo, etc. Se o livro contém ficheiros também especificados em XMLMAN3, especificar apenas aqui os ficheiros XML para a secção 1, não o livro em si. Se o livro contém apenas conteúdo para esta secção, especificar apenas o ficheiro do livro.

 # Ficheiros DocBook XML para a secção 1
 XMLMAN1="po4a-build.xml po4aman-display-po.xml po4apod-display-po.xml"
Ficheiros DocBook XML para gerar páginas de manual na secção 3. Nomes dos ficheiros separados com espaços. Todos os ficheiros precisam estar no diretório XMLDIR.

É prática comum envolver múltiplos ficheiros XML num livro, a fim de fornecer uma tabela de conteúdo, etc. Se o livro contém ficheiros também especificados em XMLMAN1, especificar apenas aqui os ficheiros XML para a secção 3, não o livro em si. Se o livro contém apenas conteúdo para esta secção, especificar apenas o ficheiro do livro.

 # Ficheiros DocBook XML para a secção 3
 XMLMAN3=""
Localização de todos os ficheiros DocBook XML. Atualmente "po4a-build" espera ser capaz de encontrar todos os ficheiros listados no XMLMAN1 e XMLMAN3 procurando ficheiros por *.xml neste diretório.

Deve ser especificado se são usados XMLMAN1 ou XMLMAN3. Caminhos são relativos à localização do ficheiro de configuração.

 # localização de ficheiros XML
 XMLDIR="share/doc/"
Quais os pacotes, fora da lista em BINÁRIOS, utilize conteúdo XML fonte

Se quaisquer valores são dados em XMLMAN1 ou XMLMAN3, um valor deve ser dado aqui também.

 # pacotes binários usando DocBook XML & xsltproc
 XMLPACKAGES="po4a"
Semelhante a XMLDIR mas apenas utilizado para preparar os ficheiros DocBook traduzidos. Se o seu pacote quer usar ficheiros .sgml, por favor, discutir como estes devem ser construídos na lista de discussão po4a-devel. 

 # Padrão para encontrar ficheiros .docbook
 DOCBOOKDIR=""
Estilo XSL usado ​​para preparar os conteúdos traduzidos e não traduzidos a partir dos ficheiros DocBook XML. 

 # Ficheiro XSL para usar DocBook XML
 XSLFILE="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"
Ficheiros POD para geração de conteúdo do manual em secção 1. Separar ficheiros POD com espaços. Caminhos, se usados​​, precisam de ser em relação ao local do ficheiro de configuração especificado. 

 # Ficheiros POD para a secção 1
 PODFILE="po4a po4a-gettextize po4a-normalize scripts/msguntypot"
O suporte especializado para módulos Perl com conteúdo POD - o nome do módulo vai ser reconstruído a partir do caminho (de modo que deve ser a apresentação típica de Perl) e as páginas do manual são automaticamente colocadas em secção 3. 

 # Ficheiros POD para a secção 3 - Nomes de módulo regenerados a partir do caminho
 PODMODULES="lib/Locale/Po4a/*.pm"
Conteúdo POD arbitrário para uso gerando páginas de manual para a secção 5. Caminhos, se usados​​, precisam de ser em relação ao local do ficheiro de configuração especificado.

Para o conteúdo nas secções 5 ou 7 (o que tende a precisar de um nome de ficheiro que é também utilizado para o conteúdo da secção 1), se o nome do ficheiro inclui a 5 ou 7 como parte do nome do ficheiro, este (e qualquer extensão do ficheiro) será automaticamente despojado.

 # Ficheiros POD para a secção 5
 POD5FILES="doc/po4a-build.conf.5.pod"
Conteúdo POD arbitrário para uso gerando páginas de manual para a secção 7. Caminhos, se usados​​, precisam de ser em relação ao local do ficheiro de configuração especificado.

Para o conteúdo nas secções 5 ou 7 (o que tende a precisar de um nome de ficheiro que é também utilizado para o conteúdo da secção 1), se o nome do ficheiro inclui a 5 ou 7 como parte do nome do ficheiro, este (e qualquer extensão do ficheiro) será automaticamente despojado.

 # Ficheiros POD para a secção 7
 POD7FILES="doc/po4a.7.pod"
Similar a XMLPACKAGES - qualquer pacote esperando conteúdo a ser construído a partir de ficheiros POD precisa incluir um valor em PODPACKAGES. Necessário se os valores são especificados para PODFILE, PODMODULES, POD5FILES ou POD7FILES. 

 # pacotes binários usando POD
 PODPACKAGES="po4a"
Subdiretório de BASEDIR a ser utilizado para emitir a saída HTML do traduzido e o não traduzido. 

 # saída HTML (subdiretório de BASEDIR)
 HTMLDIR=""
Ficheiro DocBook para ser convertido em HTML (pode ser o mesmo que um dos ficheiros de XMLMAN1 ou XMLMAN3). secções não são relevantes para a saída HTML, sinta-se à vontade para usar o único ficheiro livro aqui assim o HTML tem uma tabela de conteúdos, etc. 

 # ficheiro HTML DocBook
 HTMLFILE=""
O padrão é usar uma folha de estilo XSL em partes. Não está neste momentosuportado para usar mais do que uma folha de estilo por arranque HTML. 

 # ficheiro XSL a utilizar para HTML
 HTMLXSL="http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl"

AUTORES

 Neil Williams <linux@codehelp.co.uk>
2014-05-02 Ferramentas Po4a