linking to javadocs

[Bob Paige <bo...@gmail.com>]

We have javadocs available on our tomcat server so I'm looking for the most
convenient way to link to them from our wiki. They are divided into a number
of libraries and lots of packages. I'd appreciate some thoughts as to the
best way to do this.

My first thought was interwiki links. There are not so many libraries that I
couldn't define links for them, but that would still yield the following
syntax:

[lib1:com/company/pkg/pkg/pkg/MyClass]

which doesn't look like a Java class name at all.

Side note: It would be cool if I could enter "com.company.pkg.etc" and have
JSPWiki change the "." for "/" using some regex.

My next thought was a plugin. Not hard to write. The syntax would end up
being:

[{Javadoc module='lib1' class='com.company.pkg.pkg.pkg.MyClass'}]

Then I could control the display and the URL transformation as well. This is
a bit more typing than the interwiki link, but does the job.

Has anyone else needed to solve this problem or have any thoughts on this?

-- 
Bobman

Re: linking to javadocs

[Bob Paige <bo...@gmail.com>]

Mikkle,

Thanks for the contribution!

In the end I chose option #3: I wrote a page filter that expands the
interwiki syntax to a path. It was tricky because I had to handle the
interwiki link in any of three positions within the [] pair, and I wanted to
handle anchors ("#toStriong()") and I needed to *not* expand it if the
interwiki link is within a code block ("{{{..}}}").

Design is fun, but this stuff is more funner!

-- 
Bobman

On Thu, Mar 19, 2009 at 9:54 PM, Mikkel Troest <mi...@mikkle.dk> wrote:

> Bob,
>
> http://www.mikkle.dk/wiki/wiki/JavadocPlugin
>
> It has a "baseurl" parameter which you could substitute for you "lib" or
> "module". It's a quick hack-together. Have a look, and use it if you
> like it!
>
> :O) Mikkle
>
> Bob Paige wrote:
> > We have javadocs available on our tomcat server so I'm looking for the
> most
> > convenient way to link to them from our wiki. They are divided into a
> number
> > of libraries and lots of packages. I'd appreciate some thoughts as to the
> > best way to do this.
> >
> > My first thought was interwiki links. There are not so many libraries
> that I
> > couldn't define links for them, but that would still yield the following
> > syntax:
> >
> > [lib1:com/company/pkg/pkg/pkg/MyClass]
> >
> > which doesn't look like a Java class name at all.
> >
> > Side note: It would be cool if I could enter "com.company.pkg.etc" and
> have
> > JSPWiki change the "." for "/" using some regex.
> >
> > My next thought was a plugin. Not hard to write. The syntax would end up
> > being:
> >
> > [{Javadoc module='lib1' class='com.company.pkg.pkg.pkg.MyClass'}]
> >
> > Then I could control the display and the URL transformation as well. This
> is
> > a bit more typing than the interwiki link, but does the job.
> >
> > Has anyone else needed to solve this problem or have any thoughts on
> this?
> >
>

Re: linking to javadocs

[Mikkel Troest <mi...@mikkle.dk>]

Bob,

http://www.mikkle.dk/wiki/wiki/JavadocPlugin

It has a "baseurl" parameter which you could substitute for you "lib" or
"module". It's a quick hack-together. Have a look, and use it if you
like it!

:O) Mikkle

Bob Paige wrote:
> We have javadocs available on our tomcat server so I'm looking for the most
> convenient way to link to them from our wiki. They are divided into a number
> of libraries and lots of packages. I'd appreciate some thoughts as to the
> best way to do this.
> 
> My first thought was interwiki links. There are not so many libraries that I
> couldn't define links for them, but that would still yield the following
> syntax:
> 
> [lib1:com/company/pkg/pkg/pkg/MyClass]
> 
> which doesn't look like a Java class name at all.
> 
> Side note: It would be cool if I could enter "com.company.pkg.etc" and have
> JSPWiki change the "." for "/" using some regex.
> 
> My next thought was a plugin. Not hard to write. The syntax would end up
> being:
> 
> [{Javadoc module='lib1' class='com.company.pkg.pkg.pkg.MyClass'}]
> 
> Then I could control the display and the URL transformation as well. This is
> a bit more typing than the interwiki link, but does the job.
> 
> Has anyone else needed to solve this problem or have any thoughts on this?
>