Sign in Join
Wiki copytemporary

How To Make Lazarus Docs/sk: what changed

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

OldNewLine
11## Tvorba dokumentácie pre Lazarus
22
3-Súbory dokumentácie, ktoré budú eventuálne zahrnuté do systému on-line nápovedy, môžete vygenerovať zo súborov jednotiek Lazarus Component Library (lcl). Utilita FpDoc generuje HTML súbory použitím zdrojových súborov Pascal (*.pp or *.pas) ako vstupu. Veľká časť veľmi dôležitých informácií môže byť zahrnutá, ak použijete popisný súbor XML v spojitosti so zdrojovým súborom.
3+Súbory dokumentácie, ktoré budú eventuálne zahrnuté do systému on-line nápovedy, môžete vygenerovať zo súborov jednotiek Lazarus Component Library (lcl). Utilita FpDoc generuje HTML súbory použitím zdrojových súborov Pascal (*.pp or *.pas) ako vstupu. Veľká časť veľmi dôležitých informácií môže byť zahrnutá, ak použijete popisný súbor XML v spojitosti so zdrojovým súborom.
44
5-Kým je výborne možné generovať XML tagy ručne, použitím inštrukcií v manuále FpDoc, oveľa jednoduchšie je použiť utilitu **makeskel** , ktorá je poskytnutá ako súčasť FpDoc. Táto utilita generuje súbor XML s množinou prázdnych tagov pre každý identifikátor, typ, procedúru a funkciu v zdrojovom kóde.
5+Kým je výborne možné generovať XML tagy ručne, použitím inštrukcií v manuále FpDoc, oveľa jednoduchšie je použiť utilitu **makeskel**, ktorá je poskytnutá ako súčasť FpDoc. Táto utilita generuje súbor XML s množinou prázdnych tagov pre každý identifikátor, typ, procedúru a funkciu v zdrojovom kóde.
66
7-Použitie nástroja makeskel úplne priamočiare: musíte zadať meno (jedného alebo viacerých) vstupného súboru (ako pri FPDOC), meno výstupného súboru a meno balíčka:
8-```
9-makeskel --package=rtl --input=crt.pp --output=crt.xml
10-```
7+Použitie nástroja makeskel úplne priamočiare: musíte zadať meno (jedného alebo viacerých) vstupného súboru (ako pri FPDOC), meno výstupného súboru a meno balíčka:
118
12-Týmto príkazom makeskel prečíta súbor **crt.pp** a vytvorí súbor **crt.xml** , ktorý obsahuje prázdne uzly pre všetky identifikátory nájdené v **crt.pp** , všetko v balíčku zvanom **rtl**. Iný príklad:
13-```
14-makeskel --input='-Sn system.pp' --input=crt.pp --output=rtl.xml
15-```
9+`makeskel --package=rtl --input=crt.pp --output=crt.xml `
1610
17-Ako vidno na príklade, voľba input môže obsahovať aj niektoré voľby prekladača, ako vprípade FPDOC. Uvedený príkaz spracuje súbory **system.pp** a **crt.pp** , a vytvorí značky prvkov, pre identifikátory oboch unít, v súbore rtl.xml.
11+Týmto príkazom makeskel prečíta súbor **crt.pp** a vytvorí súbor **crt.xml**, ktorý obsahuje prázdne uzly pre všetky identifikátory nájdené v **crt.pp**, všetko v balíčku zvanom **rtl**. Iný príklad:
1812
19-Používateľ môže editovať tento XML súbor, buď pomocou jednoduchého textového editora alebo pomocou editora XML ako KXMLEditor. V týchro súboroch môže existovať obrovský počet údajov.
13+`makeskel --input='-Sn system.pp' --input=crt.pp --output=rtl.xml `
2014
21- **Pripomínam** , že upravované sú len značky popisujúce Objekty, aspoň zo začiatku (použite Search na nájdenie objektu a potom zadajte krátke titulky a popisy komponentov).
15+Ako vidno na príklade, voľba input môže obsahovať aj niektoré voľby prekladača, ako vprípade FPDOC. Uvedený príkaz spracuje súbory **system.pp** a **crt.pp**, a vytvorí značky prvkov, pre identifikátory oboch unít, v súbore rtl.xml.
2216
23-Keď dokončíte úpravy XML súboru, uložte ho a spusťte
24-```
25-fpdoc --package=lcl --input=thisunit.pp --descr=thisunit.xml
26-```
17+Používateľ môže editovať tento XML súbor, buď pomocou jednoduchého textového editora alebo pomocou editora XML ako KXMLEditor. V týchro súboroch môže existovať obrovský počet údajov.
2718
28-Výsledné HTML súbory budú umiestnené v podadresári nazvanom 'thisunit'.
19+
20+**Pripomínam**, že upravované sú len značky popisujúce Objekty, aspoň zo začiatku (použite Search na nájdenie objektu a potom zadajte krátke titulky a popisy komponentov).
2921
30-Bude tam veľký počet HTML súborov (zvyčajne okolo 160) - tieto budú eventuálne všetky použité pre Help súbory, ale je tam veľmi veľa informácií, napr. pre umiestnenie na tejto Wiki stránke. Je užitočné tieto súbory prefiltrovať a zahrnúť len tie, ktoré popisujú komponenty. To môžete urobiť pomocou
31-```
32-grep -l Inheritance * > outputfile
33-```
22+Keď dokončíte úpravy XML súboru, uložte ho a spusťte
3423
35-keďže len komponenty majú popis ich dedičnosti (Inheritance).
24+` fpdoc --package=lcl --input=thisunit.pp --descr=thisunit.xml`
3625
37-Výstupný súbor môže byť použitý na ovládanie utilizy pre konverziu z HTML na text, napríklad aplikáciou **html2text**. Tento proces môže byť čiastočne automatizovaný v nasledujúcom Pascal programe (ktorý je prehnane jednoduchý, nie veľmi robustný, ale pracuje!):
38-```
39-program convhtml;
40- { CT Kirkpatrick, MD 20040720 }
41- {$mode objfpc}{$H+}
42- { číta zoznam mien súborov z listfile a konvertuej ich z HTML na text,
43- zapísaním výstupu všetkých súborov do výstupného súboru }<br>
44- uses
45- Classes, unix;<br>
46- var
47- listfile, outfile: text;
48- pathname, listfname, outfname, fname: string;
49- execstring, comstring: string;
50- begin
51- Writeln ('Zadajte cestu k súborom na konverziu');
52- Readln (pathname);
53- Writeln ('Zadajte meno súboru obsahujúceho zoznam súborov pre konverziu');
54- Readln (listfname);
55- shell ('grep -l Inheritance ' + pathname + '* > ' + pathname + 'filelist.txt');
56- Writeln ('Zadajte meno výstupného súboru');
57- Readln (outfname);
58- Assign (listfile, pathname +'filelist.txt');
59- Assign (outfile, pathname + outfname);
60- Reset (listfile);
61- Rewrite (outfile);
62- while not eof (listfile) do
63- begin
64- readln (listfile, fname); //writeln (fname);
65- //if fname = '' then begin readln (listfile, fname); writeln (fname) end;
66- execstring := '/usr/bin/html2text ';
67- comstring := '-nobs ' + fname
68- + ' >> ' + pathname + outfname;
69- writeln ('Executing ', execstring, comstring);
70- shell (execstring + comstring);
71- end;
72- end.
26+Výsledné HTML súbory budú umiestnené v podadresári nazvanom 'thisunit'.
27+
28+Bude tam veľký počet HTML súborov (zvyčajne okolo 160) - tieto budú eventuálne všetky použité pre Help súbory, ale je tam veľmi veľa informácií, napr. pre umiestnenie na tejto Wiki stránke. Je užitočné tieto súbory prefiltrovať a zahrnúť len tie, ktoré popisujú komponenty. To môžete urobiť pomocou
29+
30+` grep -l Inheritance * > outputfile`
31+
32+keďže len komponenty majú popis ich dedičnosti (Inheritance).
33+
34+Výstupný súbor môže byť použitý na ovládanie utilizy pre konverziu z HTML na text, napríklad aplikáciou **html2text**. Tento proces môže byť čiastočne automatizovaný v nasledujúcom Pascal programe (ktorý je prehnane jednoduchý, nie veľmi robustný, ale pracuje!):
35+
36+``` pascal
37+ program convhtml;
38+ { CT Kirkpatrick, MD 20040720 }
39+ {$mode objfpc}{$H+}
40+ { číta zoznam mien súborov z listfile a konvertuej ich z HTML na text,
41+ zapísaním výstupu všetkých súborov do výstupného súboru }<br>
42+ uses
43+ Classes, unix;<br>
44+ var
45+ listfile, outfile: text;
46+ pathname, listfname, outfname, fname: string;
47+ execstring, comstring: string;
48+ begin
49+ Writeln ('Zadajte cestu k súborom na konverziu');
50+ Readln (pathname);
51+ Writeln ('Zadajte meno súboru obsahujúceho zoznam súborov pre konverziu');
52+ Readln (listfname);
53+ shell ('grep -l Inheritance ' + pathname + '* > ' + pathname + 'filelist.txt');
54+ Writeln ('Zadajte meno výstupného súboru');
55+ Readln (outfname);
56+ Assign (listfile, pathname +'filelist.txt');
57+ Assign (outfile, pathname + outfname);
58+ Reset (listfile);
59+ Rewrite (outfile);
60+ while not eof (listfile) do
61+ begin
62+ readln (listfile, fname); //writeln (fname);
63+ //if fname = '' then begin readln (listfile, fname); writeln (fname) end;
64+ execstring := '/usr/bin/html2text ';
65+ comstring := '-nobs ' + fname
66+ + ' >> ' + pathname + outfname;
67+ writeln ('Executing ', execstring, comstring);
68+ shell (execstring + comstring);
69+ end;
70+ end.
7371```
7472
7573## Pôvodní spolupracovníci a zmeny
7674
77-This page has been imported from the epikwiki [version](<http://lazarus-ccr.sourceforge.net/index.php?wiki=HowToMakeLazarusDocs>). Original by [User:Kirkpatc](</User:Kirkpatc> "User:Kirkpatc").
75+This page has been imported from the epikwiki [version](http://lazarus-ccr.sourceforge.net/index.php?wiki=HowToMakeLazarusDocs). Original by User:Kirkpatc.
7876
79- * preložené z originálu - [Slavko](</User:Slavko> "User:Slavko") 14:50, 11 Apr 2005 (PDT)
77+- preložené z originálu - Slavko 14:50, 11 Apr 2005 (PDT)
8078
8179---
82-*From the Free Pascal wiki, page "How To Make Lazarus Docs/sk", as the Internet Archive kept it on 2024-12-02. 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).*
80+*From the Free Pascal wiki, page "How To Make Lazarus Docs/sk", as it stood on 2020-02-17 after a change by Trev, 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