dagblog.
← Archiv

DocBook — dokumentace v hrsti


Pokud jste někdy vytvářeli jakýkoliv typ dokumentu nebo se na to chystáte, 
 tak pravděpodobně v průběhu narazíte čí jste spíše již narazili na některý z následujících problémů.

Potřeba srozumitelného(otevřeného) formátu
 Dokument byl vytvořen v editoru, který produkoval soubor v proprietárnim formátu.
 Nezávislost či spíše snadná změna výstupu
 Dokument byl vytvořen pro určitý typ média(elektronické publikování), ale Vy jej potřebujete šířit i jinou cestou(tištěná podoba,hlasový výstup atd.) .
 Snadná práce s dokumentem
 Dokument byl vytvořen a Vy ho potřebujete dále upravovat, sdílet, rozšiřovat

Výše uvedené problémy souvisí s jakýmkoliv druhem dokumentu který si umíte představit, 
 lhostejno jestli se jedná o článek pro místní noviny, vědeckou publikaci, knihu, 
 dokumentaci k hardwaru nebo softwaru či uživatelskou příručku. 
 Všechny výše uvedené problémy mají něco společného, jsou důsledkem míchání toho co 
 dokument vyjadřuje s tím jak to má být prezentováno.

V důsledku potřebujeme jazyk nepopisující prezentaci informace, ale její význam
 a strukturu. Právě pro strukturování informací se dobře hodí jazyk XML. Nyní už stačí
 pouze definovat značky popisující danou strukturu a to je právě úkol DocBooku.

DocBook je ve své podstatě pouze DTD, které určuje strukturu XML dokumentu. DocBook
 tak má tak stejný význam jako XHTML. Jak XHTML tak DocBook vyjadřuje pouze jaký element a kde 
 můžete použít. Pokud píšeme dokument v DocBooku, tak produkujeme XML data popsaná jazykem
 DocBook.

Na jedné straně výhody XML a na druhé dobrá sémantika(rozuměj vyjadřovací schopnost)
 dělají z DocBooku jednu z nejpoužívanějších aplikací SGML/XML(Podle J.Koska dokonce druhou za jazykem HTML).
 O DocBooku se již dále budeme bavit pouze jako o systému neboť XML a DTD je pouze jádro, na které
 se nabalily a nabalují nástroje umožňující jeho zpracování.

DocBook nabízí úžasnou vlastnost, kterou bych charakterizoval jako jednou naspat a mnoha způsoby prezentovat. Pokud v DocBooku napíšeme článek o 
 Matějovi z Horní dolní, můžeme jej velice snadno přetransformovat na HTML pro web a
 také do RTF pro redakci místního novinového plátku využívající nelegální kopii kancelářského balíku. Stejně tak můžeme napsat knihu, kterou předáme tiskaři v PostScriptu 
 a její elektronickou podobu umístíme ve formátu PDF na FTP server.

Z historie do současnosti

DocBook spatřil světlo světa v roce 1991 a u jeho zrodu stála firma HaL Computers a nakladatelství O’Reilly. V průběhu let se hojně využíval ve velkých firmách jako Hewlett-Packard, SCO, Fujitsu atd. V roce 1999 přešel DocBook pod křídla sdružení OASIS a neustále se vyvíjí.

Původně byl DocBook vyžíván k tvorbě dokumentace k systému Unix, v současnosti byl použit například
 pro dokumentaci k Linuxu, PHP, FreeBSD a používá se ve firmách jako Sun nebo ve zmíněném nakladatelství 
 O’Reilly.Dnešní možnosti DocBooku ovšem daleko přesahují původní účel dokumentace, bez problémů můžeme napsat článek, knihu či jiný typ dokumentu. DocBook také nabízí možnosti generování rejstříků a jiných vlastností, které jsou pro daný typ dokumentu obvyklé.

Výstupní formáty DocBooku

Právě výstupní formáty jsou jedním z toho nejcennějšího co může DocBook nabídnout. Mezi ty nejznámější patří

  • Web — HTML, XHTML
  • Tisk — Rtf, Pdf, PostScript, LaTex
  • Nápověda — HTMLHelp, JavaHelp

Výstupních formátu je samozřejmě více a podpora dalších se rozšiřuje. K tolika rozličným formátům 
 pomáhá XSL transformace produkující přímo daný formát(HTML,XHTML) nebo transformace do XSL-FO objektu, které jsou patřičným FO procesorem zpracovány na daný formát. Třetí možností je použití DSSL stylů, které jsou již trochu zastaralejší.

Valná většina nástrojů, které budete pro generování příslušného formátu potřebovat je šířena pod licencemi, 
 které umožňují jejich svobodné používání i pro komerční účely. Konfigurace těchto nástrojů a jejich 
 použití je i s DocBookem popsáno ve volně dostupné elektronické knize 
 DocBook:The Definitive Guide.

Další informace jsou k nalezení na oficiálních stránkách DocBooku a hlavně na domovských stránkách Jiřího Koska,
 který se na DocBooku intenzivně podílí a můžeme u něj najít i neocenitelnou příručku k DocBooku
 trochu skromě nazvanou DocBook — Stručný úvod do tvorby a zpracování dokumentů, kde se dozvíté mnohem více. 
 Jiří Kosek dokonce připravil i instalační balíček DocBooku pro Windows.

Nevýhoda DocBooku nastane v případě vytváření XML. Pro začátek se budete muset naučit základním pravidlům XML 
 a osvojit si několik základních strukturálních značek. V případě jedince chápajícího, alespoň zlomek 
 toho co nabízí DocBook to neni problém. Vysvětlete ovšem sekretářce, že zápisy z porad nebude psát tak
 jak je doposud zvyklá ve WYSIWYG textovém editoru typu Word, ale že se bude pohybovat ve světě špičatých závorek. 
 Samozřejmě existují i WYSIWYG editory produkující DocBook XML ovšem jejich cena je vysoká.

Aktualizováno 14.11.2003 v 12:30

Zdenek Bohdanecky Jr. mě upozornil na editor AUTHENTIC 2004 firmy Altova, který by měl DocBook také podporovat. Na stránkách editoru jsem našel zajímavou informaci cituji “authentic™ 2004 is offered under a free software licensing model. (Yes, completely free).”.

Aktualizováno 13.11.2003 v 7:20

Tak i použitelný editor s integrovaným DocBookem a dokonce i s českým rozhraním je k dispozici, jak mi napsal Jiří Kosek

otrlejší sekretářka by možná zvládla následující editor:
XMLmind (http://www.xmlmind.com/xmleditor/)
Editor se nainstaluje rovnou i s DTD a XSL styly pro DocBook, takže 
 stačí v menu vybrat New -> DocBook Document a začít psát. Rozhraní 
 editoru je dokonce počeštěné.

Verze na Medium

Související články

Související epizody CZ Podcastu