| Primer do Projeto de Documentação do FreeBSD para novos colaboradores | ||
|---|---|---|
| Anterior | Capítulo 1. Visão Geral | Próxima |
Se você deseja ir começando, e se sente seguro de que pode ir pegando as coisas a medida que avança, siga estas instruções.
Instale o meta-port textproc/docproj.
# cd /usr/ports/textproc/docproj # make JADETEX=no install
Obtenha uma cópia local da árvore de documentação do FreeBSD (doc). Utilize o CVSup em modo checkout para fazer isso, ou então obtenha uma cópia completa do repositório CVS localmente.
Se você possui uma cópia local do repositório CVS, então o mínimo que você vai precisar será retirar uma cópia de trabalho dos diretórios doc/share, e doc/en_US.ISO8859-1/share.
% cvs checkout doc/share % cvs checkout doc/en_US.ISO8859-1/share
Se você tiver abundância de espaço em disco, você pode retirar uma cópia de trabalho completa (de todos os subdiretórios da árvore doc).
% cvs checkout doc
Se você está preparando uma alteração a um artigo ou livro existente, retire uma versão de trabalho do arquivo do repositório. Se você está planejando contribuir com um novo livro ou artigo, então utlize um dos existentes como guia.
Por exemplo, se você deseja contribuir com um novo artigo sobre como configurar uma VPN entre o FreeBSD e o windows 2000, você pode fazer o seguinte:
Retire uma cópia de trabalho do diretório articles.
% cvs checkout doc/en_US.ISO8859-1/articles
Copie um artigo existente para utilizar como template. Neste caso, você decidiu que o seu novo artivo iria para um diretório chamado vpn-w2k .
% cd doc/en_US.ISO8859-1/articles % cp -r committers-guide vpn-w2k
Se você deseja editar um documento existente, como por exemplo o FAQ, o qual está em doc/en_US.ISO8859-1/books/faq você deve retirar a cópia de trabalho do repositório da seguinte forma:
% cvs checkout doc/en_US.ISO8859-1/books/faq
Edite os arquivos .sgml utilizando o editor da sua preferência.
Teste a marcação SGML utilizando o alvo lint com o comando make. Isto irá listar rapidamente qualquer erro existente no documento sem realizar realmente qualquer tipo de transformação no seu arquivo a que consumiria tempo.
% make lint
Quando você estiver pronto para efetivamente compilar o documento, você pode
especificar um único formato ou uma lista de formatos de destino, na variável
FORMATS . Atualmente os formatos suportados são, html, html-split, txt,
ps, pdf, e rtf. A lista mais atualizada dos formatos suportados está listada no
inicio do arquivo doc/share/mk/doc.docbook.mk file.
Certifique-se de utilizar aspas (") em volta da lista de
formatos quando você estiver compilando mais de um formato num uníco comando.
Por exemplo, para converter o documento apenas para html, você deve utilizar:
% make FORMATS=html
Mas quando você deseja converter o documento tanto para o formato html quanto para o formato txt, você pode utilizar duas execuções separadas do make(1), como a seguir:
% make FORMATS=html % make FORMATS=txt
ou, você pode fazer isso em um único comando:
% make FORMATS="html txt"
Envie suas alterações utilizando o send-pr(1).
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>.