Primer do Projeto de Documentação do FreeBSD para Novos Colaboradores
		Próxima

Primer do Projeto de Documentação do FreeBSD para Novos Colaboradores

Projeto de Documentação do FreeBSD

2020-08-05 22:09:20 +0000 por Danilo G. Baio.

Resumo

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

Este primer cobre tudo o que você precisa saber para começar a contribuir com o Projeto de Documentação do FreeBSD, ou FDP, incluindo ferramentas, softwares, e a filosofia por trás do Projeto de Documentação.

Este documento é um trabalho em andamento. Correções e adições são sempre bem vindas.

[ Documento HTML em partes / Documento HTML completo ]

Índice

Prefácio

1. Prompts do Shell
2. Convenções Tipográficas
3. Notas, Dicas, Informações Importantes, Avisos e Exemplos
4. Agradecimentos

1. Visão Geral

1.1. Quick Start
1.2. Conjunto de Documentação do FreeBSD

2. Ferramentas

2.1. Ferramentas Obrigatórias
2.2. Ferramentas Opcionais

3. A Área de Trabalho

3.1. Documentação e Páginas de Manual
3.2. Escolhendo um Diretório
3.3. Baixando uma Cópia
3.4. Atualizando
3.5. Revertendo Alterações
3.6. Criando um Diff
3.7. Referências Subversion

4. Estrutura de Diretórios da Documentação

4.1. O Nível Superior, doc/
4.2. Os Diretórios lang.encoding/
4.3. Informação Específica de Documentação

5. O Processo de Compilação da Documentação

5.1. Renderizando DocBook
5.2. O Conjunto de Ferramentas de Compilação da Documentação do FreeBSD
5.3. Noções Básicas de Makefiles no Repositório de Documentação
5.4. Includes do Make do Projeto de Documentação do FreeBSD

6. O Website

6.1. Variáveis de Ambiente
6.2. Compilando e Instalando as Páginas Web

7. Primer XML

7.1. Visão Geral
7.2. Elementos, Tags e Atributos
7.3. A Declaração DOCTYPE
7.4. De Volta para o XML
7.5. Comentários
7.6. Entidades
7.7. Usando Entidades para Incluir Arquivos
7.8. Seções Marcadas
7.9. Conclusão

8. XHTML Markup

8.1. Introdução
8.2. Identificador Público Formal (FPI)
8.3. Seções de Elementos
8.4. Elementos Block
8.5. Elementos In-line

9. DocBook Markup

9.1. Introdução
9.2. Extensões do FreeBSD
9.3. Identificador Público Formal (FPI)
9.4. Estrutura do Documento
9.5. Elementos Block
9.6. Elementos In-line
9.7. Imagens
9.8. Links

10. Folhas de Estilo

10.1. CSS

11. Traduções

12. Traduções PO

12.1. Introdução
12.2. Quick Start
12.3. Criando Novas Traduções
12.4. Traduzindo
12.5. Dicas para Tradutores
12.6. Compilando um Documento Traduzido
12.7. Submetendo a Nova Tradução

13. Páginas de Manual

13.1. Introdução
13.2. Seções
13.3. Marcação
13.4. Exemplo de Estruturas de Página de Manual
13.5. Exemplos de páginas de manuais para usar como modelos
13.6. Recursos

14. Estilo de escrita

14.1. Dicas
14.2. Diretrizes
14.3. Guia de estilo
14.4. Lista de palavras

15. Configuração do Editor

15.1. Vim
15.2. Emacs
15.3. nano

16. Veja também

16.1. O projeto de documentação do FreeBSD
16.2. XML
16.3. HTML
16.4. DocBook

A. Exemplos

A.1. Livro DocBook
A.2. Artigo DocBook

Índice Remissivo

Lista de Tabelas

5.1. Formatos de Saída Comuns
12.1. Nomes de Idioma

Lista de Exemplos

1. Uma Amostra de Exemplo
5.1. Compilar um Arquivo Único HTML
5.2. Compilar HTML-Split e PDF
6.1. Compile o Web Site Completo e Todos Documentos
6.2. Compile Apenas o Web Site em Inglês
6.3. Compile e Instale o Web Site
7.1. Utilizando um Elemento (Tag Inicial e Final)
7.2. Usando um Elemento Sem Conteúdo
7.3. Elementos Dentro de Elementos; em
7.4. Usando um Elemento com um Atributo
7.5. Aspas Simples nos Atributos
7.6. XML Comentários Genéricos
7.7. Comentário XML Incorreto
7.8. Definindo Entidades Gerais
7.9. Definindo Entidades de Parâmetro
7.10. Usando Entidades Gerais para Incluir Arquivos
7.11. Usando Entidades de Parâmetro para Incluir Arquivos
7.12. Estrutura de uma Seção Marcada
7.13. Usando uma Seção Marcada CDATA
7.14. Usando INCLUDE e IGNORE em Seções Marcadas
7.15. Usando uma Entidade de Parâmetro para Controlar uma Seção Marcada
8.1. Estrutura de um Documento XHTML
8.2. h1, h2 e Outras Tags de Cabeçalho
8.3. Exemplo p
8.4. Exemplo blockquote
8.5. Exemplo ul and ol
8.6. Listas de Definição com dl
8.7. Exemplo pre
8.8. Uso Simples de table
8.9. Usando rowspan
8.10. Usando colspan
8.11. Usando rowspan e colspan Juntos
8.12. Exemplo em e strong
8.13. Exemplo tt
8.14. Usando <a href="...">
8.15. Criando uma Âncora
8.16. Criando Link para uma Parte Nomeada de um Outro Documento
8.17. Criando Link para uma Parte Nomeada no Mesmo Documento
9.1. Exemplo de book com info
9.2. Exemplo de article com info
9.3. Um Capítulo Simples
9.4. Capítulos Vazios
9.5. Seções em Capítulos
9.6. Exemplo de um para
9.7. Exemplo blockquote
9.8. Example de tip e important
9.9. example
9.10. example Renderizado
9.11. Exemplo de itemizedlist e orderedlist
9.12. Exemplovariablelist
9.13. Exemplo procedure
9.14. Exemplo programlisting
9.15. Exemplo co e calloutlist
9.16. Exemplo informaltable
9.17. Exemplo de Tabela com frame="none"
9.18. Exemplos screen, prompt, e userinput
9.19. Exemplo de emphasis
9.20. Exemplo acronym
9.21. Exemplo quote
9.22. Exemplos de Teclas, Botões do Mouse e Combinações
9.23. Exemplo de Aplicações, Comandos e Opções
9.24. Exemplo filename
9.25. Exemplo de package
9.26. Exemplos systemitem
9.27. Exemplo uri
9.28. Exemplo de Hiperlink com email
9.29. Exemplo de email Sem Hiperlink
9.30. Exemplo de buildtarget e varname
9.31. Exemplo literal
9.32. Exemplo de replaceable
9.33. Exemplo guibutton
9.34. Exemplo errorname
9.35. xml:id em Ccapítulos e sSeções de eExemplo
9.36. Exemplo xref
9.37. link para um Exemplo de Página Web de Documentação do FreeBSD
9.38. link para um Exemplo de Página Web do FreeBSD
9.39. link para um Exemplo de Página Web Externa
12.1. Criando uma Tradução em Espanhol do Porter's Handbook
12.2. Criando uma tradução em Francês do Artigo Chaves Open PGP
12.3. Traduzindo o Porter's Handbook para o Espanhol
12.4. Preservando Tags XML
12.5. Construindo o Porter's Handbook Espanhol
12.6. Tradução Espanhola do Artigo NanoBSD
12.7. Tradução Coreana UTF-8 do Artigo Explicando o BSD
A.1. Livro DocBook
A.2. Artigo DocBook

		Próxima
		Prefácio