Maven 1.x XDoc Plugin

major improvements to the xdoc plugin

Details

  • Type: Improvement Improvement
  • Status: Closed Closed
  • Priority: Major Major
  • Resolution: Fixed
  • Affects Version/s: None
  • Fix Version/s: None
  • Labels:
    None
  • Number of attachments :
    5

Description

this patch contains multiple fixes/improvements for the xdoc plugin:

1) generated site is valid tableless XHTML with a fully css layout. This allows user to create totally different look and feel customizing the site css file. For example the navigation bar can be floated, put on the right, etc. Base css has been updated with a slightly different look and feel. Print css is also updated ( MPXDOC-75 )

2) Html elements are now used properly: link lists are <ul>, titles are <h1>, <h2>, etc. This improve accessibility making the site readable also without css or using altenative browsers (screen readers, smart phones without css support...).

3) invalid html produced for sections "name" elements is now fixed, escaping unvalid chars (replaced by "_"). Hrefs for local links (starting with "#") are fixed accordingly during transformation.

4) whitespace in output has been dramatically reduced (only preserved in sensitive elements such as <pre>, <script>, <style>) (also fixes MPXDOC-12 )

5) fixes layout during loading in internet explorer: actually empty images in the nav bar are popping up with the default blue border and text is initially unstyled. No empty images are used anymore ("handles" for nav bar are created using css)

6) this also apply an update version of MAVEN-853: add a doc:jslToSite tag which allows to transform individual file without having to call doc:performJSL on the whole site or setting a bunch of xdoc plugin internal variables. Test cases are added too. (also fixes MPXDOC-68 )

7) xdoc:copy-user-resources also copies resource from maven.gen.docs and not only from maven.docs.src: this allows for reporting plugin to generate images without copying them directly to maven.docs.dest

8) users can add links after the standard project info/project reports section setting the "type" attribute to "footer" for the menu element ($nav/body/menu[@type='footer'])

9) development process URL is not included if maven.xdoc.developmentProcessUrl is empty (fixes MPXDOC-70 )

10) xhtml fix: missing "alt" attribute for images (required in xhtml) is added automatically

I'm attaching an universal diff as well as a zip with all the modified files.

  1. File
    xdoc-patch.diff
    25/Jan/04 5:04 PM
    41 kB
    fabrizio giustina
  3. File
    xdoc-patch-updated.diff
    29/Jan/04 5:26 PM
    45 kB
    fabrizio giustina
  1. IE_screenshot.png
    2 kB
    30/Jan/04 5:37 AM

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
fabrizio giustina added a comment -

universal dill

Show
fabrizio giustina added a comment - universal dill
Hide
Permalink
fabrizio giustina added a comment -

changed files (if you have any problem in applaying the patch)

Show
fabrizio giustina added a comment - changed files (if you have any problem in applaying the patch)
Hide
Permalink
fabrizio giustina added a comment -

updated diff.
Also fixes the followings:

  • html errors in team-list template
  • fxed generated html for <goal> section: the <description> element was included in the html output (nstead of including only the content).

Please use this updated patch instead of the previous

Show
fabrizio giustina added a comment - updated diff. Also fixes the followings: html errors in team-list template fxed generated html for <goal> section: the <description> element was included in the html output (nstead of including only the content). Please use this updated patch instead of the previous
Hide
Permalink
fabrizio giustina added a comment -

zip containing the full files for the patch (only needed if you have problem with the diff)

Show
fabrizio giustina added a comment - zip containing the full files for the patch (only needed if you have problem with the diff)
Hide
Permalink
dion gillard added a comment -

When I apply this patch and run maven site on the maven source code,

  • the 'links bar' underneath the header is up in the header
  • the header has a grey background
  • the project nav bar has a dotted border rather than a solid one.

but only in mozilla. internet explorer looks reasonable.

See http://cvs.apache.org/~dion/maven.apache.org/index.html for a live example.

Show
dion gillard added a comment - When I apply this patch and run maven site on the maven source code, the 'links bar' underneath the header is up in the header the header has a grey background the project nav bar has a dotted border rather than a solid one. but only in mozilla. internet explorer looks reasonable. See http://cvs.apache.org/~dion/maven.apache.org/index.html for a live example.
Hide
Permalink
fabrizio giustina added a comment -

it's only a single css issue:

  • the 'links bar' underneath the header is up in the header
  • the header has a grey background

please add this css rule to maven-base.css, it solves this two problems in Netscape:
#banner {
border-bottom: 1px solid #fff;
}

  • the project nav bar has a dotted border rather than a solid one.

this is intentional. If you don't like it and want a solid border by default (so bad?) you can replace the css rule in maven-theme:

#leftColumn {
...
border: 1px dashed #999;
}

with:

#leftColumn {
...
border: 1px solid #999;
}

In the live example you posted there is a problem in IE, though...
in my patch I replaced the menu icons with the old +- signs: the newer arrows requires png alpha trasparency to display properly, and png alpha is not supported at all in internet explorer for windows (90% of the users).
In IE you see the square background for the arrows since they are not transparent.
I think the +- signs (should be included in my patch) are more compatible

Show
fabrizio giustina added a comment - it's only a single css issue: the 'links bar' underneath the header is up in the header the header has a grey background please add this css rule to maven-base.css, it solves this two problems in Netscape: #banner { border-bottom: 1px solid #fff; } the project nav bar has a dotted border rather than a solid one. this is intentional. If you don't like it and want a solid border by default (so bad?) you can replace the css rule in maven-theme: #leftColumn { ... border: 1px dashed #999; } with: #leftColumn { ... border: 1px solid #999; } In the live example you posted there is a problem in IE, though... in my patch I replaced the menu icons with the old +- signs: the newer arrows requires png alpha trasparency to display properly, and png alpha is not supported at all in internet explorer for windows (90% of the users). In IE you see the square background for the arrows since they are not transparent. I think the +- signs (should be included in my patch) are more compatible
Hide
Permalink
fabrizio giustina added a comment -

IE screenshot (background behind arrows)

Show
fabrizio giustina added a comment - IE screenshot (background behind arrows)
Hide
Permalink
dion gillard added a comment -

I am making the changes in the comments and testing

Show
dion gillard added a comment - I am making the changes in the comments and testing
Hide
Permalink
dion gillard added a comment -

All works well.

The only issue I can see is the arrows vs the +/- sign.

Anyone else care to chime in?

Show
dion gillard added a comment - All works well. The only issue I can see is the arrows vs the +/- sign. Anyone else care to chime in?
Hide
Permalink
dion gillard added a comment -

From what I can tell, the PNGs for collapsed and expanded are valid, and have an alpha of 0 (transparent) for all except the arrow piece.

That means that IE may not be displaying them properly.

Show
dion gillard added a comment - From what I can tell, the PNGs for collapsed and expanded are valid, and have an alpha of 0 (transparent) for all except the arrow piece. That means that IE may not be displaying them properly.
Hide
Permalink
dion gillard added a comment -

I'll try saving as a GIF

Show
dion gillard added a comment - I'll try saving as a GIF
Hide
Permalink
dion gillard added a comment -

Patch applied in xdoc-1.5
Replaced old PNG files with GIFs to better support IE.

Show
dion gillard added a comment - Patch applied in xdoc-1.5 Replaced old PNG files with GIFs to better support IE.

People

  • Assignee:
    dion gillard
    Reporter:
    fabrizio giustina
Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved:

Time Tracking

Estimated:
10m
Original Estimate - 10 minutes
Remaining:
10m
Remaining Estimate - 10 minutes
Logged:
Not Specified
Time Spent - Not Specified