On Fri, 2008-09-05 at 20:14 +0100, Ross Gardler wrote:
> Thorsten Scherler wrote:
> > On Fri, 2008-09-05 at 14:51 +0100, Ross Gardler wrote:
> >> Thorsten Scherler wrote:
> >>> Hi all,
> >>>
> >>> I will have some time in the next week to enhance the performance of the
> >>> dispatcher. The performance always have been the Achilles’ heel of the
> >>> dispatcher. 
> >> Actually, the achilles' heel is the lack of clarity in the documentation.
> >>
> >> This mail is an amazing coincidence. One of our team hear asked me this 
> >> morning how to do something with the dispatcher. I've done it before and 
> >> have sites running dispatcher, but I can't remember how I did it and I 
> >> can't point to any documentation about it.
> > 
> > How about
> > http://forrest.apache.org/pluginDocs/plugins_0_80/org.apache.forrest.plugin.internal.dispatcher/
> > 
> > I agree that documentation always can be enhanced but we have some.
> 
> I didn't say there was no documentation I said there was a documentation 
> problem.

Just wanted to link to the existing docu for the archive.

> 
> Pointing to a resource that is unintelligible does not help.
> 
> I've read those docs, even written some of them, but they make little 
> sense to me and I have the background of Forrest. The individual I'm 
> talking about has also read them and failed to achieve what he needs.

We need more examples and the corresponding how to's. We started but
sadly is has not been pursued. 

> ...
> > Yes, I agree. I found a nice tool to create uml diagrams in javadocs:
> > UmlGraph. Have a look at the droids javadoc to see it in action.
> 
> What about the horrible mess of redirection (indirection) between 
> sitemap and locationmap. I've found it near to impossible to figure out 
> what is coming from where in the dipatcher.
> 
> I'm sure it doesn't need to be as complex as it is, but I can't figure 
> out how to simplify it.

I started to drop some locationmaps a while ago but I reckon they can be
dropped some more. The matches in the sitemap should nearly go away
entirely after the rewrite. 

> Perhaps an effort to document the flow will help make it understandable 
> or illustrate where we can simplify.

The small part that should stay I will document. Actually a colleague of
mine needs to write a comprehensive documentation of the dispatcher - in
Spanish but maybe I can get him to translate it and submit it as patch.

> Again, I doubt I'm going to be able to do this myself, I'm just flagging 
> areas for improvement - sine you ask ;-)

jeje, that is perfect. Thanks.
...

> It's still in whiteboard , therefore it is unfinished.
> 
> I'm just saying we should get a usable version out there that people can 
> use (normal people, not just those with years of Forrest history) and 
> then start adding new features.

Agreed.

> 
> > Cheers Ross for your feedback.
> 
> You're welcome. I know your big enough to pick and choose the most 
> important bits, rather than think I'm demanding the world (although if 
> you want to deliver the world...)

lol

salu2
-- 
Thorsten Scherler                                 thorsten.at.apache.org
Open Source Java                      consulting, training and solutions