Lazarus Docs: what changed

Revision 0 to 1. Removed lines have a minus sign; added lines have a plus sign.

Title: Lazarus Docs

New		Line
1	+	## Overview of the Lazarus Documentation
2	+
3	+	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)
4	+
5	+	### Free Pascal Project
6	+
7	+	Common
8	+	Free Pascal programming guide (prog.pdf, prog.chm, ... [[http://www.freepascal.org/docs-html/prog/prog.html online]])
9	+
10	+	Free Pascal language referenz guide (ref.pdf, ref.chm, ... [[http://www.freepascal.org/docs-html/ref/ref.html online]])
11	+
12	+	Free Pascal user guide (user.pdf, user.chm, ... [[http://www.freepascal.org/docs-html/user/user.html online]])
13	+
14	+	Development Tutorial (buildfaq.pdf, [[http://www.stack.nl/~marcov/buildfaq/ online]])
15	+
16	+	Runtime Library
17	+	Runtime library (rtl.pdf, rtl.chm, ... [[http://www.freepascal.org/docs-html/rtl/ online]])
18	+
19	+	Free components reference
20	+	Reference for package fcl (fcl.pdf, fcl.chm [[http://www.freepascal.org/docs-html/fcl/ online]])
21	+
22	+	Programs
23	+	Free Pascal code documenter FPDoc (fpdoc.pdf, fpdoc.chm, ... [[http://lazarus-ccr.sourceforge.net/fpcdoc/fpdoc/fpdoc.html online]])
24	+
25	+	### Lazarus Project
26	+
27	+	Lazarus Komponenten Bibliothek
28	+	Reference for package lcl (lcl.chm, ...[[http://lazarus-ccr.sourceforge.net/docs/lcl/ online]], [[Lazarus Documentation\|Wiki LCL]])
29	+
30	+	## Installation of the help in Lazarus
31	+
32	+	### Online Help
33	+
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.
35	+
36	+	### Offline help
37	+
38	+	Is un der the path (\$Lazarus/docs/)
39	+
40	+	See also
41	+
42	+	- [[Installing Help in the IDE]]
43	+
44	+	## Using the help in Lazarus
45	+
46	+	### Online help
47	+
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.
49	+
50	+	### Offline help
51	+
52	+	If offline help is installed and the information is available, so is firdt the offline help used and secondary the online.
53	+
54	+	## Build the offline help
55	+
56	+	The building of the offline help is complex. Threr are more building path used.
57	+
58	+	### Free Pascal Programming Guide
59	+
60	+	`(prog.pdf, prog.chm, ... )`
61	+
62	+	Available languages
63	+	english
64	+
65	+	Sources
66	+	in SVN under <http://svn.freepascal.org/svn/fpcdocs>
67	+
68	+	Sourceformat
69	+	Latex (fpcdocs/prog.tex)
70	+
71	+	Toolchain
72	+	make based
73	+
74	+	Unix based, Windows could work
75	+
76	+	Formats
77	+	html, pdf, chm
78	+
79	+	Buildtime
80	+	not defined, if needed ?
81	+
82	+	In Lazarus installed
83	+	yes (\$(lazarusdir)/docs/chm/prog.chm)
84	+
85	+	### Free Pascal Language Reference Guide
86	+
87	+	`(ref.pdf, ref.chm, ... )`
88	+
89	+	Available languages
90	+	english
91	+
92	+	Sources
93	+	in SVN under <http://svn.freepascal.org/svn/fpcdocs>
94	+
95	+	Sourceformat
96	+	Latex (fpcdocs/ref.tex)
97	+
98	+	Toolchain
99	+	make based
100	+
101	+	Unix based, Windows could work
102	+
103	+	Formats
104	+	html, pdf, chm
105	+
106	+	Buildtime
107	+	not defined, if needed ?
108	+
109	+	In Lazarus installed
110	+	yes (\$(lazarusdir)/docs/chm/ref.chm)
111	+
112	+	### Free Pascal User Guide
113	+
114	+	(user.pdf, user.chm, ...)
115	+
116	+	Available languages
117	+	english
118	+
119	+	Sources
120	+	in SVN under <http://svn.freepascal.org/svn/fpcdocs>
121	+
122	+	Sourceformat
123	+	Latex (fpcdocs/user.tex)
124	+
125	+	Toolchain
126	+	make based
127	+
128	+	Unix based, Windows could work
129	+
130	+	Formate
131	+	html, pdf, chm
132	+
133	+	Buildtime
134	+	not defined, if needed ?
135	+
136	+	In Lazarus installed
137	+	yes (\$(lazarusdir)/docs/chm/user.chm)
138	+
139	+	### Development Tutorial
140	+
141	+	`(buildfaq.pdf)`
142	+
143	+	Available languages
144	+	English
145	+
146	+	Sources
147	+	in SVN under <http://svn.freepascal.org/svn/fpcdocs>
148	+
149	+	Sourceformat
150	+	Lyx (Latex) (fpcdocs/buildfaq/buildfaq.lyx)
151	+
152	+	Toolchain
153	+	make based
154	+
155	+	Unix based, Windows could work
156	+
157	+	Formate
158	+	html, pdf
159	+
160	+	Buildtime
161	+	not defined, if needed ?
162	+
163	+	In Lazarus installed
164	+	no
165	+
166	+	### Runtime Library
167	+
168	+	(rtl.pdf, rtl.chm, ... )
169	+
170	+	Available languages
171	+	English
172	+
173	+	Sources
174	+	in SVN under <http://svn.freepascal.org/svn/fpcdocs>
175	+
176	+	Sourceformat
177	+	Latex (fpcdocs/rtl.tex)
178	+
179	+	Diverse Verzeichnis in fpcdocs im FPDoc Format (xml)
180	+
181	+	Toolchain
182	+	make based
183	+
184	+	Unix based, Windows could work
185	+
186	+	Formate
187	+	html, pdf, chm
188	+
189	+	Buildtime
190	+	not defined, if needed ?
191	+
192	+	In Lazarus installed
193	+	yes (\$(lazarusdir)/docs/chm/rtl.chm)
194	+
195	+	### Free Components Library
196	+
197	+	Reference for package fcl (fcl.pdf, fcl.chm)
198	+
199	+	Available languages
200	+	English
201	+
202	+	Sources
203	+	in SVN under <http://svn.freepascal.org/svn/fpcdocs>
204	+
205	+	Sourceformat
206	+	Latex (fpcdocs/fcl.tex)
207	+
208	+	Diverse Verzeichnis in fpcdocs im FPDoc Format (xml)
209	+
210	+	Toolchain
211	+	make based
212	+
213	+	Unix based, Windows could work
214	+
215	+	Formate
216	+	html, pdf, chm
217	+
218	+	Buildtime
219	+	not defined, if needed ?
220	+
221	+	In Lazarus installed
222	+	yes (\$(lazarusdir)/docs/chm/fcl.chm)
223	+
224	+	### Free Pascal Code Documenter FPDoc
225	+
226	+	`(fpdoc.pdf, fpdoc.chm, ...)`
227	+
228	+	Available languages
229	+	English
230	+
231	+	Sources
232	+	in SVN under <http://svn.freepascal.org/svn/fpcdocs>
233	+
234	+	Sourceformat
235	+	Latex (fpcdocs/fpdoc.tex)
236	+
237	+	Toolchain
238	+	make based
239	+
240	+	Unix based, Windows could work
241	+
242	+	Formate
243	+	html, pdf, chm
244	+
245	+	Buildtime
246	+	not defined, if needed ?
247	+
248	+	In Lazarus installed
249	+	yes (\$(lazarusdir)/docs/chm/fpdoc.chm)
250	+
251	+	### Lazarus Components Library
252	+
253	+	` (lcl.chm, ..)`
254	+
255	+	Available languages
256	+	English
257	+
258	+	Sources
259	+	in directory (\$(lazarusdir)/docs/xml/lcl)
260	+
261	+	Sourceformat
262	+	FPDoc format XML
263	+
264	+	Toolchain
265	+	FPDoc based (xml)
266	+
267	+	Programm \$(lazarusdir)/docs/html/build_lcl_docs.lpr builds chm or html
268	+
269	+	Formats
270	+	html, chm
271	+
272	+	Buildtime
273	+	If you start it by yourself (Attention, built in \$(lazarusdir)/docs/html/lcl/lcl.chm -\> move ?!)
274	+
275	+	In Lazarus installed
276	+	yes (\$(lazarusdir)/docs/chm/lcl.chm)
277	+
278	+	## Used programms and toolchains
279	+
280	+	### FPDoc
281	+
282	+
283	+	Tutorial : [[FPCDocs Tutorial\|FPCDocs_Tutorial (englisch)]]
284	+
285	+	CHM Bckend : [[chm backend for fpdoc\|chm_backend_for_fpdoc (englisch)]]
286	+
287	+	How to make Lazarus Docs [[How To Make Lazarus Docs\|How_To_Make_Lazarus_Docs (english)]]
288	+
289	+	### Make in SVN-fpcdocs
290	+
291	+	Please read README.DOCS and readmechm.txt.
292	+
293	+	---
294	+	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).
295	+	Category: Help and Docs
296	+	Category: Lazarus

Back to history