Strumenti per scrivere in DocBook XML

Editor di testi
Editor XML

Editor di testi

Poichè DocBook è un formato non binario, si può usare qualsiasi editor di testo semplice, come emacs, pico, il blocco note di Windows, oppure vi di Linux/Unix per scrivere il documento. E alcuni scrittori preferiscono proprio questo metodo, rispetto ad altri editor più sofisticati, perchè permette il completo controllo sul loro testo ed i marcatori scritti per esteso sono sempre visibili. Il rovescio della medaglia è che gli editor di testo semplice non possono validare il documento e gli errori si potranno notare solo quando la ricostruzione non funziona. Inoltre la struttura di un documento, specialmente di quelli grandi, è difficile da seguire in modo testo, anche se un consistente uso dell'indentazione può aiutare.

Volendo usare questo metodo, o almeno per provarlo, sarebbe bene almeno utilizzare un editor di testo in grado di evidenziare la sintassi XML. Uno adatto, ed al momento di uso gratuito, è ConText, disponibile a http://www.fixedsys.com/context/. Purtroppo ConText non è in grado di salvare i caratteri in formato UTF-8. Questo non è un problema per i documenti in US-ASCII (basta salvarli come DOS o Unix), ma appena si usano caratteri accentati o qualsiasi carattere oltre ASCII 127, ConText diventa inutile. Un'alternativa, sempre gratuita, è SciTE a http://scintilla.sourceforge.net/SciTEDownload.html. È meno intuitivo, ma molto potente.

Avvertimento

Non salvare documenti contenenti caratteri non US-ASCII in formato 8-bit, sia in ConText che in qualsiasi altro editor! Qualsiasi cosa che non sia US-ASCII deve essere salvato in codifica Unicode, ad esempio UTF-8 (per molti linguaggi) o UTF-16 (per altri languaggi, se la lunghezza del file in UTF-16 è minore o non molto più grande di UTF-8). Di fatto, questi motivi legati alle codifiche, sono un altro buon motivo per usare gli editor XML, perchè di solito salvano nel formato corretto automaticamente.

Editor XML

Gli editor dedicati a XML hanno spesso un'interfaccia adatta a gestire i marcatori in modo più semplice (anche se in qualche caso fastidioso); molti permettono di collassare ed espandere gli elementi strutturali in modo da verificare la struttura del documento ed allo stesso tempo di zoomare nell'elemento su cui si sta' lavorando; permettono inoltre di passare tra diverse modalità di vista. Molte possono validare il documento rispetto al DTD di DocBook, ed alcune anche hanno perfino una modalità di scrittura che permette di scrivere quasi come in un word processor.

L'autore di questa guida ne ha provati un gran numero (gratuiti, economici, versioni di valutazione) e ha trovato che XMLMind XML Editor è il più utile. Questa è un'opinione personale, naturalmente (N.d.T. coincide, se è permesso, con con quella del traduttore); naturalmente l'esperienza di ciascuno può essere diversa.

Alcuni XML editors da prendere in considerazione sono:

XMLMind XML Editor, detto brevemente XXE. L'edizione standard è gratuita.

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

Esiste per Linux, Windows e Mac OS X. Richiede Java, ma comunque Java sarebbe necessario altrimenti non si riuscirebbe a ricostruire la documentazione dai sorgenti, vedi Come scaricare e ricostruire il modulo del manuale di Firebird.

Caratteristiche: vista ad albero (tutti gli elementi collassabili) e vista testo (capitoli e sezioni collassabili). Questa è la modalità in cui di solito si lavora: mostra il documento in modo che sembri il semplice e chiaro word processor d'una volta, definito con dei fogli di stile che vengono con il programma. Entrambe le viste possono essere attive contemporaneamente. La modalità DocBook non permette di immettere nulla che non sia aderente alle specifiche DocBook. Selezionatore di elementi, editor degli attributi. Funzioni di ricerca e sostituzione. Dizionario (purtroppo non ancora in italiano). Selezione di caratteri speciali. Pulsanti per creare gli elementi usati più di frequente come sezioni, liste, tabelle, ecc. Sembra mancare una vista del testo XML vero e proprio.
Oxygen XML Editor. $ 48 per usi non commerciali. Prova gratuita per 30 giorni.

http://www.oxygenxml.com

Esiste per Windows, Mac OS X, Linux, Eclipse. Richiede Java.

Caratteristiche: editor del sorgente XML. Editor dell'albero. Editor di attributi. Pannello della struttura. Suggerimenti dei marcatori DocBook. XSLT debugger (uno strumento molto potente, non importante per scrivere ma per lavorare sui fogli di stile delle trasformazioni). Validazione, ristrutturazione, dizionario, ecc. ecc. Un XML editor proprio buono.
epcEdit. € 89 per usi non commerciali. Prova gratuita per 60 giorni.

http://www.epcedit.com

Esiste per: Linux, Windows, Solaris. Richiede Tcl/Tk 8.1 o superiore (incluso nel pacchetto).

Caratteristiche: Pannello della struttura ad albero. Selezione degli elementi. Editor di attributi. Il pannello del documento può passare dalla vista testo puro a quella grafica XML. Nessuna particolare modalità per DocBook, ma può validare ogni documento XML basandosi sul suo DTD.
Altova XMLSpy. La versione Home Edition è adesso gratuita.

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

Esiste per: Windows, Eclipse. (Si dice che funzioni su Linux usando Wine, e su Mac OS X usando Virtual PC 6.)

Caratteristiche: Vista testo e navigatore. Tutti gli elementi sono collassabili nella vista navigatore, che però è in sola lettura. Selezione degli elementi. Selezione degli attributi. Funzioni modifica e cerca. Selezione dei caratteri speciali.

C'è una matrice di comparazione delle caratteristiche delle versioniHome, Professional e Enterprise a http://www.altova.com/matrix_x.html.

Questo elenco non intende essere completo; tuttavia, conoscendo un buon editor XML (cioè adatto a scrivere documento per Firebird) e ritenendo debba essere in questa lista, si può farcelo come al solito sapere attraverso la mailing list.