|
Win32::HtmlHelp - Perl extension for the HTML Help API |
Win32::HtmlHelp - Perl extension for the HTML Help API
use Win32::HtmlHelp 'DisplayTopic'; DisplayTopic( "MyHelp.chm", "html/intro.html" );
The HTML Help application programming interface (API) enables a Windows program to create a help window that displays a help topic.
This Perl module provides access to a few HTML Help API calls.
chmfilename specifies a compiled help (.chm) file, or a specific topic
within a compiled help file.
The optional parameter topic is a topic within a compiled help file.
A compiled help file retains the folder structure in which it was organized before compilation, unless the option to compile flat has been selected.
For example, if a project is organized in three folders (one for HTML files, one for images, and one for style sheets), the help file will contain those same folders internally. The folder in which the project file resides is considered the root.
To correctly link to a topic file, you must specify the full path. The following example specifies an overview topic:
DisplayTopic( "HelpFile.chm", "Html/Overview/Topic.htm" );
where Overview is a folder within the Html folder.
To specify a topic within a compiled help file, use the following syntax:
DisplayTopic( "HelpFile.chm::/Html/Overview/Topic.htm" );
chmfilename specifies a compiled help (.chm) file, or a specific topic
within a compiled help file.
The optional parameter keyword specifies the keyword to select in the
index (.hhk) file.
DisplayIndex( "HelpFile.chm", "foo" );
CloseAll()
None by default.
The function names must be explicitly exported.
The Microsoft HTML Help SDK:
http://msdn2.microsoft.com/en-us/library/ms670169.aspx
J-L Morel <jl_morel@bribes.org>
Home page: http://www.bribes.org/perl
Copyright (c) 2008 J-L Morel. All rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
|
Win32::HtmlHelp - Perl extension for the HTML Help API |