>There is a common XML design flaw I see more often than I should. I especially see it in eclipse EXSD designs. I saw it again today, after Mik posted their Discovery Site extension point definition:
The problem in the above markup is the summary attribute in the Overview element. A summary in practice should be a couple of sentences, but what if for some reason somebody needs a couple of paragraphs for the summary? There is no easy way to do this. Sure the content has an externalized string, but this only puts the issue off to a properties file.
This same issue appears through out Eclipse related extension points or where XML is used to describe possibly long descriptions. The XML markup for the Templates files is notoriously bad. Unfortunately nobody is willing to fix it or revisit it.
Please if you are using XML try to use it effectively. A little more thought into how you layout your XML and what you are using it for can go a long way in both maintainability and useability.