June 2013 - xwiki-devs@xwiki.org

[xwiki-devs] Should Main.Spaces/Main.Activity be hidden by default?
by Vincent Massol 26 Jun '13

26 Jun '13

Hi, I think it should since it's the page that serves to define the {{spaces/}} macro. Similar question for the Main.Activity page which defines the {{activity/}} macro. If we want to have those pages used by the user as "features", then I think we should separate the pages: have one page for the macro definition and another page for using the macro. One reason is that we don't want technical code to be returned by default in searches for example and if we have a separate page for the macro then we can mark it hidden and it won't be returned by default in searches. I think we need to hunt for all pages that return code by default. Personally I think that Main.Spaces and Main.Activity should be hidden since there's no navigation leading to them. WDYT? Thanks -Vincent

4 7

[xwiki-devs] [Proposal] Make Solr the default search engine for 5.1 final
by Marius Dumitru Florea 25 Jun '13

25 Jun '13

Hi devs, I'd like to enable Solr by default for 5.1 final. What's left to do in order for it to be really usable is to have some feedback about the indexing progress in the administration section but I think I can work on this before the 5.1 final (shouldn't take long since Thomas has already committed some helping script service). Hope this is fine with you, Marius

5 6

[xwiki-devs] [Proposal] Restricting the wiki syntax
by Thomas Delafosse 25 Jun '13

25 Jun '13

Hi all, We have some security issues with the wiki syntax : people can use it for including some javascript, as you can pass javascript attributes (onclick, etc...) in links parameters for example. As it is dangerous to let anyone include javascript code, we should at least restrict which attributes unprivileged users could use with the wiki syntax. The question is, should users with PR rights still be able to include Javascript thanks to the syntax ? Either : 1) We restrict the wiki syntax for unprivileged users but give no restriction for users with PR. 2) We restrict the wiki syntax for everybody. To my mind, the wiki syntax is not designed for including javascript, there is the HTML macro and Skin extensions for that, so I'm in favor of 2). But perhaps this is something some of you use often, in which case we should perhaps rather go for solution 1). What do you think ? Thanks, Thomas

6 13

[xwiki-devs] [QA] Feedback for 5.1 RC1
by Manuel Smeria 24 Jun '13

24 Jun '13

Hello devs, XWiki 5.1 RC1 is scheduled to be released on Monday, the 24th. Besides the list of bugs fixed for this version, do you want some other features tested as well ? Keep in mind that the Iasi team will be off next Monday. Have a great weekend, Manuel

3 2

[xwiki-devs] [Reminder] BFD#26
by Marius Dumitru Florea 24 Jun '13

24 Jun '13

Hi everyone, Today is BFD26. Our goal is still to have more bugs closed than created for the past 1200 days! http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=10352 As of now we're only 7 bugs behind! Here's the BFD#26 dashboard to follow the progress during the day: http://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=11600 Thanks Marius

4 6

[xwiki-devs] Extension Points in 5.1
by Ludovic Dubost 21 Jun '13

21 Jun '13

Hi, It's been a few version now that we have the UI Extension mecanism in the core platform. However we have not added many extension points and it's bad to wait to long to do this at it will lead to have to build extensions with versions that have them and versions that do not have them. It would be great to add the most important extension points as soon as possible. Here are from my point of view as an extension developer the most important ones: 1/ Page Menu so that you can add an action to the current page 2/ Wiki Menu 3/ Profile Menu 4/ For each attachment 5/ For the attachment area 6/ Next to the document title 7/ Document action tabs (comments, files, etc) 8/ Document action tab links (in the document title area) 9/ Footer Less important: All menus Search form Edit panels Ludovic -- Ludovic Dubost Founder and CEO Blog: http://blog.ludovic.org/ XWiki: http://www.xwiki.com Skype: ldubost GTalk: ldubost

4 3

[xwiki-devs] [GSOC] First coding period started
by Ecaterina Moraru (Valica) 20 Jun '13

20 Jun '13

Hello Buddhiprabha, Yesterday we entered the 'Coding' period of the Google Summer of Code 2013. There are some things that need to be mentioned about GSOC that could help any student contributing to XWiki: = Mentorship = We prefer open mentorship. While your assigned mentor is the one officially in charge with your guidance, almost all interaction should be done 'in the open' as much as possible, on the IRC channel or on the mailing list. You should choose the communication medium according to the importance of the matters to be discussed: naturally, the less important issues are to be discussed on IRC, while the design decisions, important progress announcements and testing/feedback requests go on the list. This way, the community is informed on the evolution of your project, and other developers can come up any time with useful ideas and suggestions. Moreover, if your mentor is hit by a bus (the bus factor [1]), another developer can take his place with little effort. = Communication = Sitting alone in your room, working secretly on your project is definitely a bad approach. However, please keep in mind that too much communication can also be harmful, as it distracts the others from their own work. You need to be able to communicate just right: - provide meaningful information about your progress, - ask the community's opinion on non-trivial design or implementation decisions - avoid wasting a lot of time on a problem, when a more experienced developer (or a student that fought the same problem) could quickly provide you an answer; however, do try to find the answer yourself at first. Wrong: "Where do I start? What do I do now? And how do I do that? Is this good? It doesn't work, help me!" Right: "Since a couple of hours ago I get a strange exception when building my project, and googling for a solution doesn't seem to help. Looking at the error, I think that there's a wrong setting for the assembly plugin, but nothing I tried works. Can someone please take a look?" Subscribe to the devs list (if you didn't do this already), and start monitoring the discussions. It is also recommended to subscribe to the users list, but not mandatory. The notifications list is a little too high volume and technical for the moment, but it is a great knowledge source. = Development process = The project's lifecycle is NOT design -> implementation -> testing -> documentation. [2] We invite you to adopt a test driven development [3][4][5] approach and to experience agile development [6]. After the first coding week, you must have some code that works. It won't do much, of course, but it will be the seed of your project. Every functionality will be validated by tests. The code must be properly tested and commented at the time of the writing (don't think you'll do that afterwards, because in most cases you won't). We encourage you to do __at least__ weekly commits (ideally, if you are well organized, you should be able to commit code that works daily, so try to aim at daily commits). This way, the code can be properly reviewed, and any problems can be detected before they grow into something too difficult to fix. One big code blob committed at the end, no matter how good it may seem, is a failure at several levels. = Documenting your work/progress = We expect students to document their work/progress in 2 ways: 1) Design page in the Design [7] space on xwiki.org GSoC students should create a Design page where they document technical aspects of the feature they are working on: architecture, use cases, problems, various solutions with pros and cons, etc. This page should be written as an XWiki community member and not a GSoC student (there is the progress report for that), ensuring that the page will remain relevant even after the GSoC period ends. 2) 'Progress' section of the GSoC project [8] This is the place where the students set their goals (milestones and deliverables) and where they report their advance towards completing them. More details and examples are available at [9][10][11]. = Conclusions = Since we are already in the coding period, there are some things that need to be done: 1. Answer this mail :) 2. Create a Design page [7] regarding your project 3. Start idling on the IRC channel 4. Start chatting on the mailing list and on IRC about your project and other aspects of XWiki that you don't yet understand 5. Get your hands dirty by diving into the code and fixing Jira issue 6. Talk about your project We want to know what you don`t understand about XWiki, what issue you are planning to undertake, what you want to start with, etc. It helps you more to start saying incorrect things and fixing them early instead of staying quiet and making a big bad choice towards the end. And a last thing, please remember that one-to-one conversations with your mentor are not encouraged and are actually harmful to the success of your project. Talk to the community, ask for help early and life will be sweeter. According to the timeline [12], you have 6 weeks of work available until the mid-term evaluation. Please make sure you have the conditions for success [13] in mind throughout all of the 12 total weeks of GSoC coding. Happy coding! Ecaterina on behalf of XWiki Mentors [1] http://en.wikipedia.org/wiki/Bus_factor [2] http://www.catb.org/~esr/writings/cathedral-bazaar/cathedral-bazaar/ [3] http://en.wikipedia.org/wiki/Test-driven_development [4] http://www.amazon.com/dp/0321146530/ [5] http://www.amazon.com/dp/0201485672/ [6] http://www.amazon.com/dp/0596527675/ [7] http://dev.xwiki.org/xwiki/bin/view/Design/ [8] http://dev.xwiki.org/xwiki/bin/view/GoogleSummerOfCode/WebHome#HSelectedPro… [9] http://dev.xwiki.org/xwiki/bin/view/GoogleSummerOfCode/DocumentingStudentPr… [10] http://dev.xwiki.org/xwiki/bin/view/GoogleSummerOfCode/SOLRsearchcomponent [11] http://dev.xwiki.org/xwiki/bin/view/GoogleSummerOfCode/Responsiveskinbasedo… [12] http://www.google-melange.com/gsoc/events/google/gsoc2013 [13] http://dev.xwiki.org/xwiki/bin/view/GoogleSummerOfCode/WebHome#HConditionsf…

3 4

[xwiki-devs] REST API usages
by Fabio Mancinelli 19 Jun '13

19 Jun '13

Hi everybody, I am working on some brainstorming about the future of the XWiki REST API... The starting point, of course, would be to understand who is using it, how she's using it (i.e., for which use cases), what are the problems she has encoutered and which kind of feature she would like to see in the API. So, if you have worked/interacted/built something with the REST API it would be great to have your feedback. Thanks, Fabio

3 2

[xwiki-devs] Fwd: Adding a customer plugin to the wysiwyg editor
by Marius Dumitru Florea 18 Jun '13

18 Jun '13

Hi Josef, Yes, you can put your design proposal on the Design space and I'll be happy to help you both with the design and the implementation. It's best if we keep the discussion on the devs mailing list so that everyone can participate. I don't have any advice/recommendation for now regarding the proposal but I'll review and comment it as soon as you have something written down. Of course, don't hesitate to ask me any question regarding the WYSIWYG editor. Thanks, Marius ---------- Forwarded message ---------- From: Haimerl, Josef <Josef.Haimerl(a)de-gmbh.com> Date: Mon, Jun 17, 2013 at 11:34 AM Subject: Adding a customer plugin to the wysiwyg editor To: "mariusdumitru.florea(a)xwiki.com" <mariusdumitru.florea(a)xwiki.com> Dear Marius,**** ** ** as already brought up on the XWiki mailing list, we want to implement a customer plugin to the wysiwyg editor and contribute it. Our head approved that now and we want to post a design proposal to arrange things with the community. We would do that here<http://dev.xwiki.org/xwiki/bin/view/Design/WebHome>- is this the right place? Also I would see you from now on as my contact person for this subject or maybe you tell me who’s the right one.**** Also if you have an further advice or recommendation we should consider, when we put down the design proposal, we would be happy. **** ** ** Regards **** Josef Haimerl**** Projektleiter**** [image: Banner_E-Mail] <http://www.de-gmbh.com/brandaktuell.html>**** ** ** DE software & control GmbH Mengkofener Str. 21, D-84130 Dingolfing Fon: +49 8731 3797-0; Fax: +49 8731 3797-29 http://www.de-gmbh.com Geschäftsführung: Friedrich Steininger, Heino Migge, Onur Mubariz Amtsgericht Landshut, HRB 4478**** ** **

2 2

[xwiki-devs] Ratings Plugin porting to Components
by Ludovic Dubost 18 Jun '13

18 Jun '13

Hi, I have ported the ratings plugin to a component architecture and also to 4.5.x. Could some devs review the pom and apis before I make a release of it ? I mostly interested if the pom are correct for releasing. On the code itself, I don't think we can change the storage classes unless we are ready to loose compatibility with the previous plugin. But we could change the script service API if there are better choices. https://github.com/xwiki-contrib/application-ratings Thanks Ludovic -- Ludovic Dubost Founder and CEO Blog: http://blog.ludovic.org/ XWiki: http://www.xwiki.com Skype: ldubost GTalk: ldubost

3 7