Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 106196

Summary: [CheatSheet] [plan item] Improve cheat sheet support
Product: [Eclipse Project] Platform Reporter: Mike Wilson <Mike_Wilson>
Component: User AssistanceAssignee: platform-ua-inbox <platform-ua-inbox>
Status: RESOLVED FIXED QA Contact:
Severity: enhancement    
Priority: P4 CC: aiproulx, aweirig, eclipse, gunnar, jhayes, jmockler, khalsted, kpeter, mkomor
Version: 3.1Keywords: plan
Target Milestone: 3.2 M6   
Hardware: All   
OS: All   
Whiteboard:

Description Mike Wilson CLA 2005-08-05 12:29:01 EDT
The Eclipse cheat sheet infrastructure was implemented 3.0, but is still not widely used. For cheat sheets 
to be become more widely adopted, the base support should be enhanced in several ways, including: 
allowing cheat sheets to be authored by non-developers (i.e. creating steps and registering a cheat sheet 
with no programming); defining and using new automation APIs to allow UI parts like dialogs and wizards 
to be opened and filled in; and reworking the implementation to support a single content delivery 
mechanism. [Help, UI]
Comment 1 Eswar Vandanapu CLA 2005-08-31 01:58:21 EDT
Is it possible to have a design where, a CheatSheatProvider can be registered 
as a plug-in, which will return a list of cheat sheats from a file or web 
server, and also provides the actual cheat sheats downloaded from the web 
rather then local machine.  This allows people to author and publish cheat 
sheats to a central server and all developers in an organization can view the 
new cheat sheats right away.

Of course this will only work when the cheatsheats use existing action classes 
only, or when the cheat sheats only meant to be used as team notes/team 
communication mechanism.
Comment 2 Alex Weirig CLA 2005-10-28 17:42:54 EDT
I have been working on cheatsheets the last couple of days for Eclipse 3.0.x
(i.e. the IBM Rational Application Developer).
Here are some features I would like to see:
* more formatting options, the text shown could/should be HTML (using bulletted
lists, colored text, etc)
* being able to put subitems in between 2 description blocks
* on a repetitive item being able to define 2 or more subitems

I'm also having some problems with the Workbench integration. From a cheatsheet
action, I would like to run the Subclipse commit action. Unfortunately this
fails because the Subclipse action can't find the selected projects in the
navigator since the navigator has lost the focus (that's my best guess at this
point of time). It would be nice if the cheatsheet could implement listeners to
Workbench events?
Comment 3 Alex Weirig CLA 2005-10-28 17:45:26 EDT
I have been working on cheatsheets the last couple of days for Eclipse 3.0.x
(i.e. the IBM Rational Application Developer).
Here are some features I would like to see:
* more formatting options, the text shown could/should be HTML (using bulletted
lists, colored text, etc)
* being able to put subitems in between 2 description blocks
* on a repetitive item being able to define 2 or more subitems

I'm also having some problems with the Workbench integration. From a cheatsheet
action, I would like to run the Subclipse commit action. Unfortunately this
fails because the Subclipse action can't find the selected projects in the
navigator since the navigator has lost the focus (that's my best guess at this
point of time). It would be nice if the cheatsheet could implement listeners to
Workbench events?
Comment 4 Mike Wilson CLA 2006-02-14 15:12:55 EST
The text of this item in the plan has changed. The new text is:
"
The Eclipse cheat sheet infrastructure was implemented 3.0, but is still not widely used. For cheat sheets to be become more widely adopted, the base support should be enhanced in several ways, including: adding support for invoking commands without the need for Java programming; make cheat sheets more scalable; providing for nonlinear dependancy between steps and enhancing the implementation to support working with modal dialogs. [UA, UI]
"
Comment 5 Curtis d'Entremont CLA 2006-03-31 10:19:48 EST
This plan item has been completed.