Lazarus Docs/de

Übersicht über die Dokumentation

edit

Man muss grundsätzlich zwischen der Dokumentation der Projekte (Free Pascal Projekt, Lazarus Projekt) unterscheiden und zusätzlich gibt es noch mehrer Formate, wie die Hilfe zugänglich ist (Online, html, chm, inf).

Free Pascal Projekt

edit
Allgemein
Free Pascal Programmier Führer (prog.pdf, prog.chm, ... http://www.freepascal.org/docs-html/prog/prog.html online)
Free Pascal Sprach Referenz Führer (ref.pdf, ref.chm, ... http://www.freepascal.org/docs-html/ref/ref.html online)
Free Pascal Benutzer Führer (user.pdf, user.chm, ... http://www.freepascal.org/docs-html/user/user.html online)
Development Tutorial (buildfaq.pdf, http://www.stack.nl/~marcov/buildfaq/ online)
Laufzeit Bibliothek
Laufzeitbibliothek (rtl.pdf, rtl.chm, ... http://www.freepascal.org/docs-html/rtl/ online)
Freie Bibliothek Referenz
Reference for package fcl (fcl.pdf, fcl.chm http://www.freepascal.org/docs-html/fcl/ online)
Programme
Free Pascal code documenter FPDoc (fpdoc.pdf, fpdoc.chm, ... http://lazarus-ccr.sourceforge.net/fpcdoc/fpdoc/fpdoc.html online)

Lazarus Projekt

edit
Lazarus Komponenten Bibliothek
Reference for package lcl (lcl.chm, ...http://lazarus-ccr.sourceforge.net/docs/lcl/ online, Wiki LCL)

Installation der Hilfe in Lazarus

edit

Online Hilfe

edit

Wird nicht installiert.

Offline Hilfe

edit

Sie befindet sich im Verzeichnis ($Lazarus/doc/)

Siehe auch

Benutzung der Hilfe in Lazarus

edit

Online Hilfe

edit

Wenn einer Verbindung zum Internet vorhanden ist, wird sie beim Drücken von F1 (oder CtrlF1 - je nach Konfiguration) angezeigt. Falls die Offline Hilfe installiert ist und das Thema vorhanden ist, so wird zuerst auf die Offline Hilfe, dann erst auf die Online Hilfe zurückgegriffen.

Offline Hilfe

edit

Falls die Offline Hilfe installiert ist und das Thema vorhanden ist, so wird zuerst auf die Offline Hilfe, dann erst auf die Online Hilfe zurückgegriffen.

Erstellung der Offline Hilfe

edit

Die Vorgang für die Erstellung der Hilfe ist vielschichtig. Es werden mehrere Verfahren zur Erzeugung verwendet

Free Pascal Leitfaden für Entwickler

edit
(prog.pdf, prog.chm, ... )
Sourcen
im SVN unter http://svn.freepascal.org/svn/fpcdocs
Sourceformat
Latex (fpcdocs/prog.tex)
Toolchain
make basierend
Unix zentriert, Windows eventuell möglich
Formate
html, pdf, chm
Buildzeitpunkt
Nicht definiert, wenn nötig ?
Bei Lazarus installiert
ja ($(lazarusdir)/docs/chm/prog.chm)

Free Pascal Sprachreferenz

edit
(ref.pdf, ref.chm, ... )
Sourcen
im SVN unter http://svn.freepascal.org/svn/fpcdocs
Sourceformat
Latex (fpcdocs/ref.tex)
Toolchain
make basierend
Unix zentriert, Windows eventuell möglich
Formate
html, pdf, chm
Buildzeitpunkt
Nicht definiert, wenn nötig ?
Bei Lazarus installiert
ja ($(lazarusdir)/docs/chm/ref.chm)

Free Pascal Benutzerhandbuch

edit

(user.pdf, user.chm, ...)

Sourcen
im SVN unter http://svn.freepascal.org/svn/fpcdocs
Sourceformat
Latex (fpcdocs/user.tex)
Toolchain
make basierend
Unix zentriert, Windows eventuell möglich
Formate
html, pdf, chm
Buildzeitpunkt
Nicht definiert, wenn nötig ?
Bei Lazarus installiert
ja ($(lazarusdir)/docs/chm/user.chm)

Development Tutorial

edit
(buildfaq.pdf)
Vorhandene Sprachen
Englisch
Sourcen
im SVN unter http://svn.freepascal.org/svn/fpcdocs
Sourceformat
Lyx (Latex) (fpcdocs/buildfaq/buildfaq.lyx)
Toolchain
make basierend
Unix zentriert, Windows eventuell möglich
Formate
html, pdf
Buildzeitpunkt
Nicht definiert, wenn nötig ?
Bei Lazarus installiert
nein

Run Time Library (RTL)

edit

(rtl.pdf, rtl.chm, ... )

Vorhandene Sprachen
Englisch
Sourcen
im SVN unter http://svn.freepascal.org/svn/fpcdocs
Sourceformat
Latex (fpcdocs/rtl.tex)
Diverse Verzeichnis in fpcdocs im FPDoc Format (xml)
Toolchain
make basierend
Unix zentriert, Windows eventuell möglich
Formate
html, pdf, chm
Buildzeitpunkt
Nicht definiert, wenn nötig ?
Bei Lazarus installiert
ja ($(lazarusdir)/docs/chm/rtl.chm)

Free Component Library (FCL)

edit

Reference for package fcl (fcl.pdf, fcl.chm)

Vorhandene Sprachen
Englisch
Sourcen
im SVN unter http://svn.freepascal.org/svn/fpcdocs
Sourceformat
Latex (fpcdocs/fcl.tex)
Diverse Verzeichnis in fpcdocs im FPDoc Format (xml)
Toolchain
make basierend
Unix zentriert, Windows eventuell möglich
Formate
html, pdf, chm
Buildzeitpunkt
Nicht definiert, wenn nötig ?
Bei Lazarus installiert
ja ($(lazarusdir)/docs/chm/fcl.chm)

Free Pascal code documenter FPDoc

edit
(fpdoc.pdf, fpdoc.chm, ...)
Vorhandene Sprachen
Englisch
Sourcen
im SVN unter http://svn.freepascal.org/svn/fpcdocs
Sourceformat
Latex (fpcdocs/fpdoc.tex)
Toolchain
make basierend
Unix zentriert, Windows eventuell möglich
Formate
html, pdf, chm
Buildzeitpunkt
Nicht definiert, wenn nötig ?
Bei Lazarus installiert
ja ($(lazarusdir)/docs/chm/fpdoc.chm)

Lazarus Component Library (LCL)

edit
 (lcl.chm, ..)
Vorhandene Sprachen
Englisch
Sourcen
im Verzeichnis ($Lazinstall/docs/xml/lcl)
Sourceformat
FPDoc format XML
Toolchain
FPDoc basierend (xml)
Programm $(lazarusdir)/docs/html/build_lcl_docs.lpr erstellt chm oder html
Formate
html, chm
Buildzeitpunkt
Wenn man es selbst startet (Achtung wird in $(lazarusdir)/docs/html/lcl/lcl.chm erstellt -> verschieben ?!)
Bei Lazarus installiert
ja ($(lazarusdir)/docs/chm/lcl.chm)

Verwendete Programme und Toolchains

edit

FPDoc

edit

Tutorial : FPCDocs_Tutorial (englisch)

CHM Bckend : chm_backend_for_fpdoc (englisch)

How to make Lazarus Docs How_To_Make_Lazarus_Docs/de (deutsch)

Make in SVN-fpcdocs

edit

Bitte die README.DOCS und readmechm.txt lesen.