You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tapestry.apache.org by Norbert Sándor <de...@erinors.com> on 2006/03/06 12:20:11 UTC
tapdoc progress...
Hello,
I'm actively working on TapDoc, you may check out the progress at
http://www.erinors.com/product/tapdoc/sample/index.html.
What's new:
- javadoc-like layout for easier navigation
- indicate component visuality (allow visual sample in case of visual
components, see Framework:RadioGroup for an example)
What I'd like to do before release:
- @Parameter annotation support (almost done)
- Ant task
- user's guide
- wrap long default values (like in case of
Tacos:Autocompleter/listItemRenderer)
- code and XSLT template cleanup
Future plans:
- handling hyperlinks in descriptions
- allow external linking to component docs
- include as many things as possible in the generated documentation
(like injected objects with links to hivedoc, referenced components,
referenced libraries, embedded components if any)
- include the XML template(s) in the docs (if any)
- examples (with live view by linking to a running tapestry app)
If you have any comments or have an idea just e-mail me!
Regards,
Norbi
---------------------------------------------------------------------
To unsubscribe, e-mail: tapestry-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: tapestry-dev-help@jakarta.apache.org
Re: tapdoc progress...
Posted by Norbert Sándor <de...@erinors.com>.
xdoc support requires only the rewrite of the xsl files (and probably
overriding 1 hivemind service of tapdoc).
As soon as the core features are ready, I will provide an implementation
for this.
Thanks for the suggestion!
Embedding tapdoc to the tacos/tapestry build system would require more
documentation in the jwc files.
Regards,
Norbi
Jesse Kuhnert wrote:
> That looks great!
>
> I'm sure tacos can benefit from working with it, but the only problem that
> I'd think tapestry would have would be navigation. It may be a personal
> peeve, but I don't like the idea of people having to navigate "away" from
> the main site to see the component docs.
>
> To do something that would make it tap friendly would probably require
> generating xdox files instead of just html. Tapestry 4.1 is supposed to be
> moving towards using maven docs which are xdoc based I think (something-doc
> at least... ) . Does this sound unreasonable? Eithery way it looks really
> nice and would be a ~huge~ benefit for tapestry as anything that makes
> writing documentation easier is a big plus imho.
>
> jesse
>
> On 3/6/06, Norbert Sándor <de...@erinors.com> wrote:
>
>> Hello,
>>
>> I'm actively working on TapDoc, you may check out the progress at
>> http://www.erinors.com/product/tapdoc/sample/index.html.
>> What's new:
>> - javadoc-like layout for easier navigation
>> - indicate component visuality (allow visual sample in case of visual
>> components, see Framework:RadioGroup for an example)
>>
>> What I'd like to do before release:
>> - @Parameter annotation support (almost done)
>> - Ant task
>> - user's guide
>> - wrap long default values (like in case of
>> Tacos:Autocompleter/listItemRenderer)
>> - code and XSLT template cleanup
>>
>> Future plans:
>> - handling hyperlinks in descriptions
>> - allow external linking to component docs
>> - include as many things as possible in the generated documentation
>> (like injected objects with links to hivedoc, referenced components,
>> referenced libraries, embedded components if any)
>> - include the XML template(s) in the docs (if any)
>> - examples (with live view by linking to a running tapestry app)
>>
>> If you have any comments or have an idea just e-mail me!
>>
>> Regards,
>> Norbi
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: tapestry-dev-unsubscribe@jakarta.apache.org
>> For additional commands, e-mail: tapestry-dev-help@jakarta.apache.org
>>
>>
>>
>
>
> ------------------------------------------------------------------------
>
> No virus found in this incoming message.
> Checked by AVG Free Edition.
> Version: 7.1.375 / Virus Database: 268.1.2/274 - Release Date: 2006.03.03.
>
---------------------------------------------------------------------
To unsubscribe, e-mail: tapestry-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: tapestry-dev-help@jakarta.apache.org
Re: tapdoc progress...
Posted by Jesse Kuhnert <jk...@gmail.com>.
Maybe so...It just seems like such a "core" thing, but maybe I'm being
resistant to change.
On 3/6/06, Massimo Lusetti <ml...@gmail.com> wrote:
>
> On 3/6/06, Jesse Kuhnert <jk...@gmail.com> wrote:
>
> > I'm sure tacos can benefit from working with it, but the only problem
> that
> > I'd think tapestry would have would be navigation. It may be a personal
> > peeve, but I don't like the idea of people having to navigate "away"
> from
> > the main site to see the component docs.
>
> Couldn't be sought just like JavaDoc or HiveDoc?
>
> --
> Massimo
> http://meridio.blogspot.com
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: tapestry-dev-unsubscribe@jakarta.apache.org
> For additional commands, e-mail: tapestry-dev-help@jakarta.apache.org
>
>
Re: tapdoc progress...
Posted by Massimo Lusetti <ml...@gmail.com>.
On 3/6/06, Jesse Kuhnert <jk...@gmail.com> wrote:
> I'm sure tacos can benefit from working with it, but the only problem that
> I'd think tapestry would have would be navigation. It may be a personal
> peeve, but I don't like the idea of people having to navigate "away" from
> the main site to see the component docs.
Couldn't be sought just like JavaDoc or HiveDoc?
--
Massimo
http://meridio.blogspot.com
---------------------------------------------------------------------
To unsubscribe, e-mail: tapestry-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: tapestry-dev-help@jakarta.apache.org
Re: tapdoc progress...
Posted by Jesse Kuhnert <jk...@gmail.com>.
That looks great!
I'm sure tacos can benefit from working with it, but the only problem that
I'd think tapestry would have would be navigation. It may be a personal
peeve, but I don't like the idea of people having to navigate "away" from
the main site to see the component docs.
To do something that would make it tap friendly would probably require
generating xdox files instead of just html. Tapestry 4.1 is supposed to be
moving towards using maven docs which are xdoc based I think (something-doc
at least... ) . Does this sound unreasonable? Eithery way it looks really
nice and would be a ~huge~ benefit for tapestry as anything that makes
writing documentation easier is a big plus imho.
jesse
On 3/6/06, Norbert Sándor <de...@erinors.com> wrote:
>
> Hello,
>
> I'm actively working on TapDoc, you may check out the progress at
> http://www.erinors.com/product/tapdoc/sample/index.html.
> What's new:
> - javadoc-like layout for easier navigation
> - indicate component visuality (allow visual sample in case of visual
> components, see Framework:RadioGroup for an example)
>
> What I'd like to do before release:
> - @Parameter annotation support (almost done)
> - Ant task
> - user's guide
> - wrap long default values (like in case of
> Tacos:Autocompleter/listItemRenderer)
> - code and XSLT template cleanup
>
> Future plans:
> - handling hyperlinks in descriptions
> - allow external linking to component docs
> - include as many things as possible in the generated documentation
> (like injected objects with links to hivedoc, referenced components,
> referenced libraries, embedded components if any)
> - include the XML template(s) in the docs (if any)
> - examples (with live view by linking to a running tapestry app)
>
> If you have any comments or have an idea just e-mail me!
>
> Regards,
> Norbi
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: tapestry-dev-unsubscribe@jakarta.apache.org
> For additional commands, e-mail: tapestry-dev-help@jakarta.apache.org
>
>