[MSITE-423] <links> item hrefs not relativised properly when inherited by child modules

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 2.1
• Fix Version/s: 2.3, 3.0
• Component/s: relative links
• Environment: Linux, JDK 1.6.0_07, Maven 2.1.0
• Assignee: Lukas Theussl
• Reporter: Robert Davey
• Created: 21/Aug/09 09:12
• Updated: 07/Apr/15 18:15
• Resolved: 18/Jan/11 04:28

Description

See attachment for reproducible minimal case.

I have a multi-module project, for the sake of argument laid out thus:

• parent
  • pom.xml

• module1
  • pom.xml
  • src/site/site.xml
  • apt/index.apt

• • submodule1
    • pom.xml
    • src/site/site.xml
    • apt/index.apt

I specify some links in our parent POM that I want to be inherited by all child multi-modules. I would hope these links would always point to the relevant html files in the super parent project for all children, no matter the nesting level.

<links>
<item name="Home" href="/index.html"/>
<item name="Getting Started" href="/getting-started.html"/>
<item name="Documentation" href="/documentation.html"/>
</links>

These links work fine for the super parent menu. The same problem, outlined below, is apparent whether the links are prefixed by "/" or "./"

When navigating down to module1, all the href links become:

../module1

Navigating again down to submodule1 of module1, the links become (or something equally wacky):

../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../submodule1

All the pom.xml files in each module refer to the staged url correctly, and these don't seem to make any difference to the eventual href whatsoever... e.g.

parent: <url>http://server/</url>
module1: <url>http://server/module1</url>
submodule1: <url>http://server/module1/submodule1</url>

Issue Links

• is related to: MSHARED-175 wrong relative path resolution for links
• is related to: MSITE-466 Breadcrumbs to grandparent in flat multi-module project broken
• is superceded by: MSITE-534 site:stage gives different links than site:deploy
• supercedes: MSITE-422 Links being "relativized" incorrectly.