Community
Participate
Working Groups
We discussed at a Mylyn Meeting (http://wiki.eclipse.org/Mylyn_Meetings#March_11th.2C_10-11am_PT) the collaboration in creating a wysiwyg html editor. The already implemented editor in Eclipse Remus was not usable due to the licesnse of the underlying tinyMCE editor. In the progress of the initial checkin of the Remus Sources I've rewritten the Widget based on the CKeditor, which is licensed under an EPL-compatible license. This contribution is not completed with all functions, but is already usable. I also want to use this contribution as a base for further discussion about possible requirements. I've attached also an example-bundle with a single view to see the widget in action. Please take a look at the code and tell me if you are still interested in hosting this widget under the mylyn-commons.
Ok, the attachment is too large. Available here: http://remus-software.org/upload/org.eclipse.mylyn.htmltext.zip
That sounds great! I think the editor would be a valuable contribution to the Mylyn Docs project which will get created as part of the project restructuring. Has the code already gone through IP review or is it already part of Remus?
No, the code is neither IP approved nor part of our project. My plan was to decouple the widget completely from the Remus project, the namespace of the bundle is already org.eclipse.mylyn.* - I think the Mylyn Doc project is a good place for the widget :). For us it would be the best if we could check the bundle into an incubation area of Mylyn, so that we can reference the bundle. This would allow us to continue our "IP-cleanup". Further work on the widget I'd like to do under the umbrella of the Mylyn project. The ckeditor (version 3.0.1) was already approved, see https://dev.eclipse.org/ipzilla/show_bug.cgi?id=3590 but we're using a newer version (3.3.1). We're also using an unmodified version.
Sounds like a great contribution. The Mylyn Docs project is the right place for it. Some things that we should consider: # It's best to attach contributions to the bug if at all possible, since it makes working with the contribution easier per the "IP process":http://www.eclipse.org/projects/dev_process/ip-process-in-cartoons.php ## it may be possible to reduce the zip size by removing binaries (nested jars, bin folders etc) # Looks like CKeditor uses some 3rd party components, such as jquery. These will have to be identified and may also have to pass IP review. # Mylyn Docs is not currently setup with a place where parallel IP review can occur. Until that's set up, working off of bug attachments is the best way to go. # Maintenance: after the initial contribution, who will maintain this code? # Cross-Platform: will this work on all platforms ## it may depend on an embedded browser, which is not always available. Is there a fall-back strategy?
Thanks Tom. We have not yet provisioned the new Mylyn projects and are not setup for parallel IP at the moment but we hopefully the restructuring will happen soon. I have added an item to next Thursday's meeting agenda to discuss how we can best consume this component. Either way it would be good if you could already file the CQs for the source code and all dependencies that are not yet approved. It should be fine to file them under the Remus project for now and we can easily move the CQs to Mylyn before checking in the code.
(In reply to comment #4) > # Looks like CKeditor uses some 3rd party components, such as jquery. These > will have to be identified and may also have to pass IP review. Ok, I have removed the unnessecary parts. The JavaScript source was present twice, a compressed version and an uncompressed; I've removed the uncompressed source. I also removed the jquery-adapter code (not needed). > # Mylyn Docs is not currently setup with a place where parallel IP review can > occur. Until that's set up, working off of bug attachments is the best way to > go. Ok, I'm fine with that. > # Maintenance: after the initial contribution, who will maintain this code? > # Cross-Platform: will this work on all platforms I don't know. If it would be okay for you, I'd maintain the contributed code. I'm very interested due to the consumptation in our project that the contributed code is kept in a healthy state. > ## it may depend on an embedded browser, which is not always available. Is > there a fall-back strategy? Actually no. The widget depends on SWT 3.5. I didn't plan to have a fall-back for environments where SWT is not supported.
(In reply to comment #5) > Either way it would be good if you could already file the CQs for the source > code and all dependencies that are not yet approved. It should be fine to file > them under the Remus project for now and we can easily move the CQs to Mylyn > before checking in the code. Ok, I'll open a CQ for the CKeditor and another for the Java-part.
Created attachment 173993 [details] Source Code bundle
Created attachment 173994 [details] Example Source bundle
> > # Maintenance: after the initial contribution, who will maintain this code? > > # Cross-Platform: will this work on all platforms > I don't know. If it would be okay for you, I'd maintain the contributed code. > I'm very interested due to the consumptation in our project that the contributed > code is kept in a healthy state. Great to hear. We would definitely be interested in getting you commit rights on the component that consumes the code. > > ## it may depend on an embedded browser, which is not always available. Is > > there a fall-back strategy? > Actually no. The widget depends on SWT 3.5. I didn't plan to have a fall-back > for environments where SWT is not supported. That's very interesting. Isn't the CKeditor JavaScript based? Which engine does it use to execute the JavaScript? (In reply to comment #7) > Ok, I'll open a CQ for the CKeditor and another for the Java-part. Great! Please add me to the CC on the CQ. I'll tentatively schedule this bug for 3.5 to ensure that we keep track of it.
FYI: Ckeditor was approved, see CQ 4372 The Java part was approved, see CQ 4428 The editor was checked into the Remus CVS Module. /cvsroot/technology/org.eclipse.remus/bundles/org.eclipse.mylyn.htmltext
That's great news. I'll bring this up on the next Mylyn call to discuss how we can move that into the Mylyn docs project.
We are getting closer to doing the CVS provisioning for the Mylyn Docs project. I have taken this bug off the milestone for now and made it a subtask of the restructuring task to track progress as part of the restructuring effort.
The code has been migrated to the Mylyn Docs CVS. Tom, can you request that the CQ are moved to the mylyn.docs project?
(In reply to comment #14) > The code has been migrated to the Mylyn Docs CVS. Tom, can you request that the > CQ are moved to the mylyn.docs project? I've created a new CQ (see CQ 4708), there is no single CQ which covers only this component (it was part of the intial contribution of Remus)
Thanks. I'll mark this as resolved then.
