Hi Nitish, Nice to see you`ve done some reading and are starting to get a decent idea about the big picture of how things work. I`m sure Vincent could give you more details about the RedPen project, but as far as I see, you`ve got a good idea of what needs to be done for this GSoC project. You just need to study on how it could be achieved and detail the approach you are going to take in your proposal. The dev guide[1] should have enough resources to help you understand about the velocity API, script services, event listeners, javascript API, application organization and that sort of stuff that you might need for you to get the job done. You will need to also include a timeline with milestones of how you are going to plan the work you propose to do. Think about the steps you need to take and plan accordingly. Remember to be realistic about your abilities and it's even OK to plan to do a bit less features, but as long as you commit to something that you can finish by the time the GSoC coding period ends. This includes testing and documentation. Also, remember that you need to get into the details of a particular issue and manage to submit a Pull Request to show us that you can understand and solve actual problems. A good proposal should either go a bit deeper into the technical details and/or be accompanied by some good code (Pull Request), proving that you understand the challenge. Don`t hesitate to ask for help, but remember to keep it to specific questions. P.S.: Try not to create multiple mail threads if they all speak about the same thing. Instead, reply to the existing mail thread (or to another user's reply) in order to not lose focus and context. Thanks, Eduard [1] http://platform.xwiki.org/xwiki/bin/view/DevGuide/ On Thu, Mar 17, 2016 at 10:55 AM, Nitish Chauhan <[email protected]> wrote:
Hello sir , For the past few days, I had examined and read the documents you mentioned about RedPen Integration in XWiki. Since I am new to XWiki, I also researched about XWiki itself. I was able to extract the following information :- 1.) XWiki is a free wiki software platform written in Java with a design emphasis on extensibility. 2.) It is large Scale structured Wiki. 3.) Can make Page Editing (like wikipedia) easy & fast. 4.) Can help to change the Wiki Layout . 5.) Easy link integration . Can change the Wiki layout also.
some Advance features :- 1.) Can integrate Code also through it.(simple scripts can be included in the wiki pages like python,velocity,etc). 2.) Xwiki allows us to include META-DATA in the pages.
How it works :- 1.) Xwiki core has many API's. 2.) There are different Classes & each class can have different instances or Objects. 3.) In XWiki there is possibilty of adding Objects like :- Tag Object , etc 4.) Application in Xwiki = set of Pages (Classes , Objects ,...).
The Current Idea for GSOC :- The Idea is to integrate RedPen inside XWiki.
What is RedPen?? 1.)RedPen is a proofreading tool that helps writers & developers to write Technical documents or manuels without any error.Basically, it improves the quality of documents.
2.) Can only be used for natural languages not computer languages.
Why to use in Xwiki?? In many cases , XWiki users had to write some Natural language documents , so in order to reduce the error , a RedPen integration would be great.
How?? 1.) There can be a RedPen plugin in Xwiki, Which will list out all the errors when the user will save the documents.
2.) RedPen does this , by using different validators.
3.)RedPen supports the following validators. 1.)SentenceLength
2.)InvalidExpression
3.)InvalidWord
4.)SpaceBeginningOfSentence
5.)CommaNumber..etc
According to our requirements , we can insert more types of Validators. RedPen users can extend RedPen by creating new Validators. (In JAVA)
I also tried to read "REDPEN INTELLIJ IDEA PLUGIN". It is easy to install RedPen Plugin in it , but sir can you help me a little on how to basically integrate it to XWiki. I need some help in this case.
I tried searching on JIRA , but was to able to extract relevent info from there.
It would be great , if you could guide me little. I am willing to learn new Technology if needed.
Also, what are the things that should be included in the GSOC proposal (I need some help in that also)
Looking Forward for your Help , reviews & suggestions.
Thank you.
regards, Nitish Chauhan _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs