Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [cdt-dev] Help Books and Hover Help for CDT

Roman,
You are right it was hand-tailored for the MPI  APIs, and done by
a former member of our group who is no longer around.
I will be looking at this again in the near future when I do the support
for OpenMP (along the lines of what we did for MPI) so will keep your
comments in mind.

...Beth

Beth Tibbitts  (859) 243-4981  (TL 545-4981)
IBM T.J.Watson Research Center
Mailing Address:  IBM Corp., 455 Park Place, Lexington, KY 40511


|---------+---------------------------->
|         |           Roman Levenstein |
|         |           <romixlev@yahoo.c|
|         |           om>              |
|         |           Sent by:         |
|         |           cdt-dev-bounces@e|
|         |           clipse.org       |
|         |                            |
|         |                            |
|         |           01/08/2006 06:48 |
|         |           AM               |
|         |           Please respond to|
|         |           "CDT General     |
|         |           developers list."|
|---------+---------------------------->
  >-----------------------------------------------------------------------------------------------------------------|
  |                                                                                                                 |
  |       To:       "CDT General developers list." <cdt-dev@xxxxxxxxxxx>                                            |
  |       cc:                                                                                                       |
  |       Subject:  Re: [cdt-dev] Help Books and Hover Help for CDT                                                 |
  >-----------------------------------------------------------------------------------------------------------------|




Hi Beth,

Thanks a lot for this link! I was already thinking
along these lines, i.e. creating an XML file with
functions descriptions and then reading it into a hash
table that maps function names to the FunctionSummary
objects. And the PTP code you pointed to does exactly
what I had in mind.

This approach is nice, but requires creation of this
specifically formatted XML file with description of
APIs. And this format is very custom and not
well-known. More over, to keep the things synchronized
such a description file should be prepared statically
and should be changed every time, when the API or set
of functions was changed in the system. It would be
even more interesting, if it would be possible to get
the information directly from the help sub-systems
installed on the system, e.g. from man pages, Windows
HLP and CHM files, info pages, etc. I'll try to
elaborate a bit more about these issues in the
following mails on this subject.

Best Regards,
 Roman

--- Beth Tibbitts <tibbitts@xxxxxxxxxx> wrote:

> We did exactly that in the MPI development tools
> part of PTP (Parallel
> Tools Platform)  http://eclipse.org/ptp
> Feel free to install it (1.0 was released recently
> for that part) or check
> out the code from CVS and see the details.  It's in
> the packages under
> org.eclipse.ptp.mpi.*
>
> ...Beth
>
> Beth Tibbitts  (859) 243-4981  (TL 545-4981)
> High Productivity Tools
> IBM T.J.Watson Research Center
> Mailing Address:  IBM Corp., 455 Park Place,
> Lexington, KY 40511
>
>
> |---------+---------------------------->
> |         |           Roman Levenstein |
> |         |           <romixlev@yahoo.c|
> |         |           om>              |
> |         |           Sent by:         |
> |         |           cdt-dev-bounces@e|
> |         |           clipse.org       |
> |         |                            |
> |         |                            |
> |         |           01/03/2006 09:12 |
> |         |           AM               |
> |         |           Please respond to|
> |         |           "CDT General     |
> |         |           developers list."|
> |---------+---------------------------->
>
>
>---------------------------------------------------------------------------------------------------------------------------|

>   |
>
>                     |
>   |       To:       "CDT General developers list."
> <cdt-dev@xxxxxxxxxxx>
>                       |
>   |       cc:
>
>                     |
>   |       Subject:  [cdt-dev] Help Books and Hover
> Help for CDT
>                       |
>
>
>---------------------------------------------------------------------------------------------------------------------------|

>
>
>
>
> Hi,
>
> We are trying now to provide some documentation and
> online help for our CDT-based plugin as well as some
> context-sensitive and hover help during editing of
> the
> source code. For example, we would like to provide
> some help for specific APIs, etc.
>
> We managed to integrate our HTML help into Eclipse
> generic help system. And it is possible to access it
> via the Help menu.
>
> But we would like to provide also the hover help or
> more precisely, the kind of help that you usually
> get
> by selecting a certain word and pressing F1 in most
> IDEs. This should popup a help window for the given
> word (assuming that it is a function name, the
> function description should be displayed). In CDT,
> I've found a C/C++ Documentation settings in the
> project settings. Obviously, there is a possibility
> to
> add some so-called Help Books. But how? I could not
> find any description anywhere. What are these Help
> Books, which format do they use? Can they be used
> for
> the hover help on APIs at all? Or may be there are
> other ways to provide such a functionality? For
> example, I've found in Google some information about
> RedHat work on a hover-help plugin in 2001. But
> since
> that time there are no further information. Is this
> problem solved in the mean-time by RedHat or some
> others? It would be also interesting to know, how
> C/C++ Help Books relate to JavaDoc-based hover-help
> available in JDT. Actually, it would be very nice to
> have a generic mechanism for doing this kind of
> things.
>
> Another question is more about different Help file
> formats. Is there any "relatively easy" way to reuse
> WinHelp/RoboHelp docs with Eclipse? Where can I find
> information how to do it?
>
> Best Regards,
>  Roman
>
>
>
>
>
>
>
> __________________________________
> Yahoo! for Good - Make a difference this year.
> http://brand.yahoo.com/cybergivingweek2005/
> _______________________________________________
> cdt-dev mailing list
> cdt-dev@xxxxxxxxxxx
> https://dev.eclipse.org/mailman/listinfo/cdt-dev
>
>
> _______________________________________________
> cdt-dev mailing list
> cdt-dev@xxxxxxxxxxx
> https://dev.eclipse.org/mailman/listinfo/cdt-dev
>




__________________________________________
Yahoo! DSL – Something to write home about.
Just $16.99/mo. or less.
dsl.yahoo.com

_______________________________________________
cdt-dev mailing list
cdt-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/cdt-dev

Back to the top