Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
[platform-help-dev] Re: Launching the help browser from code


Hi Mark,

I first tried to find a topic in the Plug-In Developers Guide for your precise situation, but did not immediately see it. It sounds like what you want is a combination of context-sensitive help (help launched from a UI widget) and launching the standalone help to a topic in the main help system window. (Vs. launching the contexts help topic file).

So the guidance for you might be in applying a combination of this information:
Declaring a context ID:
http://dev.eclipse.org/viewcvs/index.cgi/~checkout~/org.eclipse.platform.doc.isv/reference/misc/help_standalone.html?rev=1.26.2.2

Launching the standalone help to a topic:
http://dev.eclipse.org/viewcvs/index.cgi/~checkout~/org.eclipse.platform.doc.isv/reference/misc/help_standalone.html?rev=1.26.2.2
and its section "How to call the help classes from Java" which says:
To invoke help when needed:
helpSystem.displayHelp();

You can also call help on specific primary TOC files or topics:

helpSystem.displayHelp("/com.mycompany.mytool.doc/toc.xml");
helpSystem.displayHelp("/com.mycompany.mytool.doc/tasks/task1.htm");



I am aware of Java Swing products that have used the information at http://dev.eclipse.org/viewcvs/index.cgi/~checkout~/org.eclipse.platform.doc.isv/reference/misc/help_standalone.html?rev=1.26.2.2
to accomplish launching the standalone help system to a specific topic. I am less familiar with doing that for an Eclipse-based GUI, but would say the capability must be there as it is the same help system methods underneath.

Hope that helps!
--Lee Anne
-----------------------------------------
Lee Anne Kowalski
IBM Corporate ID Leadership Team - User Assistance Technology Lead
Internet: kowalski at us dot ibm dot com

"Think big, start small, and be pragmatic."

----- Forwarded by Lee Anne Kowalski/Silicon Valley/IBM on 10/13/2005 09:41 AM -----

Mark Drew <mark.drew@xxxxxxxxx>
Sent by: platform-help-dev-bounces@xxxxxxxxxxx

10/13/2005 09:20 AM

Please respond to
"Eclipse Platform Help component developers list."

To
platform-help-dev@xxxxxxxxxxx
cc
Subject
[platform-help-dev] Launching the help browser from code





I have been trying to make a plugin that would launch the help browser straight to a specific book from a button. I cant seem to find any code examples for this apart from Program.launch("http://localhost:8081/help"); which isnt quite right.

Any pointers with this would be very welcome!

Many Thanks

--
Mark Drew

http://cybersonic.blogspot.com _______________________________________________
platform-help-dev mailing list
platform-help-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/platform-help-dev

Back to the top