Difference between revisions of "FPDoc Editor/de"

From Lazarus wiki
m (Zukünftige Pläne: Typo)
m
Line 1: Line 1:
 
{{FPDoc Editor}}
 
{{FPDoc Editor}}
  
= Einleitung =
+
== Einleitung ==
 
FPDoc ist das Free-Pascal-Dokumentationswerkzeug zum Erzeugen von Hilfedateien. Lazarus liefert zwei Editoren mit zum Erzeugen/Aktualisieren der FPDoc Quelltext Dokumentation. Einen einfachen, eingebauten names '''FPDoc Editor''', der auf dieser Seite beschrieben wird, und einen vollständigen Editor namens '''LazDE'''.
 
FPDoc ist das Free-Pascal-Dokumentationswerkzeug zum Erzeugen von Hilfedateien. Lazarus liefert zwei Editoren mit zum Erzeugen/Aktualisieren der FPDoc Quelltext Dokumentation. Einen einfachen, eingebauten names '''FPDoc Editor''', der auf dieser Seite beschrieben wird, und einen vollständigen Editor namens '''LazDE'''.
  
Line 10: Line 10:
 
[[Lazarus_Documentation_Editor|LazDE - Lazarus Documentation Editor]]
 
[[Lazarus_Documentation_Editor|LazDE - Lazarus Documentation Editor]]
  
=Wo ist FPDoc zu finden? =
+
== Wo ist FPDoc zu finden? ==
 
FPDoc ist in die Lazarus IDE integriert. Es ist im Menü "Ansicht" zu finden.
 
FPDoc ist in die Lazarus IDE integriert. Es ist im Menü "Ansicht" zu finden.
  
= Gebrauch =
+
== Gebrauch ==
 
Die Verwendung von FPDoc ist sehr einfach.
 
Die Verwendung von FPDoc ist sehr einfach.
  
Line 26: Line 26:
 
5. Klicken Sie auf den Speichern-Knopf links oder gehen Sie zum nächsten Element. Der Editor wird dann automatisch speichern.
 
5. Klicken Sie auf den Speichern-Knopf links oder gehen Sie zum nächsten Element. Der Editor wird dann automatisch speichern.
  
 
+
== Bearbeiten von FPDoc-Einträgen von FPC-Quellen, RTL und FCL ==
=Bearbeiten von FPDoc-Einträgen von FPC-Quellen, RTL und FCL=
 
  
 
Die FPDoc-Einträge von FPC-Quellen können von SVN heruntergeladen werden:
 
Die FPDoc-Einträge von FPC-Quellen können von SVN heruntergeladen werden:
Line 38: Line 37:
 
Machen Sie einen Terst mit ''TComponent.Name''.
 
Machen Sie einen Terst mit ''TComponent.Name''.
  
= Zukünftige Pläne =
+
== Zukünftige Pläne ==
 
Die Todo-Liste enthält gegenwärtig folgende Punkte, in keiner besonderen Reihenfolge:
 
Die Todo-Liste enthält gegenwärtig folgende Punkte, in keiner besonderen Reihenfolge:
  
Line 45: Line 44:
 
* Unterstützung von Operatoren
 
* Unterstützung von Operatoren
  
= Erledigt =
+
== Erledigt ==
 
* Den Linkeditor erweitert um Packages und Bezeichner anzuzeigen
 
* Den Linkeditor erweitert um Packages und Bezeichner anzuzeigen
 
* Dokumentationsmarkierungen "example" im FPDoc-Editor angefügt
 
* Dokumentationsmarkierungen "example" im FPDoc-Editor angefügt
Line 65: Line 64:
 
* Einen HTML-Viewer hinzufügen; Dieser ist verfügbar durch Installation des Packages 'turbopoweriprodsgn'.
 
* Einen HTML-Viewer hinzufügen; Dieser ist verfügbar durch Installation des Packages 'turbopoweriprodsgn'.
 
* Checks nach ungültigen xml-Tags und automatische Reparaturen
 
* Checks nach ungültigen xml-Tags und automatische Reparaturen
<br>
 
 
<br>
 
<br>
  
 
[[Category:Tutorials/de]]
 
[[Category:Tutorials/de]]

Revision as of 18:02, 14 July 2013

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

Einleitung

FPDoc ist das Free-Pascal-Dokumentationswerkzeug zum Erzeugen von Hilfedateien. Lazarus liefert zwei Editoren mit zum Erzeugen/Aktualisieren der FPDoc Quelltext Dokumentation. Einen einfachen, eingebauten names FPDoc Editor, der auf dieser Seite beschrieben wird, und einen vollständigen Editor namens LazDE.

Für mehr Informationen siehe: Free Pascal Dokumentationstool Handbuch.

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.

LazDE - Lazarus Documentation Editor

Wo ist FPDoc zu finden?

FPDoc ist in die Lazarus IDE integriert. Es ist im Menü "Ansicht" zu finden.

Gebrauch

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 wird dann automatisch speichern.

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 Menü/Einstellungen/Umgebung/FPDoc-Editor hinzu.

Machen Sie einen Terst mit 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