Forum: Ruby Help files

Announcement (2017-05-07): www.ruby-forum.com is now read-only since I unfortunately do not have the time to support and maintain the forum any more. Please see rubyonrails.org/community and ruby-lang.org/en/community for other Rails- und Ruby-related community platforms.
Stuart C. (Guest)
on 2009-03-08 22:19
Hi forum,

I am looking to have some form of help file/technical documentation to
go alongside a GUI application. Basically on the click of a button (help
button) a file will be opened in its native viewer eg adobe reader for a
PDF file.

What is the best way to perform such a task in ruby, I am quite flexible
as to the format of the help file either a PDF or compiled html.

Many thanks
Eric H. (Guest)
on 2009-03-08 23:29
(Received via mailing list)
On Mar 8, 2009, at 13:17, Stuart C. wrote:
> I am looking to have some form of help file/technical documentation to
> go alongside a GUI application. Basically on the click of a button
> (help
> button) a file will be opened in its native viewer eg adobe reader
> for a
> PDF file.
>
> What is the best way to perform such a task in ruby, I am quite
> flexible
> as to the format of the help file either a PDF or compiled html.

Don't most GUI frameworks have a built in API for displaying help
documentation?
Alex F. (Guest)
on 2009-03-09 19:21
(Received via mailing list)
Stuart C. wrote:
> Hi forum,
>
> I am looking to have some form of help file/technical documentation to
> go alongside a GUI application. Basically on the click of a button (help
> button) a file will be opened in its native viewer eg adobe reader for a
> PDF file.
>
> What is the best way to perform such a task in ruby, I am quite flexible
> as to the format of the help file either a PDF or compiled html.

It depends how sophisticated you want to get. If you simply want to
display a PDF with help on a button being clicked, then pretty much any
GUI should be able to do that. Call Ruby's system with 'start' [Windows]
'open' [OS X] or 'xdg-open' [Linux] and the name of the file, eg

system "open myhelp.pdf"

If you want a more sophisticated help browser - eg context-specific
links to sections from the GUI, searching, using the native Windows CHM
help browser, see something like:

http://wxruby.rubyforge.org/doc/#online_help

Esp HelpController / HtmlHelpController. As Eric says, I'd expect the
other heavyweight GUI toolkits (GNOME2, Qt) to offer something similar,
though I couldn't find a reference to this for GNOME2.

alex
Stuart C. (Guest)
on 2009-03-09 21:08
Thanks Alex. Really useful. I have been messing around with Lauchy this
afternoon which may do the job, but I will check out your link.

Regards

Alex F. wrote:
> Stuart C. wrote:
>> Hi forum,
>>
>> I am looking to have some form of help file/technical documentation to
>> go alongside a GUI application. Basically on the click of a button (help
>> button) a file will be opened in its native viewer eg adobe reader for a
>> PDF file.
>>
>> What is the best way to perform such a task in ruby, I am quite flexible
>> as to the format of the help file either a PDF or compiled html.
>
> It depends how sophisticated you want to get. If you simply want to
> display a PDF with help on a button being clicked, then pretty much any
> GUI should be able to do that. Call Ruby's system with 'start' [Windows]
> 'open' [OS X] or 'xdg-open' [Linux] and the name of the file, eg
>
> system "open myhelp.pdf"
>
> If you want a more sophisticated help browser - eg context-specific
> links to sections from the GUI, searching, using the native Windows CHM
> help browser, see something like:
>
> http://wxruby.rubyforge.org/doc/#online_help
>
> Esp HelpController / HtmlHelpController. As Eric says, I'd expect the
> other heavyweight GUI toolkits (GNOME2, Qt) to offer something similar,
> though I couldn't find a reference to this for GNOME2.
>
> alex
This topic is locked and can not be replied to.