]> git.saurik.com Git - wxWidgets.git/commitdiff
documented need to install ZIP handler
authorVáclav Slavík <vslavik@fastmail.fm>
Fri, 6 Sep 2002 19:03:36 +0000 (19:03 +0000)
committerVáclav Slavík <vslavik@fastmail.fm>
Fri, 6 Sep 2002 19:03:36 +0000 (19:03 +0000)
(Julian's claim in previous commit was incorrect, mine is not)

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@17028 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

docs/latex/wx/hthelpct.tex

index 7ffcd083b78f93986829d4b0173c6eb51d480553..2e667c66daf6a6afd8bed3cdda64a0d0ae771fd7 100644 (file)
@@ -5,7 +5,7 @@
 
 \section{\class{wxHtmlHelpController}}\label{wxhtmlhelpcontroller}
 
-Although this class has an API compatible with other wxWindows
+{\bf WARNING!} Although this class has an API compatible with other wxWindows
 help controllers as documented by \helpref{wxHelpController}{wxhelpcontroller}, it
 is recommended that you use the enhanced capabilities of wxHtmlHelpController's API.
 
@@ -23,17 +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.
 
-When using wxHtmlHelpController, you must add an extra include at the top of your
-application class source file and a line to your application initialization:
-
-\begin{verbatim}
-    #include <wx/fs_zip.h>
-    ...
-    wxFileSystem::AddHandler(new wxZipFSHandler);
-\end{verbatim}
-
-or nothing will be shown in your help window.
-
 \wxheading{Note}
 
 It is strongly recommended to use preprocessed {\bf .hhp.cached} version of
@@ -104,6 +93,12 @@ recommended way.
 
 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}
 
 \func{virtual wxHtmlHelpFrame*}{CreateHelpFrame}{\param{wxHtmlHelpData * }{data}}