Difference between revisions of "Lazarus Docs/de"
From Lazarus wiki
Jump to navigationJump to search| (29 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{Lazarus Docs | + | {{Lazarus Docs}} |
| − | == Übersicht über die | + | == Übersicht über die Dokumentation == |
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). | 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 === | |
| + | ; '''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 === | ||
| + | ; '''Lazarus Komponenten Bibliothek''' | ||
| + | : Reference for package lcl (lcl.chm, ...[[http://lazarus-ccr.sourceforge.net/docs/lcl/ online]], [[Lazarus_Documentation#LCL_-_Lazarus_component_library|Wiki LCL]]) | ||
| − | + | == Installation der Hilfe in Lazarus == | |
| − | + | === Online Hilfe === | |
| − | + | Wird nicht installiert. | |
| − | + | === Offline Hilfe === | |
| − | + | Sie befindet sich im Verzeichnis ($Lazarus/doc/) | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | == | + | Siehe auch |
| + | * [[Installing_Help_in_the_IDE|Installing_Help_in_the_IDE (englisch)]] | ||
| + | |||
| + | == Benutzung der Hilfe in Lazarus == | ||
=== Online Hilfe === | === Online Hilfe === | ||
| + | Wenn einer Verbindung zum Internet vorhanden ist, wird sie beim Drücken von {{keypress|F1}} (oder {{keypress|Ctrl}}{{keypress|F1}} - 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 === | === Offline Hilfe === | ||
| − | + | 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 == | ||
| + | Die Vorgang für die Erstellung der Hilfe ist vielschichtig. Es werden mehrere Verfahren zur Erzeugung verwendet | ||
| + | |||
| + | === Free Pascal Leitfaden für Entwickler === | ||
| + | (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 === | ||
| + | (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 === | ||
| + | (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 === | ||
| + | (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) === | ||
| + | (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) === | ||
| + | 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 === | ||
| + | (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) === | ||
| + | (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 == | ||
| + | === FPDoc === | ||
| + | :Tutorial : [[FPCDocs_Tutorial|FPCDocs_Tutorial (englisch)]] | ||
| + | :CHM Bckend : [[chm_backend_for_fpdoc|chm_backend_for_fpdoc (englisch)]] | ||
| + | : How to make Lazarus Docs [[How_To_Make_Lazarus_Docs/de| How_To_Make_Lazarus_Docs/de (deutsch)]] | ||
| + | |||
| + | === Make in SVN-fpcdocs === | ||
| + | Bitte die README.DOCS und readmechm.txt lesen. | ||
| + | [[Category:Help_and_Docs/de]] [[Category:Lazarus/de]] | ||
Latest revision as of 19:07, 19 July 2015
│
Deutsch (de) │
English (en) │
Übersicht über die Dokumentation
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
- Allgemein
- Free Pascal Programmier Führer (prog.pdf, prog.chm, ... [online])
- Free Pascal Sprach Referenz Führer (ref.pdf, ref.chm, ... [online])
- Free Pascal Benutzer Führer (user.pdf, user.chm, ... [online])
- Development Tutorial (buildfaq.pdf, [online])
- Laufzeit Bibliothek
- Laufzeitbibliothek (rtl.pdf, rtl.chm, ... [online])
- Freie Bibliothek Referenz
- Reference for package fcl (fcl.pdf, fcl.chm [online])
- Programme
- Free Pascal code documenter FPDoc (fpdoc.pdf, fpdoc.chm, ... [online])
Lazarus Projekt
Installation der Hilfe in Lazarus
Online Hilfe
Wird nicht installiert.
Offline Hilfe
Sie befindet sich im Verzeichnis ($Lazarus/doc/)
Siehe auch
Benutzung der Hilfe in Lazarus
Online Hilfe
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
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
Die Vorgang für die Erstellung der Hilfe ist vielschichtig. Es werden mehrere Verfahren zur Erzeugung verwendet
Free Pascal Leitfaden für Entwickler
(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
(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
(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
(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)
(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)
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
(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)
(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
FPDoc
- 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
Bitte die README.DOCS und readmechm.txt lesen.
