Difference between revisions of "FPDoc Editor/de"

From Lazarus wiki
Jump to navigationJump to search
m
 
(17 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{LazDoc}}
+
{{FPDoc Editor}}
 +
<br>
 +
Zurück zu den [[Additional information/de|Zusätzlichen Informationen]].<br>
 +
<br>
 +
== Einleitung ==
 +
FPDoc ist das Free-Pascal-Dokumentationswerkzeug speziell zum Erzeugen von Hilfedateien für individuelle Einheiten vom Pascal Quellkode. Für mehr Informationen siehe: [http://lazarus-ccr.sourceforge.net/fpcdoc/fpdoc/fpdoc.html Free Pascal Dokumentationstool Handbuch (englisch)].
 +
 
 +
[[image:FPDocEditorDescription.png]]
 +
 
 +
Lazarus liefert einen eingebauten FPDoc Hilfe Betrachter und zwei Editoren mit zum Erzeugen beziehungsweise Aktualisieren der FPDoc Quelltext Dokumentation. Einen einfachen, eingebauten names '''FPDoc Editor''', der auf dieser Seite beschrieben wird, und einen vollständigen und aufwendigeren Editor namens [[Lazarus_Documentation_Editor/de|LazDE]].
 +
 
 +
Der große Bruder des ''FPDoc Editor'' ist [[Lazarus_Documentation_Editor/de|LazDE]] der Lazarus-Dokumentationseditor. Er ist ein eigenständiges Programm und befindet sich in ($LazDir)/doceditor/lazde.lpi. Er muss mit der IDE übersetzt werden und läuft dann außerhalb der IDE. Sie können ihn als externes Werkzeug zum Werkzeugemenü hinzufügen.
  
== Einleitung ==
+
== Benutzung des FPDoc Editors ==
LazDoc ist ein integrierter Editor/Betrachter für Lazarus. Hierzu beschriebene Elemente und der Gebrauch von LazDoc selbst erfordern von ihnen, mit FPDoc vertraut zu sein. Für mehr Informationen siehe: [http://lazarus-ccr.sourceforge.net/fpcdoc/fpdoc/fpdoc.html Free Pascal Dokumentationstool Handbuch]
+
Die Verwendung von FPDoc ist sehr einfach.
 +
 
 +
1. Öffnen Sie den FPDoc Editor. Sie können ihn im Menü "Ansicht" finden.
 +
 
 +
2. Setzen und bewegen Sie den Cursor. Nachdem der Cursor im Quelltext-Editor platziert wurde, werden Sie bemerken, dass sich die Beschriftung des Formulars FPDoc ändert. Die Beschriftung zeigt das ausgewählte Quellelement und den Dateinamen der Dokumentationsdatei. Durch Auswahl der geeigneten Seite in FPDoc können Sie ein spezifisches Dokumentations-Tag bearbeiten. Natürlich ist es auch möglich, FPDoc nur als Betrachter zu nutzen.
 +
 
 +
3. Klicken Sie auf die Schaltfläche 'Hilfe erzeugen'. Falls Sie die FPDoc-Suchpfade noch nicht eingerichtet haben, wird die IDE Sie fragen, wo die FPDoc-Dateien gespeichrt werden sollen. Für Projekte werden Sie normalerweise ein Unterverzeichnis 'docs' nehmen.
 +
 
 +
4. Schreiben Sie eine kurze Beschreibung.
 +
 
 +
5. Klicken Sie auf den Speichern-Knopf links oder gehen Sie zum nächsten Element (Der Editor speichert automatisch, wenn sie das Element verlassen).
  
== Wo ist LazDoc zu finden? ==
+
== Bearbeiten von FPDoc-Einträgen von LCL- und Lazarus-Quellen ==
  
LazDoc ist in die Lazarus IDE integriert. Es ist im Ansicht Menü zu finden.
+
Die sind in den Verzeichnissen  ($LazDir)\docs\xml, sie können diese Verzeichnisse zu den FPDoc Pfaden unter Werkzeuge / Einstellungen / FPDoc-Editor hinzufügen.
  
== Gebrauch ==
+
== Bearbeiten von FPDoc-Einträgen von FPC-Quellen, RTL und FCL ==
Die Verwendung von LazDoc ist sehr einfach.
 
  
1. Öffnen sie den LazDoc Editor. Sie können ihn im Ansicht Menü finden.
+
Die FPDoc-Einträge von FPC-Quellen können von SVN heruntergeladen werden:
  
2. Setzen sie den Suchpfad für LazDoc im Projekt | Projekteinstellungen ... Dialog, unter der LazDoc Registerseite.
+
cd /home/username/yourchoice/
 +
svn co http://svn.freepascal.org/svn/fpcdocs/trunk fpcdocs
  
3. Öffnen oder wählen sie eine Datei, für die eine Dokumentation existiert.  
+
Fügen Sie den Pfad ''/home/username/yourchoice/fpcdocs'' unter  Werkzeuge / Einstellungen / FPDoc-Editor hinzu.
  
4. Setzen und bewegen sie den Cursor. Nachdem der Cursor im Quelltext Editor platziert wurde, werden sie beobachten, daß sich die Beschriftung des LazDoc Formulars ändert. Die Beschriftung zeigt das ausgewählte Quellelement und den Dateinamen der Dokumentations Datei. Durch Auswahl der geeigneten Seite in LazDoc können sie ein spezifisches Dokumentations Tag bearbeiten. Natürlich ist es auch möglich, LazDoc nur als Betrachter zu nutzen.
+
Ein gutes Elment für einen Test ist ''TComponent.Name''.
  
 
== Zukünftige Pläne ==
 
== Zukünftige Pläne ==
Die todo Liste enthält gegenwärtig die folgenden Punkte, in keiner besonderen Reihenfolge:
+
Die Todo-Liste enthält gegenwärtig folgende Punkte, in keiner besonderen Reihenfolge:
 +
 
 +
* Einen Hilfeeditor für Themen schreiben.
 +
* Nettere html-Ausgaben für die Tooltips (Hinweisfenster) erzeugen.
 +
* Unterstützung von Operatoren
  
* Einen HTML Viewer hinzufügen; LazDoc wird die Dokumentation automatisch erzeugen
+
=== Erledigt ===
* Auch das Bearbeiten von Projektdateien ermöglichen
+
* Den Linkeditor erweitert um Packages und Bezeichner anzuzeigen
* Das Erstellen neuer Elemente mit LazDoc in der Dokumentation ermöglichen
+
* Dokumentationsmarkierungen "example" im FPDoc-Editor angefügt
* Vorschlag die Dokumentations Tags zu erweitern mit: "todo", "notes" und "topic"
+
* Dokumentationsmarkierungen  "topic" im FPDoc-Editor angefügt
* Alle Dokumentations Tags zu LazDoc hinzufügen
+
* FPDoc-Editor erzeugt neue Elemente in der Dokumentation
* Mehr Quellen Elemente für die Interpretation durch LazDoc hinzufügen unter Verwendung existierender Code Werkzeuge (jetzt werden procedure/function/constructor/destructor unterstützt)  
+
* FPDoc-Editor erzeugt neue Dokumentationsdateien
* Den Overhead noch weiter zu reduzieren
+
* Eine kleine Werkzeugleiste mit den verfügbaren Makeup-Tags hinzugefügt
* IPC für die Kommunikation benutzen
+
* FPDoc-Editor arbeitet auf Tastendruck im Quelltexteditor
* Make LazDoc create new documentation files
+
* FPDoc-Editor in den IDE-Einstellungen berücksichtigt (Anzeige und Position in der IDE)
* LazDoc zu den IDE Einstellungen hinzufügen (showing and position in IDE)  
+
* Ihn mit FPC-Quellen zum Laufen bringen (rtl Dateien existieren bereits)
* Make LazDoc work on keydown in sourceeditor (broken)
+
* Einstellungen zum Menü "Umgebungseinstellungen" hinzugefügt
* LazDoc zu einem WYSIWYG Editor zu machen, vergleichbar mit einem richtext Editor.
+
* Bearbeitung von Projektdateien ermöglicht
 +
* Die Dokumentations-Tags erweitert mit: "todo" and "notes" (Kein Grund. Es gibt Alternativen)
 +
* Overhead noch weiter reduziert
 +
* Alle Quellelemente werde von FPDoc-Editor mittels der CodeTools interpretiert.
 +
* Finde geerbte Einträge. Zum Beispiel TControl.Align von TButton.Align.
 +
* Optimierung: geerbte Einträge werden bei Leerlauf (des Prozessors) analysiert.
 +
* Optimierung: XML-Dateien werden gecached und nur einmal geparsed bzw. nur wenn sie sich auf der Festplatte änderten.
 +
* Einen HTML-Viewer hinzufügen; Dieser ist verfügbar durch Installation des Packages 'turbopoweriprodsgn'.
 +
* Checks nach ungültigen xml-Tags und automatische Reparaturen
 +
<br>
  
== Erledigt ==
+
[[Category:Tutorials/de]]
* Arbeiten für FPC Quellen zu schaffen (rtl Dateien existieren bereits)
 
* Einstellungen zum Umgebungseinstellungen Menü hinzufügen
 
* Adding a small toolbar makes it possible to use the available makeup tags.
 
* documentation tags "seealso" zu LazDoc hinzufügen
 
* Make it work on project files also
 
* Propose to expand documentation tags with: "todo" and "notes" (no need for that, as there are alternatives)
 
* Overhead noch weiter reduzieren
 
* Find inherited entries. Zum Beispiel TControl.Align von TButton.Align.
 
* Optimierung: inherited Entries werden bei Leerlauf (des Prozessors) analysiert.
 
* Optimierung: XML Dateien are cached, and only parsed once or if they changed on disk
 

Latest revision as of 12:05, 3 July 2015

Deutsch (de) English (en) français (fr) 日本語 (ja) polski (pl) português (pt) русский (ru)

Zurück zu den Zusätzlichen Informationen.

Einleitung

FPDoc ist das Free-Pascal-Dokumentationswerkzeug speziell zum Erzeugen von Hilfedateien für individuelle Einheiten vom Pascal Quellkode. Für mehr Informationen siehe: Free Pascal Dokumentationstool Handbuch (englisch).

FPDocEditorDescription.png

Lazarus liefert einen eingebauten FPDoc Hilfe Betrachter und zwei Editoren mit zum Erzeugen beziehungsweise Aktualisieren der FPDoc Quelltext Dokumentation. Einen einfachen, eingebauten names FPDoc Editor, der auf dieser Seite beschrieben wird, und einen vollständigen und aufwendigeren Editor namens LazDE.

Der große Bruder des FPDoc Editor ist LazDE der Lazarus-Dokumentationseditor. Er ist ein eigenständiges Programm und befindet sich in ($LazDir)/doceditor/lazde.lpi. Er muss mit der IDE übersetzt werden und läuft dann außerhalb der IDE. Sie können ihn als externes Werkzeug zum Werkzeugemenü hinzufügen.

Benutzung des FPDoc Editors

Die Verwendung von FPDoc ist sehr einfach.

1. Öffnen Sie den FPDoc Editor. Sie können ihn im Menü "Ansicht" finden.

2. Setzen und bewegen Sie den Cursor. Nachdem der Cursor im Quelltext-Editor platziert wurde, werden Sie bemerken, dass sich die Beschriftung des Formulars FPDoc ändert. Die Beschriftung zeigt das ausgewählte Quellelement und den Dateinamen der Dokumentationsdatei. Durch Auswahl der geeigneten Seite in FPDoc können Sie ein spezifisches Dokumentations-Tag bearbeiten. Natürlich ist es auch möglich, FPDoc nur als Betrachter zu nutzen.

3. Klicken Sie auf die Schaltfläche 'Hilfe erzeugen'. Falls Sie die FPDoc-Suchpfade noch nicht eingerichtet haben, wird die IDE Sie fragen, wo die FPDoc-Dateien gespeichrt werden sollen. Für Projekte werden Sie normalerweise ein Unterverzeichnis 'docs' nehmen.

4. Schreiben Sie eine kurze Beschreibung.

5. Klicken Sie auf den Speichern-Knopf links oder gehen Sie zum nächsten Element (Der Editor speichert automatisch, wenn sie das Element verlassen).

Bearbeiten von FPDoc-Einträgen von LCL- und Lazarus-Quellen

Die sind in den Verzeichnissen ($LazDir)\docs\xml, sie können diese Verzeichnisse zu den FPDoc Pfaden unter Werkzeuge / Einstellungen / FPDoc-Editor hinzufügen.

Bearbeiten von FPDoc-Einträgen von FPC-Quellen, RTL und FCL

Die FPDoc-Einträge von FPC-Quellen können von SVN heruntergeladen werden:

cd /home/username/yourchoice/
svn co http://svn.freepascal.org/svn/fpcdocs/trunk fpcdocs

Fügen Sie den Pfad /home/username/yourchoice/fpcdocs unter Werkzeuge / Einstellungen / FPDoc-Editor hinzu.

Ein gutes Elment für einen Test ist TComponent.Name.

Zukünftige Pläne

Die Todo-Liste enthält gegenwärtig folgende Punkte, in keiner besonderen Reihenfolge:

  • Einen Hilfeeditor für Themen schreiben.
  • Nettere html-Ausgaben für die Tooltips (Hinweisfenster) erzeugen.
  • Unterstützung von Operatoren

Erledigt

  • Den Linkeditor erweitert um Packages und Bezeichner anzuzeigen
  • Dokumentationsmarkierungen "example" im FPDoc-Editor angefügt
  • Dokumentationsmarkierungen "topic" im FPDoc-Editor angefügt
  • FPDoc-Editor erzeugt neue Elemente in der Dokumentation
  • FPDoc-Editor erzeugt neue Dokumentationsdateien
  • Eine kleine Werkzeugleiste mit den verfügbaren Makeup-Tags hinzugefügt
  • FPDoc-Editor arbeitet auf Tastendruck im Quelltexteditor
  • FPDoc-Editor in den IDE-Einstellungen berücksichtigt (Anzeige und Position in der IDE)
  • Ihn mit FPC-Quellen zum Laufen bringen (rtl Dateien existieren bereits)
  • Einstellungen zum Menü "Umgebungseinstellungen" hinzugefügt
  • Bearbeitung von Projektdateien ermöglicht
  • Die Dokumentations-Tags erweitert mit: "todo" and "notes" (Kein Grund. Es gibt Alternativen)
  • Overhead noch weiter reduziert
  • Alle Quellelemente werde von FPDoc-Editor mittels der CodeTools interpretiert.
  • Finde geerbte Einträge. Zum Beispiel TControl.Align von TButton.Align.
  • Optimierung: geerbte Einträge werden bei Leerlauf (des Prozessors) analysiert.
  • Optimierung: XML-Dateien werden gecached und nur einmal geparsed bzw. nur wenn sie sich auf der Festplatte änderten.
  • Einen HTML-Viewer hinzufügen; Dieser ist verfügbar durch Installation des Packages 'turbopoweriprodsgn'.
  • Checks nach ungültigen xml-Tags und automatische Reparaturen