Ultimamente pode-se notar um significativo aumento do interesse pela documentação, introdutória ou avançada, do NetBSD. Trata-se sem dúvida de um sinal da crescente popularidade do sistema e do aumento da massa de usuários. Portanto, é mais que importante continuar a atualizar e a acrescentar o material seja deste guia, seja dos vários HOWTO presentes no site do NetBSD.
Independentemente do próprio nível de conhecimento e de experiência com o NetBSD, qualquer um pode contribuir com o desenvolvimento deste guia. Este apêndice explica de que modo se pode contribuir com o guia e o que é necessário saber antes de começar.
Os principiantes e, mais em geral, aqueles que instalam o sistema pela primeira vez, podem enviar seus próprios comentários e sugestões diretamente para mim indicando, por exemplo, se alguma coisa não funcionou, se um tópico não está explicado de modo suficientemente claro, etc. Ou se pode enviar uma solicitação para que seja tratado de um determinado assunto. Esse tipo de intercâmbio é muito útil.
Os usuários mais avançados podem escrever uma nova seção ou até mesmo um capítulo inteiro para acrescentar ao guia. Ou podem modificar uma parte já existente acrescentando exemplos, figuras ou reformulando-a de maneira mais clara.
Quem tem um pouco de tempo livre pode levar em conta a idéia de traduzir o guia para uma nova língua.
O que quer que se escolha fazer, antes de tudo contate-me. Isso pode evitar trabalho duplicado e inútil.
Quem quiser traduzir o guia deve antes de mais nada pôr-se em contato comigo ou escrever à mailing list netbsd-doc@netbsd.org.
Se outras pessoas já estiverem trabalhando em uma tradução do guia na mesma língua, é possível juntar-se ao grupo, abreviando os prazos de término do trabalho. Se ninguém estiver traduzindo no momento, é sempre possível que alguns capítulos já tenham sido traduzidos no passado. Do contrário será necessário iniciar a tradução a partir do zero. Qualquer que seja a situação que se apresente, não é necessário traduzir o guia inteiro. Mesmo a tradução de um só capítulo será uma contribuição útil e apreciada.
Mesmo quando uma tradução já foi terminada, é necessário manter o guia sempre atualizado, com material novo e com correções no material existente. E é possível, portanto, tornar-se o mantainer de uma versão do guia.
Para iniciar uma tradução do guia basta ter as fontes do mesmo. Ponha-se em contato comigo e lhe enviarei a versão mais recente.
Em maiores detalhes, o que se precisa é:
fontes do guia (em formato SGML/DocBook)
um editor de texto como o vi ou o emacs.
O trabalho de tradução pode ser desenvolvido em qualquer sistema operacional.
Nota: não comece a trabalhar em HTML ou outros formatos: será muito trabalhoso converter o trabalho para o formato SGML/DocBook.
Para traduzir o guia não é necessário aprender a escrever em SGML/DocBook. É suficiente trabalhar com um editor em cima das fontes, substituindo o texto original e deixando invariados os tags. Ou seja, reutilizando a estrutura do documento. A título de exemplo, para traduzir a nota precedente poder-se-ia operar do seguinte modo:
abrir as fontes do capítulo corrente ap-contrib.sgml no editor.
encontrar o texto correspondente à nota precedente, que tem o seguinte aspecto:
<note>
<para>
non iniziate a lavorare in HTML o altri formati:
sarà molto oneroso convertire il lavoro in
formato SGML/DocBook.
</para>
</note> acrescentar a tradução no interior dos tags, depois da versão italiana (ou antes, como preferir). Agora o texto terá este aspecto:
<note>
<para>
non iniziate a lavorare in HTML o altri formati:
sarà molto oneroso convertire il lavoro in
formato SGML/DocBook.
sua tradução vai aqui
sua tradução vai aqui
sua tradução vai aqui
</para>
</note> eliminar as três linhas do texto original italiano deixando a tradução.
<note>
<para>
sua tradução vai aqui
sua tradução vai aqui
sua tradução vai aqui
</para>
</note> Quando se escreve a tradução é preferível utilizar a mesma indentação e a mesma formatação da versão original. Ver Secção C.3 para um exemplo.
Um problema que se deve quase sempre enfrentar quando se escreve em SGML/DocBook é o dos "caracteres nacionais" (por exemplo, as letras acentuadas como "è"). Ainda que possamos utilizar esse tipo de caracter em um documento, é preferível substituí-lo com a correspondente entidade SGML. Por exemplo, o caracter "é" escreve-se "è". É evidente que isso torna mais difícil a escrita e, sobretudo, a leitura do texto mas, pelo menos o problema da escrita pode ser minorado com o uso de um editor que suporte macros. O vi e o emacs, dois editores dentre os mais conhecidos, oferecem a possibilidade de se associar macros às teclas, gerando automaticamente as entidades requeridas. Por exemplo, para se obter automaticamente a letra "e" acentuada precedente, pode-se inserir o seguinte comando no arquivo .exrc:
map! è è
Apêndice D explica como instalar as ferramentas de software necessárias para gerar o formato HTML e outros formatos a partir das fontes DocBook. O formato HTML é o mais simples de gerar e é útil para se verificar a correção das fontes (isto é, que não haja qualquer erro nos tags), assim como para uma leitura mais ágil do texto. Naturalmente, como já dito, a geração do formato HTML não é absolutamente necessária para se efetuar a tradução. O que conta são as fontes traduzidas.
Quem quiser contribuir com o guia enviando material, tem diversas possibilidades, de acordo com a quantidade de texto que quer escrever. Quando se trata apenas de uma breve correção ou adendo, a coisa mais simples é enviar um e-mail para mim com o texto. Providenciarei a inserção no guia.
Se o desejo for escrever uma certa quantidade de texto, como uma seção ou um capítulo inteiro, pode-se escolher entre vários formatos:
SGML/DocBook. Este é o formato preferido. Quando se escolhe esse formato é preciso que se obtenha as fontes do guia e usá-las como esquema para a indentação e para o formato do texto e dos tags.
texto. Se a formatação do texto é simples, a conversão ao formato SGML não é muito trabalhosa.
HTML. É preferível escrevê-lo a mão (isto é, com um editor de texto normal) no lugar de utilizar um gerador de HTML para que a conversão à SGML fique mais simples. O uso do HTML em comparação com o texto puro não traz vantagens particulares, exceto o de tornar mais evidente o formato que se deseja dar ao conteúdo. Um outro benefício colateral é que as entidades HTML para os caracteres acentuados, etc., já estarão provavelmente presentes no texto.
são aceitos também outros formatos, mas apenas nos casos em que não seja possível utilizar nenhum dos precedentes.
Para as fontes do guia é uso um estilo de formatação parecido com o de um programa. Eis um esquema:
<chapter id="chap-xxxxx"> <title>Este é o título de um capítulo</title> <para> Este é o texto. Este é o texto. Este é o texto. Este é o texto. Este é o texto. Este é o texto. </para> <!-- ============================================================= --> <sect1> <title>Título de uma sect1</title> <para> Este é o texto. Este é o texto. Este é o texto. Este é o texto. Este é o texto. Este é o texto. </para> <!-- ........................................................... --> <sect2> <title>Título de uma sect2</title> <para> Uma sect2 é aninhada dentro de uma sect1 </para> </sect2> </sect1> <!-- ============================================================= --> <sect1> <title>Título de uma sect1</title> <para> Esta é uma lista: <itemizedlist> <listitem> <para> texto </para> </listitem> <listitem> <para> texto </para> </listitem> </itemizedlist> </para> </sect1> </chapter>
Os defaults são:
dois espaços para cada nível de indentação
linhas não mais longas que 72 caracteres
usar linhas de separação (comentários) entre sect1/sect2