Este é o FAQ para as pessoas que traduzem a documentação do FreeBSD (FAQ, Manual do FreeBSD, tutoriais, páginas de manual e outros) para diferentes línguas.
Ele é fortemente baseado na
tradução do FAQ do Projeto Alemão de Documentação do FreeBSD,
originalmente escrito por Frank Gründer <elwood@mc5sys.in-berlin.de>
e
traduzido novamente para o inglês por Bernd Warken <bwarken@mayn.de>
.
Este FAQ é mantido pela Equipe de Engenharia de Documentação
<doceng@FreeBSD.org>
.
Mais e mais pessoas estão se juntando à lista de discussão FreeBSD-doc e estão se oferecendo para traduzir a documentação do FreeBSD para outras línguas. Este FAQ visa responder as suas perguntas, de forma que eles possam iniciar a tradução da documentação o quanto antes.
i18n significa internacionalização e l10n significa locallização. São apenas abreviações.
i18n pode ser lido como “i” seguido por 18 letras, seguidas por “n”. Similarmente, l10n é “l” seguido por 10 letras, seguidas por “n”.
Sim. Os diferentes grupos de tradução possuem as suas próprias listas de discussão. A lista dos projetos de tradução possui maiores informações sobre as listas de discussão e sobre os web sites mantidos por cada um dos projetos de tradução.
Sim. Quanto maior o número de pessoas trabalhando na tradução, mais rapidamente ela será finalizada, e mais rapidamente as mudanças na documentação em Inglês serão refletidas nos documentos traduzidos.
Você não precisa ser um tradutor profissional para poder ajudar.
Idealmente, você deverá possuir bons conhecimentos de Inglês escrito, e obviamente necessitará ser fluente na língua para a qual estiver traduzindo.
O conhecimento do idioma Inglês não é estritamente necessário. Por exemplo, você poderia fazer uma tradução do FAQ para o idioma Húngaro a partir da versão em Espanhol do documento.
É fortemente recomendado que você mantenha uma cópia local do repositório Subversion do FreeBSD (ao menos da parte referente a documentação). Isto pode ser feito executando o comando:
% svn checkout svn://svn.FreeBSD.org/doc/head/ head
Nota: Você irá precisar ter o devel/subversion instalado.
Você deverá ter conhecimentos básicos de svn. Ele permitirá que você veja o que mudou entre as diferentes versões dos arquivos que compõem a documentação.
Por exemplo, para ver as diferenças entre as revisões r33733 e r33734 do en_US.ISO8859-1/books/fdp-primer/book.xml , execute:
% svn diff -r33733:33734 en_US.ISO8859-1/books/fdp-primer/book.xml
9.7. Como eu faço para descobrir se já existem outras pessoas traduzindo documentos para o meu idioma?
A página do Projeto de Tradução da Documentação lista os trabalhos de tradução que são conhecidos atualmente. Se outros já estão trabalhando na tradução da documentação para o seu idioma, por favor, não duplique os esforços. Ao invés disso, faça contato com o grupo para ver como pode ajudá-los.
Se não existir nenhum projeto de tradução para o seu idioma listado nesta página, envie uma mensagem para lista de discussão do projeto de documentação do FreeBSD para o caso de alguém estar pensando em fazer a tradução, mas ainda não tiver anunciado nada.
Parabés, você acabou de começar o “FreeBSD sua-língua-aqui Documentation Translation Project”. Bem vindo a bordo.
Primeiro, pense se você terá o tempo necessário. Uma vez que você é a única pessoa trabalhando no seu idioma no momento, será sua a responsabilidade de publicar o seu trabalho e coordenar qualquer voluntário que queira ajudá-lo.
Escreva um email para a lista de discussão do Projeto de Documentação, anunciando que você irá traduzir a documentação, assim a página do Projeto de Traduções de Documentação poderá ser atualizada.
Se já existir alguém em seu país provendo o espelhamento de serviços do FreeBSD, você deve contacta-lo e perguntar se você pode ter algum espaço web para seu projeto, e se possível um endereço de email ou mesmo um serviço de lista de discussão.
Então escolha um documento e comece a traduzir. É melhor começar com algo razoavelmente pequeno como FAQ ou um dos tutoriais.
Isso depende. Se você já está trabalhando com uma equipe de tradução (tal como a equipe japonesa, ou a equipe alemã) então ela terá seus próprios procedimentos para manipular a documentação submetida, e estes serão descritos em seus web sites.
Se você for a única pessoa trabalhando em um determinado idioma (ou se você é o responsável pelo projeto de tradução e quer submeter suas mudanças de volta para o projeto FreeBSD) então você deve enviar sua tradução ao Projeto FreBSD (veja pergunta seguinte).
9.10. Eu sou a única pessoa trabalhando na tradução para este idioma, como faço para enviar meus documentos?
ou
Nós somos uma equipe de tradução, e queremos submeter os documentos que nossos membros traduziram para nós.
Primeiramente certifique-se que sua tradução está organizada corretamente. Isto significa que ela deve se encaixar na árvore de diretórios corrente e ser processada de maneira correta.
Atualmente a documentação do FreeBSD é armazenada em um diretório de nível superior chamado head/. Os diretórios abaixo deste são nomeados de acordo com o código do idioma em que eles estão escritos, definidos na ISO639 (/usr/share/misc/iso639 em uma versão do FreeBSD mais nova que 20 de janeiro de 1999).
Se seu idioma puder ser codificado de maneiras diferentes (por exemplo, Chinês) então deverão existir outros diretórios abaixo deste, um para cada formato que você tenha forncecido.
Finalmente você deve ter diretórios para cada original.
Por exemplo, em uma hipotética tradução para o Sueco ficaria assim:
head/ sv_SE.ISO8859-1/ Makefile htdocs/ docproj books/ faq/ Makefile book.xml
sv_SE.ISO8859-1 é o nome da tradução, na forma lang.encoding. Repare nos dois Makefiles que serão usados para construir a documentação.
Use tar(1) e gzip(1) para compactar sua documentação, e envie para o projeto.
% cd doc % tar cf swedish-docs.tar sv_SE.ISO8859-1 % gzip -9 swedish-docs.tar
Coloque o arquivo swedish-docs.tar.gz em algum lugar.
Se você não tiver acesso ao seu próprio espaço web (talvez seu ISP não
disponibilize um), então você pode enviar um email para Equipe de Engenharia de
Documentação <doceng@FreeBSD.org>
, e combinar de enviar
os arquivos por email quando for conveniente.
De qualquer forma, você deve usar o send-pr(1) para enviar um relatório indicando que você submeteu a documentação. Seria muito útil se você conseguisse outras pessoas para revisar a sua tradução antes de submetê-la, uma vez que é improvável que a pessoa que irá disponibilizá-la no repositório seja fluente no seu idoma.
Alguém (provavelmente o gerente do projeto de documentação, atualmente Equipe de
Engenharia de Documentação <doceng@FreeBSD.org>
) irá examinar
os seus arquivos e irá confirmar se eles compilam sem erros. Em especial, os
seguintes items serão verificados:
Todos os seus arquivos usam strings RCS (tais como "ID")?
O make all no diretório sv_SE.ISO8859-1 funciona corretamente?
O make install funciona corretamente?
Se houver algum problema, a pessoa que estiver examinando a sua submissão irá entrar em contato para que você faça as correções.
Se não exitir nenhum problema, os seus documentos traduzidos serão disponibilizados no repositório o quanto antes.
Nós preferimos que você não faça isso.
Por exemplo, suponha que você esteja traduzindo o Manual do FreeBSD para o Coreano e queira incluir uma seção sobre varejistas na Coréia em seu Manual do FreeBSD.
Não há razão pela qual esta informação não deva estar nas versões em Inglês (ou Alemão, ou Espanhol, ou Japonâs, ou …). É possível que uma pessoa que fale Inglês na Coréia possa tentar obter uma cópia do FreeBSD enquanto esteja ali. Isso também ajuda a aumentar a presença perceptível do FreeBSD ao redor do mundo, o que não é uma coisa ruim.
Se você tem uma informação específica do seu país, por favor, submeta ela para alteração no Manual do FreeBSD em Inglês (usando send-pr(1)) e depois traduza novamente para sua língua no Manual do FreeBSD traduzido.
Obrigado.
Caracteres não-ASCII devem ser incluídos na documentação usando entidades SGML.
Resumidamente, eles são um ``e'' comercial (&), o nome da entidade e um ponto-e-vírgula (;).
Os nomes de entidades estão definidos no ISO8879, que está na árvore do ports como textproc/iso8879.
Alguns exemplos Incluem
Entidade: é
Aparência: é
Descrição: “e” minúsculo com acento agudo
Entidade: É
Aparência: É
Descrição: “E” maiúsculo com acento agudo
Entidade: ü
Aparência: ü
Descrição: “u” minúsculo com trema
Depois que você instalar o pacote iso8879, os arquivos em /usr/local/share/xml/iso8879 conterão a lista completa.
Nos documentos em Inglês, o leitor é tratado por “você”, não há distinção entre formal/informal como existe em alguns idiomas.
Se você estiver traduzindo para um idioma que tenha esta distinção, use qualquer forma que normalmente é usada em outras documentações técnicas. Na dúvida, use a forma mais polida.
Sim.
O cabeçalho da versão em Inglês de cada documento será parecido com o texto exibido abaixo:
<!-- The FreeBSD Documentation Project $FreeBSD: head/en_US.ISO8859-1/books/faq/book.xml 38674 2012-04-14 13:52:52Z $ -->
A forma exata pode mudar, mas ela sempre incluirá a linha $FreeBSD$ e a frase The FreeBSD Documentation Project. Note que o $FreeBSD é inserido pelo svn, portanto ele deve estar vazio (apenas $FreeBSD$) para novos documentos.
O seu documento traduzido deve incluir sua própria linha $FreeBSD$, e você deve mudar a linha FreeBSD Documentation Project para The FreeBSD language Documentation Project.
Você deve ainda adicionar uma terceira linha que indicará qual revisão do texto em inglês o texto é baseado.
Assim, a versão em Espanhol deste arquivo pode começar com:
<!-- The FreeBSD Spanish Documentation Project $FreeBSD: head/es_ES.ISO8859-1/books/faq/book.xml 38826 2012-05-17 19:12:14Z hrs $ Original revision: r38674 -->
Este, e outros documentos, podem ser obtidos em ftp://ftp.FreeBSD.org/pub/FreeBSD/doc/.
Para perguntas sobre FreeBSD, leia a documentação antes de contatar <questions@FreeBSD.org>.
Para perguntas sobre esta documentação, envie e-mail para <doc@FreeBSD.org>.