Overview of the Lazarus Documentation
editBasically 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
edit- Common
- Free Pascal programming guide (prog.pdf, prog.chm, ... http://www.freepascal.org/docs-html/prog/prog.html online)
- Free Pascal language referenz guide (ref.pdf, ref.chm, ... http://www.freepascal.org/docs-html/ref/ref.html online)
- Free Pascal user guide (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)
- Runtime Library
- Runtime library (rtl.pdf, rtl.chm, ... http://www.freepascal.org/docs-html/rtl/ online)
- Free components reference
- Reference for package fcl (fcl.pdf, fcl.chm http://www.freepascal.org/docs-html/fcl/ online)
- Programs
- Free Pascal code documenter FPDoc (fpdoc.pdf, fpdoc.chm, ... http://lazarus-ccr.sourceforge.net/fpcdoc/fpdoc/fpdoc.html online)
Lazarus Project
edit- Lazarus Komponenten Bibliothek
- Reference for package lcl (lcl.chm, ...http://lazarus-ccr.sourceforge.net/docs/lcl/ online, Wiki LCL)
Installation of the help in Lazarus
editOnline Help
editIs 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
editIs un der the path ($Lazarus/docs/)
See also
Using the help in Lazarus
editOnline help
editIf 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
editIf offline help is installed and the information is available, so is firdt the offline help used and secondary the online.
Build the offline help
editThe building of the offline help is complex. Threr are more building path used.
Free Pascal Programming Guide
edit(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 Reference Guide
edit(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
edit(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
edit(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
edit(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 Components Library
editReference 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
edit(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
edit (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
editFPDoc
editTutorial : 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
editPlease read README.DOCS and readmechm.txt.