[
http://jira.codehaus.org/browse/DOXIA-397?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=226562#action_226562
]
Thom Nichols commented on DOXIA-397:
------------------------------------
bq. It is assumed that site builders have control over both target ids and
links for internal and local links, ie if Doxia fixes an invalid id, the
developer should be forced to fix the link and avoid the warning.
But the _developer_ isn't being forced to fix the link, Doxia is attempting to
fix it for me (and breaking it in the process.) I think you mean, if Doxia
fixes the link, the developer will be forced to fix the anchor that it points
to?
bq. Unfortunately this is not possible for auto-generated docs that produce
invalid anchors/links, like javadoc.
But even if I properly escape the link, Doxia still munges it. I don't think
this has anything to do with the fact that Javadoc leaves unescaped characters
in the URI. A valid URI like:
{noformat}
{{{../apidocs/groovyx/net/http/HTTPBuilder.html#defaultSuccessHandler%28org.apache.http.HttpResponse%2C%20java.lang.Object%29}defaultSuccessHandler}}
{noformat}
is still getting smashed by Doxia.
I apologize for being dense, as I feel like keep asking the same question. But
the above link -- you said it cannot be a Doxia ID. OK! So if it's not a
Doxia ID, then it must be a relative URI, right? So if it's a relative URI,
why would Doxia ever try to manipulate it? And if it _does_ feel the need to
manipulate a "non Doxia ID" link, shouldn't it just be doing normal URI
escaping like replacing " " with "%20"? But instead it appears that the "Doxia
ID" rules (converting spaces to underscores and removing characters like '%')
are being applied to links that are clearly relative URIs. I guess I fail to
understand what the intended goal is in this case.
Can't the logic be "If I see what appears to be a Doxia ID, perform the Doxia
link/anchor manipulation." "If I see a link that's _not_ a Doxia ID, just
apply URI-escaping rules."
A link like "{{{Some Section Heading}blah}}" is clearly a Doxia ID, so don't
change any of the current behavior in that case and preserve backward
compatibility.
> Cannot link to javadoc methods
> ------------------------------
>
> Key: DOXIA-397
> URL: http://jira.codehaus.org/browse/DOXIA-397
> Project: Maven Doxia
> Issue Type: Bug
> Components: Core, Module - Apt, Module - Xdoc
> Affects Versions: 1.1.3
> Reporter: Lukas Theussl
>
> Using a link to a javadoc method like
> {noformat}
> {{{../apidocs/groovyx/net/http/ParserRegistry.html#parseText(org.apache.http.HttpResponse)}ParserRegistry}}
> {noformat}
> the apt parser removes the brackets of the anchor. The same thing happens
> with xdocs and probably other formats. Note that non-ascii characters are not
> legal in anchor names, but they should be replaced by their hex values, see
> http://www.w3.org/TR/html401/appendix/notes.html#non-ascii-chars.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
