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

Bug 332575

Summary: Build up new reference documentation for Draw2d, GEF, and Zest in the GEF wiki
Product: [Tools] GEF Reporter: Alexander Nyßen <nyssen>
Component: MiscAssignee: gef-inbox <gef-inbox>
Status: RESOLVED WORKSFORME QA Contact:
Severity: normal    
Priority: P3 CC: bilnoski, irbull, krispala, milesparker
Version: 3.6.1   
Target Milestone: ---   
Hardware: All   
OS: All   
Whiteboard:
Attachments:
Description Flags
Patch for column issue. none

Description Alexander Nyßen CLA 2010-12-14 16:48:54 EST 
As the GEF project is no longer constituted by Draw2d and GEF alone, but augmented by Zest (which as well depends on Draw2d), I think it would make sense to provide a separate reference documentation for all three components instead of just having the integrated Draw2d and GEF plug-in developer guide (as part of the Eclipse Help). Further, as the existing Draw2d and GEF plug-in developer guide is a quite "sparse" reference documentation that does only cover some facets of Draw2d/GEF (most of the framework seems to be documented by means of articles or EclipseCon tutorials), an augmentation of the existing documentation seems to be reasonable (e.g. the Draw2d examples that could be quite helpful for beginners could be prepared and documented, as already proposed in bug #213041).

As the wiki already provides some additional information in form of the Régis Lemaigre's GEF tutorial, which was provided by bug #73636, and as it would - at least as I see it - make maintenance of such a reference documentation much easier compared to "classical" HTML, I would propose to build up a new reference documentation in the GEF wiki, based on the Draw2d and GEF plug-in developer guide, the mentioned GEF tutorial, as well as the - up to now - quite sparse Zest documentation that spread through the GEF wiki as well. As Fabian already did it for his Dot4Zest component, the Eclipse Help pages could in turn be generated from the wiki pages: http://fsteeg.com/2010/03/14/generating-documentation-from-a-wiki-with-ant-and-mylyn-wikitext to keep the Eclipse Help documentation in sync (we would only have to clarify how to include the Javadocs).
Comment 1 Alexander Nyßen CLA 2010-12-17 15:50:00 EST 
*** Bug 329983 has been marked as a duplicate of this bug. ***
Comment 2 Miles Parker CLA 2011-10-11 12:57:28 EDT 
Hi,

I just wanted to point out that either a) the GridLayout example doesn't work, b) the GridLayout doesn't work. :) I suspect the former, because for example when I try to change the number of columns nothing happens, and it seems that when I click on a figure it doesn't always load or set the values for that figure. It might be helpful to have an explicit "revalidate" button.

Otherwise, I find the examples valuable, so thanks.
Comment 3 Alexander Nyßen CLA 2011-10-12 15:53:33 EDT 
(In reply to comment #2)
> Hi,
> 
> I just wanted to point out that either a) the GridLayout example doesn't work,
> b) the GridLayout doesn't work. :) I suspect the former, because for example
> when I try to change the number of columns nothing happens, and it seems that
> when I click on a figure it doesn't always load or set the values for that
> figure. It might be helpful to have an explicit "revalidate" button.
> 
> Otherwise, I find the examples valuable, so thanks.

Hmm, I can't reproduce this. If I change the columns I get direct feedback. What platform are you running the example on?
Comment 4 Miles Parker CLA 2011-10-12 16:47:01 EDT 
(In reply to comment #3)
> Hmm, I can't reproduce this. If I change the columns I get direct feedback.
> What platform are you running the example on?

OS X. To be more clear, here is what I tried.

1. Launch example.
2. Add 2 children, making 4.
3. Enter '3' in "numColumns".
4. Leave numColumns focus.

Nothing happens. Thinking that maybe the issue was that I had already added the items, I also tried doing a clear and then adding the items. I still have everything showing up in just two columns, e.g. 2x2.
Comment 5 Alexander Nyßen CLA 2011-10-12 16:52:55 EDT 
(In reply to comment #4)
> (In reply to comment #3)
> > Hmm, I can't reproduce this. If I change the columns I get direct feedback.
> > What platform are you running the example on?
> 
> OS X. To be more clear, here is what I tried.
> 
> 1. Launch example.
> 2. Add 2 children, making 4.
> 3. Enter '3' in "numColumns".
> 4. Leave numColumns focus.
> 
> Nothing happens. Thinking that maybe the issue was that I had already added the
> items, I also tried doing a clear and then adding the items. I still have
> everything showing up in just two columns, e.g. 2x2.

Ah, I used CR to confirm step 3.). It works if you do so...
Comment 6 Miles Parker CLA 2011-10-12 16:55:57 EDT 
Created attachment 205069 [details]
Patch for column issue.

Looks like it was just a UI issue. Here's a patch -- don't worry about using it or not but default selection works only for the combo boxes and the widget was a Text.
Comment 7 Miles Parker CLA 2011-10-12 16:58:43 EDT 
(In reply to comment #6)
> Created attachment 205069 [details]
> Patch for column issue.
> 
> Looks like it was just a UI issue. Here's a patch -- don't worry about using it
> or not but default selection works only for the combo boxes and the widget was
> a Text.

And my solution breaks for CR. :) Perhaps an apply button would be good, I dunno.
Comment 8 Alexander Nyßen CLA 2011-10-12 17:03:42 EDT 
(In reply to comment #7)
> (In reply to comment #6)
> > Created attachment 205069 [details] [details]
> > Patch for column issue.
> > 
> > Looks like it was just a UI issue. Here's a patch -- don't worry about using it
> > or not but default selection works only for the combo boxes and the widget was
> > a Text.
> 
> And my solution breaks for CR. :) Perhaps an apply button would be good, I
> dunno.

I created bug #360733 to keep track of this.
Comment 9 Alexander Nyßen CLA 2012-03-11 15:08:29 EDT 
As GEF4 is meant to provide the next generation API, I think building up a new documentation should target that component as well. I created bug #373894 to keep track of it and I close this as worksforme though.