[Java lista] User dokumentacio

[dorothy]

Hi,
Ha már docbook - az Oasis (aki ezt gondozza), pár éve megkapta az 
IBM-től ajándékba a DITA (Darwin Information Typing Architecture) 
projektet is. Ezt az IBM a '90-es évek elején kezdte csinálni a saját 
dokumentációihoz és azóta is ezt használja (például ahhoz, amit az 
Eclipse help meg az infocenterek megjelenítenek). Én ugyan a 
dokumentáció készítést nem próbáltam, de pl. fordítok ilyen fájlokat.

Ez is egy XML-alapú cucc, de a docbook-hoz képest annyiban más, hogy 
igazi kis "objektum orientált" darab. Sok picike .dita fájlból meg egy 
.ditamap-ból össze lehet rakni egy jó nagy könyvet, darabkák 
újrafelhasználhatók (pl. a "Fájl menü" című részt - ha mindig ugyanazt 
csinálja - elég egyszer megírni, aztán utána csak be kell emelni a 
következő doksiba, vagy ha verzióváltás van, akkor simán le lehet 
cserélni csak a megváltozott funkciókat, nem is beszélve a 
jognyilatkozatokról meg egyéb állandó sallangokról), konzisztensek (ha 
rebranding van, akkor elég egy helyen kicserélni az új névre, és 
mindenhol ugyanúgy kerül be a szövegbe), meg ilyenek. Automatikusan 
generálja a tartalomjegyzéket, az oldalszámozást, az indexet (asszem még 
kereszthivatkozásokat is). Lehet bele rakni css-t meg képeket is.  Van 
neki referencia implementációja: DITA Open Toolkit, 1.4-nál tart 
(sourceforge-ról letölthető). Ezzel a kis játékkal 9 féle kimenetet 
lehet generálni a .dita fájlokból (XHTML, HTML Help, PDF, Eclipse help, 
DocBook, Eclipse content, JavaHelp, troff, Word RTF). Mivel nem mai 
darab, elég sok háttéranyag van hozzá, mindjárt pl. egy elég részletes 
userguide:
http://dita-ot.sourceforge.net/doc/ot-userguide131/xhtml/index.html

Ha valaki rendszeresen csinál pl. user meg admin guide-ot, vagy  
telepítési útmutatót, akkor talán érdemes rászánni az időt és kicsit 
kiismerni a lelkivilágát... Állítólag minimális xml ismeretekkel már 
használható,  van hozzá egy csomó előregyártott séma (ezesetben csak egy 
WYSIWYG xml editor kell). A nagy mélységekhez már kell tudni, hogy mi az 
a Java, XSLT, Ant, meg ezek hogyan dumcsiznak egymással (ez már csak 
akkor kell, ha a saját specializációt meg transzformációkat akarsz írni).

üdv
D

Aron Gombas írta:
>   Hi!
>
>   Ket tippem lenne:
>
> 1. docbook: itt a transzformacioba be tudod kotni a sajat
>     felteteleidet is, szoval a kimenet lehet mas a userek
>     fuggvenyeben. Eleg sokat tud, komoly hatrany, hogy meg
>     kell tanulni egy ujabb XML dialektust, bar vannak
>     GUI editorok is...
>
> 2. wiki: kenyelmesebb es talan ez is tudhatja az elobbit.
>     Peldanak okaert a JSPwiki, a CodeBeamer vagy a Confluence
>     is egy XSLT tranformacioval csinalja a PDF exportot,
>     amibe termeszetesen be tudsz avatkozni.
>
>   Udv,
>