X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0c874f87e542fbb4b0a9351791fdaa4d32b6f18d..d6c6a32321219a3a2961e7f1ee1a8d2d54dc5cdf:/docs/latex/wx/hthelpct.tex

diff --git a/docs/latex/wx/hthelpct.tex b/docs/latex/wx/hthelpct.tex
index 9560d7e72d..e7230bb8e2 100644
--- a/docs/latex/wx/hthelpct.tex
+++ b/docs/latex/wx/hthelpct.tex
@@ -81,17 +81,33 @@ all other sections (sections, subsections, ...) have a folder icon.}
 
 \membersection{wxHtmlHelpController::AddBook}\label{wxhtmlhelpcontrolleraddbook}
 
-\func{bool}{AddBook}{\param{const wxString\& }{book}, \param{bool }{show\_wait\_msg}}
+\func{bool}{AddBook}{\param{const wxFileName\& }{book\_file}, \param{bool }{show\_wait\_msg}}
+
+\func{bool}{AddBook}{\param{const wxString\& }{book\_url}, \param{bool }{show\_wait\_msg}}
 
 Adds book (\helpref{.hhp file}{helpformat} - HTML Help Workshop project file) into the list of loaded books.
 This must be called at least once before displaying  any help.
 
-{\it book} may be either .hhp file or ZIP archive that contains arbitrary number of .hhp files in 
+{\it book\_file} or {\it book\_url}  may be either .hhp file or ZIP archive
+that contains arbitrary number of .hhp files in 
 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.
+(the latter stands for "HTML book"). In other words,
+{\tt AddBook(wxFileName("help.zip"))}
+is possible and, in fact, recommended way.
+
+\wxheading{Parameters}
+
+\docparam{show\_wait\_msg}{If true then a decoration-less window with progress message is displayed.}
+\docparam{book\_file}{Help book filename. It is recommended to use this prototype
+instead of the one taking URL, because it is less error-prone.}
+\docparam{book\_url}{Help book URL (note that syntax of filename and URL is 
+different on most platforms)}
+
+\wxheading{Note}
 
-If {\it show\_wait\_msg} is TRUE then a decorationless window with progress message is displayed.
+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}
 
@@ -150,7 +166,7 @@ Displays help window and focuses index panel.
 \func{bool}{KeywordSearch}{\param{const wxString\& }{keyword}}
 
 Displays help window, focuses search panel and starts searching.
-Returns TRUE if the keyword was found.
+Returns true if the keyword was found.
 
 {\bf Important:} KeywordSearch searches only pages listed in .hhc file(s).
 You should list all pages in the contents file.