AltaVista
Google

Apêndice G. Documentação

Sumário
G.1. DocBook
G.2. Conjunto de ferramentas
G.3. Geração da documentação
G.4. Criação da documentação
G.5. Guia de estilo

O PostgreSQL possui quatro formatos de documentação principais:

Além desses, podem ser encontrados vários arquivos texto puro README dentro da árvore do código fonte do PostgreSQL, documentando vários tópicos da implementação.

A documentação em HTML e as man pages fazem parte da distribuição padrão, sendo instaladas por padrão. Os formatos PDF e Postscript da documentação estão disponíveis em separado, podendo ser baixados.

G.1. DocBook

Os fontes da documentação estão escritos em DocBook, que é uma linguagem de marcação semelhante, superficialmente, ao HTML. Estas duas linguagens são aplicações da Linguagem Padrão de Marcação Generalizada (Standard Generalized Markup Language), SGML, que é essencialmente uma linguagem para descrever outras linguagens. No que vem a seguir, é utilizado tanto o termo DocBook quanto SGML, mas tecnicamente estes dois termos não são intercambiáveis.

O DocBook permite ao autor especificar a estrutura e o conteúdo de um documento técnico, sem se preocupar com os detalhes da apresentação. O estilo do documento define como o conteúdo é apresentado em uma dentre várias formas finais. O DocBook é mantido pelo grupo OASIS. O sítio oficial do DocBook possui uma boa documentação introdutória e de referência, além de um livro completo da O'Reilly que pode ser lido on-line. O Projeto de Documentação do FreeBSD também usa o DocBook e possui boas informações, incluindo vários guias para estilo que valem a pena serem levados em consideração.

Notas

[1]

man pages — Unix Manual Page - Uma parte da extensa documentação on-line do Unix. FOLDOC - Free On-Line Dictionary of Computing (N. do T.)

SourceForge.net Logo CSS válido!