How To Make Lazarus Docs/de

From Lazarus wiki
Revision as of 21:52, 23 February 2006 by Swen (talk | contribs) (Erstellen von Dokumentationsdateien für Lazarus)

Deutsch (de) English (en) slovenčina (sk)

Erstellen von Dokumentationsdateien für Lazarus

Dokumentationsdateien, welche möglicherweise in das Online Hilfesystem eingebunden werden, können generiert werden aus den Unit Dateien in der Lazarus Component Library (LCL). Das FpDoc Dienstprogramm kann HTML Dateien generieren unter Verwendung der Pascal Quelldateien (*.pp oder *.pas) als Eingabe. A great deal more useful information can be incorporated wenn eine XML Beschreibungsdatei verwendet werden kann in Verbindung mit der Quelldatei.

While it is perfectly possible to generate the XML tags by hand, unter Verwendung der Anweisungen im FpDoc Handbuch, ist es viel einfacher, das Dienstprgramm makeskel zu verwenden, welches als Teil der FpDoc suite geliefert wird. Diese Dienstprogramm generiert eine XML Datei mit a set of empty tags for every identifier, type, procedure and function in the source file. 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: I suggest that only the tags describing Objects be edited, at least initially (use the Search facility to find 'object', and then enter short titles and descriptions for the components).

Wenn sie die Bearbeitung der XML Datei beendet haben, speichern sie diese und starten

fpdoc --package=lcl --input=thisunit.pp --descr=thisunit.xml

Die resultierenden HTML Dateien werden in einem Unterverzeichnis namens 'thisunit' abgelegt.

Es wird eine große Anzahl von HTML Dateien geben (typischerweise über 160) - diese werden eventuell alle verwendet für die Hilfedateien, aber es gibt zu viele Informationen, zum Beispiel, um sie auf dieser WiKi Seite zu zeigen. Es ist hilfreich, die Dateien zu filtern, so daß nur diejenigen einbegriffen werden, die Komponenten beschreiben. Dies kann erreicht werden mit

grep -l Inheritance * > outputfile

da nur Komponenten eine Beschreibung ihrer Vererbung haben. Die Outputdatei kann dann benutzt werden, um ein Werkzeug zu führen für die Konvertierung von HTML zu Text. Eine solche Anwendung ist html2text. Der Prozess wurde teilweise automatisiert in dem folgenden Pascal Programm (welches mehr als einfach ist, nicht besonders robust, aber es funktioniert!):

program convhtml;
{ CT Kirkpatrick, MD 20040720 }
{$mode objfpc}{$H+}
{ liest eine Liste der Dateinamen von listfile ein, und konvertiert sie sinngemäß von HTML zu Klartext, den Output aller Dateien schreibend in outfile }
uses Classes, unix;
var listfile, outfile: text; pathname, listfname, outfname, fname: string; execstring, comstring: string; begin Writeln ('Enter path for files to convert'); Readln (pathname); Writeln ('Enter name of file to contain list of files for conversion'); Readln (listfname); shell ('grep -l Inheritance ' + pathname + '* > ' + pathname + 'filelist.txt'); Writeln ('Enter name of output file'); Readln (outfname); Assign (listfile, pathname +'filelist.txt'); Assign (outfile, pathname + outfname); Reset (listfile); Rewrite (outfile); while not eof (listfile) do begin readln (listfile, fname); //writeln (fname); //if fname = then begin readln (listfile, fname); writeln (fname) end; execstring := '/usr/bin/html2text '; comstring := '-nobs ' + fname + ' >> ' + pathname + outfname; writeln ('Executing ', execstring, comstring); shell (execstring + comstring); end; end.

Mitwirkende und Änderungen

Diese Seite wurde von der epikwiki Version konvertiert. Original von User:Kirkpatc.