thr3ads.net - wxruby development - [Wxruby-development] [761] trunk/wxruby2: Initial commit of HtmlHelpController & HelpController support + doc, [Nov 2006]

If this information is useful, please help other people find it:
Share via:
nobody at rubyforge.org
2006-Nov-29 20:12 UTC
[Wxruby-development] [761] trunk/wxruby2: Initial commit of HtmlHelpController & HelpController support + doc,

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type"
content="text/html; charset=utf-8" /><style
type="text/css"><!--
#msg dl { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:'':'';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer { font-family:
verdana,arial,helvetica,sans-serif; font-size: 10pt;  }
#msg dl a { font-weight: bold}
#msg dl a:link    { color:#fc3; }
#msg dl a:active  { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt;
font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fc0 solid; padding:
6px; }
#msg ul, pre { overflow: auto; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid;
padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family:
verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff  {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch
.binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<title>[761] trunk/wxruby2: Initial commit of HtmlHelpController &
HelpController support + doc,</title>
</head>
<body>

<div id="msg">
<dl>
<dt>Revision</dt> <dd>761</dd>
<dt>Author</dt> <dd>brokentoy</dd>
<dt>Date</dt> <dd>2006-11-29 15:12:37 -0500 (Wed, 29 Nov
2006)</dd>
</dl>

<h3>Log Message</h3>
<pre>Initial commit of HtmlHelpController & HelpController support +
doc,
sample to follow</pre>

<h3>Modified Paths</h3>
<ul>
<li><a
href="#trunkwxruby2doctextilehelpcontrollertxtl">trunk/wxruby2/doc/textile/helpcontroller.txtl</a></li>
<li><a
href="#trunkwxruby2doctextilehtmlhelpcontrollertxtl">trunk/wxruby2/doc/textile/htmlhelpcontroller.txtl</a></li>
<li><a
href="#trunkwxruby2swigclassesAppi">trunk/wxruby2/swig/classes/App.i</a></li>
</ul>

<h3>Added Paths</h3>
<ul>
<li><a
href="#trunkwxruby2swigclassesHelpControlleri">trunk/wxruby2/swig/classes/HelpController.i</a></li>
<li><a
href="#trunkwxruby2swigclassesHtmlHelpControlleri">trunk/wxruby2/swig/classes/HtmlHelpController.i</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwxruby2doctextilehelpcontrollertxtl"></a>
<div class="modfile"><h4>Modified:
trunk/wxruby2/doc/textile/helpcontroller.txtl (760 => 761)</h4>
<pre class="diff"><span>
<span class="info">---
trunk/wxruby2/doc/textile/helpcontroller.txtl&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp2006-11-27
10:21:56 UTC (rev 760)
+++
trunk/wxruby2/doc/textile/helpcontroller.txtl&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp2006-11-29
20:12:37 UTC (rev 761)
</span><span class="lines">@@ -1,71 +1,52 @@
</span><span class="cx"> h1(#wxhelpcontroller).
Wx::HelpController
</span><span class="cx"> 
</span><del>-This is a family of classes by which
-applications may invoke a help viewer to provide on-line help.
</del><ins>+This is a family of classes by which applications invoke
a viewer to
+provide on-line help. A help controller allows an application to display
+help, at the index page or on a particular topic, and shut the help
+program down on termination.  This avoids proliferation of many
+instances of the help viewer whenever the user requests a different
+topics via the application''s menus or buttons.
</ins><span class="cx"> 
</span><del>-A help controller allows an application to display
help, at the contents
-or at a particular topic, and shut the help program down on termination.
-This avoids proliferation of many instances of the help viewer whenever the
-user requests a different topic via the application''s menus or
buttons.
</del><ins>+Typically, an application will create a help controller
instance when it
+starts, and immediately call *load_file* to load the help content from a
+file. The help viewer will only get run, however, just before the first
+call to display something.
</ins><span class="cx"> 
</span><del>-Typically, an application will create a help controller
instance
-when it starts, and immediately call *Initialize* to associate a filename with
it. The help viewer will only get run, however,
-just before the first call to display something.
</del><ins>+Using this class will invoke the most appropriate help
viewer on each
+different platform, using the native help controller where
+possible. This means:
</ins><span class="cx"> 
</span><del>-Most help controller classes actually derive from
HelpControllerBase and have
-names of the form XXXHelpController or HelpControllerXXX. An
-appropriate class is aliased to the name HelpController for each platform, as
follows:
</del><ins>+* On desktop Windows, Microsoft HTML Help is used
+* On all other platforms,
"HtmlHelpController":htmlhelpcontroller.html is used
</ins><span class="cx"> 
</span><ins>+These two classes are very similar in functionality and
+appearance. Unless you have a strong preference for using the native
+help viewer on Windows, it''s recommended that you use
+"HtmlHelpController":htmlhelpcontroller.html directly, rather than
using
+this class. This has the additional advantage that you only need to
+provide help files in one format (.htb) to cover all desktop platforms,
+instead of needing to provide a format (.chm) specially for windows. See
+"HtmlHelpController":htmlhelpcontroller.html for more details on the
+file formats used.
</ins><span class="cx"> 
</span><del>-* On desktop Windows, CHMHelpController is used (MS
HTML Help).
-* On Windows CE, WinceHelpController is used.
-* On all other platforms, HtmlHelpController is used if HTML is
-compiled into Widgets; otherwise ExtHelpController is used (for invoking an
external
-browser).
</del><ins>+WxWidgets also provides classes for viewing help on Win
CE, but WxRuby
+is not currently ported to this platform. 
</ins><span class="cx"> 
</span><span class="cx"> 
</span><del>-The remaining help controller classes need to be named
-explicitly by an application that wishes to make use of them.
-
-There are currently the following help controller classes defined:
-
-
-* WinHelpController, for controlling Windows Help.
-* CHMHelpController, for controlling MS HTML Help. To use this, you need to set
USE_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 Widgets loads necessary DLL at runtime and
so it
-works with all compilers).
-* BestHelpController, for controlling MS HTML Help or, if Microsoft''s
runtime is
-not available, "HtmlHelpController":htmlhelpcontroller.html. You need
to provide
-*both* CHM and HTB versions of the help file. For 32bit Windows only.
-* ExtHelpController, for controlling external browsers under Unix.
-The default browser is Netscape Navigator. The ''help'' sample
shows its use.
-* WinceHelpController, for controlling a simple @.htm@ help controller for
Windows CE applications.
-* "HtmlHelpController":htmlhelpcontroller.html, a sophisticated help
controller using "HTML":html.html, 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 if
you
-use .zip or .htb formats for your books, you
-must add this line to your application initialization:
@FileSystem::AddHandler(new ZipFSHandler);@
-or nothing will be shown in your help window.
-
-
</del><span class="cx"> h2. Derived from
</span><span class="cx"> 
</span><del>-HelpControllerBase
</del><ins>+ "Wx::Object":object.html
</ins><span class="cx"> 
</span><del>-"Object":object.html
-
</del><span class="cx"> h2. See also
</span><span class="cx"> 
</span><del>-"HtmlHelpController":htmlhelpcontroller.html,
"HTML":html.html
</del><ins>+"HtmlHelpController":htmlhelpcontroller.html
</ins><span class="cx"> 
</span><span class="cx"> <div
id="methods">
</span><span class="cx"> 
</span><span class="cx"> h2. Methods
</span><span class="cx"> 
</span><span class="cx"> *
"HelpController.new":#HelpController_new
</span><del>-*
"HelpController#initialize":#HelpController_initialize
</del><ins>+* "HelpController#init":#HelpController_init
</ins><span class="cx"> *
"HelpController#display_block":#HelpController_displayblock
</span><span class="cx"> *
"HelpController#display_contents":#HelpController_displaycontents
</span><span class="cx"> *
"HelpController#display_context_popup":#HelpController_displaycontextpopup
</span><span class="lines">@@ -88,20 +69,19 @@
</span><span class="cx"> 
</span><span class="cx"> Destroys the help instance,
closing down the viewer if it is running.
</span><span class="cx"> 
</span><del>-h3(#HelpController_initialize).
HelpController#initialize
</del><ins>+h3(#HelpController_init). HelpController#init
</ins><span class="cx"> 
</span><del>-  *initialize*(%(arg-type)String% file)
</del><ins>+  *init*(%(arg-type)String% file)
</ins><span class="cx"> 
</span><del>-  *initialize*(%(arg-type)String% file, 
%(arg-type)Integer% server)
</del><ins>+Initializes the help instance with a help filename. Does
not invoke the
+help viewer.  This must be called directly after the help instance
+object is created and before any attempts to communicate with the
+viewer.
</ins><span class="cx"> 
</span><del>-Initializes the help instance with a help filename, and
optionally a server socket
-number if using Help (now obsolete). Does not invoke the help viewer.
-This must be called directly after the help instance object is created and
before
-any attempts to communicate with the viewer.
-
</del><span class="cx"> You may omit the file extension
and a suitable one will be chosen. For
</span><del>-HtmlHelpController, the extensions zip, htb and hhp
will be appended while searching for
-a suitable file. For WinHelp, the hlp extension is appended.
</del><ins>+HtmlHelpController, the extensions zip, htb and hhp will
be appended
+while searching for a suitable file. For WinHelp, the hlp extension is
+appended.
</ins><span class="cx"> 
</span><span class="cx"> h3(#HelpController_displayblock).
HelpController#display_block
</span><span class="cx"> 
</span></span></pre></div>
<a id="trunkwxruby2doctextilehtmlhelpcontrollertxtl"></a>
<div class="modfile"><h4>Modified:
trunk/wxruby2/doc/textile/htmlhelpcontroller.txtl (760 => 761)</h4>
<pre class="diff"><span>
<span class="info">---
trunk/wxruby2/doc/textile/htmlhelpcontroller.txtl&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp2006-11-27
10:21:56 UTC (rev 760)
+++
trunk/wxruby2/doc/textile/htmlhelpcontroller.txtl&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp2006-11-29
20:12:37 UTC (rev 761)
</span><span class="lines">@@ -1,45 +1,205 @@
</span><span class="cx"> h1(#wxhtmlhelpcontroller).
Wx::HtmlHelpController
</span><span class="cx"> 
</span><del>-*WARNING!* Although this class has an API compatible
with other Widgets
-help controllers as documented by
"HelpController":helpcontroller.html, it
-is recommended that you use the enhanced capabilities of
HtmlHelpController''s API.
</del><ins>+This help controller provides an easy way of displaying
HTML help in
+your application. It provides a sophisticated system for showing help
+that includes a hierarchical contents listing, index, keyword search and
+bookmarking. 
</ins><span class="cx"> 
</span><del>-This help controller provides an easy way of displaying
HTML help in your
-application (see _test_ sample). The help system is based on *books* 
-(see "add_book":#HtmlHelpController_addbook). A book is a logical
-section of documentation (for example "User''s Guide" or
"Programmer''s Guide" or
-"C++ Reference" or "Widgets Reference"). The help
controller can handle as
-many books as you want.
</del><ins>+It is similar to the Microsoft Windows HTML Help Viewer,
but unlike that
+viewer it is available and uses the same help file format on all
+platforms. The native Windows help viewer is available in WxRuby by
+using the "Wx::HelpController":helpcontroller.html class, which will
+create an OS-native viewer on Windows and an HtmlHelpController on
+Linux/GTk and OS X. However, unless you have a strong preference for
+using the native control on Windows, you are recommended to use this
+class, as it means you can provide your help file(s) in a single format
+only.
</ins><span class="cx"> 
</span><del>-HTML uses Microsoft''s HTML Help Workshop
project files (.hhp, .hhk, .hhc) as its
-native format. The file format is described "here":helpformat.html.
-Have a look at docs/html/ directory where sample project files are stored.
</del><ins>+The help system is based on *books* (see). A book is a
logical section
+of documentation (for example "User''s Guide" or
"Programmer''s Guide" or
+"Ruby Reference" or "Class Reference"). The help controller
can handle
+as many books as you want.
</ins><span class="cx"> 
</span><del>-You can use Tex2RTF to produce these files when
generating HTML, if you set *htmlWorkshopFiles* to *true* in
-your tex2rtf.ini file.
</del><ins>+h2(#html_help_file_format). Html Help File Format
</ins><span class="cx"> 
</span><del>-h2. Note
</del><ins>+@Wx::HtmlHelpController@ library uses a reduced version
of Microsoft''s
+HTML Workshop format. This consists of standard HTML 4.0 files, plus a
+set of three files (.hhp, .hhc, .hhk) that are a project header file, a
+help contents file and a help index file, respectively. These are all
+simple text files that are easily authored or generated using any of a
+wide variety of tools.
</ins><span class="cx"> 
</span><del>-It is strongly recommended to use preprocessed
*.hhp.cached* version of
-projects. It can be either created on-the-fly (see 
-"set_temp_dir":#HtmlHelpController_settempdir) or you can use 
-*hhp2cached* utility from _utils/hhp2cached_ to create it and
-distribute the cached version together with helpfiles. See _samples/html/help_ 
-sample for demonstration of its use.
</del><ins>+A HtmlHelpController can use an .hhp header file
directly as an argument
+to "add_book":#HtmlHelpController_addbook to open documentation. 
</ins><span class="cx"> 
</span><del>-h2. See also
</del><ins>+You can make a regular zip archive of these files, plus
the HTML and any
+image files, for wxHTML (or helpview) to read; and the .zip file can
+optionally be renamed to .htb.
</ins><span class="cx"> 
</span><del>-"Information about
BestHelpController":helpcontroller.html
</del><ins>+h3(#hhp_header_file). Header file (.hhp)
</ins><span class="cx"> 
</span><del>-h2. Derived from
</del><ins>+Header file must contain these lines (and may contain
additional lines which are ignored) :
</ins><span class="cx"> 
</span><del>-HelpControllerBase
</del><ins>+ Contents file=[filename.hhc]
+ Index file=[filename.hhk]
+ Title=[title of your book]
+ Default topic=[default page to be displayed.htm]
</ins><span class="cx"> 
</span><ins>+All filenames (including the Default topic) are
relative to the location
+of .hhp file.
+
+_Localization note_ In addition, .hhp file may contain the line
+
+ Charset=<rfc_charset>
+
+which specifies what charset (e.g. "iso8859_1") was used in contents
and
+index files. Please note that this line is incompatible with MS HTML
+Help Workshop and it would either silently remove it or complain with
+some error.
+
+h3(#hhc_contents_file). Contents file (.hhc)
+
+The contents file lists the hierarchical structure of the help
+documentation. The contents file has HTML syntax and it can be parsed by
+regular HTML parser. It contains exactly one list
+(&lt;ul&gt;....&lt;/ul&gt; statement), with &lt;li&gt;
elements
+containing an &lt;object&gt; of type @text/sitemap@ for each node of
the
+contents:
+
+<pre>
+ <ul>
+  <li>
+&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp<object
type="text/sitemap">
+      <param name="Name" value="@topic name@">
+      <param name="ID" value=@numeric_id@>
+      <param name="Local" value="@filename.htm@">
+    </object>
+  <li>
+    <object type="text/sitemap">
+      <param name="Name" value="@topic name@">
+      <param name="ID" value=@numeric_id@>
+      <param name="Local" value="@filename.htm@">
+    </object>
+  ...    
+ </ul>
+</pre>
+
+You can modify the value attributes of param tags. @topic name@ is name
+of chapter/topic as is displayed in the contents listing, @filename.htm@
+is the HTML page name (relative to .hhp file) and @numeric_id@ is
+optional - it is used only when you use the HtmlHelpController#display()
+method to show a specific part of the help documentation.
+
+Items in the list may be nested to produce a hierarchical tree-like
+organisation of content topics. To do this, one &lt;li&gt; statement
may
+contain one or more &lt;ul&gt; sub-statements in the .hhc file:
+
+<pre>
+ <ul>
+   <li> 
+     <object type="text/sitemap">
+       <param name="Name" value="Top node">
+       <param name="Local" value="top.htm">
+     </object>
+     <ul>
+       <li>
+&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp    
<object type="text/sitemap">
+           <param name="Name" value="subnode in
topnode">
+           <param name="Local" value="subnode1.htm">
+         </object>
+      ...
+    </ul>
+  <li> 
+    <object type="text/sitemap">
+      <param name="Name" value="Another Top">
+      <param name="Local" value="top2.htm">
+    </object>
+  ...    
+ </ul>
+</pre>
+
+h3(#hhk_index_file). Index file (.hhk)
+
+The index file is a listing of keywords, associated with locations that
+describe those keywords. Index files have same format as contents file
+except that ID params are ignored and sublists are not allowed.
+
+h3(#html_content_files). Html Content Files
+
+HtmlHelpController uses "HtmlWindow":htmlwindow.html to display the
HTML
+content pages of the help documentation. Therefore, it understand the
+large subset of HTML 4.0 that is understood by that widget.
+
+One "feature" to note is that it does *not* support anchors specified
+using the modern @id@ attribute used on any HTML element. Only
+old-fashioned named anchors (using the @name@ attribute on an @a@ tag)
+are recognised.
+
+h3(#htb_bundle_files). Bundling help files (.htb)
+
+Distributing help using the file format described above means
+distributing a reasonably number of files (at least the header file,
+contents page and the actual documentation), and maintaining the
+directory organisation. It can be more convenient to bundle all the
+content and index files together into a single file.
+
+A help file bundle can be created by zipping up the .hhp, .hhc, .hhk
+plus the HTML content files and any images into a single standard .zip
+archive. WxRuby can then load help from this single archive file instead of
+from an .hhp file. If you prefer, the .zip file can be renamed .htb
+(''HTml help Book'') to indicate that it contains help
documentation.
+
+The .chm (Compiled Help) format that is generated by Microsoft''s Help
+Workshop is a similar concept.  However, this file format is *not*
+compatible with WxRuby''s Wx::HtmlHelpController. These .chm files can
be
+read by the native Microsoft Help Viewer, which is accessible in WxRuby
+by using the "HelpController":helpcontroller.html class, on Windows
+only.
+
+h3(#creating_html_help_files). Generating HTML Help files
+
+There are several tools that can be used to automate the creation of
+.hhp, .hhc, .hhk and .html files for use with the help viewer.
+
+You can use Tex2RTF, a utility included with the wxWidgets distribution
+to produce these files when generating HTML from Latex. To do so, set
+*htmlWorkshopFiles* to *true* in your tex2rtf.ini file.
+
+The files can also be generated from Docbook XML documentation, by using
+the *htmlhelp.xsl* stylesheet.
+
+If you prefer to use a GUI, Microsoft offers a free HTML Help Workshop
+for authoring Help documentation.
+
+Although we do not know of any tool to automatically create the contents
+and index files from Ruby''s RDoc system, it should be relatively
+straightforward to adapt RDoc''s output for use with
HtmlHelpController.
+
+h3(#note_on_caching). Note on caching
+
+The WxWidgets documentation recommends the use of preprocessed
+*.hhp.cached* version of projects. These can be either created
+on-the-fly (see "set_temp_dir":#HtmlHelpController_settempdir) or you
+can use *hhp2cached* utility from _utils/hhp2cached_ directory in the
+WxWidgets distribution to create it and distribute the cached version
+together with helpfiles.
+
+h2(#see_also). See also
+
+"Wx::HelpController":helpcontroller.html
+
+h2(#superclasses). Inherits from
+
+ "Wx::Object":object.html
+
</ins><span class="cx"> <div id="methods">
</span><span class="cx"> 
</span><del>-h2. Methods
</del><ins>+h2. Class Methods
</ins><span class="cx"> 
</span><span class="cx"> *
"HtmlHelpController.new":#HtmlHelpController_new
</span><ins>+
+h2. Instance Methods
+
</ins><span class="cx"> *
"HtmlHelpController#add_book":#HtmlHelpController_addbook
</span><span class="cx"> *
"HtmlHelpController#create_help_frame":#HtmlHelpController_createhelpframe
</span><span class="cx"> *
"HtmlHelpController#display":#HtmlHelpController_display
</span><span class="lines">@@ -54,8 +214,9 @@
</span><span class="cx"> 
</span><span class="cx"> </div>
</span><span class="cx"> 
</span><ins>+h2(#class_methods). Class Methods
</ins><span class="cx"> 
</span><del>-h3(#HtmlHelpController_wxhtmlhelpcontroller).
HtmlHelpController.new
</del><ins>+h3(#HtmlHelpController_new). HtmlHelpController.new
</ins><span class="cx"> 
</span><span class="cx">  
*HtmlHelpController.new*(%(arg-type)Integer% style = HF_DEFAULT_STYLE)
</span><span class="cx"> 
</span><span class="lines">@@ -78,39 +239,29 @@
</span><span class="cx"> |@HF_ICONS_BOOK@|All nodes in
contents panehave a book icon. This is how Microsoft''s HTML help viewer
behaves.|
</span><span class="cx"> |@HF_ICONS_FOLDER@|Book nodes in
contents pane havea book icon, book''s sections have a folder icon. This
is the default.|
</span><span class="cx"> |@HF_ICONS_BOOK_CHAPTER@|Both
book nodes andnodes of top-level sections of a book (i.e. chapters) have a book
icon,all other sections (sections, subsections, ...) have a folder icon.|
</span><del>-|@HF_DEFAULT_STYLE@|@HF_TOOLBAR | HF_CONTENTS| HF_INDEX
| HF_SEARCH | HF_BOOKMARKS | HF_PRINT@|
</del><ins>+|@HF_DEFAULT_STYLE@|@HF_TOOLBAR@&#124;@HF_CONTENTS@&#124;@HF_INDEX@&#124;@HF_SEARCH@&#124;@HF_BOOKMARKS@&#124;@HF_PRINT@|
</ins><span class="cx"> 
</span><span class="cx"> 
</span><ins>+h2(#instance_methods). Instance Methods
+
</ins><span class="cx"> h3(#HtmlHelpController_addbook).
HtmlHelpController#add_book
</span><span class="cx"> 
</span><del>- Boolean *add_book*(%(arg-type)FileName% book_file, 
%(arg-type)Boolean% show_wait_msg)
</del><ins>+ Boolean *add_book*(%(arg-type)String% book_file, 
%(arg-type)Boolean% show_wait_msg)
</ins><span class="cx"> 
</span><del>- Boolean *add_book*(%(arg-type)String% book_url, 
%(arg-type)Boolean% show_wait_msg)
</del><ins>+Adds book into the list of loaded books. This must be
called at least
+once before displaying any help. 
</ins><span class="cx"> 
</span><del>-Adds book (".hhp file":helpformat.html - HTML
Help Workshop project file) into the list of loaded books.
-This must be called at least once before displaying  any help.
</del><ins>+_book_file_ may be either .hhp file or ZIP archive that
contains
+arbitrary number of .hhp files in top-level directory. This ZIP archive
+must have the .zip or .htb extension (the latter stands for "HTML
+book"). See above for more information about the format of the help
+files. 
</ins><span class="cx"> 
</span><del>-_book_file_ or _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,
-@AddBook(FileName("help.zip"))@
-is possible and, in fact, recommended way.
-
</del><span class="cx"> h4. Parameters
</span><span class="cx"> 
</span><del>-* _show_wait_msg_ If true then a decoration-less window
with progress message is displayed.
-* _book_file_ Help book filename. It is recommended to use this prototype
-instead of the one taking URL, because it is less error-prone.
-* _book_url_ Help book URL (note that syntax of filename and URL is 
-different on most platforms)
</del><ins>+* _book_file_ Help book filename; this should be a
fully-qualified path to the helpfile; @File.expand_path@ may be useful here.
+* _show_wait_msg_ If true then a decoration-less window with progress message
is displayed while the help file is loaded.
</ins><span class="cx"> 
</span><del>-h4. Note
-
-Don''t forget to install FileSystem ZIP handler with
-@FileSystem::AddHandler(new ZipFSHandler);@ before calling this method
-on a .zip or .htb file!
-
</del><span class="cx">
h3(#HtmlHelpController_createhelpframe). HtmlHelpController#create_help_frame
</span><span class="cx"> 
</span><span class="cx"> 
"HtmlHelpFrame":htmlhelpframe.html
*create_help_frame*(%(arg-type)HtmlHelpData% data)
</span><span class="lines">@@ -149,8 +300,6 @@
</span><span class="cx"> 
</span><span class="cx"> This alternative form is used to
search help contents by numeric IDs.
</span><span class="cx"> 
</span><del>-
-
</del><span class="cx">
h3(#HtmlHelpController_displaycontents). HtmlHelpController#display_contents
</span><span class="cx"> 
</span><span class="cx">   *display_contents*()
</span><span class="lines">@@ -185,21 +334,23 @@
</span><span class="cx"> 
</span><span class="cx">  
*set_temp_dir*(%(arg-type)String% path)
</span><span class="cx"> 
</span><del>-Sets the path for storing temporary files - cached
binary versions of index and contents files. These binary
-forms are much faster to read. Default value is empty string (empty string
means
-that no cached data are stored). Note that these files are _not_ 
-deleted when program exits.
</del><ins>+Sets the path for storing temporary files - cached
binary versions of
+index and contents files. These binary forms are much faster to
+read. Default value is empty string (empty string means that no cached
+data are stored). Note that these files are _not_ deleted when program
+exits.
</ins><span class="cx"> 
</span><del>-Once created these cached files will be used in all
subsequent executions
-of your application. If cached files become older than corresponding .hhp
-file (e.g. if you regenerate documentation) it will be refreshed.
</del><ins>+Once created these cached files will be used in all
subsequent
+executions of your application. If cached files become older than
+corresponding .hhp file (e.g. if you regenerate documentation) it will
+be refreshed.
</ins><span class="cx"> 
</span><span class="cx">
h3(#HtmlHelpController_settitleformat). HtmlHelpController#set_title_format
</span><span class="cx"> 
</span><span class="cx">  
*set_title_format*(%(arg-type)String% format)
</span><span class="cx"> 
</span><del>-Sets format of title of the frame. Must contain exactly
one "\%s"
-(for title of displayed HTML page).
</del><ins>+Sets format of title of the frame. Must contain exactly
one "\%s" (for
+title of displayed HTML page).
</ins><span class="cx"> 
</span><span class="cx">
h3(#HtmlHelpController_useconfig). HtmlHelpController#use_config
</span><span class="cx"> 
</span></span></pre></div>
<a id="trunkwxruby2swigclassesAppi"></a>
<div class="modfile"><h4>Modified:
trunk/wxruby2/swig/classes/App.i (760 => 761)</h4>
<pre class="diff"><span>
<span class="info">---
trunk/wxruby2/swig/classes/App.i&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp2006-11-27
10:21:56 UTC (rev 760)
+++
trunk/wxruby2/swig/classes/App.i&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp2006-11-29
20:12:37 UTC (rev 761)
</span><span class="lines">@@ -7,6 +7,8 @@
</span><span class="cx"> 
</span><span class="cx"> %{
</span><span class="cx"> #include <wx/init.h>
</span><ins>+#include <wx/filesys.h>
+#include <wx/fs_zip.h>
</ins><span class="cx"> %}
</span><span class="cx"> 
</span><span class="cx"> %ignore GetAuto3D;
</span><span class="lines">@@ -101,6 +103,7 @@
</span><span class="cx">         {
</span><span class="cx">            
Init_wxRubyEventTypes();
</span><span class="cx">            
Init_wxRubyStockObjects();
</span><ins>+&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspwxFileSystem::AddHandler(new
wxZipFSHandler);
</ins><span class="cx">         }
</span><span class="cx">         return result;
</span><span class="cx">     }
</span></span></pre></div>
<a id="trunkwxruby2swigclassesHelpControlleri"></a>
<div class="addfile"><h4>Added:
trunk/wxruby2/swig/classes/HelpController.i (0 => 761)</h4>
<pre class="diff"><span>
<span class="info">---
trunk/wxruby2/swig/classes/HelpController.i&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp
(rev 0)
+++
trunk/wxruby2/swig/classes/HelpController.i&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp2006-11-29
20:12:37 UTC (rev 761)
</span><span class="lines">@@ -0,0 +1,16 @@
</span><ins>+#   Copyright 2004-2006 by Kevin Smith
+#   released under the MIT-style wxruby2 license
+
+%include "../common.i"
+
+%module(directors="1") wxHelpController
+
+%{
+#include <wx/help.h>
+%}
+
+%rename(Init) wxHelpController::Initialize;
+
+%import "include/wxObject.h"
+
+%include "include/wxHelpController.h"
</ins></span></pre></div>
<a id="trunkwxruby2swigclassesHtmlHelpControlleri"></a>
<div class="addfile"><h4>Added:
trunk/wxruby2/swig/classes/HtmlHelpController.i (0 => 761)</h4>
<pre class="diff"><span>
<span class="info">---
trunk/wxruby2/swig/classes/HtmlHelpController.i&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp
(rev 0)
+++
trunk/wxruby2/swig/classes/HtmlHelpController.i&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp2006-11-29
20:12:37 UTC (rev 761)
</span><span class="lines">@@ -0,0 +1,16 @@
</span><ins>+#   Copyright 2004-2006 by Kevin Smith
+#   released under the MIT-style wxruby2 license
+
+%include "../common.i"
+
+%module(directors="1") wxHtmlHelpController
+
+%{
+#include <wx/html/helpctrl.h>
+%}
+
+%ignore wxHtmlHelpController::CreateHelpFrame;
+
+%import "include/wxObject.h"
+
+%include "include/wxHtmlHelpController.h"
</ins></span></pre>
</div>
</div>

</body>
</html>
Apparently Analagous Threads

Search for more reasonably related threads
wxruby development - Nov 2006 - [761] trunk/wxruby2: Initial commit of HtmlHelpController & HelpController support + doc,

[Wxruby-development] [761] trunk/wxruby2: Initial commit of HtmlHelpController & HelpController support + doc,

Apparently Analagous Threads

Wisdom of the Ancients
