Sign in Join
Wiki copytemporary

Lazarus Docs: what changed

Revision 2 to 3. Removed lines have a minus sign; added lines have a plus sign.

OldNewLine
11## Overview of the Lazarus Documentation
22
33Basically you should make a difference between the projects ((Free Pascal Project, Lazarus Project) and the used formats of the help (Online, html, chm, inf)
44
55### Free Pascal Project
66
77**Common**
88Free Pascal programming guide (prog.pdf, prog.chm, ... [[http://www.freepascal.org/docs-html/prog/prog.html online]])
99
1010Free Pascal language referenz guide (ref.pdf, ref.chm, ... [[http://www.freepascal.org/docs-html/ref/ref.html online]])
1111
1212Free Pascal user guide (user.pdf, user.chm, ... [[http://www.freepascal.org/docs-html/user/user.html online]])
1313
1414Development Tutorial (buildfaq.pdf, [[http://www.stack.nl/~marcov/buildfaq/ online]])
1515
1616**Runtime Library**
1717Runtime library (rtl.pdf, rtl.chm, ... [[http://www.freepascal.org/docs-html/rtl/ online]])
1818
1919**Free components reference**
2020Reference for package fcl (fcl.pdf, fcl.chm [[http://www.freepascal.org/docs-html/fcl/ online]])
2121
2222**Programs**
2323Free Pascal code documenter FPDoc (fpdoc.pdf, fpdoc.chm, ... [[http://lazarus-ccr.sourceforge.net/fpcdoc/fpdoc/fpdoc.html online]])
2424
2525### Lazarus Project
2626
2727**Lazarus Komponenten Bibliothek**
2828Reference for package lcl (lcl.chm, ...[[http://lazarus-ccr.sourceforge.net/docs/lcl/ online]], [[Lazarus Documentation|Wiki LCL]])
2929
3030## Installation of the help in Lazarus
3131
3232### Online Help
3333
3434Is not to install. If a connection to the internet is available, you can use it with `F1` (or `Ctrl``F1` - 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.
3535
3636### Offline help
3737
3838Is un der the path (\$Lazarus/docs/)
3939
4040See also
4141
4242- [[Installing Help in the IDE]]
4343
4444## Using the help in Lazarus
4545
4646### Online help
4747
4848If you have connection to the internet, you have to press `F1` (or `Ctrl``F1` - 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.
4949
5050### Offline help
5151
5252If offline help is installed and the information is available, so is firdt the offline help used and secondary the online.
5353
5454## Build the offline help
5555
5656The building of the offline help is complex. Threr are more building path used.
5757
5858### Free Pascal Programming Guide
5959
60-`(prog.pdf, prog.chm, ... )`
60+```text
61+(prog.pdf, prog.chm, ... )
62+```
6163
6264Available languages
6365english
6466
6567Sources
6668in SVN under <http://svn.freepascal.org/svn/fpcdocs>
6769
6870Sourceformat
6971Latex (fpcdocs/prog.tex)
7072
7173Toolchain
7274make based
7375
7476Unix based, Windows could work
7577
7678Formats
7779html, pdf, chm
7880
7981Buildtime
8082not defined, if needed ?
8183
8284In Lazarus installed
8385yes (\$(lazarusdir)/docs/chm/prog.chm)
8486
8587### Free Pascal Language Reference Guide
8688
87-`(ref.pdf, ref.chm, ... )`
89+```text
90+(ref.pdf, ref.chm, ... )
91+```
8892
8993Available languages
9094english
9195
9296Sources
9397in SVN under <http://svn.freepascal.org/svn/fpcdocs>
9498
9599Sourceformat
96100Latex (fpcdocs/ref.tex)
97101
98102Toolchain
99103make based
100104
101105Unix based, Windows could work
102106
103107Formats
104108html, pdf, chm
105109
106110Buildtime
107111not defined, if needed ?
108112
109113In Lazarus installed
110114yes (\$(lazarusdir)/docs/chm/ref.chm)
111115
112116### Free Pascal User Guide
113117
114118(user.pdf, user.chm, ...)
115119
116120Available languages
117121english
118122
119123Sources
120124in SVN under <http://svn.freepascal.org/svn/fpcdocs>
121125
122126Sourceformat
123127Latex (fpcdocs/user.tex)
124128
125129Toolchain
126130make based
127131
128132Unix based, Windows could work
129133
130134Formate
131135html, pdf, chm
132136
133137Buildtime
134138not defined, if needed ?
135139
136140In Lazarus installed
137141yes (\$(lazarusdir)/docs/chm/user.chm)
138142
139143### Development Tutorial
140144
141-`(buildfaq.pdf)`
145+```text
146+(buildfaq.pdf)
147+```
142148
143149Available languages
144150English
145151
146152Sources
147153in SVN under <http://svn.freepascal.org/svn/fpcdocs>
148154
149155Sourceformat
150156Lyx (Latex) (fpcdocs/buildfaq/buildfaq.lyx)
151157
152158Toolchain
153159make based
154160
155161Unix based, Windows could work
156162
157163Formate
158164html, pdf
159165
160166Buildtime
161167not defined, if needed ?
162168
163169In Lazarus installed
164170no
165171
166172### Runtime Library
167173
168174(rtl.pdf, rtl.chm, ... )
169175
170176Available languages
171177English
172178
173179Sources
174180in SVN under <http://svn.freepascal.org/svn/fpcdocs>
175181
176182Sourceformat
177183Latex (fpcdocs/rtl.tex)
178184
179185Diverse Verzeichnis in fpcdocs im FPDoc Format (xml)
180186
181187Toolchain
182188make based
183189
184190Unix based, Windows could work
185191
186192Formate
187193html, pdf, chm
188194
189195Buildtime
190196not defined, if needed ?
191197
192198In Lazarus installed
193199yes (\$(lazarusdir)/docs/chm/rtl.chm)
194200
195201### Free Components Library
196202
197203Reference for package fcl (fcl.pdf, fcl.chm)
198204
199205Available languages
200206English
201207
202208Sources
203209in SVN under <http://svn.freepascal.org/svn/fpcdocs>
204210
205211Sourceformat
206212Latex (fpcdocs/fcl.tex)
207213
208214Diverse Verzeichnis in fpcdocs im FPDoc Format (xml)
209215
210216Toolchain
211217make based
212218
213219Unix based, Windows could work
214220
215221Formate
216222html, pdf, chm
217223
218224Buildtime
219225not defined, if needed ?
220226
221227In Lazarus installed
222228yes (\$(lazarusdir)/docs/chm/fcl.chm)
223229
224230### Free Pascal Code Documenter FPDoc
225231
226-`(fpdoc.pdf, fpdoc.chm, ...)`
232+```text
233+(fpdoc.pdf, fpdoc.chm, ...)
234+```
227235
228236Available languages
229237English
230238
231239Sources
232240in SVN under <http://svn.freepascal.org/svn/fpcdocs>
233241
234242Sourceformat
235243Latex (fpcdocs/fpdoc.tex)
236244
237245Toolchain
238246make based
239247
240248Unix based, Windows could work
241249
242250Formate
243251html, pdf, chm
244252
245253Buildtime
246254not defined, if needed ?
247255
248256In Lazarus installed
249257yes (\$(lazarusdir)/docs/chm/fpdoc.chm)
250258
251259### Lazarus Components Library
252260
253-` (lcl.chm, ..)`
261+```text
262+ (lcl.chm, ..)
263+```
254264
255265Available languages
256266English
257267
258268Sources
259269in directory (\$(lazarusdir)/docs/xml/lcl)
260270
261271Sourceformat
262272FPDoc format XML
263273
264274Toolchain
265275FPDoc based (xml)
266276
267277Programm \$(lazarusdir)/docs/html/build_lcl_docs.lpr builds chm or html
268278
269279Formats
270280html, chm
271281
272282Buildtime
273283If you start it by yourself (Attention, built in \$(lazarusdir)/docs/html/lcl/lcl.chm -\> move ?!)
274284
275285In Lazarus installed
276286yes (\$(lazarusdir)/docs/chm/lcl.chm)
277287
278288## Used programms and toolchains
279289
280290### FPDoc
281291
282292
283293Tutorial : [[FPCDocs Tutorial|FPCDocs_Tutorial (englisch)]]
284294
285295CHM Bckend : [[chm backend for fpdoc|chm_backend_for_fpdoc (englisch)]]
286296
287297How to make Lazarus Docs [[How To Make Lazarus Docs|How_To_Make_Lazarus_Docs (english)]]
288298
289299### Make in SVN-fpcdocs
290300
291301Please read README.DOCS and readmechm.txt.
292302
293303---
294304*From the Free Pascal wiki, page "Lazarus Docs", as it stood on 2024-03-13 after a change by Raskaton, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).*
295305Category: Help and Docs
296306Category: Lazarus

Back to history