You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by "Raffaele P. Guidi" <ra...@apache.org> on 2011/11/11 23:54:32 UTC
Maven Site Indexer plugin
Hi, I wrote a small plugin to index and search-enable static maven
generated sites using javascript (you can see its self generated site as an
example at: [1]). It's a pretty simple "and" only search but nevertheless
quite effective and I couldn't find anything similar (I notice that even in
the main maven site the search box is powered by google). I am interested
in contributing the code to the maven project (it's already released under
the apache license and available on github [2]) and improving the
integration with the maven site plugin. The plugin leverages js-search [3]
by theladders.com written by Larry Ogrodnek, which I both put in cc.
Do you think this is of some interest? And, in case, how could we proceed?
Regards,
Raffaele
[1] http://raffaeleguidi.github.com/Maven-Site-Indexer-plugin/site/
[2] https://github.com/raffaeleguidi/Maven-Site-Indexer-plugin
[3] http://code.google.com/p/js-search/
Re: Maven Site Indexer plugin
Posted by "Raffaele P. Guidi" <ra...@gmail.com>.
Cool. The most important thing in the plugin is indexing itself, which is
done in java and can also be improved in many ways (with a stopwords list,
removing text from the menus and so on ), we could replece the javascript
search engine with whatever we think it's better.
Ciao,
R
On Tue, Nov 15, 2011 at 10:04 AM, Simone Tripodi
<si...@apache.org>wrote:
> For what I can see, search is faster in therms of finding results (I
> bet guice javadoc index is bigger than the demo one) and gui is more
> responsive.
> Once completed fluido (almost done for a 1.0) and once moved your
> index under mvn umbrella, we can co-work on it - I'm not a JS guru
> either but I bet working in community can supply our lacks ;)
>
> Have a nice day!
> Simo
>
> http://people.apache.org/~simonetripodi/
> http://simonetripodi.livejournal.com/
> http://twitter.com/simonetripodi
> http://www.99soft.org/
>
>
>
> On Tue, Nov 15, 2011 at 2:01 AM, Raffaele P. Guidi
> <ra...@gmail.com> wrote:
> > What do you men exactly with 'faster'? Faster search or just more usable
> > from a user's perspective? Or course auto completion looks smarter but
> I'm
> > not a js guru band I tend to keep things simple :-P
> >
> > I'il give another try to The head tag and see what it leads TO.
> >
> > Ciao,
> > R
> > Il giorno 14/nov/2011 11:51, "Simone Tripodi" <si...@apache.org>
> ha
> > scritto:
> >
> >> Hi again!
> >>
> >> > [...] but couldn't get
> >> > anything to appear into the header or head section (only the footer
> >> works).
> >> > I suppose this is related to the work-in-progress version of the
> fluido
> >> > skin.
> >> >
> >>
> >> Please try to update the fluido skin to latest snapshot because the DM
> >> one was still at prototypal status. Moreover, <head/> and <footer/>
> >> elements have to be declared inside <body/> (even if it sounds a
> >> little weird) and not <custom/>, have a look at the decoration XSD[1].
> >>
> >> Moreover, for the search feature, I suggest you to take a look at how
> >> the Google guys managed it in Doclava[2] (browse the Guice APIs) that
> >> looks be faster than the current approach.
> >>
> >> HTH, have a nice day!
> >> Simo
> >>
> >> [1] http://maven.apache.org/xsd/decoration-1.1.0.xsd
> >> [2] http://google-guice.googlecode.com/git/javadoc/packages.html
> >>
> >> http://people.apache.org/~simonetripodi/
> >> http://simonetripodi.livejournal.com/
> >> http://twitter.com/simonetripodi
> >> http://www.99soft.org/
> >>
> >> ---------------------------------------------------------------------
> >> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> >> For additional commands, e-mail: dev-help@maven.apache.org
> >>
> >>
> >
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
>
>
Re: Maven Site Indexer plugin
Posted by Simone Tripodi <si...@apache.org>.
For what I can see, search is faster in therms of finding results (I
bet guice javadoc index is bigger than the demo one) and gui is more
responsive.
Once completed fluido (almost done for a 1.0) and once moved your
index under mvn umbrella, we can co-work on it - I'm not a JS guru
either but I bet working in community can supply our lacks ;)
Have a nice day!
Simo
http://people.apache.org/~simonetripodi/
http://simonetripodi.livejournal.com/
http://twitter.com/simonetripodi
http://www.99soft.org/
On Tue, Nov 15, 2011 at 2:01 AM, Raffaele P. Guidi
<ra...@gmail.com> wrote:
> What do you men exactly with 'faster'? Faster search or just more usable
> from a user's perspective? Or course auto completion looks smarter but I'm
> not a js guru band I tend to keep things simple :-P
>
> I'il give another try to The head tag and see what it leads TO.
>
> Ciao,
> R
> Il giorno 14/nov/2011 11:51, "Simone Tripodi" <si...@apache.org> ha
> scritto:
>
>> Hi again!
>>
>> > [...] but couldn't get
>> > anything to appear into the header or head section (only the footer
>> works).
>> > I suppose this is related to the work-in-progress version of the fluido
>> > skin.
>> >
>>
>> Please try to update the fluido skin to latest snapshot because the DM
>> one was still at prototypal status. Moreover, <head/> and <footer/>
>> elements have to be declared inside <body/> (even if it sounds a
>> little weird) and not <custom/>, have a look at the decoration XSD[1].
>>
>> Moreover, for the search feature, I suggest you to take a look at how
>> the Google guys managed it in Doclava[2] (browse the Guice APIs) that
>> looks be faster than the current approach.
>>
>> HTH, have a nice day!
>> Simo
>>
>> [1] http://maven.apache.org/xsd/decoration-1.1.0.xsd
>> [2] http://google-guice.googlecode.com/git/javadoc/packages.html
>>
>> http://people.apache.org/~simonetripodi/
>> http://simonetripodi.livejournal.com/
>> http://twitter.com/simonetripodi
>> http://www.99soft.org/
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
>> For additional commands, e-mail: dev-help@maven.apache.org
>>
>>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: Maven Site Indexer plugin
Posted by "Raffaele P. Guidi" <ra...@gmail.com>.
What do you men exactly with 'faster'? Faster search or just more usable
from a user's perspective? Or course auto completion looks smarter but I'm
not a js guru band I tend to keep things simple :-P
I'il give another try to The head tag and see what it leads TO.
Ciao,
R
Il giorno 14/nov/2011 11:51, "Simone Tripodi" <si...@apache.org> ha
scritto:
> Hi again!
>
> > [...] but couldn't get
> > anything to appear into the header or head section (only the footer
> works).
> > I suppose this is related to the work-in-progress version of the fluido
> > skin.
> >
>
> Please try to update the fluido skin to latest snapshot because the DM
> one was still at prototypal status. Moreover, <head/> and <footer/>
> elements have to be declared inside <body/> (even if it sounds a
> little weird) and not <custom/>, have a look at the decoration XSD[1].
>
> Moreover, for the search feature, I suggest you to take a look at how
> the Google guys managed it in Doclava[2] (browse the Guice APIs) that
> looks be faster than the current approach.
>
> HTH, have a nice day!
> Simo
>
> [1] http://maven.apache.org/xsd/decoration-1.1.0.xsd
> [2] http://google-guice.googlecode.com/git/javadoc/packages.html
>
> http://people.apache.org/~simonetripodi/
> http://simonetripodi.livejournal.com/
> http://twitter.com/simonetripodi
> http://www.99soft.org/
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
>
>
Re: Maven Site Indexer plugin
Posted by Simone Tripodi <si...@apache.org>.
Hi again!
> [...] but couldn't get
> anything to appear into the header or head section (only the footer works).
> I suppose this is related to the work-in-progress version of the fluido
> skin.
>
Please try to update the fluido skin to latest snapshot because the DM
one was still at prototypal status. Moreover, <head/> and <footer/>
elements have to be declared inside <body/> (even if it sounds a
little weird) and not <custom/>, have a look at the decoration XSD[1].
Moreover, for the search feature, I suggest you to take a look at how
the Google guys managed it in Doclava[2] (browse the Guice APIs) that
looks be faster than the current approach.
HTH, have a nice day!
Simo
[1] http://maven.apache.org/xsd/decoration-1.1.0.xsd
[2] http://google-guice.googlecode.com/git/javadoc/packages.html
http://people.apache.org/~simonetripodi/
http://simonetripodi.livejournal.com/
http://twitter.com/simonetripodi
http://www.99soft.org/
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: Maven Site Indexer plugin
Posted by "Raffaele P. Guidi" <ra...@gmail.com>.
Hey man, stop preparing pizza without inviting me!!! :D
>> hooking at the "post-site" phase solves the issue of having the html
files rebuilt AFTER the indexing
Calling mvn site-deploy rebuilds the site and modifications made by the
indexer plugin get lost - the search box doesn't appear into the deployed
site. Hooking the indexer into the "post-site" phase should solve this
>> I meant placing the search bar just configuring parameters in the
site.xml in the <custom/> section, see the fluido-skin to see how we did
it, if interested.
Uhm this is the first thing I tried (on the DM site) but couldn't get
anything to appear into the header or head section (only the footer works).
I suppose this is related to the work-in-progress version of the fluido
skin. It is, of course, the way to go and solves the issue at the previous
point as well.
Ciao,
R
On Sat, Nov 12, 2011 at 2:53 PM, Simone Tripodi <si...@apache.org>wrote:
> Hola Raf!!!
> just back from lunching and preparing the pizza for tonight :P
>
> On Sat, Nov 12, 2011 at 11:09 AM, Raffaele P. Guidi
> <ra...@gmail.com> wrote:
> >>> [...] the maven sandbox is open to all ASF committer - so there
> > shouldn't be any issue on moving
> >
> > Always great to feel I'm in the club
> >
>
> great is that you are here!!!
>
> >>> I think you have to submit a SoftwareGrant since it is a
> > software donation to the ASF
> >
> > I think I'll take Oliver advice, here: the github repo was only a place
> to
> > show off the thing and I'm the only contributor. And it's the less
> > work-demanding way ;)
> >
>
> I'm not sure this is the way to go (due to my experience) just to
> avoid any possible misunderstanding I suggest to subscribe to legal@
> and discuss about it tere to clarify any doubt.
>
> >>> About technical PoV, I just have two observations:
> >>> [...] I'd suggest to configure the plugin to be automatically
> executed
> > in the `post-site ` phase
> >
> > Nice hint I was looking at something like this - hooking at the
> "post-site"
> > phase solves the issue of having the html files rebuilt AFTER the
> indexing
> > should disappear as well, right? You solved the first issue ;)
> >
>
> I maybe lost you, didn't understand :) Sorry but during the WE I lost
> my powers :D
>
> >>> * I'd suggest to base the js search engine on a jquery compliant plugin
> > rather than an almost abandoned project
> >
> > I was looking for a javascript search library I wrote myself in 2001 but
> > couldn't find it anymore and found this one, instead, which works well
> > enough and is apache licensed. Switching is pretty easy and I can make it
> > pluggable if needed. I also tried to write the author and the company
> > behind it but with no success, yet - I'll mantain it directly if he
> didn't
> > show up.
> >
> >>> * users should be able to plug the search bar in different location
> >
> > They already are - look at searchbox.html:
> >
> > $(document).ready(function() {
> >> $("#dialog", window.parent.document).css('position', 'fixed');
> >> $("#dialog", window.parent.document).css('top', '10px');
> >> $("#dialog", window.parent.document).css('left', $(window).width()-
> 325
> >> );
> >> });
> >
> >
> > It's actually just a matter of changing top and left values - but all the
> > searchbox is customizable, it resides into site/resource for a reason ;)
> I
> > use jquery and html absolute positioning because I didn't want to tie
> this
> > to a particular skin but, of course, if a skin puts the tags (only one:
> > <iframe src="searchbox.html"> </iframe>) into the page directly where
> > needed things could even get simpler.
> >
>
> I see, but that would require a little work for our users - I meant
> placing the search bar just configuring parameters in the site.xml in
> the <custom/> section, see the fluido-skin to see how we did it, if
> interested.
>
> > I also tried (of course :P) on DirectMemory's site - and it works fine,
> > positioned a bit more on the left and aligned to the incubator logo, but
> I
> > am not able to properly rebuild the site (the black top bar is always
> > missing) - wanna try that for yourself?
> >
>
> no worries, no fault from your side, that is because the skin changed
> a little and elements are now configurable, DM site would require a
> little work configuring skin elements in the site.xml, see [1] and [2]
> :P
>
> > Ciao,
> > R
> >
> >
>
> Have a nice WE!
> Simo
>
> [1] http://people.apache.org/~simonetripodi/fluido/sidebar/
> [2] http://people.apache.org/~simonetripodi/fluido/topbar/
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
>
>
Re: Maven Site Indexer plugin
Posted by Simone Tripodi <si...@apache.org>.
Hola Raf!!!
just back from lunching and preparing the pizza for tonight :P
On Sat, Nov 12, 2011 at 11:09 AM, Raffaele P. Guidi
<ra...@gmail.com> wrote:
>>> [...] the maven sandbox is open to all ASF committer - so there
> shouldn't be any issue on moving
>
> Always great to feel I'm in the club
>
great is that you are here!!!
>>> I think you have to submit a SoftwareGrant since it is a
> software donation to the ASF
>
> I think I'll take Oliver advice, here: the github repo was only a place to
> show off the thing and I'm the only contributor. And it's the less
> work-demanding way ;)
>
I'm not sure this is the way to go (due to my experience) just to
avoid any possible misunderstanding I suggest to subscribe to legal@
and discuss about it tere to clarify any doubt.
>>> About technical PoV, I just have two observations:
>>> [...] I'd suggest to configure the plugin to be automatically executed
> in the `post-site ` phase
>
> Nice hint I was looking at something like this - hooking at the "post-site"
> phase solves the issue of having the html files rebuilt AFTER the indexing
> should disappear as well, right? You solved the first issue ;)
>
I maybe lost you, didn't understand :) Sorry but during the WE I lost
my powers :D
>>> * I'd suggest to base the js search engine on a jquery compliant plugin
> rather than an almost abandoned project
>
> I was looking for a javascript search library I wrote myself in 2001 but
> couldn't find it anymore and found this one, instead, which works well
> enough and is apache licensed. Switching is pretty easy and I can make it
> pluggable if needed. I also tried to write the author and the company
> behind it but with no success, yet - I'll mantain it directly if he didn't
> show up.
>
>>> * users should be able to plug the search bar in different location
>
> They already are - look at searchbox.html:
>
> $(document).ready(function() {
>> $("#dialog", window.parent.document).css('position', 'fixed');
>> $("#dialog", window.parent.document).css('top', '10px');
>> $("#dialog", window.parent.document).css('left', $(window).width()- 325
>> );
>> });
>
>
> It's actually just a matter of changing top and left values - but all the
> searchbox is customizable, it resides into site/resource for a reason ;) I
> use jquery and html absolute positioning because I didn't want to tie this
> to a particular skin but, of course, if a skin puts the tags (only one:
> <iframe src="searchbox.html"> </iframe>) into the page directly where
> needed things could even get simpler.
>
I see, but that would require a little work for our users - I meant
placing the search bar just configuring parameters in the site.xml in
the <custom/> section, see the fluido-skin to see how we did it, if
interested.
> I also tried (of course :P) on DirectMemory's site - and it works fine,
> positioned a bit more on the left and aligned to the incubator logo, but I
> am not able to properly rebuild the site (the black top bar is always
> missing) - wanna try that for yourself?
>
no worries, no fault from your side, that is because the skin changed
a little and elements are now configurable, DM site would require a
little work configuring skin elements in the site.xml, see [1] and [2]
:P
> Ciao,
> R
>
>
Have a nice WE!
Simo
[1] http://people.apache.org/~simonetripodi/fluido/sidebar/
[2] http://people.apache.org/~simonetripodi/fluido/topbar/
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: Maven Site Indexer plugin
Posted by "Raffaele P. Guidi" <ra...@gmail.com>.
>> [...] the maven sandbox is open to all ASF committer - so there
shouldn't be any issue on moving
Always great to feel I'm in the club
>> I think you have to submit a SoftwareGrant since it is a
software donation to the ASF
I think I'll take Oliver advice, here: the github repo was only a place to
show off the thing and I'm the only contributor. And it's the less
work-demanding way ;)
>> About technical PoV, I just have two observations:
>> [...] I'd suggest to configure the plugin to be automatically executed
in the `post-site ` phase
Nice hint I was looking at something like this - hooking at the "post-site"
phase solves the issue of having the html files rebuilt AFTER the indexing
should disappear as well, right? You solved the first issue ;)
>> * I'd suggest to base the js search engine on a jquery compliant plugin
rather than an almost abandoned project
I was looking for a javascript search library I wrote myself in 2001 but
couldn't find it anymore and found this one, instead, which works well
enough and is apache licensed. Switching is pretty easy and I can make it
pluggable if needed. I also tried to write the author and the company
behind it but with no success, yet - I'll mantain it directly if he didn't
show up.
>> * users should be able to plug the search bar in different location
They already are - look at searchbox.html:
$(document).ready(function() {
> $("#dialog", window.parent.document).css('position', 'fixed');
> $("#dialog", window.parent.document).css('top', '10px');
> $("#dialog", window.parent.document).css('left', $(window).width()- 325
> );
> });
It's actually just a matter of changing top and left values - but all the
searchbox is customizable, it resides into site/resource for a reason ;) I
use jquery and html absolute positioning because I didn't want to tie this
to a particular skin but, of course, if a skin puts the tags (only one:
<iframe src="searchbox.html"> </iframe>) into the page directly where
needed things could even get simpler.
I also tried (of course :P) on DirectMemory's site - and it works fine,
positioned a bit more on the left and aligned to the incubator logo, but I
am not able to properly rebuild the site (the black top bar is always
missing) - wanna try that for yourself?
Ciao,
R
On Sat, Nov 12, 2011 at 1:11 AM, Simone Tripodi <si...@apache.org>wrote:
> Hola Raf,
> nice idea and good job! the maven sandbox is open to all ASF committer
> - and you are - so there shouldn't be any issue on moving the code
> under the ASF.
> I think you have to submit a SoftwareGrant since it is a software
> donation to the ASF.
>
> About technical PoV, I just have two observations:
>
> * unless you don't want to index a different directory than the
> produced site, I'd suggest to configure the plugin to be automatically
> executed in the `post-site ` phase;
> * I'd suggest to base the js search engine on a jquery compliant
> plugin rather than an almost abandoned project (activity is tracked as
> `none` on gcode)
>
> Hint (due to my recent experience on the fluido skin)
>
> * users should be able to plug the search bar in different location
>
> keep rockin'!!!
> best,
> Simo
>
> http://people.apache.org/~simonetripodi/
> http://simonetripodi.livejournal.com/
> http://twitter.com/simonetripodi
> http://www.99soft.org/
>
>
>
> On Sat, Nov 12, 2011 at 12:37 AM, Raffaele P. Guidi
> <ra...@apache.org> wrote:
> > Hi, I wrote a small plugin to index and search-enable static maven
> > generated sites using javascript (you can see its self generated site as
> an
> > example at: [1]). It's a pretty simple "and" only search but nevertheless
> > quite effective and I couldn't find anything similar (I notice that even
> in
> > the main maven site the search box is powered by google). I am interested
> > in contributing the code to the maven project (it's already released
> under
> > the apache license and available on github [2]) and improving the
> > integration with the maven site plugin. The plugin leverages js-search
> [3]
> > by theladders.com written by Larry Ogrodnek.
> >
> > Do you think this is of some interest? And, in case, how could we
> proceed?
> >
> > Regards,
> > Raffaele
> >
> > [1] http://raffaeleguidi.github.com/Maven-Site-Indexer-plugin/site/
> > [2] https://github.com/raffaeleguidi/Maven-Site-Indexer-plugin
> > [3] http://code.google.com/p/js-search/
> >
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
>
>
Re: Maven Site Indexer plugin
Posted by Simone Tripodi <si...@apache.org>.
Salut Olivier!
I had a similar experience with commons, they required me to send the
SG for a Sandbox component, even if I was the owner of the original
codebase...
Simo
http://people.apache.org/~simonetripodi/
http://simonetripodi.livejournal.com/
http://twitter.com/simonetripodi
http://www.99soft.org/
On Sat, Nov 12, 2011 at 9:28 AM, Olivier Lamy <ol...@apache.org> wrote:
> Hello,
>
> 2011/11/12 Simone Tripodi <si...@apache.org>:
>> Hola Raf,
>> nice idea and good job! the maven sandbox is open to all ASF committer
> Yes use maven sandbox for that.
> (http://svn.apache.org/repos/asf/maven/sandbox/trunk/plugins/ )
>> - and you are - so there shouldn't be any issue on moving the code
>> under the ASF.
>> I think you have to submit a SoftwareGrant since it is a software
>> donation to the ASF.
> Not sure.
> If Raffaele is the only contributor on his github space.
> As he is an ASF contributor with cla recorded, he can simply add
> necessary license headers in sources and commit that to the sandbox.
>>
>> About technical PoV, I just have two observations:
>>
>> * unless you don't want to index a different directory than the
>> produced site, I'd suggest to configure the plugin to be automatically
>> executed in the `post-site ` phase;
>> * I'd suggest to base the js search engine on a jquery compliant
>> plugin rather than an almost abandoned project (activity is tracked as
>> `none` on gcode)
>>
>> Hint (due to my recent experience on the fluido skin)
>>
>> * users should be able to plug the search bar in different location
>>
>> keep rockin'!!!
>> best,
>> Simo
>>
>> http://people.apache.org/~simonetripodi/
>> http://simonetripodi.livejournal.com/
>> http://twitter.com/simonetripodi
>> http://www.99soft.org/
>>
>>
>>
>> On Sat, Nov 12, 2011 at 12:37 AM, Raffaele P. Guidi
>> <ra...@apache.org> wrote:
>>> Hi, I wrote a small plugin to index and search-enable static maven
>>> generated sites using javascript (you can see its self generated site as an
>>> example at: [1]). It's a pretty simple "and" only search but nevertheless
>>> quite effective and I couldn't find anything similar (I notice that even in
>>> the main maven site the search box is powered by google). I am interested
>>> in contributing the code to the maven project (it's already released under
>>> the apache license and available on github [2]) and improving the
>>> integration with the maven site plugin. The plugin leverages js-search [3]
>>> by theladders.com written by Larry Ogrodnek.
>>>
>>> Do you think this is of some interest? And, in case, how could we proceed?
>>>
>>> Regards,
>>> Raffaele
>>>
>>> [1] http://raffaeleguidi.github.com/Maven-Site-Indexer-plugin/site/
>>> [2] https://github.com/raffaeleguidi/Maven-Site-Indexer-plugin
>>> [3] http://code.google.com/p/js-search/
>>>
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
>> For additional commands, e-mail: dev-help@maven.apache.org
>>
>>
>
>
>
> --
> Olivier Lamy
> Talend: http://coders.talend.com
> http://twitter.com/olamy | http://linkedin.com/in/olamy
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: Maven Site Indexer plugin
Posted by Olivier Lamy <ol...@apache.org>.
Hello,
2011/11/12 Simone Tripodi <si...@apache.org>:
> Hola Raf,
> nice idea and good job! the maven sandbox is open to all ASF committer
Yes use maven sandbox for that.
(http://svn.apache.org/repos/asf/maven/sandbox/trunk/plugins/ )
> - and you are - so there shouldn't be any issue on moving the code
> under the ASF.
> I think you have to submit a SoftwareGrant since it is a software
> donation to the ASF.
Not sure.
If Raffaele is the only contributor on his github space.
As he is an ASF contributor with cla recorded, he can simply add
necessary license headers in sources and commit that to the sandbox.
>
> About technical PoV, I just have two observations:
>
> * unless you don't want to index a different directory than the
> produced site, I'd suggest to configure the plugin to be automatically
> executed in the `post-site ` phase;
> * I'd suggest to base the js search engine on a jquery compliant
> plugin rather than an almost abandoned project (activity is tracked as
> `none` on gcode)
>
> Hint (due to my recent experience on the fluido skin)
>
> * users should be able to plug the search bar in different location
>
> keep rockin'!!!
> best,
> Simo
>
> http://people.apache.org/~simonetripodi/
> http://simonetripodi.livejournal.com/
> http://twitter.com/simonetripodi
> http://www.99soft.org/
>
>
>
> On Sat, Nov 12, 2011 at 12:37 AM, Raffaele P. Guidi
> <ra...@apache.org> wrote:
>> Hi, I wrote a small plugin to index and search-enable static maven
>> generated sites using javascript (you can see its self generated site as an
>> example at: [1]). It's a pretty simple "and" only search but nevertheless
>> quite effective and I couldn't find anything similar (I notice that even in
>> the main maven site the search box is powered by google). I am interested
>> in contributing the code to the maven project (it's already released under
>> the apache license and available on github [2]) and improving the
>> integration with the maven site plugin. The plugin leverages js-search [3]
>> by theladders.com written by Larry Ogrodnek.
>>
>> Do you think this is of some interest? And, in case, how could we proceed?
>>
>> Regards,
>> Raffaele
>>
>> [1] http://raffaeleguidi.github.com/Maven-Site-Indexer-plugin/site/
>> [2] https://github.com/raffaeleguidi/Maven-Site-Indexer-plugin
>> [3] http://code.google.com/p/js-search/
>>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
>
>
--
Olivier Lamy
Talend: http://coders.talend.com
http://twitter.com/olamy | http://linkedin.com/in/olamy
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: Maven Site Indexer plugin
Posted by Simone Tripodi <si...@apache.org>.
Hola Raf,
nice idea and good job! the maven sandbox is open to all ASF committer
- and you are - so there shouldn't be any issue on moving the code
under the ASF.
I think you have to submit a SoftwareGrant since it is a software
donation to the ASF.
About technical PoV, I just have two observations:
* unless you don't want to index a different directory than the
produced site, I'd suggest to configure the plugin to be automatically
executed in the `post-site ` phase;
* I'd suggest to base the js search engine on a jquery compliant
plugin rather than an almost abandoned project (activity is tracked as
`none` on gcode)
Hint (due to my recent experience on the fluido skin)
* users should be able to plug the search bar in different location
keep rockin'!!!
best,
Simo
http://people.apache.org/~simonetripodi/
http://simonetripodi.livejournal.com/
http://twitter.com/simonetripodi
http://www.99soft.org/
On Sat, Nov 12, 2011 at 12:37 AM, Raffaele P. Guidi
<ra...@apache.org> wrote:
> Hi, I wrote a small plugin to index and search-enable static maven
> generated sites using javascript (you can see its self generated site as an
> example at: [1]). It's a pretty simple "and" only search but nevertheless
> quite effective and I couldn't find anything similar (I notice that even in
> the main maven site the search box is powered by google). I am interested
> in contributing the code to the maven project (it's already released under
> the apache license and available on github [2]) and improving the
> integration with the maven site plugin. The plugin leverages js-search [3]
> by theladders.com written by Larry Ogrodnek.
>
> Do you think this is of some interest? And, in case, how could we proceed?
>
> Regards,
> Raffaele
>
> [1] http://raffaeleguidi.github.com/Maven-Site-Indexer-plugin/site/
> [2] https://github.com/raffaeleguidi/Maven-Site-Indexer-plugin
> [3] http://code.google.com/p/js-search/
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Maven Site Indexer plugin
Posted by "Raffaele P. Guidi" <ra...@apache.org>.
Hi, I wrote a small plugin to index and search-enable static maven
generated sites using javascript (you can see its self generated site as an
example at: [1]). It's a pretty simple "and" only search but nevertheless
quite effective and I couldn't find anything similar (I notice that even in
the main maven site the search box is powered by google). I am interested
in contributing the code to the maven project (it's already released under
the apache license and available on github [2]) and improving the
integration with the maven site plugin. The plugin leverages js-search [3]
by theladders.com written by Larry Ogrodnek.
Do you think this is of some interest? And, in case, how could we proceed?
Regards,
Raffaele
[1] http://raffaeleguidi.github.com/Maven-Site-Indexer-plugin/site/
[2] https://github.com/raffaeleguidi/Maven-Site-Indexer-plugin
[3] http://code.google.com/p/js-search/