Uvod v namizje K

Poglavje 1. Uvod

Dokumentacijski projekt KDE sedaj uporablja DocBook kot privzet format za vso dokumentacijo. Kot boste videli omogoča ta format veliko več fleksibilnosti kot Linuxdoc za majhno ceno učenja nekaj novih značk. Da bi naredili prehod v nov format karseda preprost, smo poskrbeli za pretvorbene skripte, predlogo za novo dokumentacijo in ta hiter tečaj. Upamo, da se vam bo zdel prehod v DocBook čimmanj boleč in da boste učivali v novih zmožnostih, ki jih DocBook prinaša v KDE dokumentacijo.

Opomba

Prosim upoštevajte da je ta hiter tečaj mišljen za uporabo z in ne namesto osnovnega 'DocBook Reference'. Obstaja vrsto primerov, kjer se je veliko lažje sklicevati na referenco kot poskušati na novo napisati to, kar ta že pokriva. Uporabite ta vodič za razumevanje katere značke boste rabili in kje.

Mnogo delov tega dokumenta je sposojenega iz DocBook 3.0 Reference, ki je delo delo Eve Maler iz ArborText, Inc. in Terrya Allena iz Fujitsu Software Corporation. Deli dokumenta, ki so bili sposojeni so Copyright Š 1992, 1993, 1994, 1995, 1996, 1997 HaL Computer Systems, Inc., O'Reilly & Associates, Inc., Fujitsu Software Corporation in ArborText, Inc.

1.1. Zakaj DocBook?

Ko se je KDE projekt leta 1996 pričel je bil Linuxdoc standard za pisanje dokumentacije, ki jo je bilo treba objaviti v različnih formatih. Na žalost Linuxdoc trpi zaradi snovalskih omejitev, ki omejujejo pisanje dokumentacije za moderne GUI programe:

Format DocBook je bil zasnovan s strani konzorcija OASIS posebej za tehnično dokumentacijo. Naslavlja vse zgoraj omenjene pomanjkljivosti tako da ponuja precej bogatejši nabor značk za opis vsebine vašega dokumenta. Edina pomankljivost DocBooka je, da je nekoliko težji za priučitev. Tudi če še niste nikoli uporabljali Linuxdoc ali DocBook-a bi morali postati spretni samo z branjem skozi ta vodnik, pregledom predloge in uporabo spletne ali pa papirne različice [DocBook - The Definitive Guide] izdane s strani O'Reilly & Associates.