Bug 1733 – Help button on "error opening sound device" dialog should link to full page on the topic rather than anchor on the FAQ:Error page

••• Introduction •••
••• Keywords •••

Audacity 3.0.3 development began 19th April 2021

Audacity Bugzilla

Bug 1733 - Help button on "error opening sound device" dialog should link to full page on the topic rather than anchor on the FAQ:Error page


Summary:	Help button on "error opening sound device" dialog should link to full page o...

Status:	RESOLVED QUICKFIXED

Product:	Audacity
Classification:	Unclassified
Component:	User Interface
Version:	2.2.0
Hardware:	Per OS All

Importance:	P4 Enhancement
Assigned To:	Default Assignee for New Bugs

URL:
Keywords:

Depends on:
Blocks:
	Show dependency tree / graph

Reported:	2017-09-01 09:54 UTC by Bill Wharrie
Modified:	2018-08-20 11:45 UTC (History)
CC List:	5 users (show)

See Also:
Steps To Reproduce:	1) Create a condition where a sound device becomes unavailable (such as unplugging a USB sound input device while Audacity is running). 2) Click Record 3) "Error opening sound device" dialog appears 4) Click the (?) help button 5) You are taken to an the FAQ:Error page in the manual Better if we went to the manual page dedicated to this error.
Release Note:
First Git SHA:
Group:	---
Workaround:
Closed:	2018-08-20 00:00:00

Flags:	petersampsonaudacity: Test‑OK‑Win+ petersampsonaudacity: Test‑OK‑Mac+ petersampsonaudacity: Test‑OK‑Lin+

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.

Description Bill Wharrie 2017-09-01 09:54:36 UTC

The button is linked to "FAQ_Error.html" when it should be linked to "FAQ:Error.html"

Comment 1 Peter Sampson 2017-09-01 10:26:35 UTC

Agree somewhat - but far better to go to the specific target page that was created
for this purpose (help link) for this error:
https://alphamanual.audacityteam.org/man/Error_opening_sound_device

which takes the user direct to what they need to know rather than the terse description (and link) that lives on the FAQ:Errors page.

That way the user needs only one click and not two - thus saving RSI (plus some readers amiss the link for the detail).

Comment 2 Bill Wharrie 2017-09-01 10:54:36 UTC

My mistake. Colons are changed to underscores in the release manual, so this is not a bug.
Agree with Peter that it would be better to link to the full page rather than the anchor, so changing the description and steps. Lowering to P4 enhancement.

Comment 3 Steve Daulton 2017-09-04 06:24:52 UTC

Help links updated in 
https://github.com/audacity/audacity/commit/e238845

Comment 4 Peter Sampson 2017-09-05 04:16:37 UTC

(In reply to Steve Daulton from comment #3)
Testing on macOS Sierra 10.12.6 
(alpha but labelled as Beta) d7cc85b 05Sep17

This now works properly with a local Manual installed on the latest alpha (obviously not incorporated into the Beta yet - as Beta dates from 02Sep17 before Steve's fix for this).  The help button on the error message goes directt to the fill error page (and not the anchored summary FAQ)


BUT, and this is a big but,  here we have the same error wih no local manual that we encountered in Bug #1730 (for the "No audio selected ..." error message) whereby:

1) Nothing in the "Help on the internet" dialog is responsive: the "Close" button does not work, the links do not work and the dialog cannot be closed with the window's close button

2) To close the "Help on the internet" dialog you must click the "OK" button in the "No Audio Selected" dialog


Since we now have see this with two error message this implies that it may well be a problem with other error messages, some of which are not easy to provoke and thus this research mey be most easily conducted by examining, and correcting the code if necessary.  (I will add thes comments to Bug #1730 - because although we have fixed the particular case there, it looks like we may not have fixed the general case)

Comment 5 Peter Sampson 2017-09-05 10:44:39 UTC

Please ignore Comment #4 this has been addressed by adding two further (albeit related) bug reports:

1) Bug #1740 - Help on Internet dialog non-responsive when invoked by help button on "Error opening sound device..." dialog

2) Bug #1741 - Error-help when attempting to Import a Project fails to go to local installed Manual

This enabled me to reset this as DEVEL-Fix MADE.


The original issue of this bug report now works fine on Mac, tested on alpha/beta 05Sep17 - so marked as ok.

Still to be tested on Windows (no nightlies) ad Linux

Comment 6 Peter Sampson 2017-09-07 11:58:00 UTC

Tested on W10 audacity-win-7314de6-2.2.0-beta-7Sep17

The help button "?" now goes direct to the correc Manual page with with local Manual installed and on-line Manual if no local Manual installed (either via the "Help on the Internet" message or via Prefs settings.

Looks to be fixed on W10 so flagged as so.

Flagged as ok on Linux as assumed tested by Steve as part of his fix&commit process.

So marked as RESOLVED QUICKFIXED