ruby sidebar for firefox?

[Daniel Berger]

Hi all,

I came across this nifty looking sidebar for Python documentation at
http://projects.edgewall.com/python-sidebar/. Is there something
similar for Ruby? If not, does someone need a project?

Regards,

Dan

 

[James Britt]

Hi all,

I came across this nifty looking sidebar for Python documentation at
http://projects.edgewall.com/python-sidebar/. Is there something
similar for Ruby? If not, does someone need a project?

Actually, it looks pretty trivial; : % s/Python/Ruby/g did 1/3 the
work. I think; have to test this.

I can put one together for ruby-doc.org.

James

 

[James Britt]

Actually, it looks pretty trivial; : % s/Python/Ruby/g did 1/3 the
work. I think; have to test this.

Less trivial than my first glance suggested, but then I wasn't happy
with the prospect of hand-coding XHTML and maintaining consistent,
tabbed headings if pages are added or removed.

So, I wrote a tool to write a tool: code that slurps in a combo of YAML
and Textile, gloms them with some simple templates, and writes out set
of files suitable for an attractive Firefox sidebar.

I can put one together for ruby-doc.org.

Which you can see here:

http://www.ruby-doc.org/docbar/

version 0.1 for safety's sake, though I doubt I'll do much more for the
moment. Down the line, though, there needs to be a way to automagically
update the source files so that current versions can be generated using
cron.

Comments welcome.

James

 

[Bill Guindon]

Which you can see here:

http://www.ruby-doc.org/docbar/

version 0.1 for safety's sake, though I doubt I'll do much more for the
moment. Down the line, though, there needs to be a way to automagically
update the source files so that current versions can be generated using
cron.

Comments welcome.

Very nice! Covers all the obvious bases content-wise

I'll toss in a vote for a RubyGarden Wiki search for a future version.
I sure wish that search box was on the top of the page.

running on WInXP Mozilla 1.7.2 for your records.

Thx much!

 

[David Ross]

Oh yes, very good. Runs very well under Firefox 0.9.1
Thank you for this nice toolbar. --David Ross

Running DragonFlyBSD with Firefox 0.9.1

Less trivial than my first glance suggested, but
then I wasn't happy
with the prospect of hand-coding XHTML and
maintaining consistent,
tabbed headings if pages are added or removed.

So, I wrote a tool to write a tool: code that slurps
in a combo of YAML
and Textile, gloms them with some simple templates,
and writes out set
of files suitable for an attractive Firefox sidebar.


Which you can see here:

http://www.ruby-doc.org/docbar/

version 0.1 for safety's sake, though I doubt I'll
do much more for the
moment. Down the line, though, there needs to be a
way to automagically
update the source files so that current versions can
be generated using
cron.

Comments welcome.

James

__________________________________
Do you Yahoo!?
Yahoo! Mail Address AutoComplete - You start. We finish.
http://promotions.yahoo.com/new_mail

 

[David Ross]

would it be possible to get a developer section on
there for announcements and Ruby changes? Mainly the
commit messages out of the CVS for Ruby_1_8. I watch
the cvs bot that was set up on IRC, but it would be
nice to see it when I browse the web . --David Ross

Less trivial than my first glance suggested, but
then I wasn't happy
with the prospect of hand-coding XHTML and
maintaining consistent,
tabbed headings if pages are added or removed.

So, I wrote a tool to write a tool: code that slurps
in a combo of YAML
and Textile, gloms them with some simple templates,
and writes out set
of files suitable for an attractive Firefox sidebar.


Which you can see here:

http://www.ruby-doc.org/docbar/

version 0.1 for safety's sake, though I doubt I'll
do much more for the
moment. Down the line, though, there needs to be a
way to automagically
update the source files so that current versions can
be generated using
cron.

Comments welcome.

James

__________________________________
Do you Yahoo!?
Yahoo! Mail Address AutoComplete - You start. We finish.
http://promotions.yahoo.com/new_mail

 

[Robert McGovern]

Which you can see here:

http://www.ruby-doc.org/docbar/

version 0.1 for safety's sake, though I doubt I'll do much more for the
moment. Down the line, though, there needs to be a way to automagically
update the source files so that current versions can be generated using
cron.

Looks good and will be quite useful.

One thing that would be nice is for the sidebar to be listed as a
"proper" side bar i.e. available in View -> Sidebar -> xxx, rather
than something accessed by a bookmark.

Firefox 0.9.3, WinXP Pro

 

[Daniel Berger]

Less trivial than my first glance suggested, but then I wasn't happy
with the prospect of hand-coding XHTML and maintaining consistent,
tabbed headings if pages are added or removed.

So, I wrote a tool to write a tool: code that slurps in a combo of YAML
and Textile, gloms them with some simple templates, and writes out set
of files suitable for an attractive Firefox sidebar.


Which you can see here:

http://www.ruby-doc.org/docbar/

version 0.1 for safety's sake, though I doubt I'll do much more for the
moment. Down the line, though, there needs to be a way to automagically
update the source files so that current versions can be generated using
cron.

Comments welcome.

James

Awesome! Thanks James!

- Dan

 

[James Britt]

Looks good and will be quite useful.

One thing that would be nice is for the sidebar to be listed as a
"proper" side bar i.e. available in View -> Sidebar -> xxx, rather
than something accessed by a bookmark.

I followed whatever instructions I could find on making this happen; all
the pages I came across said to use a mozilla/firefox-specific
javascript call:

window.sidebar.addPanel ("Ruby Sidebar",
"http://www.ruby-doc.org/docbar/toc_tut.html","");

But that does not do quite what I would have expected.

If anyone knows of a better way to get the pages added as a true
sidebar, rather than as a bookmark-that-may-be-opened-in-the-sidebar,
please let me know.

James

 

[James Britt]

Very nice! Covers all the obvious bases content-wise

I'll toss in a vote for a RubyGarden Wiki search for a future version.
I sure wish that search box was on the top of the page.

I added RubyGarden wiki search.


James

 

[Robert McGovern]

I followed whatever instructions I could find on making this happen; all

the pages I came across said to use a mozilla/firefox-specific
javascript call:

window.sidebar.addPanel ("Ruby Sidebar",
"http://www.ruby-doc.org/docbar/toc_tut.html","");

But that does not do quite what I would have expected.

No, not very intuitive.

If anyone knows of a better way to get the pages added as a true
sidebar, rather than as a bookmark-that-may-be-opened-in-the-sidebar,
please let me know.

I'll keep an eye out.

Rob

 

[Caio Chassot]

If anyone knows of a better way to get the pages added as a true
Here: http://v2studio.com/k/moz/rubysidebar.xpi

It may be overkill to write an extension to do it, but it was the only
way I found.

Perhaps in the future I could implement a local copy to use when offline.

 

[Caio Chassot]

If anyone knows of a better way to get the pages added as a true

Here: http://v2studio.com/k/moz/rubysidebar.xpi

actually, the server admin is lazy to set a proper mime type, so try
this link for a direct install:

http://v2studio.com/k/moz/serve.asp?file=rubysidebar.xpi

 

[Stephan Kämper]

actually, the server admin is lazy to set a proper mime type, so try
this link for a direct install:

http://v2studio.com/k/moz/serve.asp?file=rubysidebar.xpi

Great! Thanks!

I works. A working solution which is a bit of overkill is a lot better
than a simple solution that doesn't work.


That in fact might be overkill (but then, of course no one is forced to
install something like that). I guess you'd duplicate a lot of material
which people alread do have for offline consumption. The pickaxe book
for example, or the StdLib docs.

Happy rubying


Stephan

 

[Michal 'hramrach' Suchanek]

James Britt wrote:

Which you can see here:

http://www.ruby-doc.org/docbar/

version 0.1 for safety's sake, though I doubt I'll do much more for the
moment. Down the line, though, there needs to be a way to automagically
update the source files so that current versions can be generated using
cron.

It probabbly did not get to the list the first time (at least I do not
see it):

The sidebar is very nice.

But to be useful for me I would have to see readable text in the sidebar
and the linked documentation.
Because the background is set to some light color or image, the text
color is not set on the web pages, and my default text color is light
the text is almost invisible.

This applies to links in the sidebar, text in stdlib, visited links in
ruby cookbook, all text in Unofficial Ruby Usage Guide, all text in
Programming ruby, text in core classes.

I keep a fixed copy of ProgrammingRuby around while writing some ruby
stuff but I am not going to try mirroring and fixing all that.

Thanks

Michal Suchanek

 

[James Britt]

actually, the server admin is lazy to set a proper mime type, so try
this link for a direct install:

http://v2studio.com/k/moz/serve.asp?file=rubysidebar.xpi

What is this supposed to do? In firebird 0.7, I get a "install script
not found" message.


Thanks,

James

 

[Caio Chassot]

What is this supposed to do? In firebird 0.7, I get a "install script
not found" message.

It'll install a firefox extension, 0.9 and 0.10 only.

 

[James Britt]

It'll install a firefox extension, 0.9 and 0.10 only.

Ah, OK. I'll try that on another machine with a later version.

Thanks.

James

 

[Bill Guindon]

I added RubyGarden wiki search.

thx much. can it be set to display results in the main window? right
now they stay in the sidebar, and things get a bit screwy there.

 

[James Britt]

thx much. can it be set to display results in the main window? right
now they stay in the sidebar, and things get a bit screwy there.

Well, that won't do. I'll go fix it.

Thanks for the heads up.

James