[xwiki-devs] [Gsoc][Update] Red Pen Integration UI
Dear all, an update with the activities regarding the red pen integration. Red-pen side implementation: As of now I am unable to establish contact with neither the community and redpen, nor with its creator, Mr. Takahito Ito. Their community seems to be quite silent, unlike ours Hence, I will be beginning preliminary design on the UI. As of now I am planning to create the UI something like the FAQ page. Each entry on the page by the user corresponds to a particular Red-Pen Validator setting which for now would be imported into a Redpen server (As of now I will use my localhost terminal to set up the server). I am dealing with the import of the validators from the ui into the server first, before incorporating the ScriptServices that will call the dependent components which will do the proofreading. What do you think? P.S. Sorry for the absence over last week, by some bad coincidences I had 2 48-hour hackathons back to back. -- View this message in context: http://xwiki.475771.n2.nabble.com/Gsoc-Update-Red-Pen-Integration-UI-tp76040... Sent from the XWiki- Dev mailing list archive at Nabble.com.
Hi,
On 31 May 2017, at 08:03, deshengchuan <chuandesheng54@gmail.com> wrote:
Dear all, an update with the activities regarding the red pen integration.
Red-pen side implementation: As of now I am unable to establish contact with neither the community and redpen, nor with its creator, Mr. Takahito Ito. Their community seems to be quite silent, unlike ours
So yes it’s possible. I’ve asked too :) Here’s the transcript: “ Chuan De Sheng @laskjk May 17 04:58 Hi all, I am interested in using redpen as a proof reading tool for a project I have. However, is it possible to use it without having to use a redpen server (i.e. use redpen as a JAR dependency) Chuan De Sheng @laskjk 07:09 @takahi-i Vincent Massol @vmassol 14:59 Hi guys. I'm vincent from the XWiki open source project (http://xwiki.org) We're trying to integrate redpen-cc with XWiki. One idea we had is to have redpen-cc validate the content of wiki pages We're wondering if it's possible to embed redpen-cc or its validators inside XWiki (XWiki is a webapp, i.e. a WAR running in a servlet container), ideally by dropping some redpen-cc JARS in WEB-INF/lib Takahiko Ito @takahi-i 15:01 Hello @vmassol @laskjk. Thank you very much for the interest on RedPen! Vincent Massol @vmassol 15:01 if you wish to see more details: http://dev.xwiki.org/xwiki/bin/view/GoogleSummerOfCode/RedPenIntegration2017 hey hi @takahi-i Takahiko Ito @takahi-i 15:03 RedPen jar files are available from Maven central repository https://search.maven.org/#search%7Cga%7C1%7Credpen Vincent Massol @vmassol 15:03 @takahi-i that's cool but do we have to run a redpen server outside of the XWiki webapp or could be embed it somehow? I tried to look in the manual and couldn't find a place where integration documentation is explaiend s/could be/could we Takahiko Ito @takahi-i 15:04 RedPen can be run without server just using redpen-core.jar. I think the cli Main method is an good example. Vincent Massol @vmassol 15:05 ok that's awesome, thanks! Takahiko Ito @takahi-i 15:05 https://github.com/takahi-i/redpen/blob/de767784e1532684225a915ccb0585d92625... The above is the code. Vincent Massol @vmassol 15:06 thanks Takahiko Ito @takahi-i 15:06 Creating RedPen object is quite simple. Just adding configuartion file. Please let us know when you have any problem integrating RedPen to XWiki. Vincent Massol @vmassol 15:07 @laskjk is in charge of the dev, he'll probably drop by later on with some questions if he doesn't succeed but at this stage it's good to know that it can be done. We'll keep you aware of our progress . I hope you can help us if we need it thanks! Takahiko Ito @takahi-i 15:08 Great! “ So you should look into this as a first step IMO since that’s the unknown part. The XWiki part is well known and we can help you on it. Thanks -Vincent
Hence, I will be beginning preliminary design on the UI.
As of now I am planning to create the UI something like the FAQ page. Each entry on the page by the user corresponds to a particular Red-Pen Validator setting which for now would be imported into a Redpen server (As of now I will use my localhost terminal to set up the server).
I am dealing with the import of the validators from the ui into the server first, before incorporating the ScriptServices that will call the dependent components which will do the proofreading. What do you think?
P.S. Sorry for the absence over last week, by some bad coincidences I had 2 48-hour hackathons back to back.
-- View this message in context: http://xwiki.475771.n2.nabble.com/Gsoc-Update-Red-Pen-Integration-UI-tp76040... Sent from the XWiki- Dev mailing list archive at Nabble.com.
On 31 May 2017, at 15:11, Vincent Massol <vincent@massol.net> wrote:
Hi,
On 31 May 2017, at 08:03, deshengchuan <chuandesheng54@gmail.com> wrote:
Dear all, an update with the activities regarding the red pen integration.
Red-pen side implementation: As of now I am unable to establish contact with neither the community and redpen, nor with its creator, Mr. Takahito Ito. Their community seems to be quite silent, unlike ours
So yes it’s possible. I’ve asked too :)
Here’s the transcript:
“ Chuan De Sheng @laskjk May 17 04:58 Hi all, I am interested in using redpen as a proof reading tool for a project I have. However, is it possible to use it without having to use a redpen server (i.e. use redpen as a JAR dependency)
Chuan De Sheng @laskjk 07:09 @takahi-i
Vincent Massol @vmassol 14:59 Hi guys. I'm vincent from the XWiki open source project (http://xwiki.org) We're trying to integrate redpen-cc with XWiki. One idea we had is to have redpen-cc validate the content of wiki pages We're wondering if it's possible to embed redpen-cc or its validators inside XWiki (XWiki is a webapp, i.e. a WAR running in a servlet container), ideally by dropping some redpen-cc JARS in WEB-INF/lib
Takahiko Ito @takahi-i 15:01 Hello @vmassol @laskjk. Thank you very much for the interest on RedPen!
Vincent Massol @vmassol 15:01 if you wish to see more details: http://dev.xwiki.org/xwiki/bin/view/GoogleSummerOfCode/RedPenIntegration2017 hey hi @takahi-i
Takahiko Ito @takahi-i 15:03 RedPen jar files are available from Maven central repository https://search.maven.org/#search%7Cga%7C1%7Credpen
Vincent Massol @vmassol 15:03 @takahi-i that's cool but do we have to run a redpen server outside of the XWiki webapp or could be embed it somehow? I tried to look in the manual and couldn't find a place where integration documentation is explaiend s/could be/could we
Takahiko Ito @takahi-i 15:04 RedPen can be run without server just using redpen-core.jar. I think the cli Main method is an good example.
Vincent Massol @vmassol 15:05 ok that's awesome, thanks!
Takahiko Ito @takahi-i 15:05 https://github.com/takahi-i/redpen/blob/de767784e1532684225a915ccb0585d92625... The above is the code.
Vincent Massol @vmassol 15:06 thanks
Takahiko Ito @takahi-i 15:06 Creating RedPen object is quite simple. Just adding configuartion file. Please let us know when you have any problem integrating RedPen to XWiki.
Vincent Massol @vmassol 15:07 @laskjk is in charge of the dev, he'll probably drop by later on with some questions if he doesn't succeed but at this stage it's good to know that it can be done. We'll keep you aware of our progress . I hope you can help us if we need it thanks!
Takahiko Ito @takahi-i 15:08 Great! “
Last message fro Takahiko Ito: " I will do any support for the integration. Please don't hesitate to ask any questions “ :) -Vincent
So you should look into this as a first step IMO since that’s the unknown part. The XWiki part is well known and we can help you on it.
Thanks -Vincent
Hence, I will be beginning preliminary design on the UI.
As of now I am planning to create the UI something like the FAQ page. Each entry on the page by the user corresponds to a particular Red-Pen Validator setting which for now would be imported into a Redpen server (As of now I will use my localhost terminal to set up the server).
I am dealing with the import of the validators from the ui into the server first, before incorporating the ScriptServices that will call the dependent components which will do the proofreading. What do you think?
P.S. Sorry for the absence over last week, by some bad coincidences I had 2 48-hour hackathons back to back.
-- View this message in context: http://xwiki.475771.n2.nabble.com/Gsoc-Update-Red-Pen-Integration-UI-tp76040... Sent from the XWiki- Dev mailing list archive at Nabble.com.
Thank you for helping me with communicating with him! Ok I will now look into the resources and develop based on the JAR libraries given -- View this message in context: http://xwiki.475771.n2.nabble.com/Gsoc-Update-Red-Pen-Integration-UI-tp76040... Sent from the XWiki- Dev mailing list archive at Nabble.com.
Hi, a short update (Full update will be written on my design page) on the RedPen side of things. As of now I have created a class that is able to take in plain input texts and validate them, generating a JSON output file. I will now be working on getting it to take in input texts in basic wiki syntax ( the ones currently supported by RedPen @ http://redpen.cc/docs/1.9/index.html#wiki-format <http://redpen.cc/docs/1.9/index.html#wiki-format> ) More importantly, I am currently developing the feature to allow the validation settings to be altered. Hopefully I'll be done with this by the end of this week so that I can start integrating the functionality into XWiki. -- View this message in context: http://xwiki.475771.n2.nabble.com/Gsoc-Update-Red-Pen-Integration-UI-tp76040... Sent from the XWiki- Dev mailing list archive at Nabble.com.
Hi,
On 5 Jun 2017, at 09:32, deshengchuan <chuandesheng54@gmail.com> wrote:
Hi, a short update (Full update will be written on my design page) on the RedPen side of things.
As of now I have created a class that is able to take in plain input texts and validate them, generating a JSON output file.
I will now be working on getting it to take in input texts in basic wiki syntax ( the ones currently supported by RedPen @ http://redpen.cc/docs/1.9/index.html#wiki-format <http://redpen.cc/docs/1.9/index.html#wiki-format> )
Cool. I don’t think we need to use redpen’s wiki syntax though. Would be good to investigate how to introduce a new syntax for RedPen so that it can validate XWiki Syntax. Another option is to use XWiki Rendering (using the Converter component for example) to convert XWiki Syntax into a syntax supported by RedPen such as plain text or other. That’s probably the easiest.
More importantly, I am currently developing the feature to allow the validation settings to be altered.
Ok.
Hopefully I'll be done with this by the end of this week so that I can start integrating the functionality into XWiki.
Thanks for the update -Vincent
View this message in context: http://xwiki.475771.n2.nabble.com/Gsoc-Update-Red-Pen-Integration-UI-tp76040... Sent from the XWiki- Dev mailing list archive at Nabble.com.
Ok I'll use XWiki Rendering and incorporate it into the file input stream then :), thanks for the advice. -- View this message in context: http://xwiki.475771.n2.nabble.com/Gsoc-Update-Red-Pen-Integration-UI-tp76040... Sent from the XWiki- Dev mailing list archive at Nabble.com.
participants (2)
-
deshengchuan -
Vincent Massol