ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Craeg K. Strong" <cstr...@arielpartners.com>
Subject [PATCH] <description> element to add a project-wide description
Date Thu, 02 Aug 2001 21:02:45 GMT
As has been discussed on this mailing list about a month back, enclosed 
please find a simple
patch to add a <description> element to a buildfile.

I followed Stefan's suggestion to implement Description as a DataType.

The implementation is a little naive, but it works.   Let me know if 
there are any issues with it.  

Example:

<project name="journals" default="doc" basedir="foo">

 <description>
  This project is used to create web-readable versions of our daily 
journals.  The journals are
   cross linked to other documents in the knowledgebase and can be built 
in any number of formats,
   including PDF, HTML, WAP, etc.      
   ....
</description>

[  rest of buildfile goes here... ]

</project>

How should this be documented?   It is not really a general-purpose 
element right now, so maybe it doesn't
deserve its own page in CoreTypes/       Please advise....

If we all agree that human readable text belongs in (XML) elements, 
rather than attributes, we could extend this
implementation for 2.0 (or even 1.5?)  so that every target can have a 
nested <description> element.  We could potentially
beef it up to handle multiple lines, or HTML tags, or stylebook, or 
whatever via pluggable formatters.

I am hoping this submission can be a first baby step in that overall 
direction.

Thanks!

--Craeg




Mime
View raw message