RE: Site/Multiproject plugins
Hey dIon, I've just done a clean build from HEAD (~10am EST 2003-07-23) and things work fine if I use: projectA | +-xdocs / navigation.xml [1] | +-multiproject / navigation.xml [2] | +-projectB ... where navigation.xml looks like [1] (Hardcoded) ... [2] ... #foreach ($reactorProject in $reactorProjects) #end But when I move multiproject/navigation.xml[2] to xdocs/navigation.xml, the build succeeds but the velocity script doesn't get interpreted. I also tried leaving [2] in both directories with the same result. I'm happy to leave it the way it is (it works, thanks Andy!), but would like to make sure that I don't misunderstand how it's supposed to be used. Is the intended usage now for the velocity-scripted version[2] to simply be placed in xdocs/navigation.xml? Is the multiproject/navigation.xml still required? Thanks for the plugin and any (more) info! Matt -Original Message- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] Sent: Tuesday, July 22, 2003 9:47 PM To: Maven Users List Subject: RE: Site/Multiproject plugins I've recently fixed this, so that what was previously in multiproject/navigation.xml is now in xdocs/navigation.xml. Let me know if u need a sample -- dIon Gillard, Multitask Consulting Blog: http://blogs.codehaus.org/people/dion/ "Lipper, Matthew" <[EMAIL PROTECTED]> wrote on 23/07/2003 03:33:46 AM: > Gotcha. Thanks! > > -Original Message- > From: Andy Jefferson [mailto:[EMAIL PROTECTED] > Sent: Tuesday, July 22, 2003 1:09 PM > To: Maven Users List > Subject: RE: Site/Multiproject plugins > > > Hi Matthew, > > > So, in other words, for the top-level project remove > > "multiproject/navigation.xml" and place it in "xdocs/navigation.xml" > > hardcoded with generated sub-project URLs...ahh, right! > > No, you need BOTH navigation.xml files. The multiproject one is added to > the index.html page, the xdocs ones is added to any pages that you have > yourself. > > To see the end-result on a site, go to > http://www.ajsoft.net/Products/WebShop/ > All pages have a "Projects" section in the side menu, with associated > projects under that heading. > > > -- > Andy > > - > To unsubscribe, e-mail: [EMAIL PROTECTED] > For additional commands, e-mail: [EMAIL PROTECTED] > > - > To unsubscribe, e-mail: [EMAIL PROTECTED] > For additional commands, e-mail: [EMAIL PROTECTED] > - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: Site/Multiproject plugins
This has been fixed in CVS a day or two ago.
--
dIon Gillard, Multitask Consulting
Blog: http://blogs.codehaus.org/people/dion/
"Lipper, Matthew" <[EMAIL PROTECTED]> wrote on 23/07/2003 01:54:43 AM:
> I was wondering whether there was any follow-up to the recently posted:
>
> http://www.mail-archive.com/[EMAIL PROTECTED]/msg01701.html
>
> specifically, I was interested in the resolution of
>
>
> The other issue is that, while (with the use of
multiproject/navigation.xml)
> it will generate the index.html with this extra navigation, it doesn't
apply
> it to my own xdocs in the top-level project (instead it uses
> xdocs/navigation.xml, which doesn't have the Projects menu section).
>
>
> I'm having the same problem. I've tried modifying
> multiproject/navigation.xml (as mentioned above) . I took a peek at
> multiproject plugin.jelly, and it seems that the navigation is created
with
> the following:
>
>
>name="${maven.gen.docs}/navigation.xml"
> basedir="${plugin.resources}/templates"
> template="navigation-${navType}.xml"/>
>
> and a little further down:
>
>
>
> Anyway, if this issue has not been resolved (I could not find MAVEN-586
> JIRA?), could someone recommend a good starting point short of modifying
> MAVEN_HOME/plugins/multiproject/templates/*navigation.xml?
>
>
> Thanks,
>
> Matt
>
>
>
>
>
>
> -
> To unsubscribe, e-mail: [EMAIL PROTECTED]
> For additional commands, e-mail: [EMAIL PROTECTED]
>
RE: Site/Multiproject plugins
I've recently fixed this, so that what was previously in multiproject/navigation.xml is now in xdocs/navigation.xml. Let me know if u need a sample -- dIon Gillard, Multitask Consulting Blog: http://blogs.codehaus.org/people/dion/ "Lipper, Matthew" <[EMAIL PROTECTED]> wrote on 23/07/2003 03:33:46 AM: > Gotcha. Thanks! > > -Original Message- > From: Andy Jefferson [mailto:[EMAIL PROTECTED] > Sent: Tuesday, July 22, 2003 1:09 PM > To: Maven Users List > Subject: RE: Site/Multiproject plugins > > > Hi Matthew, > > > So, in other words, for the top-level project remove > > "multiproject/navigation.xml" and place it in "xdocs/navigation.xml" > > hardcoded with generated sub-project URLs...ahh, right! > > No, you need BOTH navigation.xml files. The multiproject one is added to > the index.html page, the xdocs ones is added to any pages that you have > yourself. > > To see the end-result on a site, go to > http://www.ajsoft.net/Products/WebShop/ > All pages have a "Projects" section in the side menu, with associated > projects under that heading. > > > -- > Andy > > - > To unsubscribe, e-mail: [EMAIL PROTECTED] > For additional commands, e-mail: [EMAIL PROTECTED] > > - > To unsubscribe, e-mail: [EMAIL PROTECTED] > For additional commands, e-mail: [EMAIL PROTECTED] >
RE: Site/Multiproject plugins
Gotcha. Thanks! -Original Message- From: Andy Jefferson [mailto:[EMAIL PROTECTED] Sent: Tuesday, July 22, 2003 1:09 PM To: Maven Users List Subject: RE: Site/Multiproject plugins Hi Matthew, > So, in other words, for the top-level project remove > "multiproject/navigation.xml" and place it in "xdocs/navigation.xml" > hardcoded with generated sub-project URLs...ahh, right! No, you need BOTH navigation.xml files. The multiproject one is added to the index.html page, the xdocs ones is added to any pages that you have yourself. To see the end-result on a site, go to http://www.ajsoft.net/Products/WebShop/ All pages have a "Projects" section in the side menu, with associated projects under that heading. -- Andy - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
RE: Site/Multiproject plugins
Hi Matthew, > So, in other words, for the top-level project remove > "multiproject/navigation.xml" and place it in "xdocs/navigation.xml" > hardcoded with generated sub-project URLs...ahh, right! No, you need BOTH navigation.xml files. The multiproject one is added to the index.html page, the xdocs ones is added to any pages that you have yourself. To see the end-result on a site, go to http://www.ajsoft.net/Products/WebShop/ All pages have a "Projects" section in the side menu, with associated projects under that heading. -- Andy - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
RE: Site/Multiproject plugins
Hey Andy, So, in other words, for the top-level project remove "multiproject/navigation.xml" and place it in "xdocs/navigation.xml" hardcoded with generated sub-project URLs...ahh, right! Thanks for the tip! Matt -Original Message- From: Andy Jefferson [mailto:[EMAIL PROTECTED] Sent: Tuesday, July 22, 2003 12:32 PM To: Maven Users List Subject: Re: Site/Multiproject plugins On Tue, 2003-07-22 at 16:54, Lipper, Matthew wrote: > I was wondering whether there was any follow-up to the recently posted: > > http://www.mail-archive.com/[EMAIL PROTECTED]/msg01701.html > > specifically, I was interested in the resolution of > > > The other issue is that, while (with the use of multiproject/navigation.xml) > it will generate the index.html with this extra navigation, it doesn't apply > it to my own xdocs in the top-level project (instead it uses > xdocs/navigation.xml, which doesn't have the Projects menu section). > > > I'm having the same problem. I've tried modifying > multiproject/navigation.xml (as mentioned above). I added the following to my xdocs/navigation.xml This results in your own docs for your main project getting this navigation added, so you can navigate to your subprojects from the main project level. The multiproject/navigation.xml is added to index.html only. Its only a workaround to the problem and not a fix ... we need Maven to do it automatically. > Anyway, if this issue has not been resolved (I could not find MAVEN-586 > JIRA?), could someone recommend a good starting point short of modifying > MAVEN_HOME/plugins/multiproject/templates/*navigation.xml? You can find the raised issue here ... http://jira.codehaus.org/secure/ViewIssue.jspa?key=MAVEN-586 -- Andy - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: Site/Multiproject plugins
On Tue, 2003-07-22 at 16:54, Lipper, Matthew wrote: > I was wondering whether there was any follow-up to the recently posted: > > http://www.mail-archive.com/[EMAIL PROTECTED]/msg01701.html > > specifically, I was interested in the resolution of > > > The other issue is that, while (with the use of multiproject/navigation.xml) > it will generate the index.html with this extra navigation, it doesn't apply > it to my own xdocs in the top-level project (instead it uses > xdocs/navigation.xml, which doesn't have the Projects menu section). > > > I'm having the same problem. I've tried modifying > multiproject/navigation.xml (as mentioned above). I added the following to my xdocs/navigation.xml This results in your own docs for your main project getting this navigation added, so you can navigate to your subprojects from the main project level. The multiproject/navigation.xml is added to index.html only. Its only a workaround to the problem and not a fix ... we need Maven to do it automatically. > Anyway, if this issue has not been resolved (I could not find MAVEN-586 > JIRA?), could someone recommend a good starting point short of modifying > MAVEN_HOME/plugins/multiproject/templates/*navigation.xml? You can find the raised issue here ... http://jira.codehaus.org/secure/ViewIssue.jspa?key=MAVEN-586 -- Andy - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: Site/Multiproject plugins
I was wondering whether there was any follow-up to the recently posted: http://www.mail-archive.com/[EMAIL PROTECTED]/msg01701.html specifically, I was interested in the resolution of The other issue is that, while (with the use of multiproject/navigation.xml) it will generate the index.html with this extra navigation, it doesn't apply it to my own xdocs in the top-level project (instead it uses xdocs/navigation.xml, which doesn't have the Projects menu section). I'm having the same problem. I've tried modifying multiproject/navigation.xml (as mentioned above) . I took a peek at multiproject plugin.jelly, and it seems that the navigation is created with the following: and a little further down: Anyway, if this issue has not been resolved (I could not find MAVEN-586 JIRA?), could someone recommend a good starting point short of modifying MAVEN_HOME/plugins/multiproject/templates/*navigation.xml? Thanks, Matt - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
Re: Site/Multiproject plugins
Thanks for your reply ... very useful.
On Sun, 2003-07-20 at 08:00, Rafal Krzewski wrote:
> The plugin is able to generate links for you, but the usage of this
> feature is not really straightforward ATM. You have two options
>
> 1) If you don't have any custom xdocs in your top level project delete
> the navigation.xml file - you'll get one containting 'Projects' menu
> with linkst to the subprojects, and well known 'Project docmentation'
> for the top level project.
>
> 2) If you have the xdocs in the top level project you must provide a
> velocity template for generating the navigation with subproject links.
> You need to grab one of the files from
> http://cvs.apache.org/viewcvs/maven/src/plugins-build/multiproject/src/plugin-resources/templates/
> and fill them in with your custom links. You need to put your copy into
> the ${basedir}/multiproject/navigation.xml location. I personally think
> it should better be ${basedir}/xdocs/multiproject-navigation.xml, I'm
> going to file an issue for that.
Yes, this works for me (but see below also). I'd also agree with the
naming of the navigation.xml file ... having a separate directory
doesn't make sense - keep the website definition documents in a single
place.
> I've never used xdoclet but I think it's a major issue for anyone who
> is. Consider filing a bug report. As a stop-gap solution you should be
> able to fix it in your maven.xml with a tag.
Added to JIRA as MAVEN-586
> > c). How do I get anything to appear under the "Project Info"->"Issue
> > Tracking" link ? Is there a section in project.xml for this ? (couldnt
> > find one).
>
>
> the url
>
Yep. I'm blind ... I had that tag in my project.xml but couldn't see it
:-)
> > [e. had to omit the main project from the multiproject generation
> > because of the bug spotted by Rafal Krzewski. - will be perfect when we
> > can enable this again, because at the moment it is ignoring generating
> > my own documentation for the top-level project].
>
> Your documentation is processed. The issue was showing up if you told
> maven to process it twice: as the super project, and one of the sub
> projects at the same time. Just look into target/docs and find the
> generated .html files. The problem is that links to the won't show up
> unless you provide ${basedir}/multiproject/navigation.xml file (see
> above).
The other issue is that, while (with the use of
multiproject/navigation.xml) it will generate the index.html with this
extra navigation, it doesn't apply it to my own xdocs in the top-level
project (instead it uses xdocs/navigation.xml, which doesn't have the
Projects menu section). I'll have to have a more detailed look at this
because generated-xdocs/navigation.xml is the multiproject version. I'll
try to workaround it.
> I have another idea for solving the issue of navigation generation.
> Multiproject plugin could add a tag to the
> navigation.xml schema. The menu would be written to
> target/generated-xdocs/subprojects-menu.xml and itegrated in the proper
> place by the site's stylesheet in the xdoc plugin. I think this would
> be a much cleaner solution that what we have now. I'll look into
> implementing this, but I'll need to learn more about manipulating
> xml/DOM under jelly so this will take some time, unless someone more
> experienced steps in to help.
That would better modularise the sub-project part, and make it more
amenable to adding. It would be nice if we had that for the "Project
Documentation" section also in the long run, allowing people to position
these 2 sections of navigation where they want in their navigation.xml
by putting a reference in there ...
e.g
...
...
Good to see we're agreeing on the direction this ought to go in.
--
Andy
-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
Re: Site/Multiproject plugins
Andy Jefferson wrote:
The plugin-generated main project pages automatically gets links down to
the sub-projects via the multiproject plugin, showing the sub-projects
in the side navigation bar. This menu above adds links back from the
sub-projects to the main in the side navigation bar (would be nice for
the multiproject to add this itself in a future release)
The plugin is able to generate links for you, but the usage of this
feature is not really straightforward ATM. You have two options
1) If you don't have any custom xdocs in your top level project delete
the navigation.xml file - you'll get one containting 'Projects' menu
with linkst to the subprojects, and well known 'Project docmentation'
for the top level project.
2) If you have the xdocs in the top level project you must provide a
velocity template for generating the navigation with subproject links.
You need to grab one of the files from
http://cvs.apache.org/viewcvs/maven/src/plugins-build/multiproject/src/plugin-resources/templates/
and fill them in with your custom links. You need to put your copy into
the ${basedir}/multiproject/navigation.xml location. I personally think
it should better be ${basedir}/xdocs/multiproject-navigation.xml, I'm
going to file an issue for that.
a). Personally I think that in the multiproject plugin, it would be
better to use project 'id' rather than 'name' in the generation of
directories under "docs/multiproject". The 'name' can be much longer,
whereas the id will be more concise and less likely to change - so for
example in my example above I could have just put 'App' instead of 'The
Application'.
See http://jira.codehaus.org/secure/ViewIssue.jspa?id=11325
b). The generation of the site seems to have changed in beta 10 (note
definite on this), but if i run a "maven site:generate" it does the
compile AFTER the javadoc. The only problem here is that I use xdoclet
to generate a series of interface classes, and hence these don't make
their way into the Javadoc since they are generated after the javadoc
(and hence javadoc complains about all sorts of missing classes). Seems
logical to change this so that it does a compile first of all ... any
problems with doing this ?
I've never used xdoclet but I think it's a major issue for anyone who
is. Consider filing a bug report. As a stop-gap solution you should be
able to fix it in your maven.xml with a tag.
c). How do I get anything to appear under the "Project Info"->"Issue
Tracking" link ? Is there a section in project.xml for this ? (couldnt
find one).
the url
d). Can I get rid of the "Development Process" link ? (I can change the
URL I know, but I want to remove it totally :-)).
I see you've filed a bug for that. If noone picks it up, I'd recommend
approaching Ben or d'Ion personally - they have a lot of experience with
site generation stuff.
[e. had to omit the main project from the multiproject generation
because of the bug spotted by Rafal Krzewski. - will be perfect when we
can enable this again, because at the moment it is ignoring generating
my own documentation for the top-level project].
Your documentation is processed. The issue was showing up if you told
maven to process it twice: as the super project, and one of the sub
projects at the same time. Just look into target/docs and find the
generated .html files. The problem is that links to the won't show up
unless you provide ${basedir}/multiproject/navigation.xml file (see
above).
I have another idea for solving the issue of navigation generation.
Multiproject plugin could add a tag to the
navigation.xml schema. The menu would be written to
target/generated-xdocs/subprojects-menu.xml and itegrated in the proper
place by the site's stylesheet in the xdoc plugin. I think this would
be a much cleaner solution that what we have now. I'll look into
implementing this, but I'll need to learn more about manipulating
xml/DOM under jelly so this will take some time, unless someone more
experienced steps in to help.
R.
-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
Site/Multiproject plugins
Hi, I'm in the depths of generating a site for a hierarchy of projects and have come across some issues. For the benefit of anyone trying something similar and for background info, what I have done is main main/Beans main/Beans/xdocs main/Beans/xdocs/navigation.xml main/App/ main/App/xdocs main/App/xdocs/navigation.xml main/xdocs main/xdocs/navigation.xml In the 2 sub-projects I have added a menu of the form The plugin-generated main project pages automatically gets links down to the sub-projects via the multiproject plugin, showing the sub-projects in the side navigation bar. This menu above adds links back from the sub-projects to the main in the side navigation bar (would be nice for the multiproject to add this itself in a future release) a). Personally I think that in the multiproject plugin, it would be better to use project 'id' rather than 'name' in the generation of directories under "docs/multiproject". The 'name' can be much longer, whereas the id will be more concise and less likely to change - so for example in my example above I could have just put 'App' instead of 'The Application'. b). The generation of the site seems to have changed in beta 10 (note definite on this), but if i run a "maven site:generate" it does the compile AFTER the javadoc. The only problem here is that I use xdoclet to generate a series of interface classes, and hence these don't make their way into the Javadoc since they are generated after the javadoc (and hence javadoc complains about all sorts of missing classes). Seems logical to change this so that it does a compile first of all ... any problems with doing this ? c). How do I get anything to appear under the "Project Info"->"Issue Tracking" link ? Is there a section in project.xml for this ? (couldnt find one). d). Can I get rid of the "Development Process" link ? (I can change the URL I know, but I want to remove it totally :-)). [e. had to omit the main project from the multiproject generation because of the bug spotted by Rafal Krzewski. - will be perfect when we can enable this again, because at the moment it is ignoring generating my own documentation for the top-level project]. TIA -- Andy - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
