You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by Dennis Lundberg <de...@mdh.se> on 2006/07/25 01:34:50 UTC

[jelly] Broken links in tag reference

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

-- 
Dennis Lundberg

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org

Re: [jelly] Broken links in tag reference

Posted by Paul Libbrecht <pa...@activemath.org>.
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 <pa...@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 <pa...@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 <de...@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
>> >> >>>
>> >>
>> >>
>> >>
>> >>
>> >
>> >
>>
>>
>>
>>
>
>

Re: [jelly] Broken links in tag reference

Posted by Dion Gillard <di...@gmail.com>.
On 7/25/06, Paul Libbrecht <pa...@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 <pa...@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 <de...@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/
"If you even dream of beating me you'd better wake up and apologize" -
Muhammad Ali

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org

Re: [jelly] Broken links in tag reference

Posted by Paul Libbrecht <pa...@activemath.org>.
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
> 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 ??
> 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 ?
> b) It doesn't provide examples and usage info.
how would you document examples except with unit-tests ??

paul
>
> On 7/25/06, Paul Libbrecht <pa...@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 <de...@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
>> >>>
>>
>>
>>
>>
>
>

Re: [jelly] Broken links in tag reference

Posted by Dion Gillard <di...@gmail.com>.
The idea with the tag reference was to have a one stop place for all
the documentation.

If we can do that with links and by improving the individual taglib
documentation, I'm all for it.

The problem with the current taglib documentation is that
a) it's autogenerated off inadequate source markup
b) It doesn't provide examples and usage info.


On 7/25/06, Paul Libbrecht <pa...@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 <de...@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/
"If you even dream of beating me you'd better wake up and apologize" -
Muhammad Ali

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org

Re: [jelly] Broken links in tag reference

Posted by Paul Libbrecht <pa...@activemath.org>.
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 <de...@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
>>>

Re: [jelly] Broken links in tag reference

Posted by Dion Gillard <di...@gmail.com>.
On 7/25/06, Dennis Lundberg <de...@apache.org> 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?

Um. It's not a matter of fixing some links, it's more about creating
the content for those links.

e.g. the ant.xml file is not in SVN, but ant_ant.xml is.

Or am I missing something?

>
> Dion Gillard wrote:
> > I don't think the tag reference is complete.
> >
> > On 7/25/06, Dennis Lundberg <de...@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
> >>
> >> --
> >> Dennis Lundberg
> >>
> >> ---------------------------------------------------------------------
> >> To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
> >> For additional commands, e-mail: commons-dev-help@jakarta.apache.org
> >>
> >>
> >
> >
>
>
> --
> Dennis Lundberg
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
> For additional commands, e-mail: commons-dev-help@jakarta.apache.org
>
>


-- 
http://www.multitask.com.au/people/dion/
"If you even dream of beating me you'd better wake up and apologize" -
Muhammad Ali

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org

Re: [jelly] Broken links in tag reference

Posted by Dennis Lundberg <de...@apache.org>.
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 <de...@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
>>
>> -- 
>> Dennis Lundberg
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
>> For additional commands, e-mail: commons-dev-help@jakarta.apache.org
>>
>>
> 
> 


-- 
Dennis Lundberg

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org

Re: [jelly] Broken links in tag reference

Posted by Dion Gillard <di...@gmail.com>.
I don't think the tag reference is complete.

On 7/25/06, Dennis Lundberg <de...@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
>
> --
> Dennis Lundberg
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
> For additional commands, e-mail: commons-dev-help@jakarta.apache.org
>
>


-- 
http://www.multitask.com.au/people/dion/
"If you even dream of beating me you'd better wake up and apologize" -
Muhammad Ali

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org