On Tuesday, November 25, 2003, 8:18:14 PM, Gavin wrote:
> 8. ...
> I forgot what I was going to put here...
I remembered now.
8. The 'find' interface to the documentation.
James wants to see http://ruby-doc.org/find/stdlib/pathname go to the
stdlib documentation for pathname. I think that's a great idea.
Now, it's pretty much impossible, until such time as RDoc links become
more predictable, to resolve it at the method level. But that's no
big deal: just point people to the package they're after and let them
find the method and read the rest anyway.
Resolving the package URL is easy. For package name 'pkg', the URL
you're after is "/stdlib/libdoc/#{pkg}/rdoc/index.html". That
includes values for pkg with a slash, like 'test/unit'.
It's not possible to provide a link back to ruby-doc.org within the
resulting page, but that's not a big deal as the user wouldn't have
come from there in the first place.
So you can only specify a package name to the finder, not a class or
method name, but that's good enough, and a great tool. You can just
rattle off in an email: "see http://ruby-doc.org/find/stdlib/XYZ";.
Gavin
|
