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:

XMLMind XML Editor, ou XXE. A Edição Standard é grátis.

http://www.xmlmind.com/xmleditor/

Roda em: Linux, Windows, Mac OS X. Requer Java, mas você precisa do Java de qualquer maneira ou você não será capaz de gerar os documentos a partir dos fontes – veja o Howto Gerando as manuais Firebird

Funcionalidades: Visão em árvore (todos os elementos recolhíveis) e visão estilizada (Capítulos e seções recolhíveis). A última é aquela na qual eu trabalho: mostra o documento num simples (mas limpo) layout imitando processador de texto, definido numa stylesheel que vêm com o programa. Ambas as visôes podem estar ativas simultaneamente. O modo DocBook não deixa você entrar nada inválido. Seletor de elementos. Editor de atributos. Funções de busca e edição. Barra de botões para criar elementos mais utilizados como seções, listas, tabelas, etc. Seletor de caracteres especiais.Corretor ortográfico. O que eu sinto falta é uma visão de XML em texto puro.
epcEdit. € 89 para uso não-comercial. Versão de avaliação (60-dias) disponível.

http://www.epcedit.com

Rode em: Linux, Windows, Solaris. Requer Tcl/Tk 8.1 ou acima (incluído na instalação).

Funcionalidades: Painel da Árvore de estrutura. Seletor de Elementos. Editor de Atributos. Painel de documento pode intercambiar com modo texto puro e modo XML gráfico. Não possui nenhum modo especial para DocBook, mas pode validar qualquer documento XML baseado sobre uma DTD.

Runs on: Linux, Windows, Solaris. Requires Tcl/Tk 8.1 or above (included in package).
Altova XMLSpy Home Edition. US$ 49. Versão de avaliação (30 dias) disponível.

http://www.altova.com/products_ide.html

Roda em Windows. (Algumas pessoas já disseram que roda em linux usando Wine, e no Mac OS X usando o Virtual PC 6).

Funcionalidades: Visões: Texto, Grid (caixas em caixas), Navegador. Todos os elementos recolhíveis exceto na visão texto. Visão Browser é apenas para leitura. Seletor de elementos. Editor de atributos. Funções de Busca e Edição. Seletor de caracteres especiais. Corretor ortográfico.
Altova Authentic. Grátis.

http://www.altova.com/products_doc.html

Tem as mesmas funcionalidades (exceto as visões de Texto e Grid) e roda nos mesmos ambientes do XML Spy. Possui a visão "Authentic" em vez disso e um corretor ortográfico. Este editor na verdade é uma interface, a qual usa uma versão mais restrita do XMLSpy como base.

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.