fix warning

[wxWidgets.git] / docs / latex / wx / helpinst.tex

diff --git a/docs/latex/wx/helpinst.tex b/docs/latex/wx/helpinst.tex
index c88d21995e43bf675e876f78c9fb6eab97e33e3a..fc91ec9cacb43ff774a6b00b1a4189eb28ba70f9 100644 (file)
--- a/docs/latex/wx/helpinst.tex
+++ b/docs/latex/wx/helpinst.tex
@@ -20,7 +20,7 @@ appropriate class is aliased to the name wxHelpController for each platform, as
 \begin{itemize}\itemsep=0pt
 \item On Windows, wxWinHelpController is used.
 \item On all other platforms, wxHtmlHelpController is used if wxHTML is
-compiled into wxWindows; otherwise wxExtHelpController is used (for invoking an external
+compiled into wxWidgets; otherwise wxExtHelpController is used (for invoking an external
 browser).
 \end{itemize}
 
@@ -33,7 +33,7 @@ There are currently the following help controller classes defined:
 \item wxWinHelpController, for controlling Windows Help.
 \item wxCHMHelpController, for controlling MS HTML Help. To use this, you need to set wxUSE\_MS\_HTML\_HELP
 to 1 in setup.h and have htmlhelp.h header from Microsoft's HTML Help kit (you don't need
-VC++ specific htmlhelp.lib because wxWindows loads necessary DLL at runtime and so it
+VC++ specific htmlhelp.lib because wxWidgets loads necessary DLL at runtime and so it
 works with all compilers).
 \item wxBestHelpController, for controlling MS HTML Help or, if Microsoft's runtime is
 not available, \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}. You need to provide
@@ -43,8 +43,9 @@ The default browser is Netscape Navigator. The 'help' sample shows its use.
 \item \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}, a sophisticated help controller using \helpref{wxHTML}{wxhtml}, in
 a similar style to the Microsoft HTML Help viewer and using some of the same files.
 Although it has an API compatible with other help controllers, it has more advanced features, so it is
-recommended that you use the specific API for this class instead. Note that you
-must add this line to your application initialization: \verb$wxFileSystem::AddHandler(new wxZipFSHandler);$
+recommended that you use the specific API for this class instead. Note that if you
+use .zip or .htb formats for your books, you
+must add this line to your application initialization: {\tt wxFileSystem::AddHandler(new wxZipFSHandler);}
 or nothing will be shown in your help window.
 \end{itemize}
 
@@ -55,7 +56,7 @@ wxHelpControllerBase\\
 
 \wxheading{Include files}
 
-<wx/help.h> (wxWindows chooses the appropriate help controller class)\\
+<wx/help.h> (wxWidgets chooses the appropriate help controller class)\\
 <wx/helpbase.h> (wxHelpControllerBase class)\\
 <wx/helpwin.h> (Windows Help controller)\\
 <wx/msw/helpchm.h> (MS HTML Help controller)\\
@@ -124,7 +125,7 @@ contents.
 
 Displays the section as a popup window using a context id.
 
-Returns FALSE if unsuccessful or not implemented.
+Returns false if unsuccessful or not implemented.
 
 \membersection{wxHelpController::DisplaySection}\label{wxhelpcontrollerdisplaysection}
 
@@ -162,7 +163,7 @@ See also the help sample for notes on how to specify section numbers for various
 
 Displays the text in a popup window, if possible.
 
-Returns FALSE if unsuccessful or not implemented.
+Returns false if unsuccessful or not implemented.
 
 \membersection{wxHelpController::GetFrameParameters}\label{wxhelpcontrollergetframeparameters}
 
@@ -183,10 +184,13 @@ that the viewer is a variant of Netscape Navigator.}
 
 \membersection{wxHelpController::KeywordSearch}\label{wxhelpcontrollerkeywordsearch}
 
-\func{virtual bool}{KeywordSearch}{\param{const wxString\& }{keyWord}}
+\func{virtual bool}{KeywordSearch}{\param{const wxString\& }{keyWord}, \param{wxHelpSearchMode }{mode = wxHELP\_SEARCH\_ALL}}
 
-If the help viewer is not running, runs it, and searches for sections matching the given keyword. If one
-match is found, the file is displayed at this section.
+If the help viewer is not running, runs it, and searches for sections matching
+the given keyword. If one match is found, the file is displayed at this
+section. The optional parameter allows the search the index
+(wxHELP\_SEARCH\_INDEX) but this currently only supported by the
+wxHtmlHelpController.
 
 {\it WinHelp, MS HTML Help:} If more than one match is found, 
 the first topic is displayed.
@@ -221,7 +225,7 @@ This does not work for all help controllers.
 
 \func{virtual void}{SetFrameParameters}{\param{const wxString \& }{title},
  \param{const wxSize \& }{size}, \param{const wxPoint \& }{pos = wxDefaultPosition},
- \param{bool }{newFrameEachTime = FALSE}}
+ \param{bool }{newFrameEachTime = false}}
 
 For wxHtmlHelpController, the title is set (again with \%s indicating the
 page title) and also the size and position of the frame if the frame is already