You are viewing a plain text version of this content. The canonical link for it is here.
Posted to user@ant.apache.org by "O'brien, Tim" <to...@transolutions.net> on 2003/01/03 19:15:14 UTC
Ant Core Task Quick Reference
I compiled a simple Ant quick reference from the existing Ant documentation.
I kept on forgetting attribute names, etc...
http://www.discursive.com/articles/2003/01/ant_core_ref.html
There are probably typos, and problems. If anyone has any suggestions
please send them my way. I figure that one could probably trim this down to
4 pages by removing some of the less-used tasks and consolidating some of
the repeated task examples.
It would be interesting for someone to do a frequeny analysis of Ant tasks.
Which tasks get used the most, etc?
Since the work is a copy of existing doc I gave credit to all Ant doc
writers at the end.
--------
Tim O'Brien
Transolutions, Inc.
W 847-574-2143
M 847-863-7045
> -----Original Message-----
> From: Scott Rickard [mailto:rickard43@insightbb.com]
> Sent: Friday, January 03, 2003 11:59 AM
> To: ant-user@jakarta.apache.org
> Subject: Problem with JUNIT/XERCES
>
>
> Hello All -
>
> I am attempting to upgrade my production build environment
> from ANT 1.4.1 to ANT 1.5.1, using the precompiled binary
> distributions. I am running under IBM JDK 1.3.0.3 on AIX
> 4.33ML10. Under ANT 1.4 I had no problems with my junit
> tasks, but under 1.5.1 I receive the following error message
> in my JUNIT tasks:
>
> [junit] Exception in thread "main" java.lang.VerifyError:
> (class: org/apache/xerces/jaxp/DocumentBuilderImpl, method:
> parse signature:
> (Lorg/xml/sax/InputSource;)Lorg/w3c/dom/Document;)
> Incompatible object argument for method call
>
> This only seems to be affecting my 'optional' tasks, as the
> standard compile and jar tasks I use work fine, and even PMD
> works fine.
>
> I have already attempted upgrading my xalan and junit
> packages to the latest levels(Xalan-j_2_4_1 and JUNIT 3.8.1),
> and the error persists, even with the latest stable versions
> of all the code.
>
> My classpath contains the proper jarfiles specified by the
> documentation, and I've been using ant (since 1.2 beta
> release) for about 2 years now, and never encountered a
> problem such as this. I need to move to ANT 1.5.1 to add in
> support for a PMD requirement, and I am stuck! I have
> searched the archives, and seen several posts like this, but
> none offered any workaround - can anyone offer any insight
> into this problem?
>
> Thanks in advance,
> Scott Rickard
> rickard43@insightbb.com
>
>
> --
> To unsubscribe, e-mail:
> <mailto:ant-user-> unsubscribe@jakarta.apache.org>
> For
> additional commands,
> e-mail: <ma...@jakarta.apache.org>
>
>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: Ant Core Task Quick Reference
Posted by Steve Loughran <st...@iseran.com>.
----- Original Message -----
From: "Kenneth Lee" <ke...@netvigator.com>
To: "Ant Users List" <an...@jakarta.apache.org>
Sent: Saturday, January 04, 2003 09:55
Subject: Re: Ant Core Task Quick Reference
> Thank you. I was once thinking about doing something similar.
> But then I realize that keeping another set of documentation is likely
> to have it not-synced with the rapidly changing core manual.
One word: xdoclet. That's how we (well Erik) autogenerated the quick
reference in our book, and some of the very new tasks (setproxy, all the
apache axis tasks) are autogenerated from the same tags.
>
> Moreover, as a beginner, I find that the existing core manual has
> inadequate information and examples to follow, ambiguous and
> incomplete in some areas, and inconsistent for both content and
> layout.
A quirk of history and the fact that open source projects are done by
volunteers. You may not appreciate it, but compared to other projects the
Ant stuff is very good.
>
> So I propose that the core documentation to be rebuilt from scratch,
> probably in XML, so that different views of the manual (normal view
> as well as quickref and index) could be generated in a unified manner
> (thru XSLT and CSS.), for both core docs and third-party docs.
> The information in the XML may also be useful for some Ant build file
> editor. An online (or offline) searchable manual is also a very good
> helper. There should be a repository of the documentation of all commonly
> used tasks, including core and third party tasks.
Are you volunteering to do it?
> May be there should be an Ant-doc subproject?
I dont think we need to go that far, we just need
(a) Xdoclet markup enhancements to bind the docs to the task source
(b) XSLT xforms to generate HTML, PDF output
(c) someone to move everything else to a docbook format for autogen of html
or PDF
Adding new markup to every single task is hard work, I should point out. We
currently have a lot of duplication in the .java and .html content, but the
.html is still richer. We need to get to a point where xdoclet generated
docs is the core of the ant task reference, and the rest is handwritten
docbook XML.
> I sincerely hope that there will be a more complete, well written Ant
> documentation which could benefit to all of us, both experienced or
> beginners.
Well, Ant always appreciates new documentation; if you have more to add, or
corrections to make to the existing stuff, get on board.
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: Ant Core Task Quick Reference
Posted by Erik Hatcher <ja...@ehatchersolutions.com>.
On Saturday, January 4, 2003, at 11:38 PM, Steve Loughran wrote:
>
> ----- Original Message -----
> From: "Erik Hatcher" <ja...@ehatchersolutions.com>
> To: "Ant Users List" <an...@jakarta.apache.org>
> Sent: Saturday, January 04, 2003 15:52
> Subject: Re: Ant Core Task Quick Reference
>
>
>
>> Its always been my goal to generate a quick reference of Ant
>> tasks/datatypes, and we achieved this goal mostly already and its
>> dead-on 100% accurate with how Ant works, rather than the current HTML
>> documentation which may (or may not) have holes in which
>> attributes/elements are shown. Generating from XDoclet will ensure
>> accuracy and allow attribute/element descriptions to be where they are
>> defined rather than separately maintained.
>
> How do you propose we go about docing nested elements?
I'm not sure how it will play out.... but probably just recursively
document them with the stop logic being when it hits a datatype, since
these will be generated separately.
So as far as what we put on Javadoc comments and @tags, it would be the
same as top-level task elements.
I've just now gotten it working again with XDoclet 1.2 and committed my
stuff to XDoclet's CVS last night, the first version of it. I plan on
making an Ant task wrapper similar to things like <ejbdoclet> and
<webdoclet> and let it contain the <taskdescriptor> and
<taskproperties> subtasks (names subject to change, of course.
Erik
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: Ant Core Task Quick Reference
Posted by Steve Loughran <st...@iseran.com>.
----- Original Message -----
From: "Erik Hatcher" <ja...@ehatchersolutions.com>
To: "Ant Users List" <an...@jakarta.apache.org>
Sent: Saturday, January 04, 2003 15:52
Subject: Re: Ant Core Task Quick Reference
> Its always been my goal to generate a quick reference of Ant
> tasks/datatypes, and we achieved this goal mostly already and its
> dead-on 100% accurate with how Ant works, rather than the current HTML
> documentation which may (or may not) have holes in which
> attributes/elements are shown. Generating from XDoclet will ensure
> accuracy and allow attribute/element descriptions to be where they are
> defined rather than separately maintained.
How do you propose we go about docing nested elements?
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
RE: Ant Core Task Quick Reference
Posted by "O'brien, Tim" <to...@transolutions.net>.
Appendix E is a good reference, but the compiled examples reference fills a
different need. In other words, it is valuable to have some sort of 20-25
page, autogenerated from xdoclet guide to tasks, but it would also be
valuable to have a more compact reference. I think Ant could get down to
two double-sided 3-column 8.5" x 11".
This was inspired by refcards.com's Apache directive reference, and Mulberry
Technologies, XML reference cards. When space is a premium, you start
getting into tweaks and formatting to ensure that space is conserved and
that page boundaries don't bissect some example. I think that things like
this will continue to be done by hand in some word processor, page layout
program. In other words, when space is a premium, you move to custom layout
- ideally this would be stored in something like SVG.
--------
Tim O'Brien
W 847-574-2143
M 847-863-7045
> -----Original Message-----
> From: Stefan Moebius [mailto:stmoebius@yahoo.com]
> Sent: Monday, January 06, 2003 6:10 AM
> To: Ant Users List
> Subject: Re: Ant Core Task Quick Reference
>
>
>
> --- Erik Hatcher <ja...@ehatchersolutions.com> wrote:
> > And its been in Ant's CVS for a while too :))
> >
> > And, I believe, is actually part of the Ant distribution of 1.5.1 at
> > least. No?
>
> Yes, it is. Obviously not very prominently placed, though 8-)
>
> -- Stefan
>
> =====
> Stefan Moebius <st...@yahoo.com>
> Wurzener Str. 43 +49 351 8475827
> 01127 Dresden +49 172 8739617
>
> __________________________________________________
> Do you Yahoo!?
> Yahoo! Mail Plus - Powerful. Affordable. Sign up now.
http://mailplus.yahoo.com
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: Ant Core Task Quick Reference
Posted by Stefan Moebius <st...@yahoo.com>.
--- Erik Hatcher <ja...@ehatchersolutions.com> wrote:
> And its been in Ant's CVS for a while too :))
>
> And, I believe, is actually part of the Ant distribution of 1.5.1 at
> least. No?
Yes, it is. Obviously not very prominently placed, though 8-)
-- Stefan
=====
Stefan Moebius <st...@yahoo.com>
Wurzener Str. 43 +49 351 8475827
01127 Dresden +49 172 8739617
__________________________________________________
Do you Yahoo!?
Yahoo! Mail Plus - Powerful. Affordable. Sign up now.
http://mailplus.yahoo.com
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: Ant Core Task Quick Reference
Posted by Erik Hatcher <ja...@ehatchersolutions.com>.
And its been in Ant's CVS for a while too :))
And, I believe, is actually part of the Ant distribution of 1.5.1 at
least. No?
On Sunday, January 5, 2003, at 07:53 PM, Bill Winspur wrote:
> Eric,
>
> the appendix e pdf has exactly the information i've needed for a long
> time,
> thanks.
>
> Bill.
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: Ant Core Task Quick Reference
Posted by Bill Winspur <bw...@wynnon.com>.
Eric,
the appendix e pdf has exactly the information i've needed for a long time,
thanks.
Bill.
----- Original Message -----
From: "Erik Hatcher" <ja...@ehatchersolutions.com>
To: "Ant Users List" <an...@jakarta.apache.org>
Sent: Saturday, January 04, 2003 4:52 PM
Subject: Re: Ant Core Task Quick Reference
>
> On Saturday, January 4, 2003, at 12:55 PM, Kenneth Lee wrote:
> > Thank you. I was once thinking about doing something similar.
> > But then I realize that keeping another set of documentation is likely
> > to have it not-synced with the rapidly changing core manual.
> >
> [...]
>
> > So I propose that the core documentation to be rebuilt from scratch,
> > probably in XML, so that different views of the manual (normal view
> > as well as quickref and index) could be generated in a unified manner
> > (thru XSLT and CSS.)
>
> Its in progress. In fact, the past several days I've been refactoring
> the proposal/xdocs stuff and I'm going to make it part of the XDoclet
> project as a special set of Ant-specific subtasks to process Ant tasks
> and datatypes and extract the useful info and XML-ify it. Its already
> been done, and the results can be seen here:
>
> http://www.manning.com/hatcher/appendixE.pdf
>
> As Steve has already mentioned, there is still a way to go with making
> documentation as rich as the current HTML docs, but that can be handled
> with some merge points in XDoclet to pull in some extra files per task
> to include examples or more.
>
> Its always been my goal to generate a quick reference of Ant
> tasks/datatypes, and we achieved this goal mostly already and its
> dead-on 100% accurate with how Ant works, rather than the current HTML
> documentation which may (or may not) have holes in which
> attributes/elements are shown. Generating from XDoclet will ensure
> accuracy and allow attribute/element descriptions to be where they are
> defined rather than separately maintained.
>
> Erik
>
>
> --
> To unsubscribe, e-mail: <ma...@jakarta.apache.org>
> For additional commands, e-mail: <ma...@jakarta.apache.org>
>
>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: Ant Core Task Quick Reference
Posted by Erik Hatcher <ja...@ehatchersolutions.com>.
On Saturday, January 4, 2003, at 12:55 PM, Kenneth Lee wrote:
> Thank you. I was once thinking about doing something similar.
> But then I realize that keeping another set of documentation is likely
> to have it not-synced with the rapidly changing core manual.
>
[...]
> So I propose that the core documentation to be rebuilt from scratch,
> probably in XML, so that different views of the manual (normal view
> as well as quickref and index) could be generated in a unified manner
> (thru XSLT and CSS.)
Its in progress. In fact, the past several days I've been refactoring
the proposal/xdocs stuff and I'm going to make it part of the XDoclet
project as a special set of Ant-specific subtasks to process Ant tasks
and datatypes and extract the useful info and XML-ify it. Its already
been done, and the results can be seen here:
http://www.manning.com/hatcher/appendixE.pdf
As Steve has already mentioned, there is still a way to go with making
documentation as rich as the current HTML docs, but that can be handled
with some merge points in XDoclet to pull in some extra files per task
to include examples or more.
Its always been my goal to generate a quick reference of Ant
tasks/datatypes, and we achieved this goal mostly already and its
dead-on 100% accurate with how Ant works, rather than the current HTML
documentation which may (or may not) have holes in which
attributes/elements are shown. Generating from XDoclet will ensure
accuracy and allow attribute/element descriptions to be where they are
defined rather than separately maintained.
Erik
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: Ant Core Task Quick Reference
Posted by Kenneth Lee <ke...@netvigator.com>.
Thank you. I was once thinking about doing something similar.
But then I realize that keeping another set of documentation is likely
to have it not-synced with the rapidly changing core manual.
Moreover, as a beginner, I find that the existing core manual has
inadequate information and examples to follow, ambiguous and
incomplete in some areas, and inconsistent for both content and
layout.
So I propose that the core documentation to be rebuilt from scratch,
probably in XML, so that different views of the manual (normal view
as well as quickref and index) could be generated in a unified manner
(thru XSLT and CSS.), for both core docs and third-party docs.
The information in the XML may also be useful for some Ant build file
editor. An online (or offline) searchable manual is also a very good
helper. There should be a repository of the documentation of all commonly
used tasks, including core and third party tasks.
May be there should be an Ant-doc subproject?
I sincerely hope that there will be a more complete, well written Ant
documentation which could benefit to all of us, both experienced or
beginners.
Kenneth
----- Original Message -----
From: "O'brien, Tim" <to...@transolutions.net>
To: "'Ant Users List'" <an...@jakarta.apache.org>
Sent: Saturday, January 04, 2003 2:15 AM
Subject: Ant Core Task Quick Reference
I compiled a simple Ant quick reference from the existing Ant documentation.
I kept on forgetting attribute names, etc...
http://www.discursive.com/articles/2003/01/ant_core_ref.html
There are probably typos, and problems. If anyone has any suggestions
please send them my way. I figure that one could probably trim this down to
4 pages by removing some of the less-used tasks and consolidating some of
the repeated task examples.
It would be interesting for someone to do a frequeny analysis of Ant tasks.
Which tasks get used the most, etc?
Since the work is a copy of existing doc I gave credit to all Ant doc
writers at the end.
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>