Difference between revisions of "IDE Window: Help Options"

From Lazarus wiki
(category)
 
(15 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{IDE Window: Help Options}}
+
[[File:IDE-options-help.png|thumb|600px|IDE Options - Help - Help Options]]
  
== General tab ==
+
<noinclude>{{IDE Window: Help Options}}<!--- This page may be used as template in other pages ---></noinclude>
Todo
+
<br />''(Help for this tab should be presented in hints, because when nothing is yet configured...)''
  
== Viewers tab ==
+
===Help Options===
Todo
+
;HTML browser:
  
(Help for this tab should be presented in hints, because when nothing is yet configured...)
+
;CHM Help viewer: CHM help should be preconfigured if you installed Lazarus via an installer. See [[Installing Help in_the IDE#Installing CHM help (Lazarus 1.0 and later)|details on downloading/checking/configuring CHM help]].
  
Windows:
+
===Databases===
(Help on Windows should simply use "open" with the document type, but...)
+
Whenever the help is invoked, databases will be scanned  for help information
For "HTML Browser" set BrowserPath to your <browser>.exe. That's all, for now.
+
;RTLUnits:
 
+
;FCLUnits:
== Databases tab ==
+
;Free Pascal Compiler Messages:
It is recommended to use CHM help as the files are compressed and are supported by the official installers.
+
;LazUtilsUnits:
 
+
;FPC Language Reference:
=== If you use HTML help ===
+
;LCL - Lazarus component library:
You can download HTML Help from folder http://sourceforge.net/projects/lazarus-ccr/files/FPC%2BLazarus%20doc-html/
+
;Free Pascal Compiler Directives:
 
+
;External help:
'''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==
 
 
 
* [[Installing Help in the IDE]]
 
 
 
[[Category:IDE Window]]
 

Latest revision as of 20:44, 13 July 2020

IDE Options - Help - Help Options

Deutsch (de) English (en)

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

Help Options

HTML browser
CHM Help viewer
CHM help should be preconfigured if you installed Lazarus via an installer. See details on downloading/checking/configuring CHM help.

Databases

Whenever the help is invoked, databases will be scanned for help information

RTLUnits
FCLUnits
Free Pascal Compiler Messages
LazUtilsUnits
FPC Language Reference
LCL - Lazarus component library
Free Pascal Compiler Directives
External help