Maven 1.x XDoc Plugin
  1. Maven 1.x XDoc Plugin
  2. MPXDOC-161

Tabbed browsing for multiprojects (this change involves both the multiproject plugin and xdoc)

    Details

    • Type: New Feature New Feature
    • Status: Closed Closed
    • Priority: Major Major
    • Resolution: Won't Fix
    • Affects Version/s: 1.9.1
    • Fix Version/s: None
    • Labels:
      None
    • Number of attachments :
      3

      Description

      Currently only aggregate navigation is possible on the top level project. It would be nice to be able to generate tabbed browsing. I have successfully done this with only a few changes to both plugins. I have attached a screenshot to see the benefits. If this sounds interesting I'll send the patch.

      1. multiproject.patch
        3 kB
        Ignacio G. Mac Dowell
      2. xdoc.patch
        7 kB
        Ignacio G. Mac Dowell
      1. tabbed.jpg
        97 kB

        Issue Links

          Activity

          Hide
          Arnaud Heritier added a comment -

          did you test if there's no side effect for sites without tabs ?
          If you send us the patch we'll try to commit it for the next main release (1.10) of the xdoc plugin (and for the multiproject plugin).
          Please, if you want, send us 2 patches (xdoc + multiproject) and we'll add a link between the 2 issues.

          Show
          Arnaud Heritier added a comment - did you test if there's no side effect for sites without tabs ? If you send us the patch we'll try to commit it for the next main release (1.10) of the xdoc plugin (and for the multiproject plugin). Please, if you want, send us 2 patches (xdoc + multiproject) and we'll add a link between the 2 issues.
          Hide
          Ignacio G. Mac Dowell added a comment -

          While it was easy to implement via maven.xml, it has been quite a bit of a headache to get it working with plugins due to problems with scope (I suppose this may sound familiar...).

          These changes have no side effects and should be unnoticeable if maven.multiproject.navigagion is set to tabs (as long as no other plugin defines a property called mpmultiprojects).

          I was thinking of having the following properties:

          #this would be the label shown in each tab
          maven.multiproject.navigation.tabs.label=artifactId | name
          #should we include the top-level project in the tabs? Currently it always is
          maven.multiproject.navigation.tabs.includeTop=true | false

          best regards

          nacho

          PD: The linkcheck report on each subproject is going to complain because the subprojects haven't been built where they should have, so all links from the tabs will fail until they are moved to their correct place.

          Show
          Ignacio G. Mac Dowell added a comment - While it was easy to implement via maven.xml, it has been quite a bit of a headache to get it working with plugins due to problems with scope (I suppose this may sound familiar...). These changes have no side effects and should be unnoticeable if maven.multiproject.navigagion is set to tabs (as long as no other plugin defines a property called mpmultiprojects). I was thinking of having the following properties: #this would be the label shown in each tab maven.multiproject.navigation.tabs.label=artifactId | name #should we include the top-level project in the tabs? Currently it always is maven.multiproject.navigation.tabs.includeTop=true | false best regards nacho PD: The linkcheck report on each subproject is going to complain because the subprojects haven't been built where they should have, so all links from the tabs will fail until they are moved to their correct place.
          Hide
          Lukas Theussl added a comment -

          Needs more testing...

          Show
          Lukas Theussl added a comment - Needs more testing...
          Hide
          Ignacio G. Mac Dowell added a comment -

          Did you find any errors? Is there anything I can do to help out testing with this issue?

          Show
          Ignacio G. Mac Dowell added a comment - Did you find any errors? Is there anything I can do to help out testing with this issue?
          Hide
          Lukas Theussl added a comment -

          Hi Ignacio,

          I haven't found any errors because I haven't had time to really test it. For the m1 development in general, due to lack of maintaining power, we have decided not to include any new features or low-priority improvements anymore.

          So if you want your patch to be included, you would have to present it in a ready-to-apply form, complete with test cases, i18n and documentation.

          You should at the very least include a test case in your patch that demonstrates how it works and what it is supposed to. You would have to confirm that it doesn't break anything in other plugins, eg by running ' maven -Dgoal=plugin:test multiproject:goal' or by rebuilding the plugins web site (from current trunk). Finally, you would also have to show that it is compatible with both maven 1.1 and 1.0.2.

          I'd be happy to apply the patches, but there's a lot of testing to do. And I would have liked to release xdoc-1.10 maybe next week...

          Show
          Lukas Theussl added a comment - Hi Ignacio, I haven't found any errors because I haven't had time to really test it. For the m1 development in general, due to lack of maintaining power, we have decided not to include any new features or low-priority improvements anymore. So if you want your patch to be included, you would have to present it in a ready-to-apply form, complete with test cases, i18n and documentation. You should at the very least include a test case in your patch that demonstrates how it works and what it is supposed to. You would have to confirm that it doesn't break anything in other plugins, eg by running ' maven -Dgoal=plugin:test multiproject:goal' or by rebuilding the plugins web site (from current trunk). Finally, you would also have to show that it is compatible with both maven 1.1 and 1.0.2. I'd be happy to apply the patches, but there's a lot of testing to do. And I would have liked to release xdoc-1.10 maybe next week...
          Hide
          Michael Osipov added a comment -

          Please refer to https://cwiki.apache.org/confluence/display/MAVEN/The+Great+JIRA+Cleanup+of+2014 if you're wondering why this issue was closed out.

          Show
          Michael Osipov added a comment - Please refer to https://cwiki.apache.org/confluence/display/MAVEN/The+Great+JIRA+Cleanup+of+2014 if you're wondering why this issue was closed out.

            People

            • Assignee:
              Unassigned
              Reporter:
              Ignacio G. Mac Dowell
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: