This is an old revision of the document!
This page contens is being MOVED to https://github.com/phpdocbrbridge/traducao/wiki
Apêndices
Translation Fest 2014
Canais de comunicação
- Canal IRC irc.freenode.net/phpdocbr (com interface web em https://webchat.freenode.net/?channels=phpdocbr)
- Sala no Gitter em https://gitter.im/phptranslationfestbrasil/chat
- Trello disponível em https://trello.com/b/j6Nuulpn/lista-de-tarefas-traducao-pt-br.
Os últimos dois são específicos do esforço de tradução do Translation Fest, e o primeiro não costuma ter movimento ou pessoas online. Acaba que a lista de email oficial é o caminho para falar da tradução.
Dependências para ambiente completo
- git
- subversion
- php5-cli
- php-pear
- php5-sqlite
- phd
Quase tudo você instala via apt-get/yum/brew, exceto o phd. O phd pode ser instalado facilmente assim:
git clone git@github.com:php/phd.git cd phd sudo pear install package.xml package_generic.xml package_php.xml
Ambientes prontos
Você pode utilizar uma máquina virtual com as dependências já instaladas. Para isso, siga os próximos passos.
Baixar e instalar o Oracle Virtual Box
Utilize a página abaixo para instalar o Virtual Box na sua máquina.
Máquinas virtuais prontas
Baixe a máquina virtual de sua preferência nos endereços abaixo.
= Máquina Virtual Ubuntu 14.04 32bits (3,8Gb) =
- md5sum 83c4947594ebdae38dc4ec515eef94c7
- Usuário root Senha translationfest
Nessa maquina ainda é preciso instalar o package_php antes de compilar o manual, você pode fazer isso da seguinte forma:
cd ~/translation_fest/phd sudo pear install package_php.xml
= Máquina Virtual xUbuntu 14.04 64bits (1,6Gb) =
- md5sum ad167d8953a36996d14f422f2942538f
- Usuário xubuntu Senha reverse
- Usuário root Senha reverse
Nessa maquina ainda é preciso instalar o package_php antes de compilar o manual, você pode fazer isso da seguinte forma:
cd ~/translation_fest/phd sudo pear install package_php.xml
= Máquina Virtual xUbuntu 14.04 32bits (2,0Gb) =
- md5sum 494e45601657efe973d1b1f19853b4f9
- Usuário xubuntu Senha reverse
- Usuário root Senha reverse
Nessa maquina ainda é preciso instalar o package_php antes de compilar o manual, você pode fazer isso da seguinte forma:
cd ~/translation_fest/phd sudo pear install package_php.xml
= Máquina Virtual centOS 7 64bits (740Mb) =
- md5sum 3794c55e94de29a4001ecaec2ce1cc50
- shasum 678c97df3d059ad784035a9a2cb7c299d0fefb1d
- Usuário root Senha tfest
Existe um compartilhamento nfs na pasta /root/translationfest para que a máquina host possa ler os arquivos. Basta montar como um compartilhamento de rede. Funciona em Windows/Linux/Mac.
Instalar as dependências no Ubuntu (e similares)
Caso não esteja usando uma máquina virtual, você também pode usar o script abaixo para instalar as dependências numa máquina Ubuntu:
source <(wget -qO- https://gist.github.com/royopa/599259ebeffa6ab7b1cb/raw/)
Pronto, você já pode começar a editar o manual.
Atualize o repositório svn da documentação
Assim que iniciar o trabalho em qualquer dos ambientes escolhidos, atualize o repositório svn da documentação, com o comando:
cd ~/translation_fest/doc-pt_BR svn up
Compilando o manual
Para compilar, existem algumas opções:
= Documentação no formato xHTML =
Gera arquivos no formato xHTML, sem imagens, porém funcional:
$ cd ~/doc-pt_BR/ $ php doc-base/configure.php --enable-xml-details --with-lang=pt_BR $ phd --docbook doc-base/.manual.xml --package PHP --format xhtml --output mydocs_xhtml
Agora inicie o servidor web do PHP para acessar a documentação pelo navegador:
$ php -S localhost:8000 -t ./mydocs_xhtml/php-chunked-xhtml
E acesse a documentação gerada através do endereço http://localhost:8000/
Veja esse processo rodando aqui: https://asciinema.org/a/14378
= Documentação no formato PHP =
Gera arquivos no formato php, que dependem de outros arquivos explicados em http://doc.php.net/tutorial/local-setup.php. Com os comandos abaixo essas dependências já são resolvidas.
$ cd ~/doc-pt_BR/ $ php doc-base/configure.php --enable-xml-details --with-lang=pt_BR $ phd --docbook doc-base/.manual.xml --package PHP --format php --output mydocsphp_pt_BR
Depois de executar os passos acima, utilize os comandos abaixo para baixar as dependências que o formato de documentação em php possui:
$ wget https://github.com/php/web-php/archive/master.zip $ unzip master.zip $ rm -rf master.zip $ rsync -avzC --timeout=600 --delete --delete-after --exclude='distributions/**' --exclude='extra/**' --exclude='backend/notes/**' ./web-php-master/ ./myphpnet/ $ rm -rf web-php-master/
Então mova a pasta da versão da documentação que você criou para dentro da pasta que será usada pelo servidor web:
$ mv mydocsphp_pt_BR/php-web/ myphpnet/manual/pt_BR
Agora inicie o servidor web do PHP para acessar a documentação pelo navegador:
$ php -S localhost:8000 -t ./myphpnet/
E acesse a documentação gerada através do endereço http://localhost:8000/manual/pt_BR/
Veja esse processo rodando aqui: https://asciinema.org/a/14385
Criando um patch com as suas alterações
Depois de terminar suas alterações de tradução e testá-las, você deve fazer um patch com essas alterações.
Para evitar mandar algum patch que mexa na estrutura do original do manual, é sugerido que o patch seja gerado a partir da pasta pt_BR
. Depois de navegar para essa pasta, execute o seguinte comando:
svn diff > minha_traducao.patch
Pronto. Basta mandar esse patch para a lista e alguém irá aplicá-lo caso esteja acordo com o foco da tradução e as regras mencionadas no manual.
Não esqueça de mandar uma commit message junto! ex.:
Translating the Windows install FAQ [Fulano de Tal <fulano@tal.com>]
Quanto mais patches seus forem aprovados, mais fácil para você conseguir uma conta VCS aprovada (SVN, nome@php.net) e agilizar o processo, pois você mesmo vai poder mesclar suas alterações.
Aplicando um patch na documentação
Para aplicar um patch na sua tradução, utilize um dos comandos abaixo:
Se tiver usando o SVN >= 1.7 é só chamar:
svn patch $file
Se não tiver o comando svn patch, use o seguinte comando:
patch -p0 < $file