Re: [platform-help-dev] accessing plug-in actions via help

[birsan@xxxxxxxxxx]

Everything is subject to changes, but if you want to live dangerously here
is some short info to get you started:

For active help (launch action from help page):

1.  in your help document include the following in the html header (you may
need to use the correct number of "../" to navigate to the right plugin) :
        <script language="Javascript" src
="../org.eclipse.help.webapp/livehelp.js"></script>

2.  in your java code (you must have a plugin with some code) you need to
implement the org.eclipse.help.LiveHelpExtension interface.  That's really
implementing two methods: run() and setInitializationData(). The run()
method will be called when you trigger the action from help (see next
step). Let's say this class is com.mycompany.MyHelpAction

3.   in an anchor's href or in some onclick event, call
          liveAction("com.mycompany", "com.mycompany.MyHelpAction",
"some_argument")
  where "some_argument" is whatever string data you need to pass to your
help action to do something useful.


For launching a webapp:
- check the code in org.eclipse.help.ui.internal.WorkbenchHelpPlugin (the
constructor, startup() and shutdown() methods)
- may also want to take a look at the interface org.eclipse.help.IAppServer
and associated doc org.eclipse.help/doc/org_eclipse_help_app-server.html

We'd appreciate any feedback from your experience trying the above, and
keep in mind that launching a web app is not in plan for 2.0 so nothing is
guranteed there, whereas active help is in plan, will be supported, but it
may change a bit before it becomes final.

-Dorian




                                                                                                                              
                    "Dave Carlson"                                                                                            
                    <dcarlson@xxxxxxxxxxxxxx>       To:     <platform-help-dev@xxxxxxxxxxx>                                   
                    Sent by:                        cc:                                                                       
                    platform-help-dev-admin@e       Subject:     [platform-help-dev] accessing plug-in actions via help       
                    clipse.org                                                                                                
                                                                                                                              
                                                                                                                              
                    02/26/2002 03:50 PM                                                                                       
                    Please respond to                                                                                         
                    platform-help-dev                                                                                         
                                                                                                                              
                                                                                                                              



Hi,
I realize that this is still pre-pre-release, but I'd like to experiment
with
invoking a plug-in action from a webapp JSP or servlet.  I understand that
this is in the plans for 2.0, but can't find the necessary hooks in the
current code.

I've browsed the source for the servlets in org.eclipse.help.webapp, and
also
the source for the tomcat wrapper.  This is in the 20020214 stable release.
Is it possible to add an action url within a help page?

Also, can anyone provide a quick hint about creating my own webapp plug-in
for
the current tomcat plugin, similar to org.eclipse.help.webapp?  How would I
assure that both this plugin and tomcat are started?

Thanks,
  Dave Carlson

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