Sign in Join
Wiki copytemporary

Lazarus Docs: what changed

Revision 1 to 2. 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
34-Is not to install. If a connection to the internet is available, you can use it with <span class="kbd">F1</span> (or <span class="kbd">Ctrl</span><span class="kbd">F1</span> - 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.
34+Is 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
48-If you have connection to the internet, you have to press <span class="kbd">F1</span> (or <span class="kbd">Ctrl</span><span class="kbd">F1</span> - 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.
48+If 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
6060`(prog.pdf, prog.chm, ... )`
6161
6262Available languages
6363english
6464
6565Sources
6666in SVN under <http://svn.freepascal.org/svn/fpcdocs>
6767
6868Sourceformat
6969Latex (fpcdocs/prog.tex)
7070
7171Toolchain
7272make based
7373
7474Unix based, Windows could work
7575
7676Formats
7777html, pdf, chm
7878
7979Buildtime
8080not defined, if needed ?
8181
8282In Lazarus installed
8383yes (\$(lazarusdir)/docs/chm/prog.chm)
8484
8585### Free Pascal Language Reference Guide
8686
8787`(ref.pdf, ref.chm, ... )`
8888
8989Available languages
9090english
9191
9292Sources
9393in SVN under <http://svn.freepascal.org/svn/fpcdocs>
9494
9595Sourceformat
9696Latex (fpcdocs/ref.tex)
9797
9898Toolchain
9999make based
100100
101101Unix based, Windows could work
102102
103103Formats
104104html, pdf, chm
105105
106106Buildtime
107107not defined, if needed ?
108108
109109In Lazarus installed
110110yes (\$(lazarusdir)/docs/chm/ref.chm)
111111
112112### Free Pascal User Guide
113113
114114(user.pdf, user.chm, ...)
115115
116116Available languages
117117english
118118
119119Sources
120120in SVN under <http://svn.freepascal.org/svn/fpcdocs>
121121
122122Sourceformat
123123Latex (fpcdocs/user.tex)
124124
125125Toolchain
126126make based
127127
128128Unix based, Windows could work
129129
130130Formate
131131html, pdf, chm
132132
133133Buildtime
134134not defined, if needed ?
135135
136136In Lazarus installed
137137yes (\$(lazarusdir)/docs/chm/user.chm)
138138
139139### Development Tutorial
140140
141141`(buildfaq.pdf)`
142142
143143Available languages
144144English
145145
146146Sources
147147in SVN under <http://svn.freepascal.org/svn/fpcdocs>
148148
149149Sourceformat
150150Lyx (Latex) (fpcdocs/buildfaq/buildfaq.lyx)
151151
152152Toolchain
153153make based
154154
155155Unix based, Windows could work
156156
157157Formate
158158html, pdf
159159
160160Buildtime
161161not defined, if needed ?
162162
163163In Lazarus installed
164164no
165165
166166### Runtime Library
167167
168168(rtl.pdf, rtl.chm, ... )
169169
170170Available languages
171171English
172172
173173Sources
174174in SVN under <http://svn.freepascal.org/svn/fpcdocs>
175175
176176Sourceformat
177177Latex (fpcdocs/rtl.tex)
178178
179179Diverse Verzeichnis in fpcdocs im FPDoc Format (xml)
180180
181181Toolchain
182182make based
183183
184184Unix based, Windows could work
185185
186186Formate
187187html, pdf, chm
188188
189189Buildtime
190190not defined, if needed ?
191191
192192In Lazarus installed
193193yes (\$(lazarusdir)/docs/chm/rtl.chm)
194194
195195### Free Components Library
196196
197197Reference for package fcl (fcl.pdf, fcl.chm)
198198
199199Available languages
200200English
201201
202202Sources
203203in SVN under <http://svn.freepascal.org/svn/fpcdocs>
204204
205205Sourceformat
206206Latex (fpcdocs/fcl.tex)
207207
208208Diverse Verzeichnis in fpcdocs im FPDoc Format (xml)
209209
210210Toolchain
211211make based
212212
213213Unix based, Windows could work
214214
215215Formate
216216html, pdf, chm
217217
218218Buildtime
219219not defined, if needed ?
220220
221221In Lazarus installed
222222yes (\$(lazarusdir)/docs/chm/fcl.chm)
223223
224224### Free Pascal Code Documenter FPDoc
225225
226226`(fpdoc.pdf, fpdoc.chm, ...)`
227227
228228Available languages
229229English
230230
231231Sources
232232in SVN under <http://svn.freepascal.org/svn/fpcdocs>
233233
234234Sourceformat
235235Latex (fpcdocs/fpdoc.tex)
236236
237237Toolchain
238238make based
239239
240240Unix based, Windows could work
241241
242242Formate
243243html, pdf, chm
244244
245245Buildtime
246246not defined, if needed ?
247247
248248In Lazarus installed
249249yes (\$(lazarusdir)/docs/chm/fpdoc.chm)
250250
251251### Lazarus Components Library
252252
253253` (lcl.chm, ..)`
254254
255255Available languages
256256English
257257
258258Sources
259259in directory (\$(lazarusdir)/docs/xml/lcl)
260260
261261Sourceformat
262262FPDoc format XML
263263
264264Toolchain
265265FPDoc based (xml)
266266
267267Programm \$(lazarusdir)/docs/html/build_lcl_docs.lpr builds chm or html
268268
269269Formats
270270html, chm
271271
272272Buildtime
273273If you start it by yourself (Attention, built in \$(lazarusdir)/docs/html/lcl/lcl.chm -\> move ?!)
274274
275275In Lazarus installed
276276yes (\$(lazarusdir)/docs/chm/lcl.chm)
277277
278278## Used programms and toolchains
279279
280280### FPDoc
281281
282282
283283Tutorial : [[FPCDocs Tutorial|FPCDocs_Tutorial (englisch)]]
284284
285285CHM Bckend : [[chm backend for fpdoc|chm_backend_for_fpdoc (englisch)]]
286286
287287How to make Lazarus Docs [[How To Make Lazarus Docs|How_To_Make_Lazarus_Docs (english)]]
288288
289289### Make in SVN-fpcdocs
290290
291291Please read README.DOCS and readmechm.txt.
292292
293293---
294294*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).*
295295Category: Help and Docs
296296Category: Lazarus

Back to history