Atualizar a documentação

Esse “como-fazer” se aplica essecialmente a mantenedores de projeto que estão usando um diretório po-doc para a localização da documentação. Esses projetos usam a ferramenta xml2po e xsltproc. Quando o mantenedor atualiza a documentação, ele deve também renovar os arquivos PO. Agora, quando o mantenedor recebe um arquivo PO atualizado, ele executa os comandos inversos para atualizar a documentação localizada e também inclui as novas imagens, quando houver alguma.

Quando você receber uma nova tradução não previamente existente você tem que criar os diretórios apropriados dentro do diretório que contém a documentação XML e os Makefiles.

1. Primeiro deixe a configuração de compilação pronta para a compilação de documentação:

./autogen.sh --enable-xsltproc --enable-xml2po

A ferramenta xsltproc é usada para gerar um formato HTML a partir de documentações XML. A ferramenta xml2po é usada para atualizar os arquivos PO a partir da versão em inglês, e também no caminho inverso para atualizar as documentações XML localizadas dos arquivos PO.

2. Adicione um novo arquivo po a po-doc/ e atualize o arquivo LINGUAS.

# exemplo
cp ja.po po-doc/
vim po-doc/LINGUAS

3. Prepare o diretório doc/ para a nova tradução.

# exemplo
mkdir -p doc/ja/images
cp doc/C/Makefile.am doc/C/project.xml.in doc/C/project.html doc/ja
cp doc/C/images/Makefile.am doc/C/images/*.png doc/ja/images
vim configure.ac.in doc/Makefile.am doc/ja/Makefile.am doc/ja/images/Makefile.am

As traduções atualizam as documentações XML que normalmente são colocadas dentro de um diretório docs/. Neste diretório você tem pelo menos um sub-diretório que é a versão em inglês chamada C. Você tem que editar os Makefiles apropriados. O script autoconf também precisa ser atualizado com os novos arquivos Makefile.in resultantes.

4. Recrie o script configure e novos Makefiles.

./autogen.sh --enable-xsltproc --enable-xml2po

5. Agora você tem que atualizar a documentação localizada XML, a qual é explicada na próxima seção.

Quando você receber um arquivo PO atualizado, você tem que atualizar a documentação localizada XML.

1. Atualizar as documentações localizadas XML.

make -C po-doc update-xml

2. Recriar os arquivos .in.

./config.status

Isso é necessário para documentações que usam substituições do autoconf, como @PACKAGE_NAME@. Isso vai somente recompilar os arquivos .in, como o Makefile.in e project.xml.in.

3. Criar a saída HTML.

make -C doc/ja/

Quando você atualziar a versão C da documentação você terá que atualizar os arquivos PO.

make -C po-doc update-po

Isso vai criar o modelo de PO (POT) e atualizar todos os arquivos PO.