Re: [Audacity-devel] Help buttons in dialogues WAS Re: Nyquist Generate Prompt

[Steve t. F. <ste...@gm...>]

On 14 May 2013 23:01, Gale Andrews <ga...@au...> wrote:
>
> | From Steve the Fiddle <ste...@gm...>
> | Tue, 14 May 2013 17:38:15 +0100
> | Subject: [Audacity-devel] Nyquist Generate Prompt
>> > On 14 May 2013 00:51, Martyn Shaw <mar...@gm...> wrote:
>> >
>> >
>> > eHelpButton appears to be there, but very little used. Do you fancy
>> > investigating it?  At a brief glance it looks not fully implemented.
>> >
>> >
>> >> I presume that this would need to link to the bundled manual and fall
>> >> back to the on-line manual if there is no local manual? I don't know
>> >> how that would be handled.
>> >
>> >
>> > There is some code that does that already, but I can't quite recall
>> > where
>> > atm.  Sorry.
>>
>> I've made some progress on effect Help buttons (patch attached).
>> Currently this has only been tested on Linux.
>
> Thanks Steve, tested on Windows 7 Unicode Release.
>
> If there is an installed Manual then:
>
> * If Interface Prefs for the Manual location are set to "Local",
>    your Bass and Treble "Help" button goes to the Bass and
>    Treble page in the installed Manual.
>
> * If Interface Prefs for the Manual location are set to "From
>    Internet", your Bass and Treble "Help" button goes to the
>    online released Manual:
>    http://manual.audacityteam.org/o/man/bass_and_treble.html .
>
> That seems good.
>
> But there is still a difference in behaviour compared to the Help >
> Manual and Help > Quick Help items if there is no installed Manual
> (which is normal for Linux).
>
> In that case the Help menu items invite you to download the
> released Manual by going to the alpha Manual online and
> visiting:
> http://manual.audacityteam.org/o/man/unzipping_the_manual.html
>
> but the Help button in Bass and Treble sends you to the online
> released Manual:
> http://manual.audacityteam.org/o/man/bass_and_treble.html .
>
> So should pressing "Help" in Bass and Treble bring up the "Help
> on the Internet" dialogue when there is no installed Manual
> (ideally pointed to the online released Manual instead)?

If the user only wants to look up one help item for one effect, why
should they be forced to download and install the entire 19.4 MB
manual?

If they want to know if a local version is available, they could
always look in "Help menu > Manual" and immediately get the answer.

>
> Otherwise you may never realise there is a local Manual
> available if you don't have it already and never use the Help
> menu.

Could we add something to the side bar where it says "Help Location"?

>
> One other point. The "Help" button in Bass and Treble has no
> access key on Windows.
>
> In comparison if I drag an unsupported file into Audacity on
> Windows or Linux, the Help button in "Error Importing" does
> have an access key.

OK thanks, I'll look into that.

>
> Do you get an access key automatically on Linux for your Bass
> and Treble Help button, as happens on Linux for "OK" and
> "Cancel"?

Yes, the access key was there automatically.

Steve

>
>
>
> Gale
>
>
>> Perhaps someone could offer some guidance as to how to progress the
>> code from here?
>>
>> Steve
>
>