PO4A-BUILD(1)

NOME
po4a-build - compila documentações traduzidas

SINOPSE

po4a-build [-f | --file ARQUIVO] [--pot-only]

po4a-build [-? | -h | --help | --version]

DESCRIÇÃO

po4a-build tem a intenção de tornar tão fácil a produção de documentação traduzida quanto é produzir conteúdo traduzido.

Quando po4a prepara o conteúdo traduzido como POD ou XML de DocBook, a documentação final pode ser compilada usando po4a-build. Ambos conteúdos traduzido e não traduzido são compilados como um único processo, atualizando os arquivos POT ao mesmo tempo.

Instruções da compilação existente são substituídas por uma única chamada ao po4a-build e um simples arquivo de configuração é usado para dizer ao po4a-build como construir cada elemento e quais pacotes de executáveis vão incluir o conteúdo traduzido e não traduzido.

Uma vez compilado, o conteúdo vai estar em diretórios específicos do pacote dentro do BASEDIR especificado no arquivo de configuração. Para um pacote binário foo, com traduções para alemão e francês, isso resultaria em:

    BASEDIR/foo/man/man1/foo.1
    BASEDIR/foo/man/de/man1/foo.1
    BASEDIR/foo/man/fr/man1/foo.1

Isso torna mais fácil incluir todo o conteúdo gerado em um pacote binário com um único local de instalação:

    doc/foo/man/* ./usr/share/man/
    doc/foo/html/* ./usr/share/doc/foo/

Essa regra não vai precisar ser atualizada quando novas traduções forem adicionadas e ao adicionar um segundo pacote binário (bar) permite-se que o conteúdo daquele pacote seja mantido separado.

  Formatos suportados

Atualmente, po4a-build fornece suporte às seguintes combinações:

    1. XML do DocBook para seção 1.

    2. XML do DocBook para seção 3.

    3. XML do DocBook para HTML.

    4. POD para seção 1.

    5. POD para seção 3.

    6. POD para seção 5.

    7. POD para seção 7.

Todos os formatos suportados, em todas combinações suportadas, podem ser manipuladas em um único arquivo de configuração po4a-build.conf e em uma única chamada ao po4a-build. Veja po4a-build.conf(5).

CONFIGURAÇÃO

po4a-build usa uma configuração padrão, po4a-build.conf, a qual deveria estar no diretório de nível de topo do VCS do seu pacote. (Use a opção -f para especificar um arquivo diferente.) Veja po4a-build.conf(5).

Exemplo 1. exemplo de arquivo de configuração

Um exemplo de arquivo de configuração está disponível em:

    /usr/share/doc/po4a/examples/po4a-build.conf.example

  layout do arquivo de configuração

O arquivo de configuração consiste em diversas seções, geral, suporte a XML/XSL, suporte a POD e suporte a HTML.

Geral inclui o nome e localização do arquivo de configuração do po4a (provavelmente é melhor para deixar é po4a.config), o diretório PO contém os arquivos PO de documentação (normalmente doc/po), o nome completo do arquivo POT usado para criar as traduções, o BASEDIR para a saída gerada, se o pacote contém páginas de manual na seção 3 ao invés de somente a seção 1 e os nomes dos pacotes binários que vão conter a saída gerada.

Suporte a XML/XSL inclui especificação de quais dos pacotes binários usam suporte a XSL na variável XMLPACKAGES, o nível de topo do arquivo DocBook para passar para xsltproc e a localização dos arquivos XML ou DocBook. O XSLFILE pode ser sobrescrito, se necessário.

Suporte a POD inclui a especificação de quais dos pacotes binários usam suporte a POD na variável PODPACKAGES e nome completo do arquivo POD.

Suporte a HTML especifica o subdiretório para criar abaixo BASEDIR para o conteúdo HTML não traduzido e traduzido e o arquivo DocBook para gerar o HTML. O arquivo HTMLXSL pode ser sobrescrito, se necessário.

COMANDOS

--pot-only
    Apenas atualiza o(s) arquivo(s) POT. --pot-only tem a intenção de prover suporte a pacotes incluindo todos os arquivos POT no pacote fonte. Pacotes usando Autotools podem ser facilmente adicionados ao arquivo POT via EXTRA_DIST, mas pacotes usando apenas um Makefile ou certos auxiliares de compilação para VCS podem achar isso estranho adicionar o arquivo POT (o qual é um arquivo geral) sem colocar o arquivo POT no VCS. Para evitar este trabalho desnecessário e feio, po4a-build pode atualizar o(s) arquivo(s) POT no início da compilação, de forma que dpkg-source inclui eles no tarball fonte.

    Exemplo 2. exemplo de svn-buildpackage

    svn-buildpackage possui suporte explícito para este tipo de adição, usando propriedade SVN useNativeDist e o Make target do native-dist.

        # adiciona o arquivo POT do tarball fonte
        native-dist: Makefile
        	po4a-build --pot-only

        $ svn propset useNativeDist 1 debian

-h|--help
    imprime a mensagem de uso e sai.

--version
    imprime a versão do script e sai.

OPÇÕES

-f|--file ARQUIVO
    Sobrescreve o arquivo de configuração padrão de po4a-build (po4a-build.conf) e fornece seu próprio.

AUTOR

po4a-build foi escrito por Neil Williams <codehelp@debian.org>.

Essa página de manual foi escrita por Neil Williams <codehelp@debian.org>