context-sensitive help procedures for RCP apps [message #592772] |
Thu, 01 November 2007 16:27 |
Robert Lauriston Messages: 31 Registered: July 2009 |
Member |
|
|
[Posted on the Yahoo eclipse_tw group but no response there.]
I'm trying to figure out how we should standardize context-sensitive
help for our RCP apps. How are people handling this?
As usual the docs are a bit sketchy. Seems like there are three basic
approaches:
1. Developers manually edit contexts.xml. This won't work for us as we
need to be free to rearrange and rename topics as necessary, so
documentation needs to own the URLs. Also, we're using MIF2Go, which
generates contexts.xml from markers in the FrameMaker source, so we need
to own that file as well.
2. Documentation maintains contexts.xml and provides it to the
developers. That would be problematic as developers should really be
free to assign context IDs when coding.
3. Developers provide a list of context IDs and associated UI elements.
That seems like the best idea (and it's what we're used to for C++
Windows apps), since the developers would own the context IDs and docs
would own the URLs, but if there's a standard format for this list I
can't find it.
Minor question: what's a "fully qualified context ID" look like? I can't
find any examples, though it seems like for RCP apps like ours it's not
an issue.
|
|
|
Powered by
FUDForum. Page generated in 0.03760 seconds