David M Johnson wrote:
That said, I'd like to see Dave's and Allen's URL sections merged
(once they agree?) as well as definitions for all the angle-bracketed
words like <list-of-tags> etc. (Sort of like BNF) It would also be
nice to have all the old URLs documented, so we can make sure to
implement all the correct redirects. Are the existing URLs (fully)
documented somewhere besides the source code?
Yes, it would be nice to systematically specify the new URL structure.
Would you like to do some of that work?
Yes. I'm willing to lead the (wiki-based) documentation effort for the
new and old URL structure. What I'm hoping is that the rest of the team
will provide the necessary information for the old (aka current) URL
structure. I don't want to have to figure it all out empirically or
from source code.
One of the things I'm planning on doing as we evaluate the SpringMVC
proposal is writing the URL configuration for SimpleUrlHandlerMapping
If the URL to Controller (or Servlet) mapping is reasonably declarative
and supports comments, we could put the documentation "in the source",
so that everything is in one place.
If we use SpringMVC, we could document the structure in the section of
roller-servlet.xml that configures the SimpleUrlHandlerMapping (or
whatever HandlerMapping we end up using)
If we use something other than SpringMVC there may still be an XML (or
other) config file that does the mapping.
I don't know if there is a JavaDoc-like tool that could be used for
generic XML that could generate HTML (or OO.org !?) output.
Spring does have BeanDoc and here is an example of output for a
SimpleUrlHanlderMapping:
http://springframework.sourceforge.net/beandoc/jpetstore/petstore-servlet.xml.html#secureHandlerMapping
This isn't quite what we want, but there might be an extension mechanism.
-- Sean
