atom feed142 messages in org.apache.cocoon.devRe: Public/Private classification (wa...
FromSent OnAttachments
89 earlier messages
Steven NoelsOct 5, 2005 3:57 am 
Carsten ZiegelerOct 10, 2005 5:02 am 
Joerg HeinickeOct 11, 2005 2:03 pm 
Vadim GritsenkoOct 11, 2005 8:01 pm 
Stefano MazzocchiOct 11, 2005 8:16 pm 
Vadim GritsenkoOct 11, 2005 8:35 pm 
Bertrand DelacretazOct 11, 2005 11:20 pm 
Max PfingsthornOct 12, 2005 12:31 am 
Torsten CurdtOct 12, 2005 12:32 am 
Bertrand DelacretazOct 12, 2005 12:58 am 
Sylvain WallezOct 12, 2005 1:34 am 
Carsten ZiegelerOct 12, 2005 2:21 am 
Daniel FagerstromOct 12, 2005 4:52 am 
Stefano MazzocchiOct 12, 2005 8:58 am 
Stefano MazzocchiOct 12, 2005 9:01 am 
UpayaviraOct 12, 2005 9:20 am 
Vadim GritsenkoOct 12, 2005 9:38 am 
Stefano MazzocchiOct 12, 2005 9:47 am 
Niclas HedhmanOct 12, 2005 10:04 am 
UpayaviraOct 12, 2005 11:57 am 
hepaboluOct 12, 2005 12:43 pm 
Stefano MazzocchiOct 12, 2005 2:09 pm 
Stefano MazzocchiOct 12, 2005 2:18 pm 
Stefano MazzocchiOct 12, 2005 2:20 pm 
Sylvain WallezOct 12, 2005 2:35 pm 
Vadim GritsenkoOct 12, 2005 2:47 pm 
Daniel FagerstromOct 13, 2005 2:41 am 
Reinhard PoetzOct 13, 2005 3:25 am 
Vadim GritsenkoOct 13, 2005 8:07 am 
Ralph GoersOct 13, 2005 9:14 am 
Vadim GritsenkoOct 13, 2005 9:22 am 
Ralph GoersOct 13, 2005 9:44 am 
Daniel FagerstromOct 13, 2005 9:56 am 
Stefano MazzocchiOct 13, 2005 10:01 am 
Stefano MazzocchiOct 13, 2005 10:05 am 
Daniel FagerstromOct 13, 2005 1:59 pm 
Joerg HeinickeOct 13, 2005 2:03 pm 
Joerg HeinickeOct 13, 2005 2:05 pm 
Stefano MazzocchiOct 13, 2005 3:25 pm 
Reinhard PoetzOct 13, 2005 10:57 pm 
Daniel FagerstromOct 14, 2005 2:05 am 
Vadim GritsenkoOct 14, 2005 6:01 am 
Vadim GritsenkoOct 14, 2005 6:06 am 
Stefano MazzocchiOct 14, 2005 11:34 am 
Vadim GritsenkoOct 14, 2005 11:45 am 
Reinhard PoetzOct 15, 2005 1:38 am 
Joerg HeinickeOct 15, 2005 1:40 am 
Joerg HeinickeOct 15, 2005 1:45 am 
Stefano MazzocchiOct 15, 2005 8:53 am 
Stefano MazzocchiOct 15, 2005 9:08 am 
Peter HunsbergerOct 21, 2005 10:12 pm 
Stefano MazzocchiOct 23, 2005 10:39 am 
Peter HunsbergerOct 24, 2005 8:05 am 
Subject:Re: Public/Private classification (was Re: javadocs navigation)
From:Stefano Mazzocchi (stef@apache.org)
Date:Oct 15, 2005 9:08:31 am
List:org.apache.cocoon.dev

Reinhard Poetz wrote:

Stefano Mazzocchi wrote:

Reinhard Poetz wrote:

Stefano Mazzocchi wrote:

Daniel Fagerstrom wrote:

[...]

Daniel,

let me repeat: I don't care about precision and elegance and completeness, I care about usability.

I am thinking at flow users that want to use java components to do their stuff. They should *NOT* care about org.apache.cocoon.xml.XMLPipe.

Not all Cocoon users are flow users only ...

Reinhard, how many cocoon users have ever implemented org.apache.cocoon.xml.XMLPipe?

My point is not about flow, is about brevity over completeness.

Stefano,

TBH I have no strong opinion whether XMLPipe should be part of the public _documentation_. Of course it is part of the _public API_ because otherwise you're not able to implement e.g. a transformer, but I'm sure that you know this as you're the author of this interface ;-)

I only doubt that the proposed way of how to find the classes and interfaces, that should become part of the public documentation, will lead to success. Do you guys really think that many people will start to evaluate ~670 classes and interfaces? And if yes, Daniel, Vadim you and me can't agree whether the interface XMLPipe is public or not. So I'm not really optimistice about the outcome as we have to discuss the other 669 classes and interfaces too.

I'm just with Daniel that we should talk about the principles of what is public and private first. After agreeing on them one person can move the public interfaces and classes into a seperate directoy and then we can create a cocoon-api.jar and can create javadocs out of it.

If you or others think that the "wiki way" of tagging classes is more successful (and faster), please go for it. Believe me, it's not my intention to block this, especially as I don't have the time to work on the alternative within the next 3-4 weeks.

Boy, this is getting frustrating.

I don't give a proverbial f*&k on how we do it the fact is that there are many levels of "public API" and we are not acknoledging that, nowhere something like this can be found.

In the past, we wanted FOM to be the only interface between flowscript and the rest of the system but given how many services are embedded in components and how many things were never added to FOM but just expected to be discovered out of getComponent(), which means that you need to know the entire cocoon internals to be able to write a simple flowscript, which is totally ridiculous.

You want principles? here they are:

1) script-oriented people, those who don't know java and don't care, those looking for RAD, those coming from the client or from the XML world, should have a reduced API which includes FOM + useful components + environment API and no cocoon internals.

2) for power users, willing to extend cocoon, the cocoon internal APIs (pipelines, caching, input modules, etc..)

3) for cocoon devepers, everything but at least packaged by block.

This is what I want.

I don't care if we do it by hand or we do it by javadoc or by other means.

I don't care if we use wikis or post-its to find out which interface goes in which category(s), or if we use tags or even if we use embedded RDF in the javadoc comments for it.

All I want is to help our users stick around... because honestly, I find myself in the very uncomfortable position of suggesting people *NOT*TO* use cocoon, because is such a horrible climb to get to that comfortable plateau of productivity and this is honestly not acceptable today.