Maven 2.x and 3.x Site Plugin

Use underscores instead of spaces in anchor names

Details

  • Type: Improvement Improvement
  • Status: Closed Closed
  • Priority: Major Major
  • Resolution: Fixed
  • Affects Version/s: 2.0-beta-5
  • Fix Version/s: 2.0-beta-6
  • Component/s: None
  • Labels:
    None
  • Number of attachments :
    0

Description

Version 2.0-beta-5 generates named anchors based on the section/subsection names.

It currently uses the text as-is, leading to anchors like <a name="Logo Contest"> which must be linked to with #Logo%20Contest.

Maven 1 used to replace spaces with underscores, producing much nicer anchor names: <a name="Logo_Contest">, and #Logo_Contest.

In addition, see MSITE-167, requesting the addition of an href attribute so that the anchor name can be specified in the xdoc:
<subsection name="Logo Contest" href="logo"> ----> <a name="logo"> ---> #logo

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Dennis Lundberg added a comment -

I just did a validation [1] on a Maven generated page [2] that has these anchors in it. It turns out that this is not valid xhtml.

[1] http://validator.w3.org/
[2] http://maven.apache.org/plugins/maven-changes-plugin/changes-report.html

Show
Dennis Lundberg added a comment - I just did a validation [1] on a Maven generated page [2] that has these anchors in it. It turns out that this is not valid xhtml. [1] http://validator.w3.org/ [2] http://maven.apache.org/plugins/maven-changes-plugin/changes-report.html
Hide
Permalink
Vincent Siveton added a comment -

Added HtmlTools#encodeId() in Doxia core
The id returned respects the W3C recommendation.

Show
Vincent Siveton added a comment - Added HtmlTools#encodeId() in Doxia core The id returned respects the W3C recommendation.
Hide
Permalink
Wendy Smoak added a comment -

The fix-for version on this is incorrect. 2.0-beta-5 is the released version which generates anchors containing spaces.

Can you please publish a new snapshot of Doxia? The last one was 7/23, before this fix.

I built Doxia and the site plugin from source and can see the new anchors generated as:
<a name="logo_contest"></a><div class="section"><h3>Logo Contest</h3>

Thanks!

Show
Wendy Smoak added a comment - The fix-for version on this is incorrect. 2.0-beta-5 is the released version which generates anchors containing spaces. Can you please publish a new snapshot of Doxia? The last one was 7/23, before this fix. I built Doxia and the site plugin from source and can see the new anchors generated as: <a name="logo_contest"></a><div class="section"><h3>Logo Contest</h3> Thanks!
Hide
Permalink
Dennis Lundberg added a comment -

Fix the Fix version.

Show
Dennis Lundberg added a comment - Fix the Fix version.

People

  • Assignee:
    Vincent Siveton
    Reporter:
    Wendy Smoak
Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: