diff --git a/docs/xml/lcl/lazhelphtml.xml b/docs/xml/lcl/lazhelphtml.xml index e760611090..09e36f52a8 100644 --- a/docs/xml/lcl/lazhelphtml.xml +++ b/docs/xml/lcl/lazhelphtml.xml @@ -60,9 +60,9 @@ ancestor class to include properties and methods needed to associate Help Keywords to specific HTML files, and to retrieve and display the help content.

-The KeywordPrefix property determines the keywords that can be accessed in -the help database. BaseURL determines the path searched when accessing HTML -files for the help database. +The KeywordPrefix property is the value found at the start of a HelpKeyword +which indicates that the topic belongs the HTML help database. BaseURL +determines the path searched when accessing HTML files for the help database.

An application can create a THTMLHelpDatabase instance, assign the @@ -78,13 +78,17 @@ help file to be displayed for the keyword/url in a web browser when the F1 key is pressed.

-There is an example program that demonstrates usage of the components in the -examples/helphtml directory for the Lazarus installation. +There is an example program that demonstrates usage of the components: + +examples/helphtml +

+TControl.HelpKeyword +TControl.HelpType @@ -452,10 +456,66 @@ Default value for the BaseURL used in the HTML help database. -BaseURL for the HTML help database. +Protocol and Path to the directory where HTML help files are stored for the +HTML help database. - - + +

+BaseURL is a String property which contains the protocol and path +used to access the HTML help files stored in the help database. The property +value starts with a URL protocol like: +

+
+
'file://'
+
Accesses a path on the local file system.
+
'http://', https://'
+
Accesses a location on a web server.
+
+

+The property value must also include path information to the directory or +location where the help files are stored. For 'file://' access, the path can be +relative to application directory. For remote access, relative paths are not +resolvable. An absolute path for the host platform can also be used. +

+

+For example: +

+
+
'file://html/', 'file://../myapp/html/'
+
+Path on the local file system relative to the application directory. +
+
'file:///usr/share/myapp/html/'
+
+Absolute path to a directory on a UNIX-like file system. Not supported on +Windows; it is relative to the current drive. +
+
'file://c:/myapp/html/', 'file://c:\myapp\html\'
+
+Absolute path to a directory on the Windows platform. Not supported on +UNIX-like file systems; they do no support disk drive specifiers. +
+
'http://www.acme.org/myapp/html/', 'https://www.acme.org/myapp/html/'
+
+Absolute path to a location on a remote web server. +
+
+

+BaseURL is used in the GetEffectiveBaseURL and ShowURL methods when a request +URL is expanded / resolved to the storage location for the help database. +

+

+Use DefaultBaseURL to set the URL used when BaseURL is not resolvable or +omitted. Use BuiltInBaseURL to access a value assigned in the Lazarus IDE Help +options. +

+
+ + + + + +
@@ -804,8 +864,8 @@ on the local file system for the browser application executable used to view HTML help topics. For example:

- AViewer.BrowserPath := '/usr/bin/mozilla'; // or - AViewer.BrowserPath := ''"C:\Program Files (x86)\Google\Chrome\Application\chrome.exe "''; +AViewer.BrowserPath := '/usr/bin/mozilla'; // or +AViewer.BrowserPath := '"C:\Program Files (X86)\Google\Chrome\Application\chrome.exe"';

When BrowserPath contains an empty string (''), the FindDefaultBrowser