Bugzilla – Full Text Bug Listing
| Summary: | [DataBinding] Update the wiki | ||
|---|---|---|---|
| Product: | [Eclipse Project] Platform | Reporter: | Brad Reynolds <bradleyjames> |
| Component: | UI | Assignee: | Brad Reynolds <bradleyjames> |
| Status: | CLOSED FIXED | QA Contact: | |
| Severity: | normal | ||
| Priority: | P3 | CC: | abuehler, bkuehl, bokowski, djo, Michael.Valenta |
| Version: | 3.2 | Keywords: | helpwanted |
| Target Milestone: | 3.4 M3 | ||
| Hardware: | All | ||
| OS: | All | ||
| Whiteboard: | |||
| Bug Depends on: | 164068 | ||
| Bug Blocks: | |||
|
Description
Brad Reynolds
Yes, a FAQ would be good, plus pointers to relevant information, where to find snippets, etc. (We should also move the databinding snippets to org.eclipse.jface.snippets.) FAQ started at http://wiki.eclipse.org/index.php/JFace_Data_Binding_FAQ. I also added JFace Data Binding to the main page under "J" and also added a link to the FAQ under the FAQ section. I hope you don't mind but I took the liberty of adding an "out-of-date" disclaimer to the HOWTO. It mentions the deprecated class Property. Since the javadoc gives no indication of what the replacement is, I assume things have changed a lot. The URL to the HOWTO I changed is: http://wiki.eclipse.org/index.php/Data_Binding_HOWTO It seems to me that it would be better renamed 'Core Databinding FAQ' than JFace Databinding FAQ, espeically if the bundle names go through. In fact, the only references to JFace in the document are the title and 2 mentions of the package name (along with 2 references to SWT/JFace). (In reply to comment #3) > I hope you don't mind but I took the liberty of adding an "out-of-date" > disclaimer to the HOWTO. We don't mind at all. Thank you very much. We should probably add this to most of the pages that exist with a simple template. (In reply to comment #4) > It seems to me that it would be better renamed 'Core Databinding FAQ' than > JFace Databinding FAQ, espeically if the bundle names go through. In fact, the > only references to JFace in the document are the title and 2 mentions of the > package name (along with 2 references to SWT/JFace). > I think this is bigger than a wiki change. JFace Data Binding is the name of the project and is a part of the branding (branding as in how it's known, we don't have a logo or cool stickers). If any change occurs I would think we'd want it to still keep something in the name that refers to Eclipse. But like I said, I think this is bigger than a wiki change. I added a disclaimer to the TODO page as well. I'd like to see this page be removed but I'd prefer to wait to do any heavy refactoring of the wiki until we have a plan. I've been thinking about restructuring things on the wiki. If this is going to be where our main introductory documentation lives it seems like it might be worth the time to get this feeling like a project site, to give us a presence. If anyone knows of projects that have a good experience on the wiki let me know so that I can take a look. I was thinking about trying to get subpages[1] enabled to be able to have: * JFace_Data_Binding/FAQ * JFace_Data_Binding/Snippets * JFace_Data_Binding/Design * etc. That way the pages will link to each other and feel a little more connected. It would be nice to have a JFace namespace[2] but that might be overkill. I'm not sure when I'll get to this but hopefully soon. If you have any ideas feel to make them known. [1] http://en.wikipedia.org/wiki/Wikipedia:Subpages [2] http://en.wikipedia.org/wiki/Wikipedia:Namespace Another thing that would be beneficial would be the project history. Mainly who has contributed and what it took to get to 1.0. I've been involved for about a year now and I feel like I'm still new. :) Plus it would help keep conspiracy therories at bay (I have heard any but you never know). I'm hopefully going to start hacking away at this stuff soon. If anyone has any information on the history feel free to start the page. Proposed new home page can be found at http://wiki.eclipse.org/index.php/JFace_Data_Binding_Home In the spirit of "forgiveness is easier to ask for than permission" I've replaced the main page[1] and cleaned some of the other pages a bit. I'm adding the "helpwanted" keyword because this still needs a lot of work. [1] http://wiki.eclipse.org/index.php/JFace_Data_Binding The pages have been expanding. I created a template that will create a side bar to help with navigation and to create the feeling of a site. All of our main pages include it. If you create a new page, or find an existing JFace Data Binding page that doesn't have it all that needs to be done is to place the following text toward the top of the document.
{{JFace Data Binding}}
It only contains 2 links at the moment but we should be able to add to it quite easily in the future. We'll probably want to add "Concepts", "Examples", "Download", etc.
Created a snippets page[1]. It can contain links to snippets in our CVS or links to other servers. [1] http://wiki.eclipse.org/index.php/JFace_Data_Binding/Snippets The wiki has been evolving and will keep evolving. Since we have a good start I'm closing this bug. FIXED > 20071020. Marking CLOSED as there's nothing to verify. |