Documentação FirebirdPara escritores de documentação FirebirdGuia de escrita → Ferramentas
Firebird home Firebird home Anterior: Introdução DocBook XMLPrincipal: Documentação FirebirdAcima: Guia de escritaPróxima: Escrevendo seu documento

Ferramentas para criar documentos DocBook XML

Por causa que DocBook é um formato não-binário, você pode usar qualquer editor de texto puro como emacs, pico, Bloco de Notas do Windows, vi, etc para escrever sua documentação. E alguns escritores de documentação realmente preferem essa abordagem em vez de ferramentas mais sofisticadas por que isso lhes dá controle completo do texto, e as tags digitadas são sempre visíveis. Mas o preço disso é que os editores de texto puro não podem validar seu documento em DocBook, de modo que somente após a geração dos documentos finais falhar é que você se dará conta do problema. E as estrutura do seu documento - especialmente quando o mesmo é grande - é também difícil de visualiza em modo texto, embora um uso consistente de indentação possa melhorar muito a situação.

Se você deseja seguir por este caminho ou apenas tentar para ver como funciona, seria uma boa idéia de um editor que permita realce de sintaxe no XML. Um muito bom, e também grátis, é o ConText. Obtenha-o em http://www.fixedsys.com/context/.

Mas para a maioria das pessoas é desejável o uso de uma ferramenta dedicada. Ferramentas de elaboração de XML geralmente possuem interfaces gráficas que fazem as tags sobressaírem muito bem (e algumas vezes irritantemente); muitas permitirão que recolham e expandam elementos de modo que você possa ver a estrutura do seu documento e ao mesmo tempo fazer zoom no elemento que você está trabalhando; podem também você trocar diferentes visôes. Algumas tem um modo DocBook especial, onde seu documento será validado não somente como XML, mas também validado como DocBook.

O autor deste documento tentou diversas dessas ferramentas (algumas grátis, outras baratas e versões de avaliação) e descobriu que o XMLMind XML Editor (XXE) como sendo o mais útl. Essa é uma opinião pessoal, claro; sua experiência pode ser diferente.

Nota

Do Tradutor: Faço coro com o autor com relação ao XXE. Excelente editor, mas tenha um outro editor de XML à mão para editar o arquivo firebirddocs-pt_br.xml.

Alguns editores que você talvez deseje avaliar:

Esta lista não tem a intensão de ser exaustiva, mas se você conhece alguma bom XML editor (bom sob a perspectiva de um escritor de documentos do Firebird) que você acha que deva estar aqui, deixe-nos saber via a lista de discussão.

Anterior: Introdução DocBook XMLPrincipal: Documentação FirebirdAcima: Guia de escritaPróxima: Escrevendo seu documento
Documentação FirebirdPara escritores de documentação FirebirdGuia de escrita → Ferramentas