maven-m2-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Brett Porter <br...@apache.org>
Subject Re: [jira] Work Started: (MNG-51) Flesh out the report API
Date Thu, 17 Feb 2005 11:35:30 GMT
Maczka Michal wrote:

>imo reports should be free to create: 
>
>a) multiple files (like javadoc). This is not supported by doxia.
>b) use random rendering technology (e.g. javadoc or hammurapi use directly
>html)   
>  
>
random? so you get something different everytime you run it? :)

>c) reports be binary files e.g. PDFs
>   (this is not supported by doxia either as doxia is based on Reader/Writer
>API, while binary files need streams)
>  
>
sure, we can create one that doesn't take a sink and just renders direct
to the whatever files it wants, which covers all 3.

>Also what's matter for reporting api is how reports will push the
>information into web site navigation etc. 
>  
>
I don't think the reports do this - its the responsibility of the site
plugin, based on its knowledge of the reports in the site. The reports
are independant.

>The way in which report will be generated is not that important IMHO. 
>Surly we can have a group of reports implementing common API, but I think
>that report generator should do more or less what they do in m1 - create
>files in well known location which are later processes (or not) by tools
>like xdoc/doxia/whatever. So the content generation is a separate concern 
>from the content presentation. 
>  
>
They can create those files if they are to be used for anything else,
but at the moment streaming it straight to the final HTML is fast and
easy. It's going to be the same level of work wither way - you need to
write something to process the events to XML, then transform the XML to
HTML. Here, we handle the events in two different outputs.

>Don't get me wrong I am all for using doxia in cases when it makes sense
>(e.g. for creating usual set of reports from POM directly to html).
>  
>
I don't see why these are any different.

>But I don't think that this is really all we can expect from reporting api
>and that it is covering all the use cases. 
>I propose to start with something simple and concrete: project team report
>and javadoc report and see how both of them can be produced by m2 report
>API.
>  
>
I'm working on the standard reports now.

- Brett

Mime
View raw message