You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@commons.apache.org by "Liviu Tudor (JIRA)" <ji...@apache.org> on 2012/07/26 22:27:33 UTC
[jira] [Created] (FUNCTOR-23) aggregator.xml generates broken
JavaDoc links
Liviu Tudor created FUNCTOR-23:
----------------------------------
Summary: aggregator.xml generates broken JavaDoc links
Key: FUNCTOR-23
URL: https://issues.apache.org/jira/browse/FUNCTOR-23
Project: Commons Functor
Issue Type: Bug
Reporter: Liviu Tudor
Priority: Trivial
{{aggregator.xml}} has a few JavaDoc links to methods, as such the anchor url contains a hash (#) as well as a method name followed by brackets (). This triggers Doxia/Velocity into "thinking" that this is a macro call, and as such the links resulted (during {{mvn site}}) do not contain these brackets.
To fix them, as per https://jira.codehaus.org/browse/MSITE-646, we need to URL-escape the # hash sign (%23).
This bug is created to propose a patch to {{aggregator.xml}} for this.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (FUNCTOR-23) aggregator.xml generates broken
JavaDoc links
Posted by "Bruno P. Kinoshita (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/FUNCTOR-23?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13480616#comment-13480616 ]
Bruno P. Kinoshita commented on FUNCTOR-23:
-------------------------------------------
Hi Liviu,
The problem with absolute links is that if you are working offline, you won't be able to generate the site and browse the links (as you would be directed to http://commons.apache.org/functor, rather than file://...).
I took a look at the Doxia issues and seems like it hasn't been solved yet. I tried using Markdown, but the same happens. No lucky trying escape the () too.
I think we should use the initial approach (i.e.: apidocs/org/apache/.../Class.html#method()) even if the () gets cut due to a bug in Doxia. Other components like Apache Commons Math [1] and Apache Commons VFS [2] use this too.
[1] http://commons.apache.org/math/userguide/genetics.html
[2] http://commons.apache.org/vfs/api.html
> aggregator.xml generates broken JavaDoc links
> ---------------------------------------------
>
> Key: FUNCTOR-23
> URL: https://issues.apache.org/jira/browse/FUNCTOR-23
> Project: Commons Functor
> Issue Type: Bug
> Reporter: Liviu Tudor
> Assignee: Simone Tripodi
> Priority: Trivial
> Labels: site
> Attachments: FUNCTOR-23.2.patch.bz2, FUNCTOR-23.patch.bz2
>
>
> {{aggregator.xml}} has a few JavaDoc links to methods, as such the anchor url contains a hash (#) as well as a method name followed by brackets (). This triggers Doxia/Velocity into "thinking" that this is a macro call, and as such the links resulted (during {{mvn site}}) do not contain these brackets.
> To fix them, as per https://jira.codehaus.org/browse/MSITE-646, we need to URL-escape the # hash sign (%23).
> This bug is created to propose a patch to {{aggregator.xml}} for this.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (FUNCTOR-23) aggregator.xml generates broken
JavaDoc links
Posted by "Liviu Tudor (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/FUNCTOR-23?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13424103#comment-13424103 ]
Liviu Tudor commented on FUNCTOR-23:
------------------------------------
Looking in the bugs for DOXIA, it turns out that they are planning a fix for this but in the next major release, meanwhile, the only workaround for this is to actually provide full URL's (rather than relative URL's -- which is what causes the problem).
I've changed the URLs to absolute (prefixed with http://commons.apache.org/functor/) only for those cases where the links contained an anchor and about to submit the new patch.
> aggregator.xml generates broken JavaDoc links
> ---------------------------------------------
>
> Key: FUNCTOR-23
> URL: https://issues.apache.org/jira/browse/FUNCTOR-23
> Project: Commons Functor
> Issue Type: Bug
> Reporter: Liviu Tudor
> Assignee: Simone Tripodi
> Priority: Trivial
> Labels: site
> Attachments: FUNCTOR-23.2.patch.bz2, FUNCTOR-23.patch.bz2
>
>
> {{aggregator.xml}} has a few JavaDoc links to methods, as such the anchor url contains a hash (#) as well as a method name followed by brackets (). This triggers Doxia/Velocity into "thinking" that this is a macro call, and as such the links resulted (during {{mvn site}}) do not contain these brackets.
> To fix them, as per https://jira.codehaus.org/browse/MSITE-646, we need to URL-escape the # hash sign (%23).
> This bug is created to propose a patch to {{aggregator.xml}} for this.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Updated] (FUNCTOR-23) aggregator.xml generates broken
JavaDoc links
Posted by "Liviu Tudor (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/FUNCTOR-23?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Liviu Tudor updated FUNCTOR-23:
-------------------------------
Attachment: FUNCTOR-23.2.patch.bz2
Updated patch, with absolute URL's, which fixes the issue for now.
> aggregator.xml generates broken JavaDoc links
> ---------------------------------------------
>
> Key: FUNCTOR-23
> URL: https://issues.apache.org/jira/browse/FUNCTOR-23
> Project: Commons Functor
> Issue Type: Bug
> Reporter: Liviu Tudor
> Assignee: Simone Tripodi
> Priority: Trivial
> Labels: site
> Attachments: FUNCTOR-23.2.patch.bz2, FUNCTOR-23.patch.bz2
>
>
> {{aggregator.xml}} has a few JavaDoc links to methods, as such the anchor url contains a hash (#) as well as a method name followed by brackets (). This triggers Doxia/Velocity into "thinking" that this is a macro call, and as such the links resulted (during {{mvn site}}) do not contain these brackets.
> To fix them, as per https://jira.codehaus.org/browse/MSITE-646, we need to URL-escape the # hash sign (%23).
> This bug is created to propose a patch to {{aggregator.xml}} for this.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Resolved] (FUNCTOR-23) aggregator.xml generates broken
JavaDoc links
Posted by "Simone Tripodi (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/FUNCTOR-23?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Simone Tripodi resolved FUNCTOR-23.
-----------------------------------
Resolution: Fixed
Assignee: Simone Tripodi
Patch applied, see r1366301, thanks a lot Liviu for taking care!!
> aggregator.xml generates broken JavaDoc links
> ---------------------------------------------
>
> Key: FUNCTOR-23
> URL: https://issues.apache.org/jira/browse/FUNCTOR-23
> Project: Commons Functor
> Issue Type: Bug
> Reporter: Liviu Tudor
> Assignee: Simone Tripodi
> Priority: Trivial
> Labels: site
> Attachments: FUNCTOR-23.patch.bz2
>
>
> {{aggregator.xml}} has a few JavaDoc links to methods, as such the anchor url contains a hash (#) as well as a method name followed by brackets (). This triggers Doxia/Velocity into "thinking" that this is a macro call, and as such the links resulted (during {{mvn site}}) do not contain these brackets.
> To fix them, as per https://jira.codehaus.org/browse/MSITE-646, we need to URL-escape the # hash sign (%23).
> This bug is created to propose a patch to {{aggregator.xml}} for this.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (FUNCTOR-23) aggregator.xml generates broken
JavaDoc links
Posted by "Sebb (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/FUNCTOR-23?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13480703#comment-13480703 ]
Sebb commented on FUNCTOR-23:
-----------------------------
bq. I think we should use the initial approach
Agreed. Although it would be better if the link took one directly to the method, using absolute links is a worse problem.
Note: there is a fix for some Doxia relativisation errors in the commons-site VM file.
The VM file just removes 'http://dummy.invalid/' from the start of any link text.
However it does not currently process the main text body though it should not be too difficult to extend the code to do so. If that were done, then one could prefix any Javadoc method links with 'http://dummy.invalid/' to skip the Doxia mangling.
> aggregator.xml generates broken JavaDoc links
> ---------------------------------------------
>
> Key: FUNCTOR-23
> URL: https://issues.apache.org/jira/browse/FUNCTOR-23
> Project: Commons Functor
> Issue Type: Bug
> Reporter: Liviu Tudor
> Assignee: Simone Tripodi
> Priority: Trivial
> Labels: site
> Attachments: FUNCTOR-23.2.patch.bz2, FUNCTOR-23.patch.bz2
>
>
> {{aggregator.xml}} has a few JavaDoc links to methods, as such the anchor url contains a hash (#) as well as a method name followed by brackets (). This triggers Doxia/Velocity into "thinking" that this is a macro call, and as such the links resulted (during {{mvn site}}) do not contain these brackets.
> To fix them, as per https://jira.codehaus.org/browse/MSITE-646, we need to URL-escape the # hash sign (%23).
> This bug is created to propose a patch to {{aggregator.xml}} for this.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Reopened] (FUNCTOR-23) aggregator.xml generates broken
JavaDoc links
Posted by "Liviu Tudor (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/FUNCTOR-23?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Liviu Tudor reopened FUNCTOR-23:
--------------------------------
Actually having looked at the output generated now closely it seems that the browser *shows* the link (in the status bar) correctly, but the generated link contains still the %23 escaped code, which results in wrong URLs.
Reopening this to provide a new patch.
> aggregator.xml generates broken JavaDoc links
> ---------------------------------------------
>
> Key: FUNCTOR-23
> URL: https://issues.apache.org/jira/browse/FUNCTOR-23
> Project: Commons Functor
> Issue Type: Bug
> Reporter: Liviu Tudor
> Assignee: Simone Tripodi
> Priority: Trivial
> Labels: site
> Attachments: FUNCTOR-23.patch.bz2
>
>
> {{aggregator.xml}} has a few JavaDoc links to methods, as such the anchor url contains a hash (#) as well as a method name followed by brackets (). This triggers Doxia/Velocity into "thinking" that this is a macro call, and as such the links resulted (during {{mvn site}}) do not contain these brackets.
> To fix them, as per https://jira.codehaus.org/browse/MSITE-646, we need to URL-escape the # hash sign (%23).
> This bug is created to propose a patch to {{aggregator.xml}} for this.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (FUNCTOR-23) aggregator.xml generates broken
JavaDoc links
Posted by "Liviu Tudor (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/FUNCTOR-23?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13424106#comment-13424106 ]
Liviu Tudor commented on FUNCTOR-23:
------------------------------------
Also the attached patch adds the link to {{aggregator.html}} (generated from {{aggregator.xml}}) in the top level menu, to make it easier to access and more visible to the users.
> aggregator.xml generates broken JavaDoc links
> ---------------------------------------------
>
> Key: FUNCTOR-23
> URL: https://issues.apache.org/jira/browse/FUNCTOR-23
> Project: Commons Functor
> Issue Type: Bug
> Reporter: Liviu Tudor
> Assignee: Simone Tripodi
> Priority: Trivial
> Labels: site
> Attachments: FUNCTOR-23.2.patch.bz2, FUNCTOR-23.patch.bz2
>
>
> {{aggregator.xml}} has a few JavaDoc links to methods, as such the anchor url contains a hash (#) as well as a method name followed by brackets (). This triggers Doxia/Velocity into "thinking" that this is a macro call, and as such the links resulted (during {{mvn site}}) do not contain these brackets.
> To fix them, as per https://jira.codehaus.org/browse/MSITE-646, we need to URL-escape the # hash sign (%23).
> This bug is created to propose a patch to {{aggregator.xml}} for this.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Updated] (FUNCTOR-23) aggregator.xml generates broken
JavaDoc links
Posted by "Liviu Tudor (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/FUNCTOR-23?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Liviu Tudor updated FUNCTOR-23:
-------------------------------
Attachment: FUNCTOR-23.patch.bz2
Patch to generated correct JavaDoc links in {{aggregator.xml}}.
> aggregator.xml generates broken JavaDoc links
> ---------------------------------------------
>
> Key: FUNCTOR-23
> URL: https://issues.apache.org/jira/browse/FUNCTOR-23
> Project: Commons Functor
> Issue Type: Bug
> Reporter: Liviu Tudor
> Priority: Trivial
> Labels: site
> Attachments: FUNCTOR-23.patch.bz2
>
>
> {{aggregator.xml}} has a few JavaDoc links to methods, as such the anchor url contains a hash (#) as well as a method name followed by brackets (). This triggers Doxia/Velocity into "thinking" that this is a macro call, and as such the links resulted (during {{mvn site}}) do not contain these brackets.
> To fix them, as per https://jira.codehaus.org/browse/MSITE-646, we need to URL-escape the # hash sign (%23).
> This bug is created to propose a patch to {{aggregator.xml}} for this.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira