Pod::HtmlHelp - Interface with Microsoft's HtmlHelp system

NAME

Pod::HtmlHelp - Interface with Microsoft's HtmlHelp system

SYNOPSIS

    use Pod::HtmlHelp;
    pod2chm([options]);

DESCRIPTION

This module creates HtmlHelp from HTML or POD source (including the Pod in PM library files) using Microsoft's HtmlHelp compiler. This creates the intermediate project files and from those creates the htmlhelp windows 32-bit help files.

FUNCTIONS

The individual functions that were designed with working with html help files rather than the Perl htmlhelp documentation are deprecated in favor of doing things with a single command. Some of them need work in order to work again.

MakeHelp
Turns a single html page into htmlhelp document.

MakeHelpFromDir
Turns a directory's worth of html pages into a single htmlhelp document.

MakeHelpFromTree
Turns a tree's worth of html pages into a single htmlhelp document.

MakeHelpFromHash
Creates an htmlhelp document where the labels on the folders are passed into the program. Useful for labels like Tk::Whatsis::Gizmo to replace the default ones looking like c:/perl/lib/site/Tk/Whatsis/Gizmo.

MakeHelpFromPod
Turns a single Pod or pm document into htmlhelp document.

MakeHelpFromPodDir
Turns a dir's worth of Pod or pm into a single htmlhelp document.

MakeHelpFromPodTree
Turns a tree's worth of Pod or pm into a single htmlhelp document.

MakeHelpFromPodHash
Like MaheHelpFromHash() but for Pod instead of html.

MakePerlHtmlIndex
Creates an HTML version of an index or TOC for perl help.

MakePerlHtml
Does everything for perl HTML works.

CONFIG.PM

This library makes use of Config.pm to know where to get its stuff.

HHC.EXE

This library makes use of the HtmlHelp compiler by microsoft.

VARIABLES

$HtmlHelp::CSS
Determines the stylesheet to be used for the htmlhelp files. Default is the ActiveState common stylesheet. This variable can be set to an empty string to allow for just plain old HTML with nothing fancy.

Default is perl.css.

$HtmlHelp::COMPILER
Complete path and file name of the HtmlHelp compiler from Microsoft. This is REQUIRED for this library to run. It defaults to it's install directory within <lib>/HtmlHelp. Feel free to move this in $COMPILER if you have the HtmlHelp workshop from Microsoft and you want to use the compiler from a different location.

$HtmlHelp::FULLTEXTSEARCH
Whether to create full text search. Defaults to true.

$HtmlHelp::CLEANUP
Whether to clean up temporary files (and html files if building from raw Pod) after building the htmlhelp. This can be useful, for example, when you need to keep the intermediate files created by the process for inclusion into a collective help file.

HISTORY

  1. 0.0 pete
    First final release, went out with (ActiveState Perl) 502

  2. 0.1 pete
    Temporary, removed CSS insertion in favor of just adding a link to the css, since it's being built on the user's machine now; and temporarily added the hardcoded contents of the main toc to the built toc until I have time to build it codewise.

  3. 0.2 gsar
    Fixed much brokenness. Much ugliness remains.

  4. 1 autrijus
    Adapted for pod2chm use.

SEE ALSO

the Pod::WinHtml manpage

AUTHORS

COPYRIGHT

Copyright 2000 by ActiveState Tools Corp (http://www.activestate.com/).

Copyright 2001, 2002 by Autrijus Tang <autrijus@autrijus.org>.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

See http://www.perl.com/perl/misc/Artistic.html

 Pod::HtmlHelp - Interface with Microsoft's HtmlHelp system