MGTEK Browser Help is a web-browser based help system that can be hosted locally on a hard disk, or remotely on a web-server. It can be viewed on many platforms that have a HTML 4.0 compliant web-browser available, such as Microsoft Windows or Linux.

The MGTEK Browser Help help system consists of a set of HTML files, images and JavaScripts. The files can be found in the output folder, which is located in the same folder as your Word document. The output folder contains the file ‘index.htm’, which must be opened to view the help system.

Hosting the help system locally

To install the help system to a local hard drive, copy all files and sub-folders from the output folder to the computer the help system will be viewed on. Typically, an application installer program will perform this task.

To view the help system, open the file ‘index.htm’. You can do so by double-clicking the file in Windows Explorer or by launching the file programmatically.

Tip   On a Microsoft Windows System, you can rename the file ‘index.htm’ to ‘index.hta’ in order to create a HTML application. HTML applications behave very similar to regular executables, and hide the user interface of Internet Explorer. If you use HTML applications, you should generate the help system with the “URL Security Zone” set to ‘Application’ (See Project->Variables) to take full advantage of the capabilities of HTML applications.

Hosting the help system remotely

To install the help system to a web server, copy all files and sub-folders from the output folder to a virtual folder of your web-server. Typically, you can use Explorer to copy the files if you have access to the web-server via a shared folder. If you connect to the web-server remotely, you can use FTP or WebDAV to copy the files.

To view the help system, open a web-browser and navigate to the URL that points to the virtual folder of your web-server. For instance, if the help system was installed to C:\Inetpub\wwwroot\yoursite\manual, type http://www.yoursite.com/manual/index.htm.

Command-line Parameters

MGTEK Browser Help supports various command-line parameters that you can use to control the help viewer. The parameters can be passed via an URL or via the command-line.

dynamic (default)

static

page=<page.html>

sync

autosync

Examples

http://www.mgtek.com/helpproducer/manual/?autosync&page=html/copyright.html
file:///C:/myhelpsystem/output/index.htm?autosync&page=html/copyright.html
C:\myhelpsystem\output\index.hta autosync page=html/copyright.html

See Also

Deploying Help Files | MGTEK Browser Help