12 Jun
2017
12 Jun
'17
2:43 p.m.
vmassol wrote
Ok, I think I'll move this discussion to a new thread which will officially
request a repository.
Thanks for the help!
--
View this message in context:
http://xwiki.475771.n2.nabble.com/GSOC-Update-2-RedPen-Integration-tp760413…
Sent from the XWiki- Dev mailing list archive at Nabble.com.
Hi De Sheng (that’s your first name right?),
Yea it is :)
vmassol wrote
Yes that’s one use case to implement indeed. The other
use case is to
provide a UI to allow to manually run the RedPen validation checks on one
or several documents.
Ok I'll design a UI for this after I get around to the event listener
vmassol wrote
Ok. You could use a ConfigurableClass
(http://extensions.xwiki.org/xwiki/bin/view/Extension/Administration%20Appli…)
to provide an Admin UI to configure what checks to execute on doc save. On
the other UI (the manual one described above) it would probaby be better
to let the user decide the checks to execute.
Ok I'll look into Configurable Classes for this. Thanks for the advice!
vmassol wrote
With that in
mind, I think I should request a repository on
xwiki-contrib,
since I already have some starting code available locally. May I know
what
are the required steps I need to achieve that?
Yes, you should do that ASAP and commit stuff so that we can start
reviewing/helping out, see
http://contrib.xwiki.org/xwiki/bin/view/Main/WebHome#HRequestingaproject
Next, I understand that there are three ways that
one can write an event
listener, either using an XWiki Component in a jar, a Wiki Component or
using Groovy. I am currently considering using Groovy to create the Event
Listener directly within a wiki page. Any thoughts on that?
Yes, it’s better to do it in Java since otherwise it would require the
user to have Programming Rights and it’ll make the integration more
fragile. So you'll need at least 3 maven modules (one that generates the
script service and contains the Listener), another one that generates the
XAR (the UI) and yet another one for the functional tests. You can check
other contrib project and importantly you should read
http://contrib.xwiki.org/xwiki/bin/view/Main/WebHome.
A good example is https://github.com/xwiki-contrib/application-blog.