Primer do Projeto de Documentação do FreeBSD para novos colaboradores

Projeto de documentação do FreeBSD

Copyright © 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 DocEng

Obrigado por tornar-se parte do Projeto de Documentação do FreeBSD. A sua contribuição é extremamente valiosa.

Este Primer do Projeto de Documentação do FreeBSD cobre tudo o que você precisa saber para começar a contribuir com o Projeto de Documentação do FreeBSD, desde as ferramentas e softwares que você estará utilizando (tanto os obrigatórios quanto os recomendados) à filosofia por trás do projeto de documentação.

Este documento é um trabalho em andamento, e não está completo. As sessões que sabemos estarem incompletas estão indicadas com um * no seu nome.

[ Split HTML / Single HTML ]
Índice
Prefácio
Prompt do interpretador de comandos (shell)
Convenções Tipográficas
Notas, dicas, informações importantes, avisos e exemplos
Agradecimentos
1 Visão Geral
1.1 Conjunto de Documentação do FreeBSD
1.2 Antes de você iniciar
1.3 Início Rápido
2 Ferramentas
2.1 Ferramentas Obrigatórias
2.1.1 Software
2.1.2 Entidades e DTDs
2.1.3 Stylesheets
2.2 Ferramentas Opcionais
2.2.1 Software
3 SGML Primer
3.1 Visão Geral
3.2 Elementos, tags, e atributos
3.2.1 Para você fazer…
3.3 A declaração DOCTYPE
3.3.1 Identificadores públicos formais (FPIs)
3.3.2 Alternativas aos FPIs
3.4 Voltando para o SGML
3.5 Comentários
3.5.1 Para você fazer…
3.6 Entidades
3.6.1 Entidades gerais
3.6.2 Entidades de parâmetro
3.6.3 Para você fazer…
3.7 Utilizando entidades para incluir arquivos
3.7.1 Utilizando entidades gerais para incluir arquivos
3.7.2 Utilizando entidades de parâmetro para incluir arquivos
3.7.3 Para você fazer…
3.8 Sessões marcadas
3.8.1 Palavras-Chave de sessões marcadas
3.8.2 Para você fazer…
3.9 Conclusão
4 Marcação SGML
4.1 HTML
4.1.1 Identificador Público Formal (IPF)
4.1.2 Elementos de Seção
4.1.3 Bloco de Elementos
4.1.4 Elementos In-line
4.1.5 Links
4.2 DocBook
4.2.1 Extensões FreeBSD
4.2.2 Identificador Formal Público (IFP)
4.2.3 Estrutura dos Documentos
4.2.4 Elementos de Blocos
4.2.5 Elementos In-line
4.2.6 Imagens
4.2.7 Links
5 * Folhas de Estilo
5.1 * DSSSL
5.2 CSS
5.2.1 Documentos DocBook
6 Estruturando Documentos Sob doc/
6.1 O Nível Superior, doc/
6.2 Os Diretórios de idioma.codificação
6.3 Informação Específica do Documento
6.3.1 O Handbook
7 O processo de construção da documentação
7.1 Ferramentas para construção da documentação do FreeBSD
7.2 Entendendo Makefiles na árvore da documentação
7.2.1 Makefiles de Subdiretórios
7.2.2 Makefiles de Documentação
7.3 Includes do Make do projeto de documentação do FreeBSD
7.3.1 doc.project.mk
7.3.2 doc.subdir.mk
8 O Website
8.1 Preparação
8.1.1 Usando o svn
8.2 Construa as páginas web do início
8.3 Instalando as web pages em seu Web Server
8.4 Variáveis de ambiente
9 Traduções
10 Estilo de Escrita
10.1 Guia de Estilo
10.1.1 Caixa de Letra (Maiúscula/Minúscula)
10.1.2 Acrônimos
10.1.3 Identação
10.1.4 Estilo de Tags
10.1.5 Mudanças nos espaços em branco.
10.1.6 Nonbreaking space
10.2 Lista de Palavras
11 Usando sgml-mode com o Emacs
12 Veja também
12.1 Projeto de documentação do FreeBSD
12.2 SGML
12.3 HTML
12.4 DocBook
12.5 Projeto de documentação do Linux
A. Exemplos
A.1 DockBook <book>
A.2 DocBook <article>
A.3 Produzindo saídas formatadas
A.3.1 Usando o Jade
Lista de Exemplos
1. Uma amostra de exemplo
3-1. Utilizando um elemento (tags de inicio e fim)
3-2. Utilizando um elemento (Apenas tag de início)
3-3. Elementos contendo elementos; <em>
3-4. Utilizando um elemento com um atributo
3-5. Aspas simples envolta de atributos
3-6. .profile, para os usuários dos shells sh(1) e bash(1)
3-7. .cshrc, para os usuários dos shell csh(1) e tcsh(1)
3-8. Comentário SGML genérico
3-9. Comentários SGML errados
3-10. Definindo uma entidade geral
3-11. Definindo entidades de parâmetros
3-12. Utilizando entidades gerais para incluir arquivos
3-13. Utilizando entidades de parâmetro para incluir arquivos.
3-14. Estrutura de uma sessão marcada
3-15. Utilizando uma sessão marcada como CDATA
3-16. Utilizando INCLUDE e IGNORE nas sessões marcadas
3-17. Utilizando uma entidade de parâmetro para controlar uma sessão marcada
4-1. Estrutura Normal de um Documento HTML
4-2. <h1>, <h2>, e outras Tags de Header.
4-3. Má organização de elementos <hn>
4-4. <p>
4-5. <blockquote>
4-6. <ul> e <ol>
4-7. Listas de Definição com <dl>
4-8. <pre>
4-9. Uso Simples de <table>
4-10. Utiliizando rowspan
4-11. Usando colspan
4-12. Usando rowspan e colspan juntos
4-13. <em> e <strong>
4-14. <b> e <i>
4-15. <tt>
4-16. <big>, <small>, e <font>
4-17. Usando <a href="...">
4-18. Usando <a name="...">
4-19. Link para uma determinada parte de outro documento
4-20. Links para determinada parte do mesmo documento
4-21. Modelo padrão <book> com <bookinfo>
4-22. Modelo padrão <article> com <articleinfo>
4-23. Um capítulo simples
4-24. Capítulos Vazios
4-25. Seções em Capítulos
4-26. <para>
4-27. <blockquote>
4-28. <warning>
4-29. <itemizedlist>, <orderedlist>, e <procedure>
4-30. <programlisting>
4-31. <co> e <calloutlist>
4-32. <informaltable>
4-33. Tabelas com frame="none"
4-34. <screen>, <prompt>, e <userinput>
4-35. <emphasis>
4-36. Citações
4-37. Teclas, Mouse e Combinações
4-38. Aplicações, Comandos, Opções
4-39. <filename>
4-40. Tag <filename> com o atributo package
4-41. <devicename>
4-42. <Hostid> e Roles
4-43. <Username>
4-44. <Maketarget> e <Makevar>
4-45. <Literal>
4-46. <replaceable>
4-47. <errorname>
4-48. O atributo id em capítulos ou seções
4-49. <anchor>
4-50. Usando <xref>
4-51. Usando <link>
4-52. <ulink>
A-1. DocBook <book>
A-2. DocBook <article>
A-3. Convertendo de DocBook para HTML (em um único grande arquivo)
A-4. Convertendo de DocBook para HTML (vários arquivos pequenos)
A-5. Convertendo de DocBook para Postscript
A-6. Convertendo de DocBook para PDF
    Próxima
    Prefácio

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>.