Mailing List Archive: Forrest: User

including a javadoc directory structure

Index | Next | Previous | View Threaded

philippe.barthelemy at gadz

Aug 12, 2004, 1:53 AM

Post #1 of 5 (35 views)
Permalink

including a javadoc directory structure

Hi,

I'd like to include a javadoc documentation in my
forrest web site.
How can I do this cleanly ?

Should I rename all the .html as .ehtml ?
What else is needed ?

More specifically, forrest do not seems to recurse the
javadoc directory structure. ( ie the directories are
just not copied in the site build, altough they are in
the site src )

( i've googled this article, but it does not help ( or
I failed to understand it...
http://www.onjava.com/pub/a/onjava/2004/05/26/forrest.html
)

thanks in advance,

---p

nicolaken at apache

Aug 12, 2004, 1:29 PM

Post #2 of 5 (34 views)
Permalink

Re: including a javadoc directory structure [In reply to]

Ph. Barthelemy wrote:

> Hi,
>
> I'd like to include a javadoc documentation in my
> forrest web site.
> How can I do this cleanly ?

Good question.

Forrest has only one way of doing this ATM, that is copying all the
javadocs to the raw directory. Not pretty, and personally I would
suggest you to simply keep them in a separate space and link them.

In the next releases, hopefully in 0.7, we will add a locationmap, that
will make users be able to specify alternate locations where to get the
sources, a sort of source/directories mount.

--
Nicola Ken Barozzi nicolaken [at] apache
- verba volant, scripta manent -
(discussions get forgotten, just code remains)
---------------------------------------------------------------------

dave at brondsema

Aug 12, 2004, 3:23 PM

Post #3 of 5 (34 views)
Permalink

Re: including a javadoc directory structure [In reply to]

Ph. Barthelemy wrote:
> Hi,
>
> I'd like to include a javadoc documentation in my
> forrest web site.
> How can I do this cleanly ?
>
> Should I rename all the .html as .ehtml ?
> What else is needed ?
>
> More specifically, forrest do not seems to recurse the
> javadoc directory structure. ( ie the directories are
> just not copied in the site build, altough they are in
> the site src )
>
> ( i've googled this article, but it does not help ( or
> I failed to understand it...
> http://www.onjava.com/pub/a/onjava/2004/05/26/forrest.html
> )
>
> thanks in advance,
>

Put them as raw html files. See http://forrest.apache.org/faq.html#link_raw

If you want them to use a forrest skin, then use ithml (ehtml has been
deprecated). But since javadocs rely on frames I don't think that would
work very well if at all.

http://forrest.apache.org/faq.html#ignoring_javadocs will also be handy.

--
Dave Brondsema : dave [at] brondsema
http://www.splike.com : programming
http://csx.calvin.edu : student org
http://www.brondsema.net : personal

Attachments:

signature.asc (0.25 KB)

philippe.barthelemy at gadz

Aug 13, 2004, 2:54 AM

Post #4 of 5 (34 views)
Permalink

Re: including a javadoc directory structure [In reply to]

Yes, it is OK for me.

It raises an other question.
As you said : the frame-based javadoc does not
integrate nicely with a forrest site.

I'd like a menu item to point to my javadoc and when
clicked I'd like it to open a new window. ( a fork
link in forrest parlance )
I did not find how to do it ?
is it possible ?

TIA,
--p

--- Dave Brondsema <dave [at] brondsema> a écrit :
> Ph. Barthelemy wrote:
> > Hi,
> >
> > I'd like to include a javadoc documentation in my
> > forrest web site.
> > How can I do this cleanly ?
> >
> > Should I rename all the .html as .ehtml ?
> > What else is needed ?
> >
> > More specifically, forrest do not seems to recurse
> the
> > javadoc directory structure. ( ie the directories
> are
> > just not copied in the site build, altough they
> are in
> > the site src )
> >
> > ( i've googled this article, but it does not help
> ( or
> > I failed to understand it...
> >
>
http://www.onjava.com/pub/a/onjava/2004/05/26/forrest.html
> > )
> >
> > thanks in advance,
> >
>
> Put them as raw html files. See
> http://forrest.apache.org/faq.html#link_raw
>
> If you want them to use a forrest skin, then use
> ithml (ehtml has been
> deprecated). But since javadocs rely on frames I
> don't think that would
> work very well if at all.
>
>
> http://forrest.apache.org/faq.html#ignoring_javadocs
> will also be handy.
>
> --
> Dave Brondsema : dave [at] brondsema
> http://www.splike.com : programming
> http://csx.calvin.edu : student org
> http://www.brondsema.net : personal
>

> ATTACHMENT part 2 application/pgp-signature
name=signature.asc

dave at brondsema

Aug 13, 2004, 4:25 AM

Post #5 of 5 (34 views)
Permalink

Re: including a javadoc directory structure [In reply to]

Ph. Barthelemy wrote:
> Yes, it is OK for me.
>
> It raises an other question.
> As you said : the frame-based javadoc does not
> integrate nicely with a forrest site.
>
> I'd like a menu item to point to my javadoc and when
> clicked I'd like it to open a new window. ( a fork
> link in forrest parlance )
> I did not find how to do it ?
> is it possible ?
>
> TIA,
> --p

It's not possible, unfortunately. It's been mentioned before, but
nobody has gotten around to doing it.

--
Dave Brondsema : dave [at] brondsema
http://www.splike.com : programming
http://csx.calvin.edu : student org
http://www.brondsema.net : personal

Attachments:

signature.asc (0.25 KB)

Index | Next | Previous | View Threaded

Interested in having your list archived? Contact Gossamer Threads