On 22/11/2011, at 7:23 PM, Adam Murdoch wrote: > On 23/11/2011, at 6:02 AM, Luke Daley wrote: > >> >> On 22/11/2011, at 6:50 PM, Adam Murdoch wrote: >> >>> Can we default to dsl? This should be the most common case. >> >> We need some kind of prefix. We were matching too much, e.g. FQCNs in pasted >> in logs. > > ok. > >> >>> One problem with coding the type is that it doesn't pick up changes to >>> either the code or the documentation (ie something that used to have only >>> javadoc gets added to the dsl reference). The doc generation stuff k nows >>> which type of link to use for the <apilink> tags. I wonder if we could >>> publish this meta-data somewhere for the forums to use? >> >> Potentially. It needs to be fast, which means JSON. >> >> Given the potential size, we may also need to do use html5 client side >> databases to avoid having to have the client load the whole data structure >> across the wire *every page*. >> >> The other alternative is to create a smart “jump off” page, that redirects >> to the appropriate place. This would move the heavy lifting to the server >> side. This is probably a better idea. > > A much better idea. Then we can have permalinks to the documentation for a > given type. Which means we could (relatively) safely include them in error > messages and generated reports and so on. And probably some other nice stuff, > too.
I can put something together quickly that works by just translating the path and issuing HEAD requests to the various spots looking for a hit. The requests will be to localhost so they'll be quick. We can get smarter later. I'd like to sort this now so we can settle on a syntax for the forum, though I guess it's not that big of an issue if some posts don't look right. So with this in place, we'll just make the syntax doc:org.gradle.Project#someMethod() (like a javadoc link but with doc: prefix). This would create a link to something like… http://gradle.org/docref/org.gradle.Project#someMethod() which would issue a redirect to the right thing. > This something that might be good to bake into the plugin portal. I don't quite see the connection. -- Luke Daley Principal Engineer, Gradleware http://gradleware.com
