Adam Murdoch-3 wrote: > > > On 15/12/2010, at 4:49 AM, frenchyan wrote: > >> >> 2) on the page like: >> http://gradle.org/latest/docs/dsl/org.gradle.api.Project.html >> I think the page is hard to navigate because of the multiple sections >> (for >> example script blocks, then script block details). I sort of like the >> layout >> in the grails documentation: http://grails.org/doc/latest/ where you have >> everything on the left and you can quickly see the details on the right >> side. > > So, would we have all the properties, script blocks, and methods of the > current class listed on the left? > >
I believe so. It would definitely be the easiest/fastest way to navigate. It really depends what you are trying to do. I think if you are trying to build a 'user guide' then the format you have is fine but it cannot (and does not have to) be exhaustive. This is what I would read when I want to learn about the dsl, to get an overview. I also think that a 'reference guide' which contains an exhaustive list of everything is where I would go once I am done with the 'user guide' (and this is what I do today... except I go to the source code because there is no such guide :) and in my mind the 'reference guide' should be easy to navigate. This is why I was thinking of a layout equivalent to the grails documentation: whenever there is something I want to do and I do not remember, this is where I go. Yan -- View this message in context: http://gradle.1045684.n5.nabble.com/dsl-reference-guide-tp3303990p3308072.html Sent from the gradle-user mailing list archive at Nabble.com. --------------------------------------------------------------------- To unsubscribe from this list, please visit: http://xircles.codehaus.org/manage_email
