Maven Doxia

Create anchor automatically from headings

Details

  • Type: New Feature New Feature
  • Status: Closed Closed
  • Priority: Major Major
  • Resolution: Duplicate
  • Affects Version/s: None
  • Fix Version/s: 1.1
  • Component/s: None
  • Labels:
    None
  • Number of attachments :
    0

Description

When writing the apt pages you often want to cross reference pages and link to headings.

Instead of manually placing the headings in an anchor block {} the site generation should do this automatically.

It would also be nice to validate that the cross reference is valid as spaces will get replaced with underscores and typos are easy to make.

Issue Links

duplicates

Bug - A problem which impairs or prevents the functions of the product. DOXIA-266 Section titles are not becoming anchors.

  • Major - Major loss of function.
  • Closed - The issue is considered finished, the resolution is correct. Issues which are not closed can be reopened.
relates to

Bug - A problem which impairs or prevents the functions of the product. DOXIA-152 Xdoc parser shouldn't insert anchors for section titles

  • Major - Major loss of function.
  • Closed - The issue is considered finished, the resolution is correct. Issues which are not closed can be reopened.

Activity

Hide
Permalink
Lukas Theussl added a comment -

The only recommended way in Doxia 1.1 is to explicitly specify anchors for section titles, see DOXIA-266.

However, for backward compatibility reasons, the anchor generation has been moved from the xdoc parser to the SiteRendererSink, see DOXIA-152. That means that if you only generate html (site plugin) you can rely on atomatic anchor generation, but the links will be broken if you generate another output format (pdf). So the recommendation is still to specify anchors manually...

Show
Lukas Theussl added a comment - The only recommended way in Doxia 1.1 is to explicitly specify anchors for section titles, see DOXIA-266 . However, for backward compatibility reasons, the anchor generation has been moved from the xdoc parser to the SiteRendererSink, see DOXIA-152 . That means that if you only generate html (site plugin) you can rely on atomatic anchor generation, but the links will be broken if you generate another output format (pdf). So the recommendation is still to specify anchors manually...

People

  • Assignee:
    Lukas Theussl
    Reporter:
    Barrie Treloar
Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: