Maven 2.x and 3.x Site Plugin

Site navigation not generated for submodules of multimodule project when site.xml defined in the parent

Details

  • Type: Bug Bug
  • Status: Closed Closed
  • Priority: Major Major
  • Resolution: Not A Bug
  • Affects Version/s: 2.1, 2.1.1
  • Fix Version/s: None
  • Component/s: None
  • Labels:
    None
  • Environment:
    Windows XP SP2, Sun/Oracle JDK 1.6, Maven 2.2.1
  • Number of attachments :
    1

Description

Bug that manifests itself like http://jira.codehaus.org/browse/MSITE-456 but in different configuration.
If you define "src/site/site.xml" file for the root module the navigation left menu in submodule is completely empty. After deleting this "site.xml" file everything works (maybe something has recently changed in this file content/structure requirements).
Everything works without problems for 2.0.1 version of Maven site plugin.

Issue Links

relates to

Bug - A problem which impairs or prevents the functions of the product. MSITE-456 [regression] Site navigation not generated

  • Critical - Crashes, loss of data, severe memory leak.
  • Closed - The issue is considered finished, the resolution is correct. Issues which are not closed can be reopened.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Grzegorz Slowikowski added a comment -

Test project attached

Show
Grzegorz Slowikowski added a comment - Test project attached
Hide
Permalink
Matthias Wegerhoff added a comment -

Got a similar problem. When defining a site.xml in a seperate Project that is referenzed as parent in a second project everything (skin, breadcrumbs,...) gets "inherited", except the "<menu ref="modules" />" entry which results in missing links to submodules. By adding a site.xml to every Project everything works fine, but trying to define a site-decriptor only for the parent results in the described problem.

Show
Matthias Wegerhoff added a comment - Got a similar problem. When defining a site.xml in a seperate Project that is referenzed as parent in a second project everything (skin, breadcrumbs,...) gets "inherited", except the "<menu ref="modules" />" entry which results in missing links to submodules. By adding a site.xml to every Project everything works fine, but trying to define a site-decriptor only for the parent results in the described problem.
Hide
Permalink
André Fügenschuh added a comment -

Adding an inherit attribute will do it (for 2.1.1).

<menu ref="modules" inherit="top"/>

See my comments and my test case under MSITE-456.

The question is whether 'preset menus' (including their links) are inherited 'by default' or not (see Site Descriptor).

At least they have been with 2.0.1, even if perhaps just 'by accident'.

Show
André Fügenschuh added a comment - Adding an inherit attribute will do it (for 2.1.1). <menu ref="modules" inherit="top"/> See my comments and my test case under MSITE-456 . The question is whether 'preset menus' (including their links) are inherited 'by default' or not (see Site Descriptor ). At least they have been with 2.0.1, even if perhaps just 'by accident'.
Hide
Permalink
Thomas Scheffler added a comment -

The workaround described by André

Adding an inherit attribute will do it (for 2.1.1).

<menu ref="modules" inherit="top"/>

does not work for me with 2.1.1.

It is definitely not an option to provide a site.xml to every child pom just to define a skin for every subproject, as it works find with 2.0.1

Show
Thomas Scheffler added a comment - The workaround described by André Adding an inherit attribute will do it (for 2.1.1). <menu ref="modules" inherit="top"/> does not work for me with 2.1.1. It is definitely not an option to provide a site.xml to every child pom just to define a skin for every subproject, as it works find with 2.0.1
Hide
Permalink
Lukas Theussl added a comment -

AFAICS this is not a bug, you are getting exactly what you ask for. The child inherits the site.xml from the parent, but menus are not inherited unless you specify the inherit attribute, so the navigation in the child is empty. If you want the equivalent behaviour as in site plugin 2.0.1, you have to put <menu ref="reports" inherit="top"/> into the parent site.xml (not modules, as above, the child has no modules). If you put <menu ref="parent" inherit="top"/>, the child will have a correct link to the parent.

Show
Lukas Theussl added a comment - AFAICS this is not a bug, you are getting exactly what you ask for. The child inherits the site.xml from the parent, but menus are not inherited unless you specify the inherit attribute, so the navigation in the child is empty. If you want the equivalent behaviour as in site plugin 2.0.1, you have to put <menu ref="reports" inherit="top"/> into the parent site.xml (not modules, as above, the child has no modules). If you put <menu ref="parent" inherit="top"/>, the child will have a correct link to the parent.

People

  • Assignee:
    Lukas Theussl
    Reporter:
    Grzegorz Slowikowski
Vote (2)
Watch (5)

Dates

  • Created:
    Updated:
    Resolved: