Creating IDE Help/de

│ Deutsch (de) │ English (en) │ 日本語 (ja) │ русский (ru) │

Hilfe für LCL Units

Wann immer der Benutzer F1 drückt für eine Objektinspektor Eigenschaft oder einen Bezeichner im Quelltexteditor sucht die IDE die Deklaration und ruft den HTML Betrachter für den fpdoc Begriff auf. Die Begriffe können einfach bearbeitet werden mit dem FPDoc-Editor Werkzeug.

Sie können den Status der LCL Dokumentation hier sehen: LCL Documentation Roadmap.

Hilfe für IDE Fenster

Dieses Feature existiert seit Version 0.9.15.

Die Hilfe für die IDE Fenster (z.B. 'Objektinspektor' oder die 'Compilereinstellungen') sind in diesem Wiki dokumentiert. Die IDE hat eine mapping Datei docs/IDEWindowHelpTree.xml, welche die Pfade von den verschiedenen IDE Formularen/Bedienelementen zu den Wiki Seiten enthält. Diese mapping Datei kann bearbeitet werden mit einem Editor durch Aufruf von Strg+Shift+F1, ausgenommen für Bedienelemente, die alle Tastendrücke abfangen, wie 'synedit'. Sie können auch das Tastenkürzel festlegen in den Editoreinstellungen -> Tastaturbelegung.

Die Hauptseite der IDE Fenster Dokumente ist Lazarus IDE.

Hilfe für FPC Schlüsselwörter

Dieses Feature existiert seit Version 0.9.15 und benötigt die FPC Dokumente als lokal installierte HTML Dateien.

Dies wird aufgerufen, wenn der Cursor im Quelltexteditor sich über einem Schlüsselwort befindet und der Benutzer F1 drückt. Die IDE sucht in der FPC HTML Dokumentation nach der ref.kwd Datei. Diese Datei wird vom FPC Team gewartet und enthält eine Liste aller HTML Seiten. Im Moment ist keine custom Hilfe implementiert.

TODO: Dokument, wo man FPC HTML Dokumente erhält/ wie man sie erzeugt.

Hilfe für Nachrichten

Dieses Feature existiert seit Version 0.9.15 und benötigt die FPC Quellen lokal installiert.

Dies wird aufgerufen, wenn der Benutzer F1 drückt oder den Hilfemenüeintrag des Nachrichtenfensters verwendet.

Normalerweise wird die IDE die errore.msg Datei in den FPC Quellen suchen und die Erläuterung für die Nachricht zeigen. Aber einige Nachrichten wie unit not found benötigen zusätzliche Hilfe. Im folgenden wird beschrieben, wie man das macht:

Um eine Wiki Hilfeseite für eine Nachricht hinzuzufügen, tun sie das Folgende:

• Erstellen sie eine Wiki Seite unter der Hauptseite Build messages
• Öffnen sie ide/helpfpcmessages.pas und fügen eine AddFPCMessageHelpItem Zeile hinzu wie:

  AddFPCMessageHelpItem('Can''t find unit',
                        'FPC_message:_Can_not_find_unit',': Can''t find unit ');

Der erste Parameter ist der in errors gezeigte Titel. Der zweite Parameter ist die Wiki URL. Und der dritte Parameter ist der reguläre Ausdruck, der der Nachricht entspricht.