How To Make Lazarus Docs/de: what changed

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

Old	New		Line
1	1		Zurück zu den [[Additional information/de\|Zusätzlichen Informationen]].\
2	2
3	3		== Erstellen von Dokumentationsdateien für Lazarus ==
4	4
5	5		Dokumentationsdateien, die möglicherweise in das Online Hilfesystem eingebunden werden, können aus den Unit Dateien in der Lazarus Component Library (LCL) generiert werden. Das FpDoc Dienstprogramm kann HTML Dateien generieren, wobei die Pascal Quelldateien (.pp oder .pas) als Eingabe verwendet werden. Erbeblich hilfreichere Informationen können aufgenommen werden, wenn in Verbindung mit der Quelldatei eine XML Beschreibungsdatei verwendet wird.
6	6
7	7		Auch wenn es möglich ist, XML Tags von Hand unter Verwendung der Anweisungen im FpDoc Handbuch zu erstellen, ist es viel einfacher, das Dienstprogramm makeskel zu verwenden, welches als Teil der FpDoc Suite geliefert wird. Dieses Dienstprogramm generiert eine XML Datei mit einer Reihe leerer Tags für jeden Bezeichner, jeden Typ, jede Prozedur und jede Funktion in der Quelldatei. Der Benutzer kann dann diese XML Datei bearbeiten, entweder mit einem einfachen Texteditor oder unter Verwendung eines XML Editors wie KXMLEditor. Es gibt eine riesige Anzahl von Einträgen in diesen Dateien: Mein Vorschlag ist, nur die Tags zu bearbeiten die Objekte beschreiben, zumindest am Anfang (benutze die Suchfunktion, um 'object' zu finden. Dann gib kurze Titel und kurze Beschreibungen für die Komponenten ein).
8	8
9	9		Wenn sie die Bearbeitung der XML Datei beendet haben, speichern sie diese und starten
10	10
11		-	~~`fpdoc --package=lcl --input=thisunit.pp --descr=thisunit.xml`~~
	11	+	```text
	12	+	fpdoc --package=lcl --input=thisunit.pp --descr=thisunit.xml
	13	+	```
12	14
13	15		Die resultierenden HTML Dateien werden in einem Unterverzeichnis namens 'thisunit' abgelegt.
14	16
15	17		Es wird eine große Anzahl von HTML Dateien geben (typischerweise über 160) - diese werden eventuell alle für die Hilfedateien verwendet, aber es gibt zu viele Informationen, zum Beispiel, um sie auf dieser WiKi Seite zu zeigen. Es ist hilfreich, die Dateien zu filtern, so dass nur die jenigen einbezogen werden, die Komponenten beschreiben. Dies kann erreicht werden mit
16	18
17		-	~~`grep -l Inheritance * > outputfile`~~
	19	+	```text
	20	+	grep -l Inheritance * > outputfile
	21	+	```
18	22
19	23		da nur Komponenten eine Beschreibung ihrer Vererbung haben. Die Outputdatei kann dann benutzt werden, den HTML-Text in einfachen Text zu konvertieren. Eine solche Anwendung ist html2text. Der Prozess wurde teilweise im folgenden Pascal Programm automatisiert (welches mehr als einfach ist, nicht besonders robust, aber es funktioniert!):
20	24
21	25		``` pascal
22	26		program convhtml;
23	27		{ CT Kirkpatrick, MD 20040720 }
24	28		{$mode objfpc}{$H+}
25	29		{ liest eine Liste von Dateinamen von listfile ein, und konvertiert sie sinngemäß von HTML zu Klartext und
26	30		schreibt den Output aller Dateien in outfile }
27	31		uses
28	32		Classes, unix;<br>
29	33		var
30	34		listfile, outfile: text;
31	35		pathname, listfname, outfname, fname: string;
32	36		execstring, comstring: string;
33	37		begin
34	38		Writeln ('Enter path for files to convert');
35	39		Readln (pathname);
36	40		Writeln ('Enter name of file to contain list of files for conversion');
37	41		Readln (listfname);
38	42		shell ('grep -l Inheritance ' + pathname + '* > ' + pathname + 'filelist.txt');
39	43		Writeln ('Enter name of output file');
40	44		Readln (outfname);
41	45		Assign (listfile, pathname +'filelist.txt');
42	46		Assign (outfile, pathname + outfname);
43	47		Reset (listfile);
44	48		Rewrite (outfile);
45	49		while not eof (listfile) do
46	50		begin
47	51		readln (listfile, fname); //writeln (fname);
48	52		//if fname = '' then begin readln (listfile, fname); writeln (fname) end;
49	53		execstring := '/usr/bin/html2text ';
50	54		comstring := '-nobs ' + fname
51	55		+ ' >> ' + pathname + outfname;
52	56		writeln ('Executing ', execstring, comstring);
53	57		shell (execstring + comstring);
54	58		end;
55	59		end.
56	60		```
57	61
58	62		## Mitwirkende und Änderungen
59	63
60	64		Diese Seite wurde von der epikwiki [Version](http://lazarus-ccr.sourceforge.net/index.php?wiki=HowToMakeLazarusDocs) konvertiert. Original von User:Kirkpatc.
61	65
62	66		---
63	67		From the Free Pascal wiki, page "How To Make Lazarus Docs/de", 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