Bugzilla – Full Text Bug Listing
| Summary: | A cheatsheet for creating your first assignment | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Product: | z_Archived | Reporter: | Wayne Beaton <wayne.beaton> | ||||||
| Component: | IDE4EDU | Assignee: | Project Inbox <ide4edu-inbox> | ||||||
| Status: | RESOLVED FIXED | QA Contact: | |||||||
| Severity: | normal | ||||||||
| Priority: | P3 | CC: | cmatheson.can, maciej.kozlowski | ||||||
| Version: | unspecified | Keywords: | helpwanted | ||||||
| Target Milestone: | --- | ||||||||
| Hardware: | PC | ||||||||
| OS: | Linux | ||||||||
| Whiteboard: | |||||||||
| Attachments: |
|
||||||||
|
Description
Wayne Beaton
I will work on this for the 1st code sprint Created attachment 148203 [details]
New project/bundle to provide introductory cheatsheets.
Here's my patch for the bug.
However I found something interesting while testing the cheat sheet. When the 'new project wizard' or 'new class wizard' is open the main Eclipse application loses focus and the user can't click through the cheat sheet steps. With this patch I made the cheat sheet so that for each wizard all the steps are visible at once, this way the user doesn't need to click through the cheat sheet. The zip file contains my entire Eclipse project.
I tested the patch, and it does indeed add a new cheat sheet, which the user is able to follow. I'm unsure what Maciej means by making all steps visible at once, as the cheat sheet's instructions tell you to "click once done" (meaning the modal window is closed, and they can continue clicking the cheat sheet). I have a couple comments / concerns however: 1. The patch is a standalone eclipse project... will this need to be integrated into a different project / package? 2. I noticed a small spelling mistake in cheat sheet title. "Cheat sheet for creating a new Project and class" - I think it should probably be a lower case "p" instead. I notice this done elsewhere in the cheat sheet too. Deciding when to create a separate plug-in is a bit of an art form. By having separate plug-ins, you gain some flexibility to decide what bits of the functionality you want to actually deploy. On the other hand, management becomes more challenging. Also, putting functionality into separate plug-ins really forces you to think about the APIs that you expose which has potential to make the base plug-ins even more useful. I'd prefer to keep the cheatsheets separate from the rest of the code as much as is possible. Is this patch, in your opinion, something we should commit and use as a basis for further development? It doesn't need to be perfect so long as it's something that we can evolve. Yup, I think we can definitely work with this patch and make it fit our needs. My 1 last comment is, the eclipse project is named "Cheatsheet Plugin", so it may need to be refactored to something like org.eclipse.ide4edu.cheatsheetplugin or some such to fit the rest of the plugins? Again, not too 100% sure on how you want this organized. But it works as advertised, so its probably worth commiting. Given that the patch is <250 lines total (and seems to conform to the track started with figure #3 in the IP Due Diligence Process document [1]), I have committed it to CVS. Before doing so, however, I have renamed the bundle to org.eclipse.ide4edu.javalite.cheatsheets.introductory. I opted for a somewhat lengthy name as a I can envision the creation of additional bundles with alternative cheatsheets. I have further removed the unnecessary Activator and have changed the required runtime environment from Java 1.6 to Java 1.5. We should probably consider reducing this further to Java 1.4. I will update the Team Project Set and mark the attached patch as iplog+ so that it appears in the project's IP Log. [1] http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf Created attachment 155931 [details]
mylyn/context/zip
Team project set updated. Marking as FIXED. |