Maven 2.x Plugin Tools

Upgrading to Maven Site 2.1 messes up plugin site generation

Details

  • Type: Bug Bug
  • Status: Closed Closed
  • Priority: Major Major
  • Resolution: Fixed
  • Affects Version/s: 2.5.1
  • Fix Version/s: 2.7
  • Component/s: API
  • Labels:
    None
  • Number of attachments :
    6

Description

If I upgrade my site plugin to 2.1 then my plugin sites get all messed up. Two problems I noted in particular include:

1. The Report links aren't rendered at all on the left side of the screen.
2. The plugin goal detail page layout is messed up. headers don't align with backgrounds for headers.

Attachments

  1. HTML File
    deployable-mojo.html
    11/Jan/10 11:57 AM
    8 kB
    Mike Youngstrom
  2. File
    FF-MPLUGIN-165.bmp
    24/Dec/10 12:59 PM
    847 kB
    Robert Scholte
  3. File
    IE-MPLUGIN-165.bmp
    24/Dec/10 12:59 PM
    841 kB
    Robert Scholte
  4. Text File
    MPLUGIN-165.patch
    24/Dec/10 12:59 PM
    0.6 kB
    Robert Scholte
  1. maven.png
    31 kB
    09/Jul/10 3:40 AM
  2. plugin-report.jpg
    178 kB
    11/Jan/10 11:57 AM

Issue Links

This issue is duplicated by:
MSITE-538 html issues in maven plugin goal report Major Closed
This issue depends upon:
MPLUGIN-120 Update to Doxia 1.2 Major Closed
This issue is depended upon by:
MOJO-1617 Update m-plugin-p to fix issue with mojo detail report Major Closed

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Dennis Lundberg added a comment -

1. Sounds like MSITE-456

2. Can you attach a screenshot? It's much easier to understand when you have a picture to look at.

Show
Dennis Lundberg added a comment - 1. Sounds like MSITE-456 2. Can you attach a screenshot? It's much easier to understand when you have a picture to look at.
Hide
Permalink
Mike Youngstrom added a comment -

I've attached a screen shot and the source for the file. The problem appears to be caused by a border="0" and align="left" that is added to the table. For some reason that code only shows up when I upgrade site to 2.1. As soon as I downgrade site to 2.0.1 that code on the table disappears and everything looks great.

Show
Mike Youngstrom added a comment - I've attached a screen shot and the source for the file. The problem appears to be caused by a border="0" and align="left" that is added to the table. For some reason that code only shows up when I upgrade site to 2.1. As soon as I downgrade site to 2.0.1 that code on the table disappears and everything looks great.
Hide
Permalink
Dennis Lundberg added a comment -

This should be fixed in Site Plugin 2.1.1-SNAPSHOT. Can you verify that?

Show
Dennis Lundberg added a comment - This should be fixed in Site Plugin 2.1.1-SNAPSHOT. Can you verify that?
Hide
Permalink
Anton Kronseder added a comment -

Just tried it with maven-site-plugin 2.2-SNAPSHOT: this error still exists.

The maven-plugin-plugin creates the page source with table align="left" as to
org.apache.maven.tools.plugin.generator.PluginXdocGenerator line 665 of maven-plugin-tools-api project,
but the maven-site-plugin <= 2.0.1 does not copy this (align="left") to the .html files in target/site.

Using maven-site-plugin >= 2.1 up to 2.2-SNAPSHOT maven site seems to handle the source-files containing the align="left" different and copies this to the output .html files.

This leads to the missing space between the table and the following h3 (contained in the section div).
(see the Image and the missing space between "Optional Parameters" and the table of "Required Parameters").

Show
Anton Kronseder added a comment - Just tried it with maven-site-plugin 2.2-SNAPSHOT: this error still exists. The maven-plugin-plugin creates the page source with table align="left" as to org.apache.maven.tools.plugin.generator.PluginXdocGenerator line 665 of maven-plugin-tools-api project, but the maven-site-plugin <= 2.0.1 does not copy this (align="left") to the .html files in target/site. Using maven-site-plugin >= 2.1 up to 2.2-SNAPSHOT maven site seems to handle the source-files containing the align="left" different and copies this to the output .html files. This leads to the missing space between the table and the following h3 (contained in the section div). (see the Image and the missing space between "Optional Parameters" and the table of "Required Parameters").
Hide
Permalink
Dennis Lundberg added a comment -

Anton, you should be using maven-site-plugin 2.1.1 - nothing else.
That version uses Doxia 1.1.3 which includes solutions for DOXIA-374 and DOXIA-385. I think these two issues are exactly what you are seeing.

Show
Dennis Lundberg added a comment - Anton, you should be using maven-site-plugin 2.1.1 - nothing else. That version uses Doxia 1.1.3 which includes solutions for DOXIA-374 and DOXIA-385. I think these two issues are exactly what you are seeing.
Hide
Permalink
Anton Kronseder added a comment - - edited

Dennis, I am using maven-site-plugin 2.1.1, only tried it with other versions for my comment here.
Unfortunately it still does not work (see screenshot maven.png).
The HTML-Source still has a align=left in the table tag and that conflicts with the maven skins (I tried them all). Moreover I tried to fix it using some css from within our maven skin, but that did not work either.

Show
Anton Kronseder added a comment - - edited Dennis, I am using maven-site-plugin 2.1.1, only tried it with other versions for my comment here. Unfortunately it still does not work (see screenshot maven.png). The HTML-Source still has a align=left in the table tag and that conflicts with the maven skins (I tried them all). Moreover I tried to fix it using some css from within our maven skin, but that did not work either.
Hide
Permalink
Anton Kronseder added a comment -

Show
Anton Kronseder added a comment -
Hide
Permalink
Robert Scholte added a comment -

I've compared the exec:help and sonar:help plugin pages. The exec renders correct, sonar's doesn't anymore.
The problem seems to be that in the original page the following fragment is used:

<div class="section"><h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
 <table class="bodyTable"><tr class="a"><th>Name</th>
 </table>
</div>

In the new style some attributes have been added, which cause these problems, especially the align=left

<div class="section"><h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
 <table class="bodyTable" border="0" align="left">
 </table>
</div>
Show
Robert Scholte added a comment - I've compared the exec:help and sonar:help plugin pages. The exec renders correct, sonar's doesn't anymore. The problem seems to be that in the original page the following fragment is used: 
<div class="section"><h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
 <table class="bodyTable"><tr class="a"><th>Name</th>
 </table>
</div>
In the new style some attributes have been added, which cause these problems, especially the align=left 
<div class="section"><h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
 <table class="bodyTable" border="0" align="left">
 </table>
</div>
Hide
Permalink
Robert Scholte added a comment -

Seems to be related to MPLUGIN-74, was modified (fixed??) in rev.629251

----------------------------------------------------------------------------
r629251 | dennisl | 2008-02-19 23:22:37 CET

MPLUGIN-74 Explicitly control layout of tables generated for parameters of mojo description
Submitted by: Benjamin Bentmann
Reviewed by: Dennis Lundberg
----------------------------------------------------------------------------

Show
Robert Scholte added a comment - Seems to be related to MPLUGIN-74, was modified (fixed??) in rev.629251 ---------------------------------------------------------------------------- r629251 | dennisl | 2008-02-19 23:22:37 CET MPLUGIN-74 Explicitly control layout of tables generated for parameters of mojo description Submitted by: Benjamin Bentmann Reviewed by: Dennis Lundberg ----------------------------------------------------------------------------
Hide
Permalink
Robert Scholte added a comment -

Attached two examples of how plugin detail pages were rendered (IE + FF).
Also a patch which removes the align=left. This will place the tables back under each other.

Show
Robert Scholte added a comment - Attached two examples of how plugin detail pages were rendered (IE + FF). Also a patch which removes the align=left. This will place the tables back under each other.
Hide
Permalink
Anders Hammar added a comment -

The plugin detail page issue is quite annoying, I think. Having very little Doxia knowledge, I don't understand how this issue depends on an upgrade to Doxia 1.1 (MPLUGIN-120). If the current impl (from MPLUGIN-74?) is desired but requires Doxia 1.1, could a short-term fix be to apply Robert's patch? And then revert when the Doxia upgrade is in place?

Show
Anders Hammar added a comment - The plugin detail page issue is quite annoying, I think. Having very little Doxia knowledge, I don't understand how this issue depends on an upgrade to Doxia 1.1 (MPLUGIN-120). If the current impl (from MPLUGIN-74?) is desired but requires Doxia 1.1, could a short-term fix be to apply Robert's patch? And then revert when the Doxia upgrade is in place?
Hide
Permalink
Dennis Lundberg added a comment -

Fixed in r1057355.
2.7-SNAPSHOT deployed, please test.

Show
Dennis Lundberg added a comment - Fixed in r1057355. 2.7-SNAPSHOT deployed, please test.
Hide
Permalink
Anders Hammar added a comment -

Yes, the goal detail page now looks good. Thanks!

Show
Anders Hammar added a comment - Yes, the goal detail page now looks good. Thanks!

People

Vote (4)
Watch (4)

Dates

  • Created:
    Updated:
    Resolved:
Atlassian JIRA (v4.4.3#663-r165197) | Report a problem
Powered by a free Atlassian JIRA open source license for Codehaus. Try JIRA - bug tracking software for your team.