cocoon-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From David Crossley <cross...@indexgeo.com.au>
Subject Re: Javadocs: need basic package information
Date Sun, 05 Jan 2003 06:39:11 GMT
Sylvain Wallez wrote:
> David Crossley wrote:
>
> >There is one important reason for having separate
> >package.xml next to the component source code ... when
> >Cocoon is able to add new components (blocks?) automatically.
> 
> Can you elaborate more on this ? As far as I understand them (they're 
> still fuzzy), blocks will provide some sitemap-level services 
> implemented using block-specific libraries that won't be visible from 
> outside the block.

Each package.xml is a simple uniform way to describe
a component. I thought that blocks would need the same,
but looking at the Wiki-BlocksDefinition i see that they
have a block.xml for that and other purposes. So please
disregard my comment.

<snip other stuff about DTDs and whether to use single
or separate package.xml/>

> >Each individual package.html for javadocs consumption can be
> >generated from package.xml at build-time. And if a single
> >document of all packages is needed then that can be aggregated
> >from the individual docs.
> 
> Do you mean generating all package.html from a single package.xml and 
> then aggregating back all the individual package.html in a single doc ? 
> I don't follow you here...

Well, each component needs a package.html for javadocs to
incorporate as the Description. Each one can be generated
from either the separate package.xml or from the large single
package.xml file.

Another reason for having the package.xml descriptions is to
generate some consistent user documentation. This can be
aggregated from the separate package.xml and transformed
to our document-v10 format and thence to html. Imagine
something like the Ant Manual.

We should just let Bernhard get on with the job in any
way that he feels like. We can always change it later
if it needs tweaking.
--David



---------------------------------------------------------------------
To unsubscribe, e-mail: cocoon-dev-unsubscribe@xml.apache.org
For additional commands, email: cocoon-dev-help@xml.apache.org


Mime
View raw message