Sign in Join
Wiki copytemporary

Lazarus Documentation Editor/sk: what changed

Revision 2 to 3. Removed lines have a minus sign; added lines have a plus sign.

OldNewLine
11## Úvod
22
33Dôležitou časťou Lazarus, ktorá stále chýba je dokumentácia. Na pomoc s vytváraním tejto dokumentácie bol vyvinutý nástroj. Táto stránka popisuje prácu s ním. Pre označenie základného adresára v tomto dokumente je použité **\[\$LazDir\]**, takže pri čítaní si to nahraďte adresárom, v ktorom je Lazarus nainštalovaný.
44
55## Prečo
66
77Prvou výhodou tohoto projektu je sprístupniť súbory online nápovedy. Aby bola nápoveda platformovo nezávislá začali sme s tvorbou XML súborov pre každú jednodtku použitú v Lazarus. Zatiaľ bolo začaté len s dialogs.pp a buttons.pp.
88
99Tieto XML súbory budú potom použité pre vytvorenie HTML stránok, ktorú budú prístupné cez Internet na [stránke dokumentácie](http://lazarus-ccr.sourceforge.net/docs/lcl/). Nakoniec bude vytvorená integrovaná nápoveda, znova pomocou týchto XML súborov.
1010
1111## Začiatok
1212
1313Ako už bolo spomenuté, pre zachovanie platformovej nezávislosti je použité XML. Aktuálnu dokumentáciu nájdete v \[\$LazDir\]/docs/xml/. Zatiaľ tam sú, v adresári lcl, väčšinou len kostrové súbory. XML súbory, ktoré sú v tomto adresári boli automaticky vytvorené a pre použitie ich treba prispôsobiť.
1414
1515Takže teraz, keď už viete kde máte hľadať súbory, poďme sa pozrieť na nástroj pre ich vytvorenie/úpravu.
1616
1717### Nástroj
1818
1919"**lazde**" je nástroj pre úpravu xml súborov, ale možno ho použiť aj na generovanie základných súborov zo zdrojových kódov a, pomocou externého nástroja, aj na generovanie HTML verzie dokumentácie. Príklad výsledku posledného nástroja môžete vidieť [na tejto stránke](http://lazarus-ccr.sourceforge.net/docs/lcl/index.html), ako časť dokumentácie. Keďže nie je poskytovaná kompilovaná verzia **lazde**, musíte si ju urobiť sami.
2020
2121Zdrojové kódy "**lazde**" sú v \[\$LazDir\]/doceditor/. Keď tento program spustíte a otvoríte \[\$LazDir\]/docs/xml/lcl/dialogs.xml stretnete sa touto obrazovkou
2222
2323![](/wiki-images/a/a8/Lazdemain.png)
2424
2525### Práca
2626
2727![](/wiki-images/9/90/Lazdeelements.png)
2828
2929Otvorenie uzla "Packages" zobrazí uzol "LCL", ktorý obsahuje uzol "Dialogs". Zvolením posledne menovaného uzla zaplní dolný treeview prvkami. Tieto prvky predstavujú Konštanty (*Constants*), Typy (*Types*) a triedy (*Classes*) definované v unite Dialogs.pp. Použité unity sú pridané rovnako ako uzly. Ďalšie uzly sú pridané pre vlastnosti (*properies*) tried, parametre funkcií a tak ďalej.
3030
3131Zvolením uzla v ľavom dolnom treeview vytvorí obsah daného uzla v pravej časti okna.
3232
3333Keď navštívite [túto stránku](http://lazarus-ccr.sourceforge.net/docs/lcl/dialogs/index-4.html), uvidíte prehľad tried definovaných v unite "dialogs". Za každou triedou uvidíte riadok textu. Tento text pochádza z "short" editbox z lazde.
3434
3535Pod "short" editbox, je memofield, do ktorého môžete zadať viac vypracovaný popis komponentu alebo vlastnosti.
3636
37-`Poznámka: Ak chcete vložiť koniec ridku použite <br/>`
37+```text
38+Poznámka: Ak chcete vložiť koniec ridku použite
39+```
3840
3941Nasledujú Chyby (*Errors*), Pozrieť aj (*See also*) a Príklad kódu (*Example code File*).
4042
4143"Errors" môžu byť použité pre popis chýb vyvolaných funkciou, ak parametre majú hodnoty, ktoré sú mimo rozsah. Pre príklad pozrite [túto stránku](http://lazarus-ccr.sourceforge.net/docs/rtl/dateutils/recodeyear.html).
4244
4345Hneď pod "See also" a "Example code File" sú tri tlačítka, ktoré dovoľujú pridať alebo odstrániť odkazy na iné stránky alebo príklady kódu.
4446
4547## Výsledok
4648
4749Pozrite sa na výsledok popisu [InputQuery](http://lazarus-ccr.sourceforge.net/docs/lcl/dialogs/inputquery.html). Na vrchu stránky môžete vidieť o čom stránka je, v tomto prípade "Use InputQuery to show a dialog box to get some input from the user". Prvý riadok textu je to, čo ste zadali do "Short" editbox v lazde.
4850
4951nasleduje deklarácia tejto funkcie v zdrojovom kóde. Časť deklarácie je vytvorená pomocou html-builder a je vzatá z zo zdrojového kódu. Pretože sú dve verzie tejto funkcie, zdrojová pouícia vraví 0.
5052
5153Potom sú dané argumenty. Keď otvoríte uzol InputQuery v lazde, uvidíte všetky argumenty označené ako podriadené uzly. Text, zobrazený za argumentami je opäť to, čo bolo zadané v "Short" editbox, keď vybraný príslušný príslušný podriadený uzol.
5254
5355Ako štvrtý odsek je zobrazený výsledok funkcie. Tu zobrazený text je možné zadať rovnako ako pri argumentoch.
5456
5557Nakoniecje zobrazený popis, to je text napísaný v okne popisu v lazde.
5658
5759## Doplnenie nových unít
5860
5961Samozrejme, že je potrebné dokumentovať i ďalšie unity. Ak sa jedná, napríklad o unitu nejakého balíčka, pravdepodobne ešte neexistuje počiatočný XML súbor. Potom treba začať od začiatku a **lazde** ponúka funkciu, pomocou ktorej môžete priamo začať. Jednoducho použite **File -\> New** a objaví sa nasledujúca obrazovka:
6062
6163![](/wiki-images/f/f2/Lazdenewdocfromfile.png)
6264
6365Začnite zadaním mena balíčka. Všetky jednotky, ktoré chcete tohoto balíčka musia mať rovnaké meno balíčka. Potom zadajte meno príslušného zdrojového súboru, môžete ho tiež nájsť pomocou prehľadávania súborového systému. Nakoniec zadajte meno výstupného súboru (nezabudnite na príponu xml!) a stlačte OK.
6466
6567**lazde** vygeneruje základ pre dokumentáciu. Vygenerovaný súbor bude otvorený a treeview bude zaplnený všetkými unitami, triedami, typmi, funkciami atď, zo zadaného zdrojového súboru a ste pripravení začať dokumentovať novú časť Lazarus.
6668
6769Pozrite sa na [[LCL Documentation Roadmap]], aby ste videli, ktoré jednotky ešte treba zdokumentovať.
6870
6971Pre jednoduchú aktualizáciu súborov FPDoc, pri zmene unít Pascal, môžete použiť [[FPDoc Updater|aktualizátor FPDoc]].
7072
7173## Konečný výsledok
7274
7375Počas používania programu som zistil, že by bolo dobré vidieť ako sú informácie zobrazené v konečnom štádiu (ako prehliadateľný dokument). Pre tento účel **lazde** sprístupňuje nástroj pre vybudovanie všetkých potrebných HTML súborov.
7476
7577Tento nástroj možno spustiť z menu **Extra -\> Build** a zobrazí sa Vám nasledujúca obrazovka:
7678
7779![](/wiki-images/2/27/Lazdebuild1.png)
7880
7981"Package" musí byť rovnaké ako meno, ktoré ste zadali pri vytváraní xml súborov. Ako "Format" zvoľte HTML. Do "Output" zadajte cestu, kde majú byť výsledné súbory uložené. Stlačte "Add all" a všetky dokumenty, na ktorých ste pracovali, budú pridané do projektu. Potom prejdite na nasledujúcu záložku
8082
8183![](/wiki-images/0/01/Lazdebuild2.png)
8284
8385a zadajte cestu k zdrojovým súborom. Po stlačení "Build" začne Váš HD rapotať a nakoniec sa v záložke "Build output" objaví nasledujúci výstup
8486
85-`Building docs using command: fpdoc --package="LCL"`\
86-`--output="/home/matthijs/documentatie/LCL" --format=html --content `\
87-`--descr="/home/matthijs/Projecten/Lazarus/doceditor/buttons.xml"`\
88-`--descr="/home/matthijs/Projecten/Lazarus/doceditor/comctrls.xml"`\
89-`--descr="/home/matthijs/Projecten/Lazarus/doceditor/dialogs.xml"`\
90-`--descr="/home/matthijs/Projecten/Lazarus/doceditor/controls.xml"`\
91-`--input="/home/matthijs/cvsroot/lazarus/lcl/buttons.pp"`\
92-`--input="/home/matthijs/cvsroot/lazarus/lcl/comctrls.pp"`\
93-`--input="/home/matthijs/cvsroot/lazarus/lcl/dialogs.pp"`\
94-`--input="/home/matthijs/cvsroot/lazarus/lcl/controls.pp" `\
87+```text
88+Building docs using command: fpdoc --package="LCL"
89+--output="/home/matthijs/documentatie/LCL" --format=html --content
90+--descr="/home/matthijs/Projecten/Lazarus/doceditor/buttons.xml"
91+--descr="/home/matthijs/Projecten/Lazarus/doceditor/comctrls.xml"
92+--descr="/home/matthijs/Projecten/Lazarus/doceditor/dialogs.xml"
93+--descr="/home/matthijs/Projecten/Lazarus/doceditor/controls.xml"
94+--input="/home/matthijs/cvsroot/lazarus/lcl/buttons.pp"
95+--input="/home/matthijs/cvsroot/lazarus/lcl/comctrls.pp"
96+--input="/home/matthijs/cvsroot/lazarus/lcl/dialogs.pp"
97+--input="/home/matthijs/cvsroot/lazarus/lcl/controls.pp"
9598
96-`FPDoc - Free Pascal Documentation Tool`\
97-`(c) 2000 - 2003 Areca Systems GmbH / Sebastian Guenther, sg@freepascal.org`\
99+FPDoc - Free Pascal Documentation Tool
100+(c) 2000 - 2003 Areca Systems GmbH / Sebastian Guenther, sg@freepascal.org
98101
99-`Writing 2788 pages...`\
100-`Done.`\
101-`Documentation successfully built.`
102+Writing 2788 pages...
103+Done.
104+Documentation successfully built.
105+```
102106
103107Keď vojdete do adresára, ktorý ste zadali ako "Output", uvidíte súbor index.html a (v tomto prípade 4) podadresáre. Otvorte index.html vo svojom prehliadači a pozrite si výstup celej svojej ťažkej práce na dokumentácii. Budete môcť následovať odkazy a prečítať tak všetko.
104108
105109Ak plánujete pokračovať v práci na dokumentácii tohoto balíčka, stlačte "Save" a uložte voľby budovania. Dostanete otázku na meno súboru a voľby budú uložené. Pri ďalšom generovaní HTML súborov ich len jednoducho načítate.
106110
107111## Odoslanie
108112
109113Keď budete so svojou prácou spokojní, asi ju budete chcieť zdieľať s komunitou Lazarus. Všetko, čo k tomu potrebujete je vytvoriť [[Creating A Patch/sk|patch]], zazipovať ho a poslať.
110114
111115## Malá poznámka
112116
113117Pamätajte na nasledujúce: lazde je stále vo vývoji. Je použiteľný, ale zatiaľ nie je úplne dokončený. Preto sa v ňom môžu objaviť chyby, ale budú odstránené.
114118
115119## Spolupracovníci a zmeny
116120
117121- Preložil --Komunista 16:08, 30 December 2007 (CET)
118122
119123---
120124*From the Free Pascal wiki, page "Lazarus Documentation Editor/sk", as it stood on 2015-11-09 after a change by Trsek, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).*

Back to history