DocBook

z Wikipédie, slobodnej encyklopédie
Prejsť na: navigácia, hľadanie

DocBook je značkovací jazyk pôvodne určený na tvorbu technickej dokumentácie, ale možno ho použiť aj na tvorbu iných dokumentov. Udržiava ho a štandardizuje technická komisia DocBook v rámci OASIS.

DocBook má verzie SGML a XML. Pôvodne vzniklo ako aplikácia SGML, ale neskôr sa pridala aj ekvivalentná aplikácia XML, ktorá sa dnes už používa častejšie. (Aplikácia XML vznikla zároveň s verziou 4 aplikácie SGML, má rovnaké číslovanie verzií.)

V minulosti využívala DocBook najmä komunita open source. Príkladom použitia je Linux Documentation Project, referencie API GNOME a GTK+, a dokumentácia jadra Linuxu. V posledných rokoch sa však rozšíril a čoraz viac organizácií používa DocBook na dokumentovanie všetkého svojho softvéru. Na základe DocBook XML vzniklo aj niekoľko komerčných dokumentačných nástrojov.

Norman Walsh a vývojový tím DocBook Open Repository udržiavajú množinu štýlov DSSSL a XSL na generovanie výstupov vo formátoch HTML, FO/PDF, RTF, manuálových stránok a HTML Help. Walsh je aj hlavným autorom knihy DocBook: The Definitive Guide, oficiálnej dokumentácie jazyka DocBook. Táto kniha je dostupná pod licenciou GNU FDL a v tlačenej podobe.

V skratke o čo ide[upraviť | upraviť zdroj]

Zjednodušene povedané (ako bude vidieť na nasledujúcom príklade), pri písaní dokumentu sa pisateľ vôbec nestará, ba dokonca ani nemôže, ako bude výsledný dokument typograficky vyzerať. Pri písaní ho zaujíma iba logická stavba dokumentu. Výsledný formát sa získava pri transformácii, pri ktorej sa podľa určenej formy prekladajú štruktúry z DocBook-u do výsledného formátu (napr.: PDF, manual page, HTML, TeX, ...).

Príklad[upraviť | upraviť zdroj]

<book id="kniha1">
 <title>Jednoduchá kniha</title>
 <chapter id="kapitola1">
   <title>Kapitola 1</title>
   <para>Čaute všetci!</para>
   <para>
   Čo takto ešte jeden odsek? Ako bude asi odsadený? Netrápime sa,
   to bude riešiť <glossterm>procesor</glossterm><footnote><para>rieši preklad xml
   DocBook dokumentu do iných formátov, ako PDF a podobne.</para></footnote>
   </para>
   <para>
   V predchadzajucom odseku je slovo procesor "otagované" pre odloženie
   do slovníku a zároveň je k nemu pridelená i poznámka pod čiarou. Klasický preklad
   na PDF ho štandardne označí indexom a vysvetľujúci text vloží pod čiaru.
   </para>
 </chapter>
</book>

Externé odkazy[upraviť | upraviť zdroj]

  • DocBook.org - oficiálna stránka knihy Normana Walsha DocBook: The Definitive Guide (po anglicky)
  • Semestrálna práca - Semestrálna práca, ktorá stručne na asi dvoch stranách predstavuje koncepciu DocBook-u (po slovensky)