commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Dion Gillard" <dion.gill...@gmail.com>
Subject Re: [Fwd: Re: [jelly] Broken links in tag reference]
Date Mon, 20 Nov 2006 08:07:27 GMT
Hi Paul,

we were looking at automating the generation of these files using an updated
jellydoc, but that never got anywhere.

I'm happy to remove them from the doc if you feel they're getting in the
way/

On 11/20/06, Paul Libbrecht <paul@activemath.org> wrote:
>
> Dion,
>
> just wanted to be sure you received this and may answer, I still don't
> know how these tag-reference pages are built and this huge broken list
> bothers me so we should find ways to fix it (e.g. by linking inside the
> tag-libs-pages, or by removing the non-documented ones). Clearly this
> doc is much better but we have no resources to make them I'm afraid.
>
> thanks
>
> paul
>
> -------- Original Message --------
> Subject:        Re: [jelly] Broken links in tag reference
> Date:   Fri, 17 Nov 2006 14:44:41 +0100
> From:   Paul Libbrecht <paul@activemath.org>
> Reply-To:       Jakarta Commons Developers List
> <commons-dev@jakarta.apache.org>, paul@activemath.org
> To:     Dion Gillard <dion.gillard@gmail.com>
> CC:     Jakarta Commons Developers List <commons-dev@jakarta.apache.org>
> References:     <44C5591A.3040005@mdh.se>
> <b22dff980607241743hb6daccjad892d0f4efd40c5@mail.gmail.com>
> <44C5D0A8.4070001@apache.org> <44C5D9EF.9070807@activemath.org>
> <b22dff980607250411j7e9a66c1u35443cb67d7a5e33@mail.gmail.com>
> <44C60506.1060707@activemath.org>
> <b22dff980607250643t92d8988xd059381704ad3a67@mail.gmail.com>
>
>
>
> Now... I'm still missing to understand how this tag-reference is produced!
> I have finally found source xdocs for the handwritten ones but how are
> the very many others produced which are empty ? At least, one should
> correct these to the jelly doc output for the moment, or ?
>
> thanks for enlightening me.
>
> paul
>
>
> Dion Gillard wrote:
> > On 7/25/06, Paul Libbrecht <paul@activemath.org> wrote:
> >> Dion Gillard wrote:
> >> > The idea with the tag reference was to have a one stop place for all
> >> > the documentation.
> >> I thought this was what libs/index.html does.
> >> It's generated before xdoc:transform
> >
> > Not very well. It lists the tag libs, but doesn't provide anything
> > like ant's manual: http://ant.apache.org/manual/index.html ,
> > especially the tasks frameset.
> >
> >> > If we can do that with links and by improving the individual taglib
> >> > documentation, I'm all for it.
> >> So the correct way for working would be to enrich libs/index.html with
> a
> >> link to examples... right? Anything else than unit-tests ??
> >
> > If libs/index.html included an easy to navigate list of the tags
> > within the taglib, it'd be a lot better.
> >
> >> > The problem with the current taglib documentation is that
> >> > a) it's autogenerated off inadequate source markup
> >> What's that wrong ?? If the javadoc comments are inadequate, we need to
> >> make them correct, I think the jellydoc takes precedence of
> >> javadoc... or ?
> >
> > Lack of detail. Check out
> >
> http://jakarta.apache.org/commons/jelly/tag-reference/ant_fileScanner.html
> >
> > and compare it to
> >
> http://jakarta.apache.org/commons/jelly/libs/ant/tags.html#ant:fileScanner
> >
> >
> >> > b) It doesn't provide examples and usage info.
> >> how would you document examples except with unit-tests ??
> >
> > Snippets for the examples, and better usage info for badly documented
> > stuff like fileScanner as an example.
> >
> > If we can merge this stuff into better done JellyDoc, I'd be happy
> > with that too.
> >
> >>
> >> paul
> >> >
> >> > On 7/25/06, Paul Libbrecht <paul@activemath.org> wrote:
> >> >> It isn't easy as that, building the site does take a huge time
> >> because
> >> >> of the very many tag-libs.... depending on the maven version this
> may
> >> >> even turn out to impossible.
> >> >>
> >> >> This tag-reference page makes double usage with:
> >> >>     http://jakarta.apache.org/commons/jelly/libs/index.html
> >> >> whose links are all correct... why keep it ?
> >> >>
> >> >> Rebuilding the site would probably fix it if replacing
> >> >> tag-reference/x.html with libs/x/tags.html
> >> >> but do we really need that ??
> >> >>
> >> >> paul
> >> >>
> >> >>
> >> >>
> >> >> Dennis Lundberg wrote:
> >> >> > That might be so, but the links on the "All tags" page work. So
> >> it's
> >> >> > just a matter of fixing some links. If I go ahead and do that
> >> would it
> >> >> > be OK to redeploy the site?
> >> >> >
> >> >> > Dion Gillard wrote:
> >> >> >> I don't think the tag reference is complete.
> >> >> >>
> >> >> >> On 7/25/06, Dennis Lundberg <dennis.lundberg@mdh.se>
wrote:
> >> >> >>> Hi
> >> >> >>>
> >> >> >>> The links under "Tag Reference" are all broken. That is
all
> >> >> except "All
> >> >> >>> tags".
> >> >> >>>
> >> http://jakarta.apache.org/commons/jelly/tag-reference/index.html
> >> >> >>>
> >> >>
> >> >>
> >> >>
> >> >>
> >> >
> >> >
> >>
> >>
> >>
> >>
> >
> >
>
>
>
>


-- 
http://www.multitask.com.au/people/dion/
Rule of Acquisition #91: Hear all, trust nothing.

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message