tips on creating component library documentation?

[Dan Adams <da...@ifactory.com>]

I have a component library that I produced for internal use here at the
company (~30-40 components) and I need to document it so that other
people can use it easily. Other than hand formatting a lot of apt or
xdoc pages, is there an easy way to create component documentation using
maven2? I noticed that the tapestry docs are pretty much all xdoc. I'm
expecting to have to do some writing obviously, but does anyone have any
suggestions?

-- 
Dan Adams
Senior Software Engineer
Interactive Factory
617.235.5857


---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@tapestry.apache.org
For additional commands, e-mail: users-help@tapestry.apache.org

Re: tips on creating component library documentation?

[Norbert Sándor <de...@erinors.com>]

The two versions on the page are older, I have recently converted it to 
be useable from maven2.
It is currently somewhat complicated, because there is no custom maven 
plugin for it, instead the ant plugin is used.
(I had some serious classloading problems but now it seems to work OK.)

Regards,
Norbi


Jesse Kuhnert wrote:
> I would stay away from xdoc if at all possible, I only used it because
> Howard had created an xsl stylesheet to convert the old forrest docs 
> over.
> APT is much better.
>
> There is always http://www.erinors.com/product/tapdoc/, but I've not 
> heard
> any updates lately about possible maven2 support.
>
> On 8/14/06, Dan Adams <da...@ifactory.com> wrote:
>>
>> I have a component library that I produced for internal use here at the
>> company (~30-40 components) and I need to document it so that other
>> people can use it easily. Other than hand formatting a lot of apt or
>> xdoc pages, is there an easy way to create component documentation using
>> maven2? I noticed that the tapestry docs are pretty much all xdoc. I'm
>> expecting to have to do some writing obviously, but does anyone have any
>> suggestions?
>>
>> -- 
>> Dan Adams
>> Senior Software Engineer
>> Interactive Factory
>> 617.235.5857
>>
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: users-unsubscribe@tapestry.apache.org
>> For additional commands, e-mail: users-help@tapestry.apache.org
>>
>>
>
>
> ------------------------------------------------------------------------
>
> No virus found in this incoming message.
> Checked by AVG Free Edition.
> Version: 7.1.405 / Virus Database: 268.10.10/419 - Release Date: 2006.08.15.
>   


---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@tapestry.apache.org
For additional commands, e-mail: users-help@tapestry.apache.org

Re: tips on creating component library documentation?

[Jesse Kuhnert <jk...@gmail.com>]

I would stay away from xdoc if at all possible, I only used it because
Howard had created an xsl stylesheet to convert the old forrest docs over.
APT is much better.

There is always http://www.erinors.com/product/tapdoc/, but I've not heard
any updates lately about possible maven2 support.

On 8/14/06, Dan Adams <da...@ifactory.com> wrote:
>
> I have a component library that I produced for internal use here at the
> company (~30-40 components) and I need to document it so that other
> people can use it easily. Other than hand formatting a lot of apt or
> xdoc pages, is there an easy way to create component documentation using
> maven2? I noticed that the tapestry docs are pretty much all xdoc. I'm
> expecting to have to do some writing obviously, but does anyone have any
> suggestions?
>
> --
> Dan Adams
> Senior Software Engineer
> Interactive Factory
> 617.235.5857
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@tapestry.apache.org
> For additional commands, e-mail: users-help@tapestry.apache.org
>
>


-- 
Jesse Kuhnert
Tapestry/Dojo/(and a dash of TestNG), team member/developer

Open source based consulting work centered around
dojo/tapestry/tacos/hivemind.