Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "COSMOS Design 220594"
(→Resources) |
(→Change History) |
||
| Line 12: | Line 12: | ||
|February 26, 2009 | |February 26, 2009 | ||
|<ul><li>Initial version</li></ul> | |<ul><li>Initial version</li></ul> | ||
| + | |- | ||
| + | |David Whiteman | ||
| + | |March 3, 2009 | ||
| + | |<ul><li>Purpose and design</li></ul> | ||
|} | |} | ||
Revision as of 13:14, 3 March 2009
Contents
Provide contextual help for toolkit UI
This is the design document for bugzilla 220594.
Change History
| Name: | Date: | Revised Sections: |
|---|---|---|
| David Whiteman | February 26, 2009 |
|
| David Whiteman | March 3, 2009 |
|
Workload Estimation
| Process | Sizing | Names of people doing the work |
|---|---|---|
| Design | 0.1 | David Whiteman |
| Code | 0.3 | David Whiteman |
| Test | 0.1 | David Whiteman |
| Documentation | 0 | |
| Build and infrastructure | 0.1 | Saurabh Dravid |
| Code review, etc.* | 0 | |
| TOTAL | 0.6 |
'* - includes other committer work (e.g. check-in, contribution tracking)
Purpose
The purpose of this enhancement is to provide contextual help for the UI fields in the MDR toolkit. The user, when encountering one of these fields, will be able to press F1 to display field-specific help, also with a link to the chapter in the Developer Guide with overall description of the usage of the MDR Toolkit. The implementation will leverage Eclipse functionality for help integration.[1]
Design
A new plug-in will need to be created: org.eclipse.cosmos.me.dmtoolkit.help. This plug-in will hold a contexts.xml file that contains a brief description for each field. It will also hold the necessary parts of the HTML from the Developer Guide so they can be linked from the field-specific help. The new plug-in will need to be added to the COSMOS SDK feature by the RE team, so that it will be included in the download.
The code for building the UI in org.eclipse.cosmos.me.dmtoolkit.common will need to be updated to hook in the help facility. There are currently only 2 COSMOS-contributed fields to the UI for the MDR toolkit. Any future fields added will also require updating the new help plug-in.