On Monday, November 24, 2003, 12:42:04 AM, jbritt wrote:
> Gavin Sinclair wrote:
>> In the tarball I uploaded, the base directory was 'stdlib', which is a
>> bit vague for someone downloading and unpacking it. 'ruby-stdlib-doc'
>> is probably right on the money.
> I think that may depend on where it gets unpacked.
> It it went into an exitisting ruby/doc dir, or doc/ruby, then stdlib
> would probably be OK.
Good point. When a standard doc dir is introduced (gotta be
optimistic, and I gotta write that proper RCR), I'll rename it to take
advantage.
> Also, as for naming and versioning the tarball, I can use a script to
> fetch and download the latest version.
> ruby-stdlib-doc.tar.gz, for example, can in fact be a script that
> locates the latest version of the tarball and does a redirect. Then the
> documentation can have a consistent URL. You can make the link relative
> to the base of the documentation so that you don't need to know any site
> directory structure.
OK. I've thought about it, and decided to give the package proper
version numbers, like 0.9.1 (probably a good place to start). That
way everyone knows what they've got. The version number will be part
of the base directory, as that's how Rake does packaging. There are
arguments for and against doing this for this package, but we'll stick
with that for the time being and have it all worked out by 1.0.
> BTW, is there a way to get the stdlib HTML to include a reference to a
> css file? Such as
> <link rel='stylesheet' type='text/css' href='/css/stdlib.css'/>
Why is this required/desirable? I'm working on CSS styles for the
page now, and it's more convenient to put them in the document.
> And a link to the root of the web site?
> Perhaps something like <a href='/'>Site home</a> would work; it
> wouldn't hardcode any domain name.
> Right now, if you are browsing the docs, there is no link to get back to
> the main page of ruby-doc.org.
Sure. I'll clearly mark the link as "ruby-doc.org" though, so it
doesn't appear weird when people browse it offline.
Gavin
|
