Uploaded image for project: 'Maven Doxia'
  1. Maven Doxia
  2. DOXIA-525

Rendering links in xdocs breaks them

    XMLWordPrintableJSON

Details

    • Bug
    • Status: Closed
    • Major
    • Resolution: Invalid
    • 1.6
    • None
    • Module - Xdoc
    • None

    Description

      Generating linkcheck report on our project has encountered some problems.
      In final report lots of links are marked as "invalid"

      Report generated on test project:

      http://alexkravin.github.io/testproject/writingchecks.html

      For example try to follow link processFiltered(java.io.File, java.util.List)

      Look to the URL:
      link looks like AbstractFileSetCheck.html#processFilteredjava.io.File_java.util.List

      Rendering link in this velocity template breaks it:

      https://github.com/alexkravin/linkstest/blob/master/src/xdocs/writingchecks.xml.vm#L13

      brackets and space in the link are broken, the similar problem was specified here
      DOXIA-397

      but in velocity template developer can't put '##' - it would fail the rendering with an error:

      [ERROR] Error parsing /home/asus/sources/links/src/xdocs/writingchecks.xml.vm as a velocity template, using as text.
      

      Steps of reproducing my problem (for simplifying I'm pointing on my test project):

      1. git clone git@github.com:alexkravin/linkstest.git && cd linkstest/
      2. mvn clean site
      3. Open target/site/writingchecks.html

      Attachments

        Activity

          People

            rfscholte Robert Scholte
            kravin Aleksey Nesterenko
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: