Re: [platform-help-dev] Converting multiple Windows help components to E

["Steve Woolley" <SWOOLLEY@xxxxxxxxxx>]

Esti,

In response to your second point, you're not entirely correct when you
state that "I understand that the Search only searches topics that appear
in the TOC".  Search is capable of searching all topics that are referenced
by the ToC, AND, any topics that happen to be contained within a specified
directory in each of your doc plugins.

For example, your doc plugin could look like this:

plugin.xml
toc.xml
doc.zip
myTopics
      topic1.html
      topic2.html
      topic3.html


The plug-in manifest for this doc plugin would look like this:

<?xml version="1.0" encoding="UTF-8"?>
<plugin
   id="com.xyz.myplugin.doc"
   name="%Plugin.name"
   version="1.0.0"
   provider-name="XYZ, Inc.>

   <extension
         point="org.eclipse.help.toc">
      <toc
            extradir="myTopics"
            file="toc.xml"
            primary="true">
      </toc>
   </extension>

</plugin>

Note the extradir attribute on the toc element.  This means that any
documents contained in the directory location (relative to the plugin root)
specified by extradir ("myTopics" in this example) will also get indexed by
search.  Search for "extradir" in the help system to learn more about the
org.eclipse.help.toc extension point.

The help says:

      extradir - specifies relative directory name of containing additional
      documents that are associated with the table of contents. All help
      documents in this directory, and all subdirectories, will be indexed,
      and accessible through the documentation search, even if topic
      elements in the TOC file do not refer to these documents.

Konrad and Dorian will be along later to provide a more educated response
to your first question!

Best wishes,


Steve
________________________________________________________________________________


Stephen Woolley - User Assistance Architect
WebSphere MQ Integrator User Technologies
Mail Point 095, IBM United Kingdom Laboratories, Hursley Park,
Winchester, Hampshire, SO21 2JN, United Kingdom
Steve Woolley/UK/IBM@IBMGB             swoolley@xxxxxxxxxx
Tel/Fax:  +44 (0)1962 818428                      Internal:  248428
Home Office:  (01962) 774812  /  +44 1962 774812



|---------+----------------------------------->
|         |           "Lederer, Esti"         |
|         |           <esti.lederer@xxxxxxxxx>|
|         |           Sent by:                |
|         |           platform-help-dev-admin@|
|         |           eclipse.org             |
|         |                                   |
|         |                                   |
|         |           12/05/2003 08:01        |
|         |           Please respond to       |
|         |           platform-help-dev       |
|         |                                   |
|---------+----------------------------------->
  >---------------------------------------------------------------------------------------------------------------------------------------------|
  |                                                                                                                                             |
  |       To:       platform-help-dev@xxxxxxxxxxx                                                                                               |
  |       cc:       "Wong, Carl" <carl.wong@xxxxxxxxx>                                                                                          |
  |       Subject:  [platform-help-dev] Converting multiple Windows help components to Eclipse                                                  |
  |                                                                                                                                             |
  |                                                                                                                                             |
  >---------------------------------------------------------------------------------------------------------------------------------------------|






Hi,

I'm not a help component developer, I'm a help component user, but I hope
this forum can answer my Q:



   I'm working on migrating a windows help system composed of ~30 chm files
   to Eclipse. I was wondering if there is a way to insert several .zip
   files into one upper-level help book. I.e. one doc.zip that is composed
   of lots of <help_component>.zip files. This would enable several help
   writers to work independently on different sections of the help.
   I understand that the Search only searches topics that appear in the
   TOC. Will a future version search all topics? (Isn't the whole idea of
   the Search feature to enable accessing all the topics?)
   http://dev.eclipse.org/viewcvs/index.cgi/~checkout~/platform-help-home/v2overview.html#search



Thanks,

Esti Lederer

Information developer

Intel Corporation