waarom docbook nodig is?
Het DocBook-formaat is door het OASIS-consortium specifiek ontworpen voor technische documentatie. Het biedt een uitgebreide set tags om de inhoud van uw document te beschrijven.
Hier volgen enkele belangrijke punten die helpen DocBook te begrijpen:
- DocBook is een opmaaktaal
Het lijkt in dit opzicht sterk op HTML. De tags geven uw document structuur en verschijnen gemengd met de informatietekst.
Dit bijzondere kenmerk is revolutionair voor documentatievertaling, omdat de DTP-fase (het document fraai opmaken) eenmalig indirect gebeurt door het originele tekst te taggen. Vertalers hoeven alleen "tussen de tags" te vertalen en met één toetsaanslag wordt de vertaalde uitvoer gegenereerd. - Het is gemaakt voor technische documentatie
DocBook is perfect geschikt voor documentatie van motoronderdelen. Het is echter sterk gericht op computerprogrammatuur-documentatie. - Technisch is DocBook een SGML- of XML-DTD
Dit betekent dat men gebruik kan maken van vele SGML- en XML-bewuste tools. Hoewel DocBook als XML-implementatie relatief nieuw is, heeft het een lange geschiedenis als SGML-implementatie. - DocBook is geen presentatietaal
DocBook let er zorgvuldig op niet vast te leggen hoe de uiteindelijke documentatie eruitziet. Dit stelt de schrijver in staat zich te concentreren op de organisatie en betekenis van het document. Alle presentatieaspecten worden uitbesteed aan stylesheets.
Dit waarborgt dat al uw documenten een consistent uiterlijk hebben, ongeacht wie de technisch schrijver is. - DocBook is aanpasbaar
Het is vrij eenvoudig om de DTD aan te passen aan uw behoeften dankzij de modulaire opbouw. U moet er echter voorzichtig mee omgaan conform SGML/XML-conventies, omdat dit incompatibiliteiten kan introduceren.
Wanneer DocBook wordt gebruikt in combinatie met Norman Walsh's modulaire stylesheets, is het ook mogelijk om aan te passen hoe een DocBook-bestand kan worden afgedrukt of online gezet. - DocBook is uitgebreid
Het grote aantal tags in DocBook zorgt ervoor dat het een breed scala aan situaties en verwerkingsverwachtingen kan ondersteunen.
Dit maakt het enigszins moeilijk om te leren, maar u kunt documentatie schrijven met slechts een beperkte set tags en raadpleeg de referentiedocumentatie wanneer nodig.
Comments