Re: [xwiki-devs] [Proposal] RedPen Integration into XWiki as Extension (Gsoc Project 2017)

Hi deshengchuan, Welcome aboard! Of course :) It’s not really a word-editing software. It’s more a text validation framework, see https://github.com/redpen-cc/redpen (see also http://redpen.cc/): "RedPen is an open source proofreading tool to check if your technical documents meet the writing standard. RedPen supports various markup text formats (Markdown, Textile, AsciiDoc, Re:VIEW, reStructuredText and LaTeX).” Here are some ideas for your work (This is how I envision this integration but let me know if you have other ideas): * Provide a UI in XWiki so that RedPen can be executed in a job on various pages of the wiki (let the user select on what pages to run it: all (sub)wikis, a given wiki, a given page and children, a given page only. It would generate some report about violations. * Provide an Admin part to configure the RedPen rules to execute * Provide the ability to add new rules defined in wiki pages (through a mechanism similar to UIExtensions - See http://redpen.cc/docs/latest/#extending-with-java on the redPen side). * Provide a Script Service so that scripts in wiki pages can validate any content using RedPen. Same from Java (the Script Service would call the Java Component). * Provide an Admin option so that RedPen executes when a wiki page is saved (turned off by default). This would be implemented as an XWiki Event Listener and would cancel the save if there are violations. * Note that the RedPen integration should be developed as an XWiki extension in xwiki-contrib. * Research how to embed redPen as a library (as a JAR dependency) and not as a standalone server. That should probably be your first task. If not possible we’ll need to have it installed as a server but that would make using the XWiki RedPen Extension much more complex. * (Optional and to be done after the rest is implemented and if enough time is left) Contribute to the RedPen project itself by contributing support for the XWiki Syntax 2.1 markup text format. This would allow to make XWiki and XWiki Rendering more known to users of RedPen. WDYT? Let’s discuss these points one by one here because it’s important you fully understand each of them so that we are all in sync about the expectations. If you agree it would be nice if you could update http://design.xwiki.org/xwiki/bin/view/Proposal/RedPenIntegration with it. Please do! :) Thanks I’ve checked it and it’s a bit light ATM with some stuff that are not clear and that are not using XWiki’s terminology so we need to be sure we’re talking about the same thing. This is why I’ve listed above the way I see it as a starting point to agree about what you’ll do. Don’t hesitate to talk on IRC (using Riot for ex, see http://dev.xwiki.org/xwiki/bin/view/Community/Chat) when you need some quick answer. For more complex things that require agreement and thinking the list is best. So your first step is to fully understand the scope of the work and to make http://design.xwiki.org/xwiki/bin/view/Proposal/RedPenIntegration as detailed as possible so that we all agree about the work. I’m very happy to have you on board! :) Thanks -Vincent