FreeBSD Handbook/Prefácio para o WikiLivros

Nota do "autor"

Minha proposta aqui é que o livro "FreeBSD Handbook" seja criado em língua portuguesa. O projeto de documentação original do sistema FreeBSD é um dos melhores existentes no âmbito do software livre, mas a tradução do livro para o português encontra-se sempre um ou vários passos atrás da versão original. As normas de documentação do projeto exigem que os voluntários aprendam novas tecnologias e linguagens de descrição de texto, nem sempre ao alcance de todos os que querem colaborar e que também tiram a praticidade e agilidade do colaborador. Vejo o WikiLivros como um meio para facilitar a existência do livro em português e ainda servir como meio de colaboração dos usuários desta língua com o projeto de documentação. Neste sentido convido os voluntários a colaborar com a tradução dos trechos ainda não traduzidos e a alterar os conteúdos mostrados. Em minha experiência ministrando cursos de FreeBSD pude localizar vários trechos que estão dúbios ou que poderiam ser melhor escritos, mesmo na língua original, e é isso que espero conseguir melhorar por aqui, com a ajuda de outros.

Como o livro está sendo feito

Copiar toda a estrutura do conteúdo em inglês
Alterar o conteúdo em inglês pelo já traduzido aqui nas partes em que isso estiver disponível. Optei por isso, pois já não dá mais para iniciar pela tradução já feita, que está bem defasada e peca inclusive na estrutura de tópicos.
Ajustar o conteúdo à formatação do wiki
Traduzir e melhorar o texto original
Acompanhar as alterações do trabalho no livro em inglês para inserir aqui as melhorias
Levar daqui para o projeto original as melhorias que acontecerem

Para isso registramos as alterações no sentido e conteúdo do texto original na discussão da página principal do livro

"Wikando" em 10 minutos

O wiki tem uma linguagem de formatação própria, que tende a ser simples para ser acessível também a pessoas não técnicas. Vamos ver alguns tópicos que já permitirão ao novato iniciar sua colaboração em uns 10 minutos (ou coisa parecida).

Criando uma nova página

É só criar um link para uma página não existente e em seguida entrar neste link. Ao entrar no link o sistema te abrirá uma tela para começar a página do zero. A seguir falo sobre como criar este link. Observe que um link para uma página que ainda não existe fica em vermelho. Qualquer link vermelho já existente lhe permitirá criar a página correspondente ao clicar sobre ele.

Editando uma página já existente

Basta estar lendo uma página e clicar no link "editar", na aba no topo da página. Isso abrirá a página para edição com o atual conteúdo dela com os "comandos" de formatação do wiki.

Sintaxe geral:

- Lista de itens: Para criar uma lista de itens basta usar o asterisco "*" no início da linha (primeiro item na linha, sem espaços ou outras coisas antes).
- Lista numérica: Para criar uma lista numerada basta usar o "#" ao invés do "*" mencionado acima. Por exemplo, se escrevermos a lista abaixo no código da página:

Primeiro item
Próximo item
Mais um item

Ela aparecerá assim ao salvar a página 1. Primeiro item 2. Próximo item 3. Mais um item

- Links: Para criar um link são usados os colchetes: [e]. Um link para uma página no próprio wiki usa dois colchetes de cada lado, já um link para um site na internet usa apenas um link, como mostra o exemplo:

Um link interno para o próprio wiki, que permite criar nova página inclusive: Isso [[Nova Página]] apareceria assim: Nova Página Um link para um site na internet: Isso [http://www.xpto.com/ Texto que aparecerá] apareceria assim: Texto que aparecerá

- Títulos: Títulos são delimitados pelos sinais de igual: "=". Se houver apenas um sinal de cada lado do título ele será de primeiro nível. Se colocarmos dois, será de segundo nível e assim por diante até o 5º nível. Um exemplo de escrita de um título de segundo nível:

Título de segundo nível

É necessário que o sinal de igual esteja no início da linha. Usualmente são usados os títulos de segundo ao quinto nível, pois o de primeiro nível se iguala ao título da página, que já aparece automaticamente.

Com essas dicas básicas já dá para fazer bastante coisa. Acesse a ajuda do sistema para mais informações, pois há ainda muitos detalhes sobre como escrever no Wiki. Se você levou mais de 10 minutos para ler isso me avise...

Dicas gerais

Use títulos iniciando todas as palavras com letras maiúsculas, exceto em pronomes e artigos e em nomes de comandos, como sysinstall
Use um corretor ortográfico

Copie o texto para um editor com corretor ortográfico para que a página não contenha erros básicos. Outra possibilidade é usar o Firefox com um complemento para correção ortográfica chamado VERO, que já vai verificar o texto a medida que for digitado no editor, conforme as regras do novo acordo ortográfico da língua portuguesa.

Mantenha os padrões da página: cabeçalho, rodapé, estilos de texto para campos específicos
Coloque um sumário sobre a alteração que está fazendo na página editada. Há um campo para isso no sistema, logo abaixo da área de edição da página. Isso ajuda a acompanhar a evolução do livro
Mantenha alguns dos tags HTML originais, isso pode facilitar quando quisermos levar o conteúdo daqui de volta para o SGML/docbook da documentação oficial. Procuro manter principalmente itálico, bold e <tt> que carreguem "class" para definir uma formatação. Não adianta manter âncoras com <a, pois o wiki não as aceita.
Use espaços definidos com   para evitar que informações se separem, indo parte para a linha de baixo, como em "20 MB" -> "20 MB"
Observe que em português nós não costumamos usar vírgula antes de "e", como em "1, 2, e 3" e a documentação em inglês está cheia disso, o que se refletiu na documentação que já temos traduzida também.
Mesmo que não queira adotar essas práticas, não deixe de contribuir, qualquer ajuda é bem-vinda

Última edição desta página: 15/03/2013 (20130315153547)