THTMLHelpDatabase.BaseURL

Protocol and Path to the directory where HTML help files are stored for the HTML help database.

Declaration

Source position: lazhelphtml.pas line 79

Description

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.

See also