Bug 288853 - A cheatsheet for writing Java code using JavaLite Perspective
Summary: A cheatsheet for writing Java code using JavaLite Perspective
Status: RESOLVED FIXED
Alias: None
Product: z_Archived
Classification: Eclipse Foundation
Component: IDE4EDU (show other bugs)
Version: unspecified   Edit
Hardware: PC Linux
: P3 normal (vote)
Target Milestone: ---   Edit
Assignee: Project Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords: helpwanted
Depends on:
Blocks:
 
Reported: 2009-09-08 14:33 EDT by Wayne Beaton CLA
Modified: 2014-01-09 15:38 EST (History)
2 users (show)

See Also:


Attachments
Building your first Java Project Cheatsheet (only portions of attachment have been used) (6.58 KB, application/x-zip)
2009-09-17 22:49 EDT, Peter Lorimer CLA
wayne.beaton: iplog+
Details
mylyn/context/zip (2.76 KB, application/octet-stream)
2010-02-03 11:49 EST, Wayne Beaton CLA
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description Wayne Beaton CLA 2009-09-08 14:33:25 EDT
This is similar to bug 288852, but IMHO, different. There likely exists something along these lines already for the Java perspective. The cheatsheet could, for example, take the student through the creation of a for-loop using templates (i.e. type "for<ctrl-space>" etc.)
Comment 1 Peter Lorimer CLA 2009-09-14 11:19:02 EDT
I would like to work on this bug for the 1st of the code sprint from Sept 14 until Sept 30.
Peter
Comment 2 Wayne Beaton CLA 2009-09-14 12:12:52 EDT
You might find some value here:

http://www.oracle.com/technology/pub/articles/dev2arch/2006/08/eclipse-cheat-sheets.html
Comment 3 Peter Lorimer CLA 2009-09-14 16:55:26 EDT
Thanks Wayne!

That was helpful. I was thinking of ideas for this, I was thinking that the feature should have more than just how to write a for-loop. Maybe a few programming basics such as a for-loop, a while-loop, an if-else statement. Or is just showing a cheat sheet for just the for-loop enough?
Comment 4 Wayne Beaton CLA 2009-09-14 17:31:59 EDT
I'd start with just the very basics. How do you build that first Java class using the JavaLite perspective? Simple main() method with "Hello World" should do.

The results of this bug should hopefully provide us with a framework for adding more cheatsheets on various topics. Keep that in mind and create additional bugs if you think of any great ideas for additional cheatsheets.
Comment 5 Peter Lorimer CLA 2009-09-15 22:01:50 EDT
For this cheat sheet, should I be using actions? I have implemented a simple cheat sheet with text only instructions and I am working on furthering it to include actions such as Opening the Java Lite Perspective, adding main method and a small snippet of code producing "Hello World.".
Comment 6 Wayne Beaton CLA 2009-09-15 22:30:31 EDT
It's hard to know if you should use actions or not. Why don't we start without them and see what your colleagues and the community thinks? Based on feedback, we can decide to add them later.

I'm of two minds myself. Actions will make it easier, but making the student do the actions themselves may be a better learning tool. As with anything else, the final answer probably lies somewhere in the middle...
Comment 7 Peter Lorimer CLA 2009-09-17 22:49:23 EDT
Created attachment 147518 [details]
Building your first Java Project Cheatsheet (only portions of attachment have been used)

This is assuming that the "lite" wizards can be used from the top file menu. It also assumes you have to open the lite perspective, which might not be the case.
Comment 8 Dwight Deugo CLA 2009-09-22 10:53:14 EDT
Good start Peter. As a coding comment, I would lower your Plug-in's requirement of a J2SE 1.6 VM, to a 1.5. I think it is better to go lower rather that to force people to 1.6. I know my Mac comes standard with 1.5.

One requirement I think we should maintain is a low level of navigation. Therefore, we need a button/menu item that people can see without having to "open up" anything else. How about at the top of the JavaLite Package Exploreer?

Another requirement is different types of cheat sheets. The ones you have are about process, e.g. how to do things. I think another format is a sheet with useful Java code segments people can use to copy and paste. There may be more. Therefore, it needs to be dead simple to manage multiple sheets.
Comment 9 Peter Lorimer CLA 2009-09-22 13:14:21 EDT
Thanks for the input. I will get on that ASAP. I would have used those quick buttons above the explorer, but to be honest I didn't know what to call them. So I opted for the file menu. Also, I had planned on starting the coding snippets, I'm tempted to use a composite cheat sheet with this being the base, or have links to "Other Helpful Sheets" something like that. This as mentioned earlier can be used as the framework.
Comment 10 Wayne Beaton CLA 2010-02-03 11:49:17 EST
I have extracted the cheatsheet and the plugin.xml fragment that describes it and have added them to org.eclipse.ide4edu.javalite.cheetsheets.introductory. In the process, I changed the name of the content.xml file to firstProgram_cheatsheet.xml.

Given some  of the changes that have occurred since this patch was provided, there are some inaccuracies in the instructions that need to be fixed. I will create a new bug to address the updates.

Attachment will be marked as iplog+. Marking as FIXED.
Comment 11 Wayne Beaton CLA 2010-02-03 11:49:21 EST
Created attachment 158067 [details]
mylyn/context/zip