Difference between revisions of "IDE Window: Help Options"

From Lazarus wiki
m (Databases tab)
(Redirect people to other help page)
Line 18: Line 18:
 
=== If you use HTML help ===
 
=== If you use HTML help ===
 
You can download HTML Help from folder http://sourceforge.net/projects/lazarus-ccr/files/FPC%2BLazarus%20doc-html/  
 
You can download HTML Help from folder http://sourceforge.net/projects/lazarus-ccr/files/FPC%2BLazarus%20doc-html/  
 
  
 
'''Release notes''':
 
'''Release notes''':
Line 31: Line 30:
 
Select RTLUnits in the left pane and browse to c:\lazarus\docs\doc-html\rtl in the BaseURL property.
 
Select RTLUnits in the left pane and browse to c:\lazarus\docs\doc-html\rtl in the BaseURL property.
  
The BaseURL property contains now: 'file://c:/lazarus/docs/doc-html/rtl'. The URL on a *nix might look like: 'file:///home/myhome/lazarus/docs/doc-html/rtl'.
+
The BaseURL property now contains: 'file://c:/lazarus/docs/doc-html/rtl'. The URL on a *nix might look like: 'file:///home/myhome/lazarus/docs/doc-html/rtl'.
  
 
Similarly change the BaseURL for the FCLUnits and LCLUnits help databases by replacing rtl by fcl rsp. lcl in the url.
 
Similarly change the BaseURL for the FCLUnits and LCLUnits help databases by replacing rtl by fcl rsp. lcl in the url.
  
 
=== If you use CHM help ===
 
=== If you use CHM help ===
You can download Lazarus CHM help from http://sourceforge.net/projects/lazarus/files/Lazarus%20Documentation/
+
CHM help should be preconfigured if you installed Lazarus via an installer.
 +
See [[Installing_Help_in_the_IDE#Installing_CHM_help_.28Lazarus_1.0_and_later.29]] for details on downloading/checking/configuring CHM help.
  
ToDo: suggested StartPage?
 
  
 
==See Also==
 
==See Also==
  
 
*[[Installing_Help_in_the_IDE]]
 
*[[Installing_Help_in_the_IDE]]

Revision as of 13:38, 15 December 2012

Deutsch (de) English (en)

General tab

Todo

Viewers tab

Todo

(Help for this tab should be presented in hints, because when nothing is yet configured...)

Windows: (Help on Windows should simply use "open" with the document type, but...) For "HTML Browser" set BrowserPath to your <browser>.exe. That's all, for now.

Databases tab

It is recommended to use CHM help as the files are compressed and are supported by the official installers.

If you use HTML help

You can download HTML Help from folder http://sourceforge.net/projects/lazarus-ccr/files/FPC%2BLazarus%20doc-html/

Release notes: This file contains the tarred and bzip2ed html documents used for the context sensitive help.

For the remainder this instruction assumes you have installed Lazarus in c:\lazarus, and you want to use the default subdirectory c:\lazarus\docs\doc-html\. In what follows, adjust the path according to your installation.

First, extract this file to c:\lazarus\docs\doc-html. You now have subdirectories like rtl and lcl. In lazarus, go to Help -> Configure Help -> Databases tab.

(The stupid setup doesn't provide any default, and requires to specify each subdirectory, instead of only the common path, so...) Select RTLUnits in the left pane and browse to c:\lazarus\docs\doc-html\rtl in the BaseURL property.

The BaseURL property now contains: 'file://c:/lazarus/docs/doc-html/rtl'. The URL on a *nix might look like: 'file:///home/myhome/lazarus/docs/doc-html/rtl'.

Similarly change the BaseURL for the FCLUnits and LCLUnits help databases by replacing rtl by fcl rsp. lcl in the url.

If you use CHM help

CHM help should be preconfigured if you installed Lazarus via an installer. See Installing_Help_in_the_IDE#Installing_CHM_help_.28Lazarus_1.0_and_later.29 for details on downloading/checking/configuring CHM help.


See Also