| version 1.4, 2002/12/14 22:43:37 |
version 1.5, 2002/12/16 11:47:40 |
|
|
| <!-- $Platon: Platon.SK/doc-projects/soft-doc-sys/sk/user-doc-systems.sgml,v 1.3 2002/12/11 18:24:27 nepto Exp $ --> |
<!-- $Platon: Platon.SK/doc-projects/soft-doc-sys/sk/user-doc-systems.sgml,v 1.4 2002/12/14 22:43:37 nepto Exp $ --> |
| |
|
| <chapter id="user-doc-sys"> |
<chapter id="user-doc-sys"> |
| <title>Systémy užívateľskej dokumentácie softvéru</title> |
<title>Systémy užívateľskej dokumentácie softvéru</title> |
| Line 14 počítačovým hardvérom a softvérom, ale r |
|
| Line 14 počítačovým hardvérom a softvérom, ale r |
|
| oblasť. <productname>DocBook</> je <acronym>SGML</> definícia typu dokumentu |
oblasť. <productname>DocBook</> je <acronym>SGML</> definícia typu dokumentu |
| (Document Type Definition - <acronym>DTD</>). |
(Document Type Definition - <acronym>DTD</>). |
| |
|
| <!-- EN: |
|
| |
|
| The most famous and the most used system for user documentation creation and |
|
| maintaning is <ulink |
|
| url="http://www.oasis-open.org/docbook/"><productname>DocBook</></ulink>. This |
|
| open tool build upon open technologies provides a system for writing structured |
|
| documents using <acronym>SGML</> or <acronym>XML</>. It is particularly |
|
| well-suited to books and papers about computer hardware and software, though it |
|
| is by no means limited to them. <productname>DocBook</> is an <acronym>SGML</> |
|
| document type definition (<acronym>DTD</>). |
|
| |
|
| --> |
|
| |
|
| </para> |
</para> |
| <para> |
<para> |
| |
|
| Line 42 otvorených technológií v procese vytvára |
|
| Line 29 otvorených technológií v procese vytvára |
|
| </para> |
</para> |
| <para> |
<para> |
| |
|
| <productname>DocBook</productname> dokument je písaný použitím tzv. značkovacích |
<productname>DocBook</> dokument je písaný použitím tzv. značkovacích |
| jazykov (markup languages) ako je <acronym>SGML</> a <acronym>XML</>. |
jazykov (markup languages) ako je <acronym>SGML</> a <acronym>XML</>. |
| <productname>DocBook</productname> existuje v oboch týchto verziách. Podobne ako |
<productname>DocBook</> existuje v oboch týchto verziách. Podobne ako |
| pri <acronym>HTML</> dokumentoch sa špecálnymi značkami (tagmi) označujú |
pri <acronym>HTML</> dokumentoch sa špecálnymi značkami (tagmi) označujú |
| jednotlivé miesta alebo elementy. V prípade <acronym>HTML</> dokumentu sa však |
jednotlivé miesta alebo elementy. V prípade <acronym>HTML</> dokumentu sa však |
| pomocou značiek definuje dizajn a výzor výsledného dokumentu (zmena farby, zmena |
pomocou značiek definuje dizajn a výzor výsledného dokumentu (zmena farby, zmena |
| písma, zvýraznenie a pod.). V <productname>DocBook</productname> dokumente |
písma, zvýraznenie a pod.). V <productname>DocBook</> dokumente |
| neexistuje žiadna značka manipulujúca priamo s dizajnom. Dokument je |
neexistuje žiadna značka manipulujúca priamo s dizajnom. Dokument je |
| štruktúrovaný <firstterm>logicky</firstterm>, čiže označované sú časti s |
štruktúrovaný <firstterm>logicky</>, čiže označované sú časti s |
| rovnakým významom (napr. mená súborov, premenných, produktov, ľudí, atď.). |
rovnakým významom (napr. mená súborov, premenných, produktov, ľudí, atď.). |
| Výsledný dizajn je komponovaný pomocou jazyka <ulink |
Výsledný dizajn je komponovaný pomocou jazyka <ulink |
| url="http://www.jclark.com/dsssl/"><acronym>DSSSL</></ulink> (Document Style |
url="http://www.jclark.com/dsssl/"><acronym>DSSSL</></ulink> (Document Style |
|
|
| <!-- prepisat, moc sa mi to nezda --> |
<!-- prepisat, moc sa mi to nezda --> |
| |
|
| Rozdiely medzi <acronym>XML</> verziou a <acronym>SGML</> verziou |
Rozdiely medzi <acronym>XML</> verziou a <acronym>SGML</> verziou |
| <productname>DocBook</productname> sú minimálne. Okrem odlišnej hlavičky |
<productname>DocBook</> sú minimálne. Okrem odlišnej hlavičky |
| dokumentu a rôznej implementácii asi dvoch tagov sú obe verzie úplne identické. |
dokumentu a rôznej implementácii asi dvoch tagov sú obe verzie úplne identické. |
| Podstatný rozdiel je v samotnom spracovaní dokumentu. Pri <acronym>SGML</> |
Podstatný rozdiel je v samotnom spracovaní dokumentu. Pri <acronym>SGML</> |
| verzii sa používa <productname>Jade Wrapper</> (<application>jw</>) a pri |
verzii sa používa <productname>Jade Wrapper</> (<application>jw</>) a pri |
| Line 99 Základný dokument vyzerá nasledovne: |
|
| Line 86 Základný dokument vyzerá nasledovne: |
|
| </para> |
</para> |
| <para> |
<para> |
| |
|
| <productname>DocBook</productname> dokument (<SGMLtag class=StartTag>book</>) sa |
<productname>DocBook</> dokument (<SGMLtag class=StartTag>book</>) sa delí na |
| delí na kapitoly (<SGMLtag class=StartTag>chapter</>), sekcie v kapitolách |
kapitoly (<SGMLtag class=StartTag>chapter</>), sekcie v kapitolách (<SGMLtag |
| (<SGMLtag class=StartTag>sect1</>) a podsekcie (<SGMLtag |
class=StartTag>sect1</>) a podsekcie (<SGMLtag class=StartTag>sect2</>). |
| class=StartTag>sect2</>). Podsekcie možu mať ďalšie podsekcie (<SGMLtag |
Podsekcie možu mať ďalšie podsekcie (<SGMLtag class=StartTag>sect3</>, <SGMLtag |
| class=StartTag>sect3</>, <SGMLtag class=StartTag>sect4</>). Kapitoly je možné |
class=StartTag>sect4</>). Kapitoly je možné združovať pomocou tagu <SGMLtag |
| združovať pomocou tagu <SGMLtag class=StartTag>part</>. Podobne viac kníh je |
class=StartTag>part</>. Podobne viac kníh je možné spojiť do kompaktného celku |
| možné spojiť do kompaktného celku pomocou tagu <SGMLtag class=StartTag>set</>. |
pomocou tagu <SGMLtag class=StartTag>set</>. |
| |
|
| <example> |
<example> |
| <title>Základné delenie <productname>DocBook</productname> <acronym>SGML</> dokumentu</title> |
<title>Základné delenie <productname>DocBook</> <acronym>SGML</> dokumentu</title> |
| <programlisting><![CDATA[ |
<programlisting><![CDATA[ |
| <chapter><title>Nadpis prvej kapitoly</title> |
<chapter><title>Nadpis prvej kapitoly</title> |
| <sect1><title>Prvá sekcia v prvej kapitole</title>> |
<sect1><title>Prvá sekcia v prvej kapitole</title>> |
| Line 135 príkazov, produktov. Ďalej tiež e-mailov |
|
| Line 122 príkazov, produktov. Ďalej tiež e-mailov |
|
| možné tiež vytvárať zoznamy alebo tabuľky, vkladať obrázky, atď. |
možné tiež vytvárať zoznamy alebo tabuľky, vkladať obrázky, atď. |
| |
|
| <example> |
<example> |
| <title>Ukážka niektorých <productname>DocBook</productname> <acronym>SGML</> tagov</title> |
<title>Ukážka niektorých <productname>DocBook</> <acronym>SGML</> tagov</title> |
| <programlisting><![CDATA[ |
<programlisting><![CDATA[ |
| <filename>/etc/passwd</filename> |
<filename>/etc/passwd</filename> |
| <filename class=headerfile>stdio.h</filename> |
<filename class=headerfile>stdio.h</filename> |
| Line 159 Na poslednom príklade je vidieť možnosť |
|
| Line 146 Na poslednom príklade je vidieť možnosť |
|
| </para> |
</para> |
| <para> |
<para> |
| |
|
| Medzi najvýznamnejšie výhody <productname>DocBook</productname> dokumentácie |
Medzi najvýznamnejšie výhody <productname>DocBook</> dokumentácie patrí aj veľký |
| patrí aj veľký počet možných formátov výstupných dokumentov. Sú to najmä |
počet možných formátov výstupných dokumentov. Sú to najmä <acronym>HTML</>, |
| <acronym>HTML</>, <acronym>RTF</>, <acronym>PDF</>, <acronym>PS</>, |
<acronym>RTF</>, <acronym>PDF</>, <acronym>PS</>, <application>TeX</>, čistý |
| <application>TeX</>, čistý text a manuálové stránky. Generovanie prebieha |
text a manuálové stránky. Generovanie prebieha pomocou programu |
| pomocou programu <application>jade</application> (predpokladáme vygenerovanie |
<application>jade</> (predpokladáme vygenerovanie súboru |
| súboru <filename>myfile.html</> zo súboru <filename>myfile.sgml</>). |
<filename>myfile.html</> zo súboru <filename>myfile.sgml</>). |
| |
|
| <literallayout> |
<literallayout> |
| <prompt>$ </><userinput> jade -d /usr/lib/sgml/stylesheets/dbtohtml.dsl -t sgml myfile.sgml > myfile.html</userinput> |
<prompt>$ </><userinput> jade -d /usr/lib/sgml/stylesheets/dbtohtml.dsl -t sgml myfile.sgml > myfile.html</userinput> |
| </literallayout> |
</literallayout> |
| |
|
| Nie je nutné používať priamo analyzátor<!-- anglicky: parser --> |
Nie je nutné používať priamo analyzátor <application>jade</>. |
| <application>jade</application>. Existujú už predpripravené |
Existujú už predpripravené <foreignphrase>shell</> skripty pre generovanie |
| <foreignphrase>shell</> skripty pre generovanie konkrétnych typov výstupných |
konkrétnych typov výstupných súborov. Sú to napr. <application>db2html</>, |
| súborov. Sú to napr. <application>db2html</>, <application>db2pdf</>, ale aj |
<application>db2pdf</>, ale aj <application>docbook2tex</> či |
| <application>docbook2tex</> či <application>docbook2txt</>. Takže pre |
<application>docbook2txt</>. Takže pre vygenerovanie <acronym>HTML</> |
| vygenerovanie <acronym>HTML</> dokumentácie stačí použiť nasledovný príkaz. |
dokumentácie stačí použiť nasledovný príkaz. |
| |
|
| <literallayout> |
<literallayout> |
| <prompt>$ </prompt><userinput> db2html myfile.sgml</userinput> |
<prompt>$ </prompt><userinput> db2html myfile.sgml</userinput> |