|Re: Providing contextual help in tooling [message #473742]
||Thu, 08 May 2008 13:17
| David Whiteman
Registered: July 2009
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.
>> ~ 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!
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
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 eclipse.platform.ua, since I just learned of that
group, and this really belongs there.]
Powered by FUDForum
. Page generated in 0.02528 seconds