You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@jspwiki.apache.org by David Vittor <dv...@gmail.com> on 2014/08/17 16:16:50 UTC
Updated Documentation
Hi Devs,
I'm new here, and have introduced myself here:
* https://jspwiki-wiki.apache.org/Wiki.jsp?page=David%20Vittor
I've just updated the documentation here:
* https://jspwiki-wiki.apache.org/Wiki.jsp?page=HowToWriteAPlugin
Could I get you to review it, and updated where needed?
Also I'm curious about why the jar and war files are in the one module?
Would it be beneficial to separate these two?
Also I've noticed there are some significant changes in
"JSPWIKI_3_0_BRANCH". If I want to help with development, should I do so on
the 3.0 branch or just on the main trunk 2.10.2? Or just follow JIRA?
Also is there anything specific you would like me to work on? Some way for
me to get familiar with the codebase.
Kind regards,
David V
Re: Updated Documentation
Posted by Juan Pablo Santos Rodríguez <ju...@gmail.com>.
Hi Jürgen,
I've just updated the page stating latest release + development version.
br,
juan pablo
On Mon, Aug 18, 2014 at 11:31 AM, Jürgen Weber <ju...@jwi.de> wrote:
> Current release is 2.10.1, development goes to 2.10.2 (can somebody please
> document that on
> http://jspwiki.apache.org/development/source_and_guide.html?).
>
> 3.0 made too many changes at once, so it was decided to restart from 2.8
> see these threads:
>
>
> http://mail-archives.apache.org/mod_mbox/incubator-jspwiki-dev/201201.mbox/%3CCAFNKvH0xHksqVnUxc_Guo77Um0Y3xYhYuB_PuUjn22C_Vfk+qg@mail.gmail.com%3E
>
>
> http://mail-archives.apache.org/mod_mbox/incubator-jspwiki-dev/201201.mbox/%3C24918B2E-766A-4F7D-9C8D-F16EA030F392@ecyrd.com%3E
>
> Have fun with JSPWIKI
> Jürgen
> Am 17.08.2014 16:17 schrieb "David Vittor" <dv...@gmail.com>:
>
> > Hi Devs,
> >
> > I'm new here, and have introduced myself here:
> > * https://jspwiki-wiki.apache.org/Wiki.jsp?page=David%20Vittor
> >
> > I've just updated the documentation here:
> > * https://jspwiki-wiki.apache.org/Wiki.jsp?page=HowToWriteAPlugin
> >
> > Could I get you to review it, and updated where needed?
> >
> > Also I'm curious about why the jar and war files are in the one module?
> > Would it be beneficial to separate these two?
> >
> > Also I've noticed there are some significant changes in
> > "JSPWIKI_3_0_BRANCH". If I want to help with development, should I do so
> on
> > the 3.0 branch or just on the main trunk 2.10.2? Or just follow JIRA?
> >
> > Also is there anything specific you would like me to work on? Some way
> for
> > me to get familiar with the codebase.
> >
> > Kind regards,
> > David V
> >
>
Re: Updated Documentation
Posted by David Vittor <dv...@gmail.com>.
Hi Juan,
Thanks for this. This is great. I might start with the externals, like the
Plugins, Filters and PageProviders, and build up my competance with these
first. Then I might try something more interesting within the core of the
application. Thanks for the links, I've checked these out and might start
with a few plugins.
Cheers,
David V
On Tue, Aug 19, 2014 at 7:04 AM, Juan Pablo Santos Rodríguez <
juanpablo.santos@gmail.com> wrote:
> Hi David, and welcome!
>
> help is always welcome, as this project is developed on free developers
> time :) Regarding the topics on your page and email, with no particular
> order:
>
> Perhaps beginning with plugins is the easiest way to begin to dive in with
> JSPWiki. I haven't read thoroughly your documentation article, but yeah,
> basically you have to implement WikiPlugin and you're set up. I'd also talk
> in there about InitializablePlugin and ParserStagePlugin (both available on
> org.apache.wiki.api.plugin package); check their javadocs to see what those
> interfaces offer. Regarding the maven installation of the artifacts,
> JSPWiki is deployed on the ASF Nexus instance, which is synced with
> central. There're some snapshots deployed in there too, so you should be
> able to pull the dependency without much hassle (if you need a more recent
> snapshot, just ping this list and I'll upload one).
>
> The reason behind the classes classifier with the java classes is that
> JSPWiki initially was built with Ant (on 2.9 if I recall correctly) and
> then migrated to Maven, all in one module; as there are quite some cycles
> between packages, it's difficult to split the source into several modules
> without breaking compatibility with previous versions. But this task is
> something I've on mind, perhaps for 2.11. All these package cycles make the
> OSGi configuration more complicated than usual, so I haven't bothered to
> look into it. Once we have clean, separate modules, it should be matter of
> configuring the appropiate maven plugin.
>
> Another extension point, easy to hop in, is the WikiFilters mechanism (
> https://jspwiki-wiki.apache.org/Wiki.jsp?page=WikiFilters). You can also
> write your own page provider (
> https://jspwiki-wiki.apache.org/Wiki.jsp?page=WikiPageProviders), which
> should be the way to go if you'd like to store the pages on
> database/jackrabbit/etc. JSPWiki also supports the notion of skins and
> themes (templates on JSPWiki language). Check for instance Clean Blue skin
> (
> https://jspwiki-wiki.apache.org/Wiki.jsp?page=CleanBlue) or the haddock
> template (https://jspwiki-wiki.apache.org/Wiki.jsp?page=HADDOCK%20Template
> ).
>
>
> Glen Mazza (a PMC/committer) wrote a guide to host JSPWiki on OpenShift.
> I've added it to
> https://jspwiki-wiki.apache.org/Wiki.jsp?page=JSPWikiPublications
>
> As where to help, well depending on your interests, there are lpenty of
> JIRAs to pick up, f.ex.:
>
> * misc.
> - there were some messages regarding an EncryptionPageProvider (
>
> http://mail-archives.apache.org/mod_mbox/jspwiki-dev/201408.mbox/%3CCAFNKvH3AxsAOjmTy%2BJs%2B7J_32b4-XAWO1hUE1f_xyH57Ki9-_A%40mail.gmail.com%3E
> and https://issues.apache.org/jira/browse/JSPWIKI-205)
> - rss feed localization (
> https://issues.apache.org/jira/browse/JSPWIKI-404
> )
> * template related:
> - logo and favicon cusotmization (
> https://issues.apache.org/jira/browse/JSPWIKI-363)
> - https://issues.apache.org/jira/browse/JSPWIKI-257
> - support for niceedit (
> https://issues.apache.org/jira/browse/JSPWIKI-362)
> - better mobile experience (
> https://issues.apache.org/jira/browse/JSPWIKI-835)
> * plugin/filter related:
> - https://issues.apache.org/jira/browse/JSPWIKI-624
> - https://issues.apache.org/jira/browse/JSPWIKI-852
> - https://issues.apache.org/jira/browse/JSPWIKI-522
> * build
> - integrate wiki on a stick on trunk (
> https://issues.apache.org/jira/browse/JSPWIKI-828). Perhaps Sieg
> - our integration tests aren't running properly, they need to be fixed
>
>
> br,
> juan pablo
>
>
> On Mon, Aug 18, 2014 at 3:21 PM, David Vittor <dv...@gmail.com> wrote:
>
> > Hi Jurgen,
> >
> > Thanks for the feedback. In that case I will leave 3.0, and focus on
> > working in the current 2.10.2-SNAPSHOT build.
> >
> > One of the things I've been thinking recently is that a wiki can function
> > almost entirely on plugins (providers and filters included) but if we
> could
> > build an OSGi framework for plugins, than it would help improve the
> plugin
> > contributions. I've been looking briefly at iPojo, and am going to see
> how
> > much work it would be to incorporate this into JSPWiki, maybe initially
> > simply as a separate plugin (and then later into the core):
> >
> >
> http://felix.apache.org/documentation/subprojects/apache-felix-ipojo/apache-felix-ipojo-gettingstarted/ipojo-in-10-minutes.html
> >
> > Cheers,
> > David V
> >
> >
> >
> > On Mon, Aug 18, 2014 at 7:31 PM, Jürgen Weber <ju...@jwi.de> wrote:
> >
> > > Current release is 2.10.1, development goes to 2.10.2 (can somebody
> > please
> > > document that on
> > > http://jspwiki.apache.org/development/source_and_guide.html?).
> > >
> > > 3.0 made too many changes at once, so it was decided to restart from
> 2.8
> > > see these threads:
> > >
> > >
> > >
> >
> http://mail-archives.apache.org/mod_mbox/incubator-jspwiki-dev/201201.mbox/%3CCAFNKvH0xHksqVnUxc_Guo77Um0Y3xYhYuB_PuUjn22C_Vfk+qg@mail.gmail.com%3E
> > >
> > >
> > >
> >
> http://mail-archives.apache.org/mod_mbox/incubator-jspwiki-dev/201201.mbox/%3C24918B2E-766A-4F7D-9C8D-F16EA030F392@ecyrd.com%3E
> > >
> > > Have fun with JSPWIKI
> > > Jürgen
> > > Am 17.08.2014 16:17 schrieb "David Vittor" <dv...@gmail.com>:
> > >
> > > > Hi Devs,
> > > >
> > > > I'm new here, and have introduced myself here:
> > > > * https://jspwiki-wiki.apache.org/Wiki.jsp?page=David%20Vittor
> > > >
> > > > I've just updated the documentation here:
> > > > * https://jspwiki-wiki.apache.org/Wiki.jsp?page=HowToWriteAPlugin
> > > >
> > > > Could I get you to review it, and updated where needed?
> > > >
> > > > Also I'm curious about why the jar and war files are in the one
> module?
> > > > Would it be beneficial to separate these two?
> > > >
> > > > Also I've noticed there are some significant changes in
> > > > "JSPWIKI_3_0_BRANCH". If I want to help with development, should I do
> > so
> > > on
> > > > the 3.0 branch or just on the main trunk 2.10.2? Or just follow JIRA?
> > > >
> > > > Also is there anything specific you would like me to work on? Some
> way
> > > for
> > > > me to get familiar with the codebase.
> > > >
> > > > Kind regards,
> > > > David V
> > > >
> > >
> >
>
Re: Updated Documentation
Posted by Juan Pablo Santos Rodríguez <ju...@gmail.com>.
Hi David, and welcome!
help is always welcome, as this project is developed on free developers
time :) Regarding the topics on your page and email, with no particular
order:
Perhaps beginning with plugins is the easiest way to begin to dive in with
JSPWiki. I haven't read thoroughly your documentation article, but yeah,
basically you have to implement WikiPlugin and you're set up. I'd also talk
in there about InitializablePlugin and ParserStagePlugin (both available on
org.apache.wiki.api.plugin package); check their javadocs to see what those
interfaces offer. Regarding the maven installation of the artifacts,
JSPWiki is deployed on the ASF Nexus instance, which is synced with
central. There're some snapshots deployed in there too, so you should be
able to pull the dependency without much hassle (if you need a more recent
snapshot, just ping this list and I'll upload one).
The reason behind the classes classifier with the java classes is that
JSPWiki initially was built with Ant (on 2.9 if I recall correctly) and
then migrated to Maven, all in one module; as there are quite some cycles
between packages, it's difficult to split the source into several modules
without breaking compatibility with previous versions. But this task is
something I've on mind, perhaps for 2.11. All these package cycles make the
OSGi configuration more complicated than usual, so I haven't bothered to
look into it. Once we have clean, separate modules, it should be matter of
configuring the appropiate maven plugin.
Another extension point, easy to hop in, is the WikiFilters mechanism (
https://jspwiki-wiki.apache.org/Wiki.jsp?page=WikiFilters). You can also
write your own page provider (
https://jspwiki-wiki.apache.org/Wiki.jsp?page=WikiPageProviders), which
should be the way to go if you'd like to store the pages on
database/jackrabbit/etc. JSPWiki also supports the notion of skins and
themes (templates on JSPWiki language). Check for instance Clean Blue skin (
https://jspwiki-wiki.apache.org/Wiki.jsp?page=CleanBlue) or the haddock
template (https://jspwiki-wiki.apache.org/Wiki.jsp?page=HADDOCK%20Template).
Glen Mazza (a PMC/committer) wrote a guide to host JSPWiki on OpenShift.
I've added it to
https://jspwiki-wiki.apache.org/Wiki.jsp?page=JSPWikiPublications
As where to help, well depending on your interests, there are lpenty of
JIRAs to pick up, f.ex.:
* misc.
- there were some messages regarding an EncryptionPageProvider (
http://mail-archives.apache.org/mod_mbox/jspwiki-dev/201408.mbox/%3CCAFNKvH3AxsAOjmTy%2BJs%2B7J_32b4-XAWO1hUE1f_xyH57Ki9-_A%40mail.gmail.com%3E
and https://issues.apache.org/jira/browse/JSPWIKI-205)
- rss feed localization (https://issues.apache.org/jira/browse/JSPWIKI-404
)
* template related:
- logo and favicon cusotmization (
https://issues.apache.org/jira/browse/JSPWIKI-363)
- https://issues.apache.org/jira/browse/JSPWIKI-257
- support for niceedit (https://issues.apache.org/jira/browse/JSPWIKI-362)
- better mobile experience (
https://issues.apache.org/jira/browse/JSPWIKI-835)
* plugin/filter related:
- https://issues.apache.org/jira/browse/JSPWIKI-624
- https://issues.apache.org/jira/browse/JSPWIKI-852
- https://issues.apache.org/jira/browse/JSPWIKI-522
* build
- integrate wiki on a stick on trunk (
https://issues.apache.org/jira/browse/JSPWIKI-828). Perhaps Sieg
- our integration tests aren't running properly, they need to be fixed
br,
juan pablo
On Mon, Aug 18, 2014 at 3:21 PM, David Vittor <dv...@gmail.com> wrote:
> Hi Jurgen,
>
> Thanks for the feedback. In that case I will leave 3.0, and focus on
> working in the current 2.10.2-SNAPSHOT build.
>
> One of the things I've been thinking recently is that a wiki can function
> almost entirely on plugins (providers and filters included) but if we could
> build an OSGi framework for plugins, than it would help improve the plugin
> contributions. I've been looking briefly at iPojo, and am going to see how
> much work it would be to incorporate this into JSPWiki, maybe initially
> simply as a separate plugin (and then later into the core):
>
> http://felix.apache.org/documentation/subprojects/apache-felix-ipojo/apache-felix-ipojo-gettingstarted/ipojo-in-10-minutes.html
>
> Cheers,
> David V
>
>
>
> On Mon, Aug 18, 2014 at 7:31 PM, Jürgen Weber <ju...@jwi.de> wrote:
>
> > Current release is 2.10.1, development goes to 2.10.2 (can somebody
> please
> > document that on
> > http://jspwiki.apache.org/development/source_and_guide.html?).
> >
> > 3.0 made too many changes at once, so it was decided to restart from 2.8
> > see these threads:
> >
> >
> >
> http://mail-archives.apache.org/mod_mbox/incubator-jspwiki-dev/201201.mbox/%3CCAFNKvH0xHksqVnUxc_Guo77Um0Y3xYhYuB_PuUjn22C_Vfk+qg@mail.gmail.com%3E
> >
> >
> >
> http://mail-archives.apache.org/mod_mbox/incubator-jspwiki-dev/201201.mbox/%3C24918B2E-766A-4F7D-9C8D-F16EA030F392@ecyrd.com%3E
> >
> > Have fun with JSPWIKI
> > Jürgen
> > Am 17.08.2014 16:17 schrieb "David Vittor" <dv...@gmail.com>:
> >
> > > Hi Devs,
> > >
> > > I'm new here, and have introduced myself here:
> > > * https://jspwiki-wiki.apache.org/Wiki.jsp?page=David%20Vittor
> > >
> > > I've just updated the documentation here:
> > > * https://jspwiki-wiki.apache.org/Wiki.jsp?page=HowToWriteAPlugin
> > >
> > > Could I get you to review it, and updated where needed?
> > >
> > > Also I'm curious about why the jar and war files are in the one module?
> > > Would it be beneficial to separate these two?
> > >
> > > Also I've noticed there are some significant changes in
> > > "JSPWIKI_3_0_BRANCH". If I want to help with development, should I do
> so
> > on
> > > the 3.0 branch or just on the main trunk 2.10.2? Or just follow JIRA?
> > >
> > > Also is there anything specific you would like me to work on? Some way
> > for
> > > me to get familiar with the codebase.
> > >
> > > Kind regards,
> > > David V
> > >
> >
>
Re: Updated Documentation
Posted by David Vittor <dv...@gmail.com>.
Hi Jurgen,
Thanks for the feedback. In that case I will leave 3.0, and focus on
working in the current 2.10.2-SNAPSHOT build.
One of the things I've been thinking recently is that a wiki can function
almost entirely on plugins (providers and filters included) but if we could
build an OSGi framework for plugins, than it would help improve the plugin
contributions. I've been looking briefly at iPojo, and am going to see how
much work it would be to incorporate this into JSPWiki, maybe initially
simply as a separate plugin (and then later into the core):
http://felix.apache.org/documentation/subprojects/apache-felix-ipojo/apache-felix-ipojo-gettingstarted/ipojo-in-10-minutes.html
Cheers,
David V
On Mon, Aug 18, 2014 at 7:31 PM, Jürgen Weber <ju...@jwi.de> wrote:
> Current release is 2.10.1, development goes to 2.10.2 (can somebody please
> document that on
> http://jspwiki.apache.org/development/source_and_guide.html?).
>
> 3.0 made too many changes at once, so it was decided to restart from 2.8
> see these threads:
>
>
> http://mail-archives.apache.org/mod_mbox/incubator-jspwiki-dev/201201.mbox/%3CCAFNKvH0xHksqVnUxc_Guo77Um0Y3xYhYuB_PuUjn22C_Vfk+qg@mail.gmail.com%3E
>
>
> http://mail-archives.apache.org/mod_mbox/incubator-jspwiki-dev/201201.mbox/%3C24918B2E-766A-4F7D-9C8D-F16EA030F392@ecyrd.com%3E
>
> Have fun with JSPWIKI
> Jürgen
> Am 17.08.2014 16:17 schrieb "David Vittor" <dv...@gmail.com>:
>
> > Hi Devs,
> >
> > I'm new here, and have introduced myself here:
> > * https://jspwiki-wiki.apache.org/Wiki.jsp?page=David%20Vittor
> >
> > I've just updated the documentation here:
> > * https://jspwiki-wiki.apache.org/Wiki.jsp?page=HowToWriteAPlugin
> >
> > Could I get you to review it, and updated where needed?
> >
> > Also I'm curious about why the jar and war files are in the one module?
> > Would it be beneficial to separate these two?
> >
> > Also I've noticed there are some significant changes in
> > "JSPWIKI_3_0_BRANCH". If I want to help with development, should I do so
> on
> > the 3.0 branch or just on the main trunk 2.10.2? Or just follow JIRA?
> >
> > Also is there anything specific you would like me to work on? Some way
> for
> > me to get familiar with the codebase.
> >
> > Kind regards,
> > David V
> >
>
Re: Updated Documentation
Posted by Jürgen Weber <ju...@jwi.de>.
Current release is 2.10.1, development goes to 2.10.2 (can somebody please
document that on
http://jspwiki.apache.org/development/source_and_guide.html?).
3.0 made too many changes at once, so it was decided to restart from 2.8
see these threads:
http://mail-archives.apache.org/mod_mbox/incubator-jspwiki-dev/201201.mbox/%3CCAFNKvH0xHksqVnUxc_Guo77Um0Y3xYhYuB_PuUjn22C_Vfk+qg@mail.gmail.com%3E
http://mail-archives.apache.org/mod_mbox/incubator-jspwiki-dev/201201.mbox/%3C24918B2E-766A-4F7D-9C8D-F16EA030F392@ecyrd.com%3E
Have fun with JSPWIKI
Jürgen
Am 17.08.2014 16:17 schrieb "David Vittor" <dv...@gmail.com>:
> Hi Devs,
>
> I'm new here, and have introduced myself here:
> * https://jspwiki-wiki.apache.org/Wiki.jsp?page=David%20Vittor
>
> I've just updated the documentation here:
> * https://jspwiki-wiki.apache.org/Wiki.jsp?page=HowToWriteAPlugin
>
> Could I get you to review it, and updated where needed?
>
> Also I'm curious about why the jar and war files are in the one module?
> Would it be beneficial to separate these two?
>
> Also I've noticed there are some significant changes in
> "JSPWIKI_3_0_BRANCH". If I want to help with development, should I do so on
> the 3.0 branch or just on the main trunk 2.10.2? Or just follow JIRA?
>
> Also is there anything specific you would like me to work on? Some way for
> me to get familiar with the codebase.
>
> Kind regards,
> David V
>