English

Suse Linux 10.1



Psaní dokumentace pomocí aplikace DocBook


31.10.2006

Aplikace DocBook generuje (html, pdf, PostScript, HTMLHelp,...) dokumentaci ze souboru xml.

Instalace

Pomocí YaST nebo apt-get nainstalujeme následující balíčky:
docbook_4
docbook-xsl-stylesheets
saxon
libxml2

DocBook xml soubor

Vytvoříme xml soubor podle dokumentace, kterou nalezneme na adresách:
http://docbook.org/tdg/en/html/docbook.html
http://docbook.org/
Česká dokumentace je na adrese:
http://www.kosek.cz/xml/db/

Ukázkový příklad xml souboru, pomocí kterého se generuje dokumentace K3dEngine skriptovacího jazyka.

Konrola xml souboru

Kontrolu provedeme příkazem
xmllint --noout --valid docbook.xml
Tento příkaz zkontroluje soubor docbook.xml

Generováni html dokumentace

HTML dokumentaci vygenerujeme příkazem
saxon docbook.xml /usr/share/xml/docbook/stylesheet/nwalsh/1.69.1/xhtml/chunk.xsl
Tento příkaz vygeneruje html dokumentaci ze souboru docbook.xml pomocí stylu chunk.xsl
cesta k xsl souboru může být různá, to záleží na tom, kam se nainstalují sxl styly balíčku docbook-xsl-stylesheets

home / linux / suse linux


Valid XHTML 1.0 Transitional