How To Make Lazarus Docs/de

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

Erstellen von Dokumentationsdateien für Lazarus

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.

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).

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!):

<delphi>

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.

</delphi>

Mitwirkende und Änderungen

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