Ruby-doc.org has been updated.
New rdoc template.
New site style.
Disqus commenting for rdocs.
No doubt there are bugs, issues, problems; please contact me directly if you find something amiss.
There's more to do but I wanted to get out something that was bette than what has there while I get on to fixing other things.
James Britt
At a first glance, looks *great*.
I'd love to see a links-to-online-tutorials section (as opposed to the
printed books section on the one hand, and the "presentations" on the
other). Of course this is mostly because I'd like to see a link to *my*
online tutorial:
http://www.apeth.com/rubyIntro/justenoughruby.html
m.
James Britt <james.britt@gmail.com> wrote:
Ruby-doc.org has been updated.
New rdoc template.
New site style.
Disqus commenting for rdocs.
No doubt there are bugs, issues, problems; please contact me directly if
you find something amiss.There's more to do but I wanted to get out something that was bette than
what has there while I get on to fixing other things.
--
matt neuburg, phd = matt@tidbits.com <http://www.tidbits.com/matt/>
A fool + a tool + an autorelease pool = cool!
AppleScript: the Definitive Guide - Second Edition!
Matt Neuburg’s Home Page
great. clean. the very nice icon/logo now stands out =)
On Tue, Oct 4, 2011 at 2:42 AM, James Britt <james.britt@gmail.com> wrote:
Ruby-doc.org has been updated.
James Britt wrote in post #1024816:
Ruby-doc.org has been updated.
awesome! nice work - an overhaul was much needed...
- j
--
Posted via http://www.ruby-forum.com/\.
[Replying on the list since everyone else is doing it -- apologies.]
It looks very nice. However, a few bad things stand out:
1. I always have to scroll horizontally. I'm probably more picky about
keeping my browser size fixed (and non-maximized) than most people; so
at my preferred browser size, the content doesn't fit horizontally.
Even when I maximize it, it doesn't quite fit, since I have a wide
taskbar at the left edge. When I hide my taskbar and maximize the
browser, I can see all of the content except for a few code examples
that run off the edge (for example, the code in
instance_variable_set(symbol, obj) → obj under Object); there is still
a horizontal scrollbar.
(I'm seeing this with more and more sites these days, so it might be
that designers don't worry about fitting horizontal space anymore, and
I need to adjust. But I'd rather not )
2. I'm a little on the fence about this one, but ultimately I'd prefer
the text color to be black for non-focused text as well as focused.
The gray background around focused text is enough to make it stand
out; the gray text sort of looks like something my brain should ignore
(which might be good for some people, but I'd like to be able to
comfortably read the descriptions of all the methods without moving my
cursor).
3. When you type in a filter term under Classes, the area containing
the classes shrinks, causing the method area to come over to the left.
It would be nicer if it stayed the same size. (As an aside: it might
be nice if the list of methods automatically got narrowed down to just
methods available in the classes found by the filter.)
4. Another one I'm on the fence about: put certain very common classes
up at the top (and then show them again in alphabetical order). I'm
not sure how to decide which classes get listed at the top, but
certainly Object should. (Ultimately, maybe there could be an optional
tree view of class relationships.)
5. It would be nice to have filtering of methods, etc. on the class pages.
6. Maybe link to RXR instead of raw source.
I'm excited to see how the discussions work out.
Someone else mentioned that you get frames if you click stdlib along
the top; is that just linking to an old version of the site?
On Mon, Oct 3, 2011 at 1:42 PM, James Britt <james.britt@gmail.com> wrote:
Ruby-doc.org has been updated.
New rdoc template.
New site style.
Disqus commenting for rdocs.
No doubt there are bugs, issues, problems; please contact me directly if you
find something amiss.There's more to do but I wanted to get out something that was bette than
what has there while I get on to fixing other things.
Great work, much needed, thanks a lot!
On browsers which dynamically show/hide their scrollbar (i.e. FF) the
page "jumps" in the following case:
1. got to http://ruby-doc.org/stdlib/libdoc/socket/rdoc/index.html
2. observe page is long due long list of methods
3. enter "z" in the methods filter
the page "jumps" as the scrollbar gets hidden because there's no content
to show.
- Markus
On 03.10.2011 20:42, James Britt wrote:
Ruby-doc.org has been updated.
It is really amazing!
The class and method searchfilter are great and very useful.
I am looking forward to have the same style applied for stdlib.
(without frameset)
Thanks all that were involved!
- --
all the best sandor
On 10/3/11 8:42 PM, James Britt wrote:
Ruby-doc.org has been updated.
New rdoc template.
New site style.
Disqus commenting for rdocs.
The new styling is a nice. And no more frames, definite upgrade!
Adding class/method search was a much-needed feature. Thank you.
Issues on the RDoc Documentation page:
1) Methods filter is failing on searches for any of the methods equal
to or starting with "<" or ">".
2) Although the method filter is snappy on the first search, it then
needs 30-90 seconds to do anything else, even update from a single
character backspace or permit the browser to do page reload. (On my
Chrome/OSX, anyway. Anyone else seeing experiencing this?). The
class/module filter does not share this issue.
On Wed, Oct 5, 2011 at 12:54 PM, Matt Neuburg <matt@tidbits.com> wrote:
James Britt <james.britt@gmail.com> wrote:
Ruby-doc.org has been updated.
New rdoc template.
New site style.
Disqus commenting for rdocs.
No doubt there are bugs, issues, problems; please contact me directly if
you find something amiss.There's more to do but I wanted to get out something that was bette than
what has there while I get on to fixing other things.At a first glance, looks *great*.
I'd love to see a links-to-online-tutorials section (as opposed to the
printed books section on the one hand, and the "presentations" on the
other). Of course this is mostly because I'd like to see a link to *my*
online tutorial:
m.
--
matt neuburg, phd = matt@tidbits.com <http://www.tidbits.com/matt/>
A fool + a tool + an autorelease pool = cool!
AppleScript: the Definitive Guide - Second Edition!
Matt Neuburg’s Home Page
--
Carina
Matt Neuburg wrote:
At a first glance, looks *great*.
I'd love to see a links-to-online-tutorials section (as opposed to the
printed books section on the one hand, and the "presentations" on the
other). Of course this is mostly because I'd like to see a link to *my*
online tutorial:
I can do that; it has to go on my growing todo list, though.
The current set of non-API doc links and files is a bit dated.
I'd appreciate suggestions on additions/changes to what tutorials and such to link to or host.
James Britt
suggestions@ruby-doc.org
Nice.
I'm kind-of missing the "oldschool" look ;), but the search was really
needed. Good job.
-- Matma Rex
Eric Christopherson wrote:
[Replying on the list since everyone else is doing it -- apologies.]
Short-term OK, long-term, not the best way to get my attention since I don't usually follow the list that closely anymore.
It looks very nice. However, a few bad things stand out:
1. I always have to scroll horizontally. I'm probably more picky about
keeping my browser size fixed (and non-maximized) than most people; so
at my preferred browser size, the content doesn't fit horizontally.
What size is good for you?
Even when I maximize it, it doesn't quite fit, since I have a wide
taskbar at the left edge. When I hide my taskbar and maximize the
browser, I can see all of the content except for a few code examples
that run off the edge (for example, the code in
instance_variable_set(symbol, obj) → obj under Object); there is still
a horizontal scrollbar.
OK.
(I'm seeing this with more and more sites these days, so it might be
that designers don't worry about fitting horizontal space anymore, and
I need to adjust. But I'd rather not
I generally assume 960px or so is reasonable.
2. I'm a little on the fence about this one, but ultimately I'd prefer
the text color to be black for non-focused text as well as focused.
I'm looking at adding switchable stylyesheets since for every light-on-dark fan there's a dark-on-light fan, etc. So, if nothing else, offering an obvious high-contrast style would be useful to a number of people.
The gray background around focused text is enough to make it stand
out; the gray text sort of looks like something my brain should ignore
(which might be good for some people, but I'd like to be able to
comfortably read the descriptions of all the methods without moving my
cursor).3. When you type in a filter term under Classes, the area containing
the classes shrinks, causing the method area to come over to the left.
It would be nicer if it stayed the same size. (As an aside: it might
be nice if the list of methods automatically got narrowed down to just
methods available in the classes found by the filter.)
Work is in progress on the JavaScript (thanks, Phrogz!) The method-reduction is part of that (which is a very good idea).
4. Another one I'm on the fence about: put certain very common classes
up at the top (and then show them again in alphabetical order). I'm
not sure how to decide which classes get listed at the top, but
certainly Object should. (Ultimately, maybe there could be an optional
tree view of class relationships.)
The main index needs work. It follows a pattern that works OK for a single gem or library, but not so OK for a massive set of classes.
I may steal the arrangement used by the default YARD template.
5. It would be nice to have filtering of methods, etc. on the class pages.
Isn't that there? if you click on the icon next to "Class/Module index" it should open a search box.
Perhaps that's not entirely obvious ...
6. Maybe link to RXR instead of raw source.
I'm excited to see how the discussions work out.
Someone else mentioned that you get frames if you click stdlib along
the top; is that just linking to an old version of the site?
I kept the old layout for that for assorted reasons, but that needs more attention. I didn't want to keep putting off what updates I already had, waiting until everything was Just So. I'd never be done.
It's a work in progress, and the feedback is welcome.
Thanks,
James Britt
Although I definitely appreciate the non-frame layout, the old variant
had a big plus: when I fetch any objects documentation page, all methods
where listed at the topic (possibly spanning multiple lines), but
definitely all of them where within the first look at the page.
Now this list is like a menu on the left and expands all the way down
... unfortunately I find less convenient, as it's harder to get an
overview of all the provided methods.
HTH
On 07.10.2011 18:46, Markus Fischer wrote:
Great work, much needed, thanks a lot!
Carina C. Zona wrote:
The new styling is a nice. And no more frames, definite upgrade!
You'd might be surprised that some people miss them. (I don't.)
Adding class/method search was a much-needed feature. Thank you.
Issues on the http://ruby-doc.org/core/ page:1) Methods filter is failing on searches for any of the methods equal
to or starting with "<" or ">".
Ah. 
I'll have to see what's up with that.
2) Although the method filter is snappy on the first search, it then
needs 30-90 seconds to do anything else, even update from a single
character backspace or permit the browser to do page reload. (On my
Chrome/OSX, anyway. Anyone else seeing experiencing this?). The
class/module filter does not share this issue.
Work is being done on this. It is slow, especially on Chrome.
Thanks for the feedback.
James
speaking of old school. it's a lot friendlier now w text browsers
2011/10/7 Bartosz Dziewoński <matma.rex@gmail.com>:
I'm kind-of missing the "oldschool" look ;), but the search was really
needed. Good job.
This is remarkably easy with a combination of css, javascript and
cookies.
I borrowed some code from a few sources, and you can see it in action
on http://spiralofhope.com with the top-right 'styles'. Feel free to
dig into and copy any code.
If I can help with this, let me know.
On Sat, 8 Oct 2011 01:51:38 +0900 James Britt <james.britt@gmail.com> wrote:
I'm looking at adding switchable stylyesheets
Don't assume that. For example, my ipad has 1024-by-768 and I usually read nerd doco in portrait, not landscape. A fluid layout would be much preferred for all devices.
On Oct 7, 2011, at 09:51 , James Britt wrote:
I generally assume 960px or so is reasonable.
Eric Christopherson wrote:
[Replying on the list since everyone else is doing it -- apologies.]
Short-term OK, long-term, not the best way to get my attention since I don't
usually follow the list that closely anymore.It looks very nice. However, a few bad things stand out:
1. I always have to scroll horizontally. I'm probably more picky about
keeping my browser size fixed (and non-maximized) than most people; so
at my preferred browser size, the content doesn't fit horizontally.What size is good for you?
It looks like my Firefox here is 950px. I'd have to check what size I
use at home. If you're designing for 960, I could certainly expand it
10 more; but, as others have argued, it would be nice to have it more
adaptable to various sizes.
Even when I maximize it, it doesn't quite fit, since I have a wide
taskbar at the left edge. When I hide my taskbar and maximize the
browser, I can see all of the content except for a few code examples
that run off the edge (for example, the code in
instance_variable_set(symbol, obj) → obj under Object); there is still
a horizontal scrollbar.OK.
(I'm seeing this with more and more sites these days, so it might be
that designers don't worry about fitting horizontal space anymore, and
I need to adjust. But I'd rather notI generally assume 960px or so is reasonable.
[snip]
5. It would be nice to have filtering of methods, etc. on the class pages.
Isn't that there? if you click on the icon next to "Class/Module index" it
should open a search box.Perhaps that's not entirely obvious ...
No, it wasn't, but I see it now. That brings up another point -- it
only filters classes and modules still. I was looking for something to
filter the methods (and/or constants, etc.) in the class under
discussion.
Also -- and I'm assuming you or Phrogz are aware of this -- the filter
text box in question doesn't respond to cursor keys, home/end, etc.
On Fri, Oct 7, 2011 at 11:51 AM, James Britt <james.britt@gmail.com> wrote:
Hmm. Why isn't Etc listed among the Class/Module selector? It's part
of core for 1.9.x, right?
On Wed, Oct 5, 2011 at 2:38 PM, James Britt <james.britt@gmail.com> wrote:
Carina C. Zona wrote:
The new styling is a nice. And no more frames, definite upgrade!
You'd might be surprised that some people miss them. (I don't.)
Adding class/method search was a much-needed feature. Thank you.
Issues on the RDoc Documentation page:1) Methods filter is failing on searches for any of the methods equal
to or starting with "<" or ">".Ah.
I'll have to see what's up with that.
2) Although the method filter is snappy on the first search, it then
needs 30-90 seconds to do anything else, even update from a single
character backspace or permit the browser to do page reload. (On my
Chrome/OSX, anyway. Anyone else seeing experiencing this?). The
class/module filter does not share this issue.Work is being done on this. It is slow, especially on Chrome.
Thanks for the feedback.
James
--
Carina
Anyone complaining about missing their beloved frames is free to do
this to double up on their frame satisfaction:
* RDoc Documentation
* click on any package name in the left frame
* click on 'Stdlib" link at top of right frame
* yay for them, duplicated left frame!
Ahhh, the fond memories of why we took frames out to the pasture and
shot them some time back around the turn of the millenium...
On Wed, Oct 5, 2011 at 2:38 PM, James Britt <james.britt@gmail.com> wrote:
Carina C. Zona wrote:
The new styling is a nice. And no more frames, definite upgrade!
You'd might be surprised that some people miss them. (I don't.)
Adding class/method search was a much-needed feature. Thank you.
Issues on the RDoc Documentation page:1) Methods filter is failing on searches for any of the methods equal
to or starting with "<" or ">".Ah.
I'll have to see what's up with that.
2) Although the method filter is snappy on the first search, it then
needs 30-90 seconds to do anything else, even update from a single
character backspace or permit the browser to do page reload. (On my
Chrome/OSX, anyway. Anyone else seeing experiencing this?). The
class/module filter does not share this issue.Work is being done on this. It is slow, especially on Chrome.
Thanks for the feedback.
James
--
Carina
+1. Not just for all devices; also for the varied needs of all users
of any single device.
I often find line lengths too long for quick skimming, so adjust
window size accordingly. Others choose to increase content size to
compensate for sub-optimal near vision. Others like to use wide
screens to multi-view windows rather than maximize. etc.
For a design heavily reliant on graphics, establishing a minimum width
is sometimes a necessary evil. But this one is delightfully texty
enough that I think it's safe to skip that.
By the way, the fixed height on home's header is forcing overlap
w/content when screen width narrows to mobile-ish sizes.
On Fri, Oct 7, 2011 at 4:00 PM, Ryan Davis <ryand-ruby@zenspider.com> wrote:
On Oct 7, 2011, at 09:51 , James Britt wrote:
I generally assume 960px or so is reasonable.
Don't assume that. For example, my ipad has 1024-by-768 and I usually read nerd doco in portrait, not landscape. A fluid layout would be much preferred for all devices.
--
Carina