Documentação Firebird → Para escritores de documentação Firebird → Obter e gerar as manuais |
Tradução para o Português do Brasil: Fabrício Araújo
13 Mar 2005 – Documento versão 1.1-pt_br
Índice
Este documento explica, passo-a-passo, como você baixa e gera o módulo de manuais do Projeto Firebird no site SourceForge.
O módulo de manuais é parte do Projeto Firebird no SourceForge. É um esforço, direcionado em produzir documentação acurada e abrangente no RDBMS Firebird (Sistema de Gerenciamento de Banco de Dados Relacional).
É importante entender que o módulo de manuais contém documentação em formato fonte – para ser mais preciso: no formato DocBook. Esses fontes precisam ser processados (gerados) para se obter documentos legíveis, os quais podem ser publicados na Internet.
Claro! Na época que este documento foi escrito, a maior parte da documentação útil do Firebird foi feita fora do módulo. Ainda temos uma longa estrada a percorrer antes que a documentação gerada por nós esteja próxima de estar completa. Aliás, facilitar a vida dos novos escritores de documentação e ajudá-los a vencer mais facilmente as dificuldades iniciais é um dos objetivos deste documento.
Se o que você busca é documentação pronta e abundante, atualmente os melhores lugares para iniciar a busca são:
http://www.ibphoenix.com – site da IBPhoenix
Siga os links Downloads -> Main Downloads e Development -> General Documentation
http://www.firebirdsql.org/index.php?op=doc – página de documentação do Projeto Firebird.
Claro que existe! Assim que alguma parte da documentação atinge um certo nível de maturidade, assim como atualizações significativas, esta é publicada – em HTML e PDF – no site do Firebird. Você pode achar todos os documentos que nós publicamos através das páginas índice de HTML e PDF
Ou então visite a página do Subprojeto de Documentação:
Só é necessário baixar o módulo de manuais e gerá-los por si mesmo se (e somente se) você deseja:
obter a versão mais atualizada possível (Esteja avisado que uma das razões de um documento não ter sido publicado é este possuir erros);
ajudar a escrever a documentação;
aprender como essa coisa de gerar documentos funciona, e / ou pensa que fazer as coisas por si mesmo é mais divertido que simplesmente baixar a coisa pronta.
Se uma destas situações se aplica a você, este documento foi feito para você.
Documentação Firebird → Para escritores de documentação Firebird → Obter e gerar as manuais |