You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Liviu Tudor (JIRA)" <ji...@codehaus.org> on 2012/07/24 00:51:21 UTC
[jira] (MSITE-646) Brackets not working when generating links using
site plugin
Liviu Tudor created MSITE-646:
---------------------------------
Summary: Brackets not working when generating links using site plugin
Key: MSITE-646
URL: https://jira.codehaus.org/browse/MSITE-646
Project: Maven 2.x and 3.x Site Plugin
Issue Type: Bug
Environment: MacOSX Lion 64 bit
java version "1.6.0_33"
Java(TM) SE Runtime Environment (build 1.6.0_33-b03-424-11M3720)
Java HotSpot(TM) 64-Bit Server VM (build 20.8-b03-424, mixed mode)
Apache Maven 3.0.3 (r1075438; 2011-02-28 09:31:09-0800)
Maven home: /usr/share/java/maven-3.0.3
Java version: 1.6.0_33, vendor: Apple Inc.
Java home: /System/Library/Java/JavaVirtualMachines/1.6.0.jdk/Contents/Home
Default locale: en_US, platform encoding: MacRoman
OS name: "mac os x", version: "10.7.4", arch: "x86_64", family: "mac"
Reporter: Liviu Tudor
Attachments: aggregator.xml
This was discovered together with Simone Tripodi when dealing with the Apache Commons Functor project (http://commons.apache.org/functor/): I've put together the attached file which include some links to the javadoc section of the site (generated using maven site plugin).
Some links are links to the classes/interfaces or packages -- and these work. Example:
{code:xml}
<a href="apidocs/org/apache/commons/functor/aggregator/ArrayListBackedAggregator.html">ArrayListBackedAggregator</a>
{code}
However, where the link is meant to be a link to the method javadoc directly, and as such it includes brackets, the brackets are lost it the process of generating the html. Example:
{code:xml}
<a href="apidocs/org/apache/commons/functor/aggregator/AbstractListBackedAggregator.html#createList()">createList()</a>
{code}
generates (you can see this on the live site here http://commons.apache.org/functor/aggregator.html):
{code:xml}
<a href="apidocs/org/apache/commons/functor/aggregator/AbstractListBackedAggregator.html#createList">createList()</a>
{code}
Same happens if the method has parameters:
{code:xml}
<a href="apidocs/org/apache/commons/functor/aggregator/Aggregator.html#add(T)">add()</a>
{code}
generates
{code:xml}
<a href="apidocs/org/apache/commons/functor/aggregator/Aggregator.html#addT">add()</a>
{code}
I am attaching the original xml file to this. I use a Mac but I believe Simo uses a Linux -- so it's not something to do with encoding I don't think. (As a side note we have actually changed various encoding settings to get the same result.)
Please let me know if there is anything else we need to provide you with.
Kind regards,
Liv
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://jira.codehaus.org/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] (MSITE-646) Brackets not working when generating links using
site plugin
Posted by "Liviu Tudor (JIRA)" <ji...@codehaus.org>.
[ https://jira.codehaus.org/browse/MSITE-646?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=304743#comment-304743 ]
Liviu Tudor commented on MSITE-646:
-----------------------------------
Oh, awesome Lukas, thank you so much for the heads-up on this!
I can confirm that URL-escaping the # in the link works -- e.g.
{code:xml}
<a href="apidocs/org/apache/commons/functor/aggregator/AbstractListBackedAggregator.html%23createList()">createList()</a>
{code}
rather than
{code:xml}
<a href="apidocs/org/apache/commons/functor/aggregator/AbstractListBackedAggregator.html#createList()">createList()</a>
{code}
> Brackets not working when generating links using site plugin
> ------------------------------------------------------------
>
> Key: MSITE-646
> URL: https://jira.codehaus.org/browse/MSITE-646
> Project: Maven 2.x and 3.x Site Plugin
> Issue Type: Bug
> Environment: MacOSX Lion 64 bit
> java version "1.6.0_33"
> Java(TM) SE Runtime Environment (build 1.6.0_33-b03-424-11M3720)
> Java HotSpot(TM) 64-Bit Server VM (build 20.8-b03-424, mixed mode)
> Apache Maven 3.0.3 (r1075438; 2011-02-28 09:31:09-0800)
> Maven home: /usr/share/java/maven-3.0.3
> Java version: 1.6.0_33, vendor: Apple Inc.
> Java home: /System/Library/Java/JavaVirtualMachines/1.6.0.jdk/Contents/Home
> Default locale: en_US, platform encoding: MacRoman
> OS name: "mac os x", version: "10.7.4", arch: "x86_64", family: "mac"
> Reporter: Liviu Tudor
> Attachments: aggregator.xml
>
>
> This was discovered together with Simone Tripodi when dealing with the Apache Commons Functor project (http://commons.apache.org/functor/): I've put together the attached file which include some links to the javadoc section of the site (generated using maven site plugin).
> Some links are links to the classes/interfaces or packages -- and these work. Example:
> {code:xml}
> <a href="apidocs/org/apache/commons/functor/aggregator/ArrayListBackedAggregator.html">ArrayListBackedAggregator</a>
> {code}
> However, where the link is meant to be a link to the method javadoc directly, and as such it includes brackets, the brackets are lost it the process of generating the html. Example:
> {code:xml}
> <a href="apidocs/org/apache/commons/functor/aggregator/AbstractListBackedAggregator.html#createList()">createList()</a>
> {code}
> generates (you can see this on the live site here http://commons.apache.org/functor/aggregator.html):
> {code:xml}
> <a href="apidocs/org/apache/commons/functor/aggregator/AbstractListBackedAggregator.html#createList">createList()</a>
> {code}
> Same happens if the method has parameters:
> {code:xml}
> <a href="apidocs/org/apache/commons/functor/aggregator/Aggregator.html#add(T)">add()</a>
> {code}
> generates
> {code:xml}
> <a href="apidocs/org/apache/commons/functor/aggregator/Aggregator.html#addT">add()</a>
> {code}
> I am attaching the original xml file to this. I use a Mac but I believe Simo uses a Linux -- so it's not something to do with encoding I don't think. (As a side note we have actually changed various encoding settings to get the same result.)
> Please let me know if there is anything else we need to provide you with.
> Kind regards,
> Liv
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://jira.codehaus.org/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] (MSITE-646) Brackets not working when generating links using
site plugin
Posted by "Robert Scholte (JIRA)" <ji...@codehaus.org>.
[ https://jira.codehaus.org/browse/MSITE-646?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=304391#comment-304391 ]
Robert Scholte commented on MSITE-646:
--------------------------------------
It looks like [velocity|http://velocity.apache.org/engine/releases/velocity-1.5/user-guide.html#velocimacros] is trying to call a macro here. In that case you need to escape the '#'
> Brackets not working when generating links using site plugin
> ------------------------------------------------------------
>
> Key: MSITE-646
> URL: https://jira.codehaus.org/browse/MSITE-646
> Project: Maven 2.x and 3.x Site Plugin
> Issue Type: Bug
> Environment: MacOSX Lion 64 bit
> java version "1.6.0_33"
> Java(TM) SE Runtime Environment (build 1.6.0_33-b03-424-11M3720)
> Java HotSpot(TM) 64-Bit Server VM (build 20.8-b03-424, mixed mode)
> Apache Maven 3.0.3 (r1075438; 2011-02-28 09:31:09-0800)
> Maven home: /usr/share/java/maven-3.0.3
> Java version: 1.6.0_33, vendor: Apple Inc.
> Java home: /System/Library/Java/JavaVirtualMachines/1.6.0.jdk/Contents/Home
> Default locale: en_US, platform encoding: MacRoman
> OS name: "mac os x", version: "10.7.4", arch: "x86_64", family: "mac"
> Reporter: Liviu Tudor
> Attachments: aggregator.xml
>
>
> This was discovered together with Simone Tripodi when dealing with the Apache Commons Functor project (http://commons.apache.org/functor/): I've put together the attached file which include some links to the javadoc section of the site (generated using maven site plugin).
> Some links are links to the classes/interfaces or packages -- and these work. Example:
> {code:xml}
> <a href="apidocs/org/apache/commons/functor/aggregator/ArrayListBackedAggregator.html">ArrayListBackedAggregator</a>
> {code}
> However, where the link is meant to be a link to the method javadoc directly, and as such it includes brackets, the brackets are lost it the process of generating the html. Example:
> {code:xml}
> <a href="apidocs/org/apache/commons/functor/aggregator/AbstractListBackedAggregator.html#createList()">createList()</a>
> {code}
> generates (you can see this on the live site here http://commons.apache.org/functor/aggregator.html):
> {code:xml}
> <a href="apidocs/org/apache/commons/functor/aggregator/AbstractListBackedAggregator.html#createList">createList()</a>
> {code}
> Same happens if the method has parameters:
> {code:xml}
> <a href="apidocs/org/apache/commons/functor/aggregator/Aggregator.html#add(T)">add()</a>
> {code}
> generates
> {code:xml}
> <a href="apidocs/org/apache/commons/functor/aggregator/Aggregator.html#addT">add()</a>
> {code}
> I am attaching the original xml file to this. I use a Mac but I believe Simo uses a Linux -- so it's not something to do with encoding I don't think. (As a side note we have actually changed various encoding settings to get the same result.)
> Please let me know if there is anything else we need to provide you with.
> Kind regards,
> Liv
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://jira.codehaus.org/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] (MSITE-646) Brackets not working when generating links using
site plugin
Posted by "Liviu Tudor (JIRA)" <ji...@codehaus.org>.
[ https://jira.codehaus.org/browse/MSITE-646?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Liviu Tudor closed MSITE-646.
-----------------------------
Resolution: Not A Bug
As per Lukas's comment, need to escape the # so this is not a bug.
> Brackets not working when generating links using site plugin
> ------------------------------------------------------------
>
> Key: MSITE-646
> URL: https://jira.codehaus.org/browse/MSITE-646
> Project: Maven 2.x and 3.x Site Plugin
> Issue Type: Bug
> Environment: MacOSX Lion 64 bit
> java version "1.6.0_33"
> Java(TM) SE Runtime Environment (build 1.6.0_33-b03-424-11M3720)
> Java HotSpot(TM) 64-Bit Server VM (build 20.8-b03-424, mixed mode)
> Apache Maven 3.0.3 (r1075438; 2011-02-28 09:31:09-0800)
> Maven home: /usr/share/java/maven-3.0.3
> Java version: 1.6.0_33, vendor: Apple Inc.
> Java home: /System/Library/Java/JavaVirtualMachines/1.6.0.jdk/Contents/Home
> Default locale: en_US, platform encoding: MacRoman
> OS name: "mac os x", version: "10.7.4", arch: "x86_64", family: "mac"
> Reporter: Liviu Tudor
> Attachments: aggregator.xml
>
>
> This was discovered together with Simone Tripodi when dealing with the Apache Commons Functor project (http://commons.apache.org/functor/): I've put together the attached file which include some links to the javadoc section of the site (generated using maven site plugin).
> Some links are links to the classes/interfaces or packages -- and these work. Example:
> {code:xml}
> <a href="apidocs/org/apache/commons/functor/aggregator/ArrayListBackedAggregator.html">ArrayListBackedAggregator</a>
> {code}
> However, where the link is meant to be a link to the method javadoc directly, and as such it includes brackets, the brackets are lost it the process of generating the html. Example:
> {code:xml}
> <a href="apidocs/org/apache/commons/functor/aggregator/AbstractListBackedAggregator.html#createList()">createList()</a>
> {code}
> generates (you can see this on the live site here http://commons.apache.org/functor/aggregator.html):
> {code:xml}
> <a href="apidocs/org/apache/commons/functor/aggregator/AbstractListBackedAggregator.html#createList">createList()</a>
> {code}
> Same happens if the method has parameters:
> {code:xml}
> <a href="apidocs/org/apache/commons/functor/aggregator/Aggregator.html#add(T)">add()</a>
> {code}
> generates
> {code:xml}
> <a href="apidocs/org/apache/commons/functor/aggregator/Aggregator.html#addT">add()</a>
> {code}
> I am attaching the original xml file to this. I use a Mac but I believe Simo uses a Linux -- so it's not something to do with encoding I don't think. (As a side note we have actually changed various encoding settings to get the same result.)
> Please let me know if there is anything else we need to provide you with.
> Kind regards,
> Liv
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://jira.codehaus.org/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira