Difference between revisions of "Lazarus Docs"
From Lazarus wiki
Jump to navigationJump to search (Translate from German to englisch) |
m (typos with lazarus fixed) |
||
| Line 59: | Line 59: | ||
: not defined, if needed ? | : not defined, if needed ? | ||
; In Lazarus installed | ; In Lazarus installed | ||
| − | : yes ($ | + | : yes ($(lazarusdir)/docs/chm/prog.chm) |
=== Free Pascal Language Refernce Guide === | === Free Pascal Language Refernce Guide === | ||
| Line 77: | Line 77: | ||
: not defined, if needed ? | : not defined, if needed ? | ||
; In Lazarus installed | ; In Lazarus installed | ||
| − | : yes ($ | + | : yes ($(lazarusdir)/docs/chm/ref.chm) |
=== Free Pascal User Guide === | === Free Pascal User Guide === | ||
| Line 95: | Line 95: | ||
: not defined, if needed ? | : not defined, if needed ? | ||
; In Lazarus installed | ; In Lazarus installed | ||
| − | : yes ($ | + | : yes ($(lazarusdir)/docs/chm/user.chm) |
=== Development Tutorial === | === Development Tutorial === | ||
| Line 132: | Line 132: | ||
: not defined, if needed ? | : not defined, if needed ? | ||
; In Lazarus installed | ; In Lazarus installed | ||
| − | : yes ($ | + | : yes ($(lazarusdir)/docs/chm/rtl.chm) |
=== Free Componets Library === | === Free Componets Library === | ||
| Line 151: | Line 151: | ||
: not defined, if needed ? | : not defined, if needed ? | ||
; In Lazarus installed | ; In Lazarus installed | ||
| − | : yes ($ | + | : yes ($(lazarusdir)/docs/chm/fcl.chm) |
=== Free Pascal Code Documenter FPDoc === | === Free Pascal Code Documenter FPDoc === | ||
| Line 169: | Line 169: | ||
: not defined, if needed ? | : not defined, if needed ? | ||
; In Lazarus installed | ; In Lazarus installed | ||
| − | : yes ($ | + | : yes ($(lazarusdir)/docs/chm/fpdoc.chm) |
=== Lazarus Components Library === | === Lazarus Components Library === | ||
| Line 176: | Line 176: | ||
: English | : English | ||
; Sources | ; Sources | ||
| − | : in directory ($ | + | : in directory ($(lazarusdir)/docs/xml/lcl) |
; Sourceformat | ; Sourceformat | ||
: FPDoc format XML | : FPDoc format XML | ||
; Toolchain | ; Toolchain | ||
: FPDoc based (xml) | : FPDoc based (xml) | ||
| − | : Programm $ | + | : Programm $(lazarusdir)/docs/html/build_lcl_docs.lpr builds chm or html |
; Formats | ; Formats | ||
: html, chm | : html, chm | ||
; Buildtime | ; Buildtime | ||
| − | : If you start it by yourself (Attention, built in $ | + | : If you start it by yourself (Attention, built in $(lazarusdir)/docs/html/lcl/lcl.chm -> move ?!) |
; In Lazarus installed | ; In Lazarus installed | ||
| − | : yes ($ | + | : yes ($(lazarusdir)/docs/chm/lcl.chm) |
== Used programms and toolchains == | == Used programms and toolchains == | ||
Revision as of 19:17, 25 January 2015
│
Deutsch (de) │
English (en) │
Overview of the Lazarus Documentation
Basically you should make a difference between the projects ((Free Pascal Project, Lazarus Project) and the used formats of the help (Online, html, chm, inf)
Free Pascal Project
- Common
- Free Pascal programming guide (prog.pdf, prog.chm, ... [online])
- Free Pascal language referenz guide (ref.pdf, ref.chm, ... [online])
- Free Pascal user guide (user.pdf, user.chm, ... [online])
- Development Tutorial (buildfaq.pdf, [online])
- Runtime Library
- Runtime library (rtl.pdf, rtl.chm, ... [online])
- Free components reference
- Reference for package fcl (fcl.pdf, fcl.chm [online])
- Programs
- Free Pascal code documenter FPDoc (fpdoc.pdf, fpdoc.chm, ... [online])
Lazarus Project
Installation of the help in Lazarus
Online Help
Is not to install. If a connection to the internet is available, you can use it with F1 (or CtrlF1 - depends on the configuration). If offline help is installed and the topic is available, so the offline will be used first, then the online help.
Offline help
Is un der the path ($Lazarus/doc/)
See also
Using the help in Lazarus
Online help
If you have connection to the internet, you have to press F1 (or CtrlF1 - depends on the configuration) to show the help. If offline help is installed and the information is available, so is firdt the offline help used and secondary the online.
Offline help
If offline help is installed and the information is available, so is firdt the offline help used and secondary the online.
Build the offline help
The building of the offline help is complex. Threr are more building path used.
Free Pascal Programming Guide Führer
(prog.pdf, prog.chm, ... )
- Available languages
- english
- Sources
- in SVN under http://svn.freepascal.org/svn/fpcdocs
- Sourceformat
- Latex (fpcdocs/prog.tex)
- Toolchain
- make based
- Unix based, Windows could work
- Formats
- html, pdf, chm
- Buildtime
- not defined, if needed ?
- In Lazarus installed
- yes ($(lazarusdir)/docs/chm/prog.chm)
Free Pascal Language Refernce Guide
(ref.pdf, ref.chm, ... )
- Available languages
- english
- Sources
- in SVN under http://svn.freepascal.org/svn/fpcdocs
- Sourceformat
- Latex (fpcdocs/ref.tex)
- Toolchain
- make based
- Unix based, Windows could work
- Formats
- html, pdf, chm
- Buildtime
- not defined, if needed ?
- In Lazarus installed
- yes ($(lazarusdir)/docs/chm/ref.chm)
Free Pascal User Guide
(user.pdf, user.chm, ...)
- Available languages
- english
- Sources
- in SVN under http://svn.freepascal.org/svn/fpcdocs
- Sourceformat
- Latex (fpcdocs/user.tex)
- Toolchain
- make based
- Unix based, Windows could work
- Formate
- html, pdf, chm
- Buildtime
- not defined, if needed ?
- In Lazarus installed
- yes ($(lazarusdir)/docs/chm/user.chm)
Development Tutorial
(buildfaq.pdf)
- Available languages
- English
- Sources
- in SVN under http://svn.freepascal.org/svn/fpcdocs
- Sourceformat
- Lyx (Latex) (fpcdocs/buildfaq/buildfaq.lyx)
- Toolchain
- make based
- Unix based, Windows could work
- Formate
- html, pdf
- Buildtime
- not defined, if needed ?
- In Lazarus installed
- no
Runtime Library
(rtl.pdf, rtl.chm, ... )
- Available languages
- English
- Sources
- in SVN under http://svn.freepascal.org/svn/fpcdocs
- Sourceformat
- Latex (fpcdocs/rtl.tex)
- Diverse Verzeichnis in fpcdocs im FPDoc Format (xml)
- Toolchain
- make based
- Unix based, Windows could work
- Formate
- html, pdf, chm
- Buildtime
- not defined, if needed ?
- In Lazarus installed
- yes ($(lazarusdir)/docs/chm/rtl.chm)
Free Componets Library
Reference for package fcl (fcl.pdf, fcl.chm)
- Available languages
- English
- Sources
- in SVN under http://svn.freepascal.org/svn/fpcdocs
- Sourceformat
- Latex (fpcdocs/fcl.tex)
- Diverse Verzeichnis in fpcdocs im FPDoc Format (xml)
- Toolchain
- make based
- Unix based, Windows could work
- Formate
- html, pdf, chm
- Buildtime
- not defined, if needed ?
- In Lazarus installed
- yes ($(lazarusdir)/docs/chm/fcl.chm)
Free Pascal Code Documenter FPDoc
(fpdoc.pdf, fpdoc.chm, ...)
- Available languages
- English
- Sources
- in SVN under http://svn.freepascal.org/svn/fpcdocs
- Sourceformat
- Latex (fpcdocs/fpdoc.tex)
- Toolchain
- make based
- Unix based, Windows could work
- Formate
- html, pdf, chm
- Buildtime
- not defined, if needed ?
- In Lazarus installed
- yes ($(lazarusdir)/docs/chm/fpdoc.chm)
Lazarus Components Library
(lcl.chm, ..)
- Available languages
- English
- Sources
- in directory ($(lazarusdir)/docs/xml/lcl)
- Sourceformat
- FPDoc format XML
- Toolchain
- FPDoc based (xml)
- Programm $(lazarusdir)/docs/html/build_lcl_docs.lpr builds chm or html
- Formats
- html, chm
- Buildtime
- If you start it by yourself (Attention, built in $(lazarusdir)/docs/html/lcl/lcl.chm -> move ?!)
- In Lazarus installed
- yes ($(lazarusdir)/docs/chm/lcl.chm)
Used programms and toolchains
FPDoc
- Tutorial : FPCDocs_Tutorial (englisch)
- CHM Bckend : chm_backend_for_fpdoc (englisch)
- How to make Lazarus Docs How_To_Make_Lazarus_Docs (english)
Make in SVN-fpcdocs
Please read README.DOCS and readmechm.txt.
