[xwiki-devs] About "Auto Completion in Content Editors" GSoC Project
Hi, First of all, I am very excited that Xwiki Community accepted my proposal "Auto Completion in Content Editors", and thanks for everyone that helped me a lot during the application time. Second, I will talk about something I have done these days, and then talk about the problems that confuse me. 1. I have setted up an Linux(Ubuntu 11.04)+Git+maven(2.2.1) environment for developing Xwiki projects. Everything goes well in this step. 2. And I have downloaded the source code of xwiki-enterprise from github, build it up, and got xwiki-enterprise-jetty-hsqldb-3.1-SNAPSHOT.zip file under distribution folder, unzip it and run the start_xwiki.sh, and visit http://localhost:8080, it is successful to see the xwiki page. 3. I have searched some issues related to WYSIWYG editors, and I finnally chose two for optionals:http://jira.xwiki.org/jira/browse/XWIKI-4471 and http://jira.xwiki.org/jira/browse/XWIKI-4179. Problems: 1.Building XE takes a long time about more than half an hour, if I am working on XE, for example fix some bugs of it, and want to compile and run it as soon as possible to see the results, have an hour would be a very long time for waiting each time. I know maybe the second time for building XE will be much faster than the first time, but it still take some time to build the whole codes, it must slow down the efficiency to debug my code. So anyone can tell me how should I do, or is there any best prictices for debuging and compling the code based on XE. 2. About the selected two issues, one is to add a small new feature, and the other one is to fix a bug, I want to ask for some advices about which issue would be ok, and could you give me some more informations for these two issues. -- Best wishes, 许凌志(Jame Xu) MOE KLINNS Lab and SKLMS Lab, Xi'an Jiaotong University Department of Computer Science and Technology, Xi’an Jiaotong University
Hi James, On 05/02/2011 06:04 AM, 许凌志(Jamesxu) wrote:
Hi,
First of all, I am very excited that Xwiki Community accepted my proposal "Auto Completion in Content Editors", and thanks for everyone that helped me a lot during the application time.
Second, I will talk about something I have done these days, and then talk about the problems that confuse me. 1. I have setted up an Linux(Ubuntu 11.04)+Git+maven(2.2.1) environment for developing Xwiki projects. Everything goes well in this step. 2. And I have downloaded the source code of xwiki-enterprise from github, build it up, and got xwiki-enterprise-jetty-hsqldb-3.1-SNAPSHOT.zip file under distribution folder, unzip it and run the start_xwiki.sh, and visit http://localhost:8080, it is successful to see the xwiki page. 3. I have searched some issues related to WYSIWYG editors, and I finnally chose two for optionals:http://jira.xwiki.org/jira/browse/XWIKI-4471 and http://jira.xwiki.org/jira/browse/XWIKI-4179.
Problems:
1.Building XE takes a long time about more than half an hour, if I am working on XE, for example fix some bugs of it, and want to compile and run it as soon as possible to see the results, have an hour would be a very long time for waiting each time. I know maybe the second time for building XE will be much faster than the first time, but it still take some time to build the whole codes, it must slow down the efficiency to debug my code. So anyone can tell me how should I do, or is there any best prictices for debuging and compling the code based on XE.
You don't have to build XE. http://ci.xwiki.org/ does this for us and publishes the results on http://maven.xwiki.org/ . You should just download (once in a while) the latest XE snapshot from http://maven.xwiki.org/snapshots/org/xwiki/enterprise/xwiki-enterprise-jetty... . Then, when you want to test your code you simply update the jars (WEB-INF/lib) and/or resources (JS, CSS, Velocity templates) from your XE instance and restart the server for jars and/or clear browser cache for resources. You should edit resources directly on your running XE instance and then update your local Git repo. Some JS and CSS files are minified. In this case you should overwrite the minified version with the original version from you local Git repo. In order to update the WYSIWYG editor you have to: * When you make changes to the client side, replace the resources/js/xwiki/wysiwyg/xwe directory with the one from the generated war (xwiki-platform-wysiwyg-war). Don't overwrite. Remove the existing directory and copy the one from the war. * When you make changes to the server side, simply update the xwiki-platform-wysiwyg-server jar from WEB-INF/lib
2. About the selected two issues, one is to add a small new feature, and the other one is to fix a bug, I want to ask for some advices about which issue would be ok, and could you give me some more informations for these two issues.
I'll comment on this when JIRA is up again. Hope this helps, Marius
Thank you Marius~~~ On Mon, May 2, 2011 at 4:06 PM, Marius Dumitru Florea < [email protected]> wrote:
Hi James,
On 05/02/2011 06:04 AM, 许凌志(Jamesxu) wrote:
Hi,
First of all, I am very excited that Xwiki Community accepted my proposal "Auto Completion in Content Editors", and thanks for everyone that helped me a lot during the application time.
Second, I will talk about something I have done these days, and then talk about the problems that confuse me. 1. I have setted up an Linux(Ubuntu 11.04)+Git+maven(2.2.1) environment for developing Xwiki projects. Everything goes well in this step. 2. And I have downloaded the source code of xwiki-enterprise from github, build it up, and got xwiki-enterprise-jetty-hsqldb-3.1-SNAPSHOT.zip file under distribution folder, unzip it and run the start_xwiki.sh, and visit http://localhost:8080, it is successful to see the xwiki page. 3. I have searched some issues related to WYSIWYG editors, and I finnally chose two for optionals:http://jira.xwiki.org/jira/browse/XWIKI-4471 and http://jira.xwiki.org/jira/browse/XWIKI-4179.
Problems:
1.Building XE takes a long time about more than half an hour, if I am working on XE, for example fix some bugs of it, and want to compile and run it as soon as possible to see the results, have an hour would be a very long time for waiting each time. I know maybe the second time for building XE will be much faster than the first time, but it still take some time to build the whole codes, it must slow down the efficiency to debug my code. So anyone can tell me how should I do, or is there any best prictices for debuging and compling the code based on XE.
You don't have to build XE. http://ci.xwiki.org/ does this for us and publishes the results on http://maven.xwiki.org/ . You should just download (once in a while) the latest XE snapshot from
http://maven.xwiki.org/snapshots/org/xwiki/enterprise/xwiki-enterprise-jetty... . Then, when you want to test your code you simply update the jars (WEB-INF/lib) and/or resources (JS, CSS, Velocity templates) from your XE instance and restart the server for jars and/or clear browser cache for resources.
Do you mean if I want to fix a bug in one of the java files, and first I should download the jar which contains the java file, and then modify it, then complile it(by maven), re-build the jar(by maven), replace it in XE instance, and restart the server to test, right?
You should edit resources directly on your running XE instance and then update your local Git repo. Some JS and CSS files are minified. In this case you should overwrite the minified version with the original version from you local Git repo.
I see, thank you~~~
In order to update the WYSIWYG editor you have to: * When you make changes to the client side, replace the resources/js/xwiki/wysiwyg/xwe directory with the one from the generated war (xwiki-platform-wysiwyg-war). Don't overwrite. Remove the existing directory and copy the one from the war. * When you make changes to the server side, simply update the xwiki-platform-wysiwyg-server jar from WEB-INF/lib
2. About the selected two issues, one is to add a small new feature, and
the
other one is to fix a bug, I want to ask for some advices about which issue would be ok, and could you give me some more informations for these two issues.
I'll comment on this when JIRA is up again.
Hope this helps, Marius _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Best wishes, 许凌志(Jame Xu) MOE KLINNS Lab and SKLMS Lab, Xi'an Jiaotong University Department of Computer Science and Technology, Xi’an Jiaotong University
On 05/02/2011 11:27 AM, 许凌志(Jamesxu) wrote:
Thank you Marius~~~
On Mon, May 2, 2011 at 4:06 PM, Marius Dumitru Florea <[email protected] <mailto:[email protected]>> wrote:
Hi James,
On 05/02/2011 06:04 AM, 许凌志(Jamesxu) wrote: > Hi, >
> First of all, I am very excited that Xwiki Community accepted my proposal > "Auto Completion in Content Editors", and thanks for everyone that helped me > a lot during the application time. > > Second, I will talk about something I have done these days, and then talk > about the problems that confuse me. > 1. I have setted up an Linux(Ubuntu 11.04)+Git+maven(2.2.1) environment for > developing Xwiki projects. Everything goes well in this step. > 2. And I have downloaded the source code of xwiki-enterprise from github, > build it up, and got xwiki-enterprise-jetty-hsqldb-3.1-SNAPSHOT.zip file > under distribution folder, unzip it and run the start_xwiki.sh, and visit > http://localhost:8080 <http://localhost:8080/>, it is successful to see the xwiki page. > 3. I have searched some issues related to WYSIWYG editors, and I finnally > chose two for optionals:http://jira.xwiki.org/jira/browse/XWIKI-4471 and > http://jira.xwiki.org/jira/browse/XWIKI-4179. > > Problems:
> 1.Building XE takes a long time about more than half an hour, if I am > working on XE, for example fix some bugs of it, and want to compile and run > it as soon as possible to see the results, have an hour would be a very long > time for waiting each time. I know maybe the second time for building XE > will be much faster than the first time, but it still take some time to > build the whole codes, it must slow down the efficiency to debug my code. > So anyone can tell me how should I do, or is there any best prictices for > debuging and compling the code based on XE.
You don't have to build XE. http://ci.xwiki.org/ does this for us and publishes the results on http://maven.xwiki.org/ . You should just download (once in a while) the latest XE snapshot from http://maven.xwiki.org/snapshots/org/xwiki/enterprise/xwiki-enterprise-jetty... . Then, when you want to test your code you simply update the jars (WEB-INF/lib) and/or resources (JS, CSS, Velocity templates) from your XE instance and restart the server for jars and/or clear browser cache for resources.
Do you mean if I want to fix a bug in one of the java files, and first I should download the jar which contains the java file, and then modify it, then complile it(by maven), re-build the jar(by maven), replace it in XE instance, and restart the server to test, right?
Jars contain (most of the time) only the byte code so you can't get the sources from them. You have to git clone xwiki-platform, modify the module you wish/need, build it with maven, copy the generated jar from the target directory to the WEB-INF/lib on your XE instance (making sure you overwrite the existing jar) then restart XE. See below re JIRA issues.
You should edit resources directly on your running XE instance and then update your local Git repo. Some JS and CSS files are minified. In this case you should overwrite the minified version with the original version from you local Git repo.
I see, thank you~~~
In order to update the WYSIWYG editor you have to: * When you make changes to the client side, replace the resources/js/xwiki/wysiwyg/xwe directory with the one from the generated war (xwiki-platform-wysiwyg-war). Don't overwrite. Remove the existing directory and copy the one from the war. * When you make changes to the server side, simply update the xwiki-platform-wysiwyg-server jar from WEB-INF/lib
> > 2. About the selected two issues, one is to add a small new feature, and the > other one is to fix a bug, I want to ask for some advices about which issue > would be ok, and could you give me some more informations for these two > issues. >
I'll comment on this when JIRA is up again.
The two issues you picked are a bit difficult for you at this point. I suggest you start with these issues, in order: http://jira.xwiki.org/jira/browse/XWIKI-6197 --> see how the WYSIWYG and wiki editors are integrated in edit mode. http://jira.xwiki.org/jira/browse/XWIKI-5560 --> understand how the content is saved in WYSIWYG and wiki edit modes. http://jira.xwiki.org/jira/browse/XWIKI-5583 --> investigate the WYSIWYG editor loading process. http://jira.xwiki.org/jira/browse/XWIKI-4475 and http://jira.xwiki.org/jira/browse/XWIKI-4398 --> understand the resource and document references and how WYSIWYG editor wizards work. This should keep you busy for a while :) Note that you can leave a comment on JIRA if you have specific questions/remarks about any of these issues. Hope this helps, Marius
Hope this helps, Marius _______________________________________________ devs mailing list [email protected] <mailto:[email protected]> http://lists.xwiki.org/mailman/listinfo/devs
-- Best wishes,
许凌志(Jame Xu)
MOE KLINNS Lab and SKLMS Lab, Xi'an Jiaotong University
Department of Computer Science and Technology, Xi’an Jiaotong University
participants (2)
-
Marius Dumitru Florea -
许凌志(Jamesxu)