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. xdoc-patch.diff
        41 kB
        fabrizio giustina
      2. xdoc-patch-updated.diff
        45 kB
        fabrizio giustina
      1. IE_screenshot.png
        2 kB

        Activity

        Hide
        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
        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
        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
        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
        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
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Time Tracking

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