Any tool for ant build.xml file documentation

[I am Who i am]

Hi All,

I have a very big build.xml, and i want to create a doucmentation for it, is
there any tool for it,

I found one called antDoc but couldn't make it work, ant its not seems to be
being updated,

Any ideas?

[Scot P. Floess]

I have an XSLT that will convert Ant scripts to HTML...  It can be found
at http://sourceforge.net/projects/keros

Or I can send it to you directly...


I am Who i am wrote:

> Hi All,
>
> I have a very big build.xml, and i want to create a doucmentation for it, is
> there any tool for it,
>
> I found one called antDoc but couldn't make it work, ant its not seems to be
> being updated,
>
> Any ideas?
>
>  

--
Scot P. Floess
27 Lake Royale
Louisburg, NC  27549

252-478-8087 (Home)
919-754-4592 (Work)

Chief Architect JPlate   http://sourceforge.net/projects/jplate
Chief Architect JavaPIM  http://sourceforge.net/projects/javapim

Architect Keros          http://sourceforge.net/projects/keros


---------------------------------------------------------------------
To unsubscribe, e-mail: user-unsubscribe@...
For additional commands, e-mail: user-help@...

[Dave Pawson-2]

On 22/04/2008, I am Who i am <ragjan@...> wrote:
> Hi All,
>
>  I have a very big build.xml, and i want to create a doucmentation for it, is
>  there any tool for it,
>
>  I found one called antDoc but couldn't make it work, ant its not seems to be
>  being updated,
>
>  Any ideas?

It would help if ant were namespace aware, then additional documentation
could be added in another namespace.

<project xmlns:d="http://www.dpawson.co.uk#ns"
    name="generate"
    basedir="/sgml/site2/pawson/"
    default="help">
<d:description>Main variable set</d:description>

Error reported:

build.xml:16: Problem: failed to create task or type
http://www.dpawson.co.uk#ns:description
Cause: The name is undefined.


That would be a very helpful feature for larger build files.

regards






--
Dave Pawson
XSLT XSL-FO FAQ.
http://www.dpawson.co.uk

---------------------------------------------------------------------
To unsubscribe, e-mail: user-unsubscribe@...
For additional commands, e-mail: user-help@...

[Steve Loughran]

Dave Pawson wrote:

>
> It would help if ant were namespace aware, then additional documentation
> could be added in another namespace.

Ant is namespace aware, it merely chooses not to ignore content in other
namespaces, as it assumes they are tasks declared into a different
namespace.

>
> <project xmlns:d="http://www.dpawson.co.uk#ns"
>     name="generate"
>     basedir="/sgml/site2/pawson/"
>     default="help">
> <d:description>Main variable set</d:description>
>
> Error reported:
>
> build.xml:16: Problem: failed to create task or type
> http://www.dpawson.co.uk#ns:description
> Cause: The name is undefined.
>
>
> That would be a very helpful feature for larger build files.

--
Consider this, then, my gift to you:

<presetdef name="description" uri="http://www.dpawson.co.uk#ns" >
        <echo level="debug" />
</presetdef>

you now get a description
<d:description>Main variable set</d:description>

which gets printed when you run
ant -debug

[description] Main variable set

--
Steve Loughran                  http://www.1060.org/blogxter/publish/5
Author: Ant in Action           http://antbook.org/

---------------------------------------------------------------------
To unsubscribe, e-mail: user-unsubscribe@...
For additional commands, e-mail: user-help@...

[Peter Reilly-2]

On Wed, Apr 23, 2008 at 10:31 AM, Steve Loughran <stevel@...> wrote:

> Dave Pawson wrote:
>
>
> >
> > It would help if ant were namespace aware, then additional documentation
> > could be added in another namespace.
> >
>
>  Ant is namespace aware, it merely chooses not to ignore content in other
> namespaces, as it assumes they are tasks declared into a different
> namespace.
>

There was some debate about this when NameSpace awareness was added to
Ant in 1.6.*.

Peter

>
>
> >
> > <project xmlns:d="http://www.dpawson.co.uk#ns"
> >    name="generate"
> >    basedir="/sgml/site2/pawson/"
> >    default="help">
> > <d:description>Main variable set</d:description>
> >
> > Error reported:
> >
> > build.xml:16: Problem: failed to create task or type
> > http://www.dpawson.co.uk#ns:description
> > Cause: The name is undefined.
> >
> >
> > That would be a very helpful feature for larger build files.
> >
>  --
>  Consider this, then, my gift to you:
>
>  <presetdef name="description" uri="http://www.dpawson.co.uk#ns" >
>         <echo level="debug" />
>  </presetdef>
>
>  you now get a description
>
>  <d:description>Main variable set</d:description>
>
>  which gets printed when you run
>  ant -debug
>
>  [description] Main variable set
>
>  --
>  Steve Loughran                  http://www.1060.org/blogxter/publish/5
>  Author: Ant in Action           http://antbook.org/
>
>
>
>  ---------------------------------------------------------------------
>  To unsubscribe, e-mail: user-unsubscribe@...
>  For additional commands, e-mail: user-help@...
>
>

---------------------------------------------------------------------
To unsubscribe, e-mail: user-unsubscribe@...
For additional commands, e-mail: user-help@...

[Dave Pawson-2]

On 23/04/2008, Steve Loughran <stevel@...> wrote:

>  Ant is namespace aware, it merely chooses not to ignore content in other
> namespaces, as it assumes they are tasks declared into a different
> namespace.

Kind of against the idea of namespace aware apps?
If you don't have a use for namespace X, ignore it.

>  Consider this, then, my gift to you:
>
>  <presetdef name="description" uri="http://www.dpawson.co.uk#ns" >
>         <echo level="debug" />
>  </presetdef>
>
>  you now get a description
>  <d:description>Main variable set</d:description>
>
>  which gets printed when you run
>  ant -debug

Nice. For debug. Thanks.

Not for other namespaced applications working on ant build files.
Documentation seems like a good use case.



regards


--
Dave Pawson
XSLT XSL-FO FAQ.
http://www.dpawson.co.uk

---------------------------------------------------------------------
To unsubscribe, e-mail: user-unsubscribe@...
For additional commands, e-mail: user-help@...

[Steve Loughran]

Dave Pawson wrote:
> On 23/04/2008, Steve Loughran <stevel@...> wrote:
>
>>  Ant is namespace aware, it merely chooses not to ignore content in other
>> namespaces, as it assumes they are tasks declared into a different
>> namespace.
>
> Kind of against the idea of namespace aware apps?
> If you don't have a use for namespace X, ignore it.

well, it depends on what you want from a namespaced app. And more
importantly, what you mean by "understand". I have been in way too many
discussions on the exact semantics of soap's "mustUnderstand" attribute
on soap headers to believe that there is any single right answer here.

For ant, how do we distinguish between "task in wrong namespace" from
"undefined task in a namespace" from "namespace we are meant to ignore".
Without an explicit <ignorenamespace> operation, we can't.

>
>
>>  Consider this, then, my gift to you:
>>
>>  <presetdef name="description" uri="http://www.dpawson.co.uk#ns" >
>>         <echo level="debug" />
>>  </presetdef>
>>
>>  you now get a description
>>  <d:description>Main variable set</d:description>
>>
>>  which gets printed when you run
>>  ant -debug
>
> Nice. For debug. Thanks.
>
> Not for other namespaced applications working on ant build files.

Well,
1. they are free to embed bits of ant in their XML and push it out later
2. If you want to write an <ignorenamespace> task, with tests, we could
always add it.




--
Steve Loughran                  http://www.1060.org/blogxter/publish/5
Author: Ant in Action           http://antbook.org/

---------------------------------------------------------------------
To unsubscribe, e-mail: user-unsubscribe@...
For additional commands, e-mail: user-help@...

[Peter Reilly-2]

On Wed, Apr 23, 2008 at 11:40 AM, Steve Loughran <stevel@...> wrote:

> Dave Pawson wrote:
>
> > On 23/04/2008, Steve Loughran <stevel@...> wrote:
> >
> >
> > >  Ant is namespace aware, it merely chooses not to ignore content in
> other
> > > namespaces, as it assumes they are tasks declared into a different
> > > namespace.
> > >
> >
> > Kind of against the idea of namespace aware apps?
> > If you don't have a use for namespace X, ignore it.
> >
>
>  well, it depends on what you want from a namespaced app. And more
> importantly, what you mean by "understand". I have been in way too many
> discussions on the exact semantics of soap's "mustUnderstand" attribute on
> soap headers to believe that there is any single right answer here.
>
>  For ant, how do we distinguish between "task in wrong namespace" from
> "undefined task in a namespace" from "namespace we are meant to ignore".
> Without an explicit <ignorenamespace> operation, we can't.

IMO ant should by default ignore elements from namespaces not prefixed
by "antlib:", unless there is an explicit *def.

Peter

>
>
>
> >
> >
> >
> > >  Consider this, then, my gift to you:
> > >
> > >  <presetdef name="description" uri="http://www.dpawson.co.uk#ns" >
> > >        <echo level="debug" />
> > >  </presetdef>
> > >
> > >  you now get a description
> > >  <d:description>Main variable set</d:description>
> > >
> > >  which gets printed when you run
> > >  ant -debug
> > >
> >
> > Nice. For debug. Thanks.
> >
> > Not for other namespaced applications working on ant build files.
> >
>
>  Well,
>  1. they are free to embed bits of ant in their XML and push it out later
>  2. If you want to write an <ignorenamespace> task, with tests, we could
> always add it.
>
>
>
>
>
>  --
>  Steve Loughran                  http://www.1060.org/blogxter/publish/5
>  Author: Ant in Action           http://antbook.org/
>
>  ---------------------------------------------------------------------
>
>  To unsubscribe, e-mail: user-unsubscribe@...
>  For additional commands, e-mail: user-help@...
>
>

---------------------------------------------------------------------
To unsubscribe, e-mail: user-unsubscribe@...
For additional commands, e-mail: user-help@...

[Dave Pawson-2]

On 23/04/2008, Steve Loughran <stevel@...> wrote:

> > Kind of against the idea of namespace aware apps?
> > If you don't have a use for namespace X, ignore it.
> >
>
>  well, it depends on what you want from a namespaced app. And more
> importantly, what you mean by "understand". I have been in way too many
> discussions on the exact semantics of soap's "mustUnderstand" attribute on
> soap headers to believe that there is any single right answer here.

I'd ignore soap (and others in the ws* stack) for ns usage.
XSLT makes a cleaner example, as does relax NG.

>
>  For ant, how do we distinguish between "task in wrong namespace" from
> "undefined task in a namespace" from "namespace we are meant to ignore".
> Without an explicit <ignorenamespace> operation, we can't.

Ant tasks take the default (null) namespace, as the precursor,
or put ant into its own namespace.

An added benefit would be other tasks, in other namespaces,
as possible experimental extensions.


>  Well,
>  1. they are free to embed bits of ant in their XML and push it out later
>  2. If you want to write an <ignorenamespace> task, with tests, we could
> always add it.

Not a facet of XML to my knowledge. Ant uses XML
(quite well from what I've used!)



--
Dave Pawson
XSLT XSL-FO FAQ.
http://www.dpawson.co.uk

---------------------------------------------------------------------
To unsubscribe, e-mail: user-unsubscribe@...
For additional commands, e-mail: user-help@...

[Charbel BITAR-2]

Hi,

Give Ant Pretty Build a try...
http://antprettybuild.sourceforge.net

HTH
--
Charbel



On Wed, Apr 23, 2008 at 12:57 AM, I am Who i am <ragjan@...> wrote:

> Hi All,
>
> I have a very big build.xml, and i want to create a doucmentation for it,
> is
> there any tool for it,
>
> I found one called antDoc but couldn't make it work, ant its not seems to
> be
> being updated,
>
> Any ideas?
>