You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tapestry.apache.org by Jesse Kuhnert <jk...@gmail.com> on 2006/12/19 21:24:40 UTC
re: tapdoc
Sorry for not responding sooner, I didn't want to randomly blurt
something out if it might cause someone to do work based on something
I said.
Of course I'd love to have the help of some sort of auto-generated
documentation help. My personal wishes for something like this would
be:
-) Ability for tapdoc to generate and contribute to the reporting
lifecycle of maven in such a way that it becomes an integrated part of
the normal maven site generation. This would mean that it would use
the same stylesheets/maven theme that the rest of the site already
uses as well as ~not~ creating a separate site with frames and such.
I'm leaning more and more towards the belief that branding/visual
presentation/etc of Tapestry is really important for us to maintain
and be sticklers about - so the ability to have a seamless flow of
documentation would be really helpful towards this goal. (whenever
possible, javadocs and the use of naturaldocs are unavoidable )
-) Have the code for tapdoc hosted in a public source control
repository that all tapestry committers have access to.
-) Additionally need the ability for tapestry developers to publish
the plugin in an ibiblio friendly maven repo somewhere. We currently
either use the apache servers or howardlewisship.com to do this.
None of this sounds like a light undertaking I know, but if we're
going to get ourselves into a situation where we depend on a tool for
something as critical as documentation I want to make sure it's as
friendly as possible.
On 12/18/06, Norbert Sándor <de...@erinors.com> wrote:
> Please?
>
> D&J Gredler írta:
> > Bump?
> >
> > On 12/16/06, Norbert Sándor <de...@erinors.com> wrote:
> >>
> >> Would you use tapdoc for building tapestry's component doc, if I would
> >> make the required modifications?
> >>
> >> Regards:
> >> Norbi
--
Jesse Kuhnert
Tapestry/Dojo team member/developer
Open source based consulting work centered around
dojo/tapestry/tacos/hivemind. http://blog.opencomponentry.com
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tapestry.apache.org
For additional commands, e-mail: dev-help@tapestry.apache.org
Re: tapdoc
Posted by Norbert Sándor <de...@erinors.com>.
OK, I do my best :)
Regards:
Norbi
Jesse Kuhnert írta:
> Sorry for not responding sooner, I didn't want to randomly blurt
> something out if it might cause someone to do work based on something
> I said.
>
> Of course I'd love to have the help of some sort of auto-generated
> documentation help. My personal wishes for something like this would
> be:
>
> -) Ability for tapdoc to generate and contribute to the reporting
> lifecycle of maven in such a way that it becomes an integrated part of
> the normal maven site generation. This would mean that it would use
> the same stylesheets/maven theme that the rest of the site already
> uses as well as ~not~ creating a separate site with frames and such.
> I'm leaning more and more towards the belief that branding/visual
> presentation/etc of Tapestry is really important for us to maintain
> and be sticklers about - so the ability to have a seamless flow of
> documentation would be really helpful towards this goal. (whenever
> possible, javadocs and the use of naturaldocs are unavoidable )
>
> -) Have the code for tapdoc hosted in a public source control
> repository that all tapestry committers have access to.
>
> -) Additionally need the ability for tapestry developers to publish
> the plugin in an ibiblio friendly maven repo somewhere. We currently
> either use the apache servers or howardlewisship.com to do this.
>
> None of this sounds like a light undertaking I know, but if we're
> going to get ourselves into a situation where we depend on a tool for
> something as critical as documentation I want to make sure it's as
> friendly as possible.
>
> On 12/18/06, Norbert Sándor <de...@erinors.com> wrote:
>> Please?
>>
>> D&J Gredler írta:
>> > Bump?
>> >
>> > On 12/16/06, Norbert Sándor <de...@erinors.com> wrote:
>> >>
>> >> Would you use tapdoc for building tapestry's component doc, if I
>> would
>> >> make the required modifications?
>> >>
>> >> Regards:
>> >> Norbi
>
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tapestry.apache.org
For additional commands, e-mail: dev-help@tapestry.apache.org
Re: tapdoc
Posted by Norbert Sándor <de...@erinors.com>.
I'm working on a new release, its primary goal is better documentation.
The info comes from .jwc files and javadoc comments as well, so you can
generate documentation for annotation based components. (Although there
is a related issue: http://issues.apache.org/jira/browse/TAPESTRY-1192)
Additional information comes from special Component.tapdoc.xml files
which is currently undocumented :|
Regards:
Norbi
D&J Gredler írta:
> Any chance of getting some better documentation, too? Like where does
> information come from? Just component specs? Or JavaDoc, too? I'm really
> interested in tapdoc, but I have no idea what the end goal is, besides
> uniting and simplifying Tapestry component documentation.
>
>
> On 12/19/06, Jesse Kuhnert <jk...@gmail.com> wrote:
>>
>> Sorry for not responding sooner, I didn't want to randomly blurt
>> something out if it might cause someone to do work based on something
>> I said.
>>
>> Of course I'd love to have the help of some sort of auto-generated
>> documentation help. My personal wishes for something like this would
>> be:
>>
>> -) Ability for tapdoc to generate and contribute to the reporting
>> lifecycle of maven in such a way that it becomes an integrated part of
>> the normal maven site generation. This would mean that it would use
>> the same stylesheets/maven theme that the rest of the site already
>> uses as well as ~not~ creating a separate site with frames and such.
>> I'm leaning more and more towards the belief that branding/visual
>> presentation/etc of Tapestry is really important for us to maintain
>> and be sticklers about - so the ability to have a seamless flow of
>> documentation would be really helpful towards this goal. (whenever
>> possible, javadocs and the use of naturaldocs are unavoidable )
>>
>> -) Have the code for tapdoc hosted in a public source control
>> repository that all tapestry committers have access to.
>>
>> -) Additionally need the ability for tapestry developers to publish
>> the plugin in an ibiblio friendly maven repo somewhere. We currently
>> either use the apache servers or howardlewisship.com to do this.
>>
>> None of this sounds like a light undertaking I know, but if we're
>> going to get ourselves into a situation where we depend on a tool for
>> something as critical as documentation I want to make sure it's as
>> friendly as possible.
>>
>> On 12/18/06, Norbert Sándor <de...@erinors.com> wrote:
>> > Please?
>> >
>> > D&J Gredler írta:
>> > > Bump?
>> > >
>> > > On 12/16/06, Norbert Sándor <de...@erinors.com> wrote:
>> > >>
>> > >> Would you use tapdoc for building tapestry's component doc, if I
>> would
>> > >> make the required modifications?
>> > >>
>> > >> Regards:
>> > >> Norbi
>>
>>
>>
>> --
>> Jesse Kuhnert
>> Tapestry/Dojo team member/developer
>>
>> Open source based consulting work centered around
>> dojo/tapestry/tacos/hivemind. http://blog.opencomponentry.com
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@tapestry.apache.org
>> For additional commands, e-mail: dev-help@tapestry.apache.org
>>
>>
>
> ------------------------------------------------------------------------
>
> No virus found in this incoming message.
> Checked by AVG Free Edition.
> Version: 7.5.432 / Virus Database: 268.15.24/592 - Release Date: 2006.12.18. 13:45
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tapestry.apache.org
For additional commands, e-mail: dev-help@tapestry.apache.org
Re: tapdoc
Posted by D&J Gredler <dj...@gmail.com>.
Any chance of getting some better documentation, too? Like where does
information come from? Just component specs? Or JavaDoc, too? I'm really
interested in tapdoc, but I have no idea what the end goal is, besides
uniting and simplifying Tapestry component documentation.
On 12/19/06, Jesse Kuhnert <jk...@gmail.com> wrote:
>
> Sorry for not responding sooner, I didn't want to randomly blurt
> something out if it might cause someone to do work based on something
> I said.
>
> Of course I'd love to have the help of some sort of auto-generated
> documentation help. My personal wishes for something like this would
> be:
>
> -) Ability for tapdoc to generate and contribute to the reporting
> lifecycle of maven in such a way that it becomes an integrated part of
> the normal maven site generation. This would mean that it would use
> the same stylesheets/maven theme that the rest of the site already
> uses as well as ~not~ creating a separate site with frames and such.
> I'm leaning more and more towards the belief that branding/visual
> presentation/etc of Tapestry is really important for us to maintain
> and be sticklers about - so the ability to have a seamless flow of
> documentation would be really helpful towards this goal. (whenever
> possible, javadocs and the use of naturaldocs are unavoidable )
>
> -) Have the code for tapdoc hosted in a public source control
> repository that all tapestry committers have access to.
>
> -) Additionally need the ability for tapestry developers to publish
> the plugin in an ibiblio friendly maven repo somewhere. We currently
> either use the apache servers or howardlewisship.com to do this.
>
> None of this sounds like a light undertaking I know, but if we're
> going to get ourselves into a situation where we depend on a tool for
> something as critical as documentation I want to make sure it's as
> friendly as possible.
>
> On 12/18/06, Norbert Sándor <de...@erinors.com> wrote:
> > Please?
> >
> > D&J Gredler írta:
> > > Bump?
> > >
> > > On 12/16/06, Norbert Sándor <de...@erinors.com> wrote:
> > >>
> > >> Would you use tapdoc for building tapestry's component doc, if I
> would
> > >> make the required modifications?
> > >>
> > >> Regards:
> > >> Norbi
>
>
>
> --
> Jesse Kuhnert
> Tapestry/Dojo team member/developer
>
> Open source based consulting work centered around
> dojo/tapestry/tacos/hivemind. http://blog.opencomponentry.com
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@tapestry.apache.org
> For additional commands, e-mail: dev-help@tapestry.apache.org
>
>