Apt munges local links to JavaDocs

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
4 messages Options
Reply | Threaded
Open this post in threaded view
|

Apt munges local links to JavaDocs

Tom Nichols
I'm trying to put links in my apt documents that link to javadoc:

{{{../apidocs/groovyx/net/http/ParserRegistry.html#parseText(org.apache.http.HttpResponse)}ParserRegistry}}


I've got the relative path (../) in front, so it should be picked up as a
local (not internal link).  Apt still doesn't like it though and munges it:

[WARNING] [APT Parser] Modified invalid link:
'parseText(org.apache.http.HttpResponse)' to
'../apidocs/groovyx/net/http/ParserRegistry.html#parseTextorg.apache.http.HttpResponse'

So essentially it doesn't like the parens in the anchor (method anchors that
include spaces and commas get munged too.)  Boo!  Now I can't link to
methods in javadocs.  Do I need to add an absolute URI for all of these
links?  As far as I can tell, I'm using doxia-core 1.1.3.  Can someone
confirm for me that it _does_ work (maybe the dependencies aren't resolving
like I think they are?)

I'm using Maven 2.2.1 and running "mvn site:site"

Thanks!

Here's the relevant part of my POM:
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-site-plugin</artifactId>
                <version>2.1.1</version>
                <dependencies>
    <!-- For SyntaxHighlighter macro:
http://code.google.com/p/m2-site-tools/ -->
                    <dependency>
                        <groupId>com.anasoft.os</groupId>
                        <artifactId>m2st-doxia-macros</artifactId>
                        <version>${m2st.version}</version>
                    </dependency>
                      <dependency>
                        <groupId>org.apache.maven.doxia</groupId>
                        <artifactId>doxia-sink-api</artifactId>
                         <version>1.1.3</version>
                    </dependency>
                     <dependency>
                        <groupId>org.apache.maven.doxia</groupId>
                        <artifactId>doxia-core</artifactId>
                         <version>1.1.3</version>
                    </dependency>
                </dependencies>
            </plugin>
Reply | Threaded
Open this post in threaded view
|

Re: Apt munges local links to JavaDocs

Lukas Theussl-4

I can confirm that this does NOT work as it should. I have opened
http://jira.codehaus.org/browse/DOXIA-397

Cheers,
-Lukas


Thom Nichols wrote:

> I'm trying to put links in my apt documents that link to javadoc:
>
> {{{../apidocs/groovyx/net/http/ParserRegistry.html#parseText(org.apache.http.HttpResponse)}ParserRegistry}}
>
>
> I've got the relative path (../) in front, so it should be picked up as a
> local (not internal link).  Apt still doesn't like it though and munges it:
>
> [WARNING] [APT Parser] Modified invalid link:
> 'parseText(org.apache.http.HttpResponse)' to
> '../apidocs/groovyx/net/http/ParserRegistry.html#parseTextorg.apache.http.HttpResponse'
>
> So essentially it doesn't like the parens in the anchor (method anchors that
> include spaces and commas get munged too.)  Boo!  Now I can't link to
> methods in javadocs.  Do I need to add an absolute URI for all of these
> links?  As far as I can tell, I'm using doxia-core 1.1.3.  Can someone
> confirm for me that it _does_ work (maybe the dependencies aren't resolving
> like I think they are?)
>
> I'm using Maven 2.2.1 and running "mvn site:site"
>
> Thanks!
>
> Here's the relevant part of my POM:
>              <plugin>
>                  <groupId>org.apache.maven.plugins</groupId>
>                  <artifactId>maven-site-plugin</artifactId>
>                  <version>2.1.1</version>
>                  <dependencies>
>      <!-- For SyntaxHighlighter macro:
> http://code.google.com/p/m2-site-tools/ -->
>                      <dependency>
>                          <groupId>com.anasoft.os</groupId>
>                          <artifactId>m2st-doxia-macros</artifactId>
>                          <version>${m2st.version}</version>
>                      </dependency>
>                        <dependency>
>                          <groupId>org.apache.maven.doxia</groupId>
>                          <artifactId>doxia-sink-api</artifactId>
>                           <version>1.1.3</version>
>                      </dependency>
>                       <dependency>
>                          <groupId>org.apache.maven.doxia</groupId>
>                          <artifactId>doxia-core</artifactId>
>                           <version>1.1.3</version>
>                      </dependency>
>                  </dependencies>
>              </plugin>
>
Reply | Threaded
Open this post in threaded view
|

Re: Apt munges local links to JavaDocs

Tom Nichols
Thanks Lukas for the sanity check and bug report.


On Fri, Jun 25, 2010 at 6:04 AM, Lukas Theussl <[hidden email]> wrote:

>
> I can confirm that this does NOT work as it should. I have opened
> http://jira.codehaus.org/browse/DOXIA-397
>
> Cheers,
> -Lukas
>
>
>
> Thom Nichols wrote:
>
>> I'm trying to put links in my apt documents that link to javadoc:
>>
>>
>> {{{../apidocs/groovyx/net/http/ParserRegistry.html#parseText(org.apache.http.HttpResponse)}ParserRegistry}}
>>
>>
>> I've got the relative path (../) in front, so it should be picked up as a
>> local (not internal link).  Apt still doesn't like it though and munges
>> it:
>>
>> [WARNING] [APT Parser] Modified invalid link:
>> 'parseText(org.apache.http.HttpResponse)' to
>>
>> '../apidocs/groovyx/net/http/ParserRegistry.html#parseTextorg.apache.http.HttpResponse'
>>
>> So essentially it doesn't like the parens in the anchor (method anchors
>> that
>> include spaces and commas get munged too.)  Boo!  Now I can't link to
>> methods in javadocs.  Do I need to add an absolute URI for all of these
>> links?  As far as I can tell, I'm using doxia-core 1.1.3.  Can someone
>> confirm for me that it _does_ work (maybe the dependencies aren't
>> resolving
>> like I think they are?)
>>
>> I'm using Maven 2.2.1 and running "mvn site:site"
>>
>> Thanks!
>>
>> Here's the relevant part of my POM:
>>             <plugin>
>>                 <groupId>org.apache.maven.plugins</groupId>
>>                 <artifactId>maven-site-plugin</artifactId>
>>                 <version>2.1.1</version>
>>                 <dependencies>
>>     <!-- For SyntaxHighlighter macro:
>> http://code.google.com/p/m2-site-tools/ -->
>>                     <dependency>
>>                         <groupId>com.anasoft.os</groupId>
>>                         <artifactId>m2st-doxia-macros</artifactId>
>>                         <version>${m2st.version}</version>
>>                     </dependency>
>>                       <dependency>
>>                         <groupId>org.apache.maven.doxia</groupId>
>>                         <artifactId>doxia-sink-api</artifactId>
>>                          <version>1.1.3</version>
>>                     </dependency>
>>                      <dependency>
>>                         <groupId>org.apache.maven.doxia</groupId>
>>                         <artifactId>doxia-core</artifactId>
>>                          <version>1.1.3</version>
>>                     </dependency>
>>                 </dependencies>
>>             </plugin>
>>
>>
Reply | Threaded
Open this post in threaded view
|

Re: Apt munges local links to JavaDocs

lluulnw
This post has NOT been accepted by the mailing list yet.
In reply to this post by Tom Nichols
เกมส์การแข่งขันในปัจจุบันมีหลากหลายแบรน หลายบริษัท แต่แบรนวิธีเล่นที่โดดเด่นที่สุดที่ชาวไทยรู้จักกันดี คาสิโนออนไลน์  ก็อยากเอาเงินพวกเราออกมาใช้ แล้วมันจะมีขั้นตอนอย่างไรละ? livescore ยินดีตอนรับสมาชิกทุกคุณ และ ผู้ที่สนใจร่วมสนุกกับเราทุกคน ผลบอล มีการจัดให้ผู้เล่นได้ทำการเลือกเล่นตามความต้องการซึ่งอาจเรียกได้ว่าเป็นช่วงเวลาฝึกการใช้งานวางพนันในสไตล์ของการออนไลน์ บาคาร่าออนไลน์ การ betting ทางเรา จะมีความยุติธรรมเชื่อถือได้ ในเกมส์วิธีการเล่นแต่ละชนิดว่าเราบริสุทธิ์ ยุติธรรม ปราศจากกลโกงทุกกรณี คาสิโน  แต่บางคุณที่เพิ่งเคยเข้ามาร่วมสนุกกันก็ยังไม่เคยชิน คนที่เล่นใหม่ๆ ยังไม่เคยใช้คำแนะนำจากวิธีวิธีเล่นผ่านเว็บไซต์ holiday  ยอดเพิ่มขึ้น ให้คุณเลือกแบบ กีฬาฟุตบอล ที่อยู่ซ้ายมือเมื่อเข้ามาแล้วก่อนเริ่มเล่น