DocBook uitproberen
Widnau (CH), 6/12/2006
Docbook dient voor het maken van documentatie, meestal voor software projecten. Het is een xml taal, die gebruikt maakt van de uit html herkenbare tags afgebakend met groter dan en kleiner dan tekens: “>” en “< "
Je kan met een eenvoudige tekstverwerker werken vanuit de command prompt. Als je met KDE werkt kan je een tekstverwerker als Kate of Quanta gebruiken; die herkennen de code en helpen met de juiste schrijfwijze door kleurcodering.
Er bestaan ook speciaal voor DocBook geschikte tekstverwerkers als "Oxygen", maar dat is geen vrije software. Ongetwijfeld bestaan er heel wat geschikte mogelijkheden als je op zoek gaat.
Ikzelf gebruik Quanta om een kleine test te doen. Daarin kan je "Tools, Highlighting" kiezen, met een reeks mogelijkheden waaronder "xml" en "Doxygen" wat me verdacht sterk aan die voornoemde commerciele tekstverwerker doet denken.
Ik schakel die in om uit te proberen, met terugvalvooruitzicht op xml.
XML heeft een definitie in een "dtd", bv voor docbook, terug te vinden in de titel:
Je kan de dtd ook downloaden en op je eigen machine installeren, zodat de spellingscontrole gebruik kan
maken van de lokale file ipv die op het internet; werkt sneller en ook off-line.
Met een tool kan je de struktuur/syntax laten nakijken:
xmllint --noout DocBookTest.xml
Als alles goed is krijg je geen antwoord. Als je er (opzettelijk) een fout inzet:
xmllint –noout DocBookTest.xml
DocBookTest.xml:9: parser error : error parsing attribute name
De omgeving
^
DocBookTest.xml:9: parser error : attributes construct error
De omgeving
^
DocBookTest.xml:9: parser error : Couldn’t find end of Start Tag fout line 8
De omgeving
^
Firefox kan je ook gebruiken, de browser geeft evengoed een fout aan:
XML Parsing Error: not well-formed
Location: file:///home/wig/Documents/Work/DocBook/DocBookTest.xml
Line Number 9, Column 7:De omgeving
——^
Of als het document juist is toont het gewoon de struktuur, in mijn geval na de melding:
This XML file does not appear to have any style information associated with it. The document tree is shown below.