X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/576507e276a32bccda610ce0e45451e6a46e4d31..d86939c4c948c98d9f840e728c8c1ae2a99e1e4f:/docs/latex/wx/hthelpct.tex diff --git a/docs/latex/wx/hthelpct.tex b/docs/latex/wx/hthelpct.tex index 4111abf3f3..2e667c66da 100644 --- a/docs/latex/wx/hthelpct.tex +++ b/docs/latex/wx/hthelpct.tex @@ -23,13 +23,6 @@ Have a look at docs/html/ directory where sample project files are stored. You can use Tex2RTF to produce these files when generating HTML, if you set {\bf htmlWorkshopFiles} to {\bf true} in your tex2rtf.ini file. -In order to use the controller in your application under Windows you must -have the following line in your .rc file: - -\begin{verbatim} -#include "wx/html/msw/wxhtml.rc" -\end{verbatim} - \wxheading{Note} It is strongly recommended to use preprocessed {\bf .hhp.cached} version of @@ -39,6 +32,10 @@ projects. It can be either created on-the-fly (see distribute the cached version together with helpfiles. See {\it samples/html/help} sample for demonstration of its use. +\wxheading{See also} + +\helpref{Information about wxBestHelpController}{wxhelpcontroller} + \wxheading{Derived from} wxHelpControllerBase @@ -75,7 +72,7 @@ user.} have a book icon. This is how Microsoft's HTML help viewer behaves.} \twocolitem{\windowstyle{wxHF\_ICONS\_FOLDER}}{Book nodes in contents pane have a book icon, book's sections have a folder icon. This is the default.} -\twocolitem{\windowstyle{wxHF\_ICONS\_BOOK_CHAPTER}}{Both book nodes and +\twocolitem{\windowstyle{wxHF\_ICONS\_BOOK\_CHAPTER}}{Both book nodes and nodes of top-level sections of a book (i.e. chapters) have a book icon, all other sections (sections, subsections, ...) have a folder icon.} \twocolitem{\windowstyle{wxHF\_DEFAULT\_STYLE}}{{\tt wxHF\_TOOLBAR | wxHF\_CONTENTS @@ -94,7 +91,13 @@ top-level directory. This ZIP archive must have .zip or .htb extension (the latter stands for "HTML book"). In other words, {\tt AddBook("help.zip")} is possible and, in fact, recommended way. -If {\it show\_wait\_msg} is TRUE then a decorationless window with progress message is displayed. +If {\it show\_wait\_msg} is TRUE then a decoration-less window with progress message is displayed. + +\wxheading{Note} + +Don't forget to install wxFileSystem ZIP handler with +{\tt wxFileSystem::AddHandler(new wxZipFSHandler);} before calling this method +on a .zip or .htb file! \membersection{wxHtmlHelpController::CreateHelpFrame}\label{wxhtmlhelpcontrollercreatehelpframe}