Skip to main content

Eclipse Community Forums
Forum Search:

Search      Help    Register    Login    Home
Home » Eclipse Projects » Platform - User Assistance (UA) » Re: Providing contextual help in tooling
Re: Providing contextual help in tooling [message #614201] Thu, 08 May 2008 17:17
David Whiteman is currently offline David WhitemanFriend
Messages: 166
Registered: July 2009
Senior Member
David Whiteman wrote:
> Chris Aniszczyk wrote:
>> If you create a view using one of the PDE templates, there should be a
>> checkbox that says "create context help." With that, the template
>> should generate the proper context xml files for you along with the
>> html file. Furthermore, it will also add the hook where it informs the
>> Platform that you're providing context-sensitive (F1) help.
>> Let me know if this helps, if not, I can blog about this.
>> Cheers,
>> ~ Chris
> I've had the view for a long time and did not use the templates when I
> created it initially. However, I can certainly generate a dummy view
> just to see what is needed, and then copy that approach for my plugin.
> Thanks, Chris!
> David

OK, I have set this up. What I've observed is you can add help hooks to
any control, which takes you to a context that can link you to a topic
in the documentation.

What I'd like to do is have the help hook go straight to the
documentation. If the documentation describes the indicated control,
why should the user have to read something like "This is the panic
button." and click on a link to see the real documentation? Plus, this
introduces more maintenance if you have more to document in the
contexts.xml file.

It would be nice if I could define a <context> and then indicate that a
<topic> auto-loads. That would solve the problem I mentioned nicely.

[Cross posting to, since I just learned of that
group, and this really belongs there.]

Previous Topic:When does help preference "Use external browser" take effect?
Next Topic:In what Eclipse source plug-in/file is default "ButtonFace" color set?
Goto Forum:

Current Time: Tue Jun 19 07:09:38 GMT 2018

Powered by FUDForum. Page generated in 0.01328 seconds
.:: Contact :: Home ::.

Powered by: FUDforum 3.0.2.
Copyright ©2001-2010 FUDforum Bulletin Board Software

Back to the top