Audacity Bug Summary
••• Introduction •••
••• Keywords •••
    Audacity 3.0.3 development began 19th April 2021

Audacity Bugzilla



Bug 1741 - Error-help when attempting to Import a Project fails to go to local installed Manual
Error-help when attempting to Import a Project fails to go to local installed...
Status: RESOLVED FIXED
Product: Audacity
Classification: Unclassified
Component: User Interface
2.2.0
Per OS All
: P3 RepeatableAll
Assigned To: Default Assignee for New Bugs
:
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2017-09-05 09:52 UTC by Peter Sampson
Modified: 2018-08-20 11:51 UTC (History)
7 users (show)

See Also:
Steps To Reproduce:
0) ensure local Manual is installed 1) Open Audacity 2) File > Import > Audio 3) chose an aup project file 4) click "Open" 5) Error dialog pops up 6) Click on the help "?" buttom 7) You do not get taken to the installed Manual 8) Rather you get the "Support for Other Formats" dialog - which does work, but always takes you to the online Manual even when the local Manual is available and 9) Observe the error message is not entirely helpful
Release Note:
GROUP: Interface * If you attempt to open an Audacity Project using the Import command you will be shown an error message (telling you to use File>Open instead). ** Clicking the (?) help button in the "xxx.aup is an Audacity Project File ..." message will take you to an Audacity dialog offering more help - but that help is inappropriate to opening a project. ** Further, if the local manual is installed (standard on Windows and Mac, optional according to your download choice on Mac and Windows), clicking the (?) help button in the "xxx.aup is an Audacity Project File ..." and then clicking on the links in the further message will take you to the online Manual and not your local installed Manual - and this will fail if you have no Internet connection.
First Git SHA:
Group: ---
Workaround:
Closed: 2018-08-20 00:00:00
petersampsonaudacity: Test‑OK‑Win+
petersampsonaudacity: Test‑OK‑Mac+


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Peter Sampson 2017-09-05 09:52:04 UTC
When using the help button in the error for attempting to use Import to "open" an Audacity project - even with a local installed Manual available you are not taken there - rather you get offered the "Support for Other Formats" dialog (which does work).

I suspect that the nub of this problem is that the creator of this message was unsure where one might want to target in the Manual.  The messahe offers help on
a) FFmpeg
b) MIDI
c) audio CDs

Note that there is no mention of simple importing of a WAV file or a suitabel link for such.

And given that the user was tryin to access/open an aup project via the import - we should probably be directing then to the pages on importing and on project opening
https://alphamanual.audacityteam.org/man/Importing_Audio
and
https://alphamanual.audacityteam.org/man/Audacity_Projects
or its anchored section (if that can be technically done)
https://alphamanual.audacityteam.org/man/Audacity_Projects#open

I have assigned this p2 as:
i) it doesn't work as intended (ifnores any locally installed Manual)
ii) has a less than helpful message
iii) Help buttons are a headline new feature for 2.2.0 and we should therefore ensure that they work properly and well.
Comment 1 Peter Sampson 2017-09-05 10:27:11 UTC
Similar obtains when you attempt to Import a MIDI file using file>Import>Audio

This is probably because the self same error dialog for "Support for Other Formats" is used here too.
Comment 2 Peter Sampson 2017-09-05 10:33:09 UTC
And you get the same  "Support for Other Formats", but a different underlying error message (Audacity did not recognize the type of file ...") when you try to import a .jpg file as audio.

So this and comment #1 imply that the primary target of this error message should be the Import page: https://alphamanual.audacityteam.org/man/Importing_Audio


And note that I have improved that page in the Manual by drawing more attention in the intro div by using an advice div highlighting that you need to use Open for projects rather than import - so a link to that page could be sufficient in itself.
Comment 3 Peter Sampson 2017-09-06 09:35:29 UTC
Downgraded to P4 Enh after an offline discussion with Steve:

How frequently do novice users attempt to import projects?
I'd guess that's pretty rare - far more common the other way round, attempting to "open" an audio file into the current project. Similarly, I expect that it is pretty rare for even a novice to attempt to import a JPG.

My guess is that the most common (by far) way that novice users end up with this error, is when they attempt to import an unsupported file type (such as WMA) and don't have FFmpeg installed.

When this is the case, the initial message is pretty good, but note that this is not an "error dialog" it is a "help window". I don't think that we can currently open another help window from a help window, or open local manual pages, but we can include (on-line) links. (It's a "help window" like the one that says something like: "you don't have the manual installed locally, do you want to view it on line or download it?")

I agree it can definitely be improved - for example, it is offering to install FFmpeg when I've already got FFmpeg installed.
Comment 4 Peter Sampson 2017-09-07 04:42:19 UTC
I have examined this some more and have now upgraded this to P3 (no Enhancement).

There are actually two bugs here relating to the error message that is shown when the user ties to use the Import command with an Audacity project.

1) When a local Manual installed clicking on the "?" help button in the error message Audacity ignores the local Manual and goes directly to the installed Manual.   

This is bad for the user that has no internet connection but does have a local Manual installed.


2) The result of clicking the "?" help button (either with or without a local Manual intalled) is an Audacity dialog which is inappropriate to what the user has just tried to do.

a) They have tried to use Import to open and Audacity project.

b) They get shown an error message (which is pretty clear in itself imo) which says:
"xxxx.aup is an Audacity Project file
Use the 'File > Open' command to open Audacity Projects."

c) If they want more information and now click in the "?" help button then they get shown the same Audacity dialog that is shown to users who try to import other unrecognized audio file types (a message which is appropriate and useful in those circumstances - just not appropriate here).

d) Instead that "?" help button should just go direct to the Manual (local or online as appropriate) - and I would suggest that this page is the most appropriate:
https://alphamanual.audacityteam.org/man/Audacity_Projects

or its anchored section:
https://alphamanual.audacityteam.org/man/Audacity_Projects#open
if that is technically achievable (if not the page itsel with its custom TOC would be fine)
Comment 5 Steve Daulton 2018-02-25 19:39:18 UTC
(In reply to Peter Sampson from comment #4)
The "error" is that the import failed.

The message shown in error dialog is customised according to what Audacity thinks may be the reason for the problem, but the dialog itself (and the dialog Help button), is for "failed audio import". The target for the Help button needs to be appropriate for "failed audio import" (whatever the user actually did).

Two possible solutions are, either:
1) extend the scope of the "Importing Audio" page so as to be more comprehensive in its coverage of possible failures,
or,
2) provide a new landing page for the Help button that focuses specifically on failed audio import (with links to pages for: importing audio, opening projects, installing FFmpeg, and importing non-audio files).

I'm thinking that (2) could be the better option.
Comment 6 Peter Sampson 2018-02-26 07:21:58 UTC
(In reply to Steve Daulton from comment #5)
OK so I spent some time this morning working on  the "Importing Audio" page
https://alphamanual.audacityteam.org/man/Importing_Audio
Tidying it and making it clearer (I hope).

I think this should now be a suitable target.
Comment 7 Steve Daulton 2018-02-26 08:15:01 UTC
Fixed in https://github.com/audacity/audacity/commit/cf9ab70406
Comment 8 Peter Sampson 2018-02-26 10:14:00 UTC
Tested on W10 with build provided by Steve:  Audacity 2-3-0 Steve's build 26Feb18

The "?" help button in the error message now directs to the local installed Manual when  that is installed and preferred.

The "?" help button directs properly to the updated page in the online Manual - when online is preferred.


I will also test this on Mac with tomorrow's nightly.
Comment 9 Peter Sampson 2018-02-28 09:45:48 UTC
Tested on macOS 10.13.3 High Sierra with audacity-macos-nightly-2.3.0-4474dec

As on W10:


The "?" help button in the error message now directs to the local installed Manual when  that is installed and preferred.

The "?" help button directs properly to the updated page in the online Manual - when online is preferred.