Difference between revisions of "Completed Proposal Improvements to Export progress dialogs"

From Audacity Wiki
Jump to: navigation, search
(Details: reordering)
 
(13 intermediate revisions by one other user not shown)
Line 4: Line 4:
  
 
==The Problem==
 
==The Problem==
TBP
+
Because we use a common dialog for '''Export''' and '''Export Multiple''' we should have a form of words that is applicable to both and accurate in both cases.  The current form of words is inaccurate when used for the Export Multiple use case as it refers to "Exporting the entire project..." when if fact it is exporting a labelled section only. We also have inconsistent wording usage between the various export forms with two different variations.
  
 +
For '''Export Selected Audio''' we have a set of messages applicable only the exporting a selection of the audio
  
 
== Proposed Feature ==
 
== Proposed Feature ==
TBP
+
In the dialogs for Export and Export Multiple change the wording to read "'''Exporting the audio ...'''"
  
 +
This should involve nine simple textual changes - and be very simple and straightforward.
 +
{{note|'''Future improvements:'''
 +
*It would probably be better if all of these messages were handled in one place rather than multiple (near but inconsistent) duplications.
 +
*It would probably be better too if we had separate dialog message paths for Export and Export Multiple,  Then we could have more targeted messages.}}
  
 
==Developer/QA Backing==
 
==Developer/QA Backing==
TBP
+
'''Peter:''' I dislike the inaccuracy of "entire project" when only a labelled part of a project is being exported.
 
 
  
 
==Use Cases==
 
==Use Cases==
TBP
+
*Export Multiple displays an inaccurate and misleading information in its progress dialog.
 
+
*For Exports that use the wording "Exporting entire file as..." this is grammatically incorrect the exporter is exporting audio (sometimes the entire project, sometimes not) '''''to''''' a file.
  
 
==Details==
 
==Details==
Line 23: Line 27:
  
 
===PCM exporter (WAV)===
 
===PCM exporter (WAV)===
 +
====Existing strings====
 
:wxString::Format(_("Exporting the selected audio as %s"),
 
:wxString::Format(_("Exporting the selected audio as %s"),
 
:formatStr.c_str()) :
 
:formatStr.c_str()) :
Line 28: Line 33:
 
:formatStr.c_str()));
 
:formatStr.c_str()));
  
===Command line exporter===
+
====Change required====
:_("Exporting the selected audio using command-line encoder") :
+
change "Exporting the entire project..." to "'''Exporting the audio ...'''"
:_("Exporting the entire project using command-line encoder"));
+
 
  
 
===FFmpeg exporter===
 
===FFmpeg exporter===
 +
====Existing strings====
 
:wxString::Format(_("Exporting selected audio as %s"),
 
:wxString::Format(_("Exporting selected audio as %s"),
 
:ExportFFmpegOptions::fmts[mSubFormat].Description()) :
 
:ExportFFmpegOptions::fmts[mSubFormat].Description()) :
 
:wxString::Format(_("Exporting entire file as %s"),
 
:wxString::Format(_("Exporting entire file as %s"),
 
:ExportFFmpegOptions::fmts[mSubFormat].Description()));
 
:ExportFFmpegOptions::fmts[mSubFormat].Description()));
 +
 +
====Change required====
 +
change "Exporting entire file..." to "'''Exporting the audio ...'''"
 +
  
 
===FLAC exporter===
 
===FLAC exporter===
 +
====Existing strings====
 
:_("Exporting the selected audio as FLAC") :
 
:_("Exporting the selected audio as FLAC") :
 
:_("Exporting the entire project as FLAC"));
 
:_("Exporting the entire project as FLAC"));
 +
 +
====Change required====
 +
change "Exporting the entire project..." to "'''Exporting the audio ...'''"
 +
  
 
===MP2 Exporter===
 
===MP2 Exporter===
 +
====Existing strings====
 
:wxString::Format(_("Exporting selected audio at %ld kbps"), bitrate) :
 
:wxString::Format(_("Exporting selected audio at %ld kbps"), bitrate) :
 
:wxString::Format(_("Exporting entire file at %ld kbps"), bitrate));
 
:wxString::Format(_("Exporting entire file at %ld kbps"), bitrate));
 +
 +
====Change required====
 +
change "Exporting entire file..." to "'''Exporting the audio ...'''"
 +
  
 
===MP3 Exporter===
 
===MP3 Exporter===
 +
====Existing strings====
 
:if (rmode == MODE_SET) {
 
:if (rmode == MODE_SET) {
 
:title.Printf(selectionOnly ?
 
:title.Printf(selectionOnly ?
Line 65: Line 86:
 
:brate);
 
:brate);
 
:}
 
:}
 +
 +
====Change required====
 +
change "Exporting entire File..." to "'''Exporting the audio ...'''"  x 3 occurrences
 +
  
 
===OGG exporter===
 
===OGG exporter===
 +
====Existing strings====
 
:_("Exporting the selected audio as Ogg Vorbis") :
 
:_("Exporting the selected audio as Ogg Vorbis") :
 
:_("Exporting the entire project as Ogg Vorbis"));
 
:_("Exporting the entire project as Ogg Vorbis"));
 +
 +
====Change required====
 +
change "Exporting the entire project..." to "'''Exporting the audio ...'''"
 +
 +
 +
===Command line exporter===
 +
====Existing strings====
 +
:_("Exporting the selected audio using command-line encoder") :
 +
:_("Exporting the entire project using command-line encoder"));
 +
 +
====Change required====
 +
change "Exporting the entire project..." to "'''Exporting the audio ...'''"
  
  
{{note|It would probably be better if all of these messages were handled in one place rather than multiple (near but inconsistent) duplications.}}
+
===MIDI (Note tracks) and Label tracks===
 +
There would appear to be no progress dialogs for the Export of Note tracks or Label tracks, presumably because both are so rapid.
  
 
===GUI Examples===
 
===GUI Examples===

Latest revision as of 18:01, 17 December 2017

Proposal pages help us get from feature requests into actual plans. This page is a proposal to ...
Proposal pages are used on an ongoing basis by the Audacity development team and are open to edits from visitors to the wiki. They are a good way to get community feedback on a proposal.


  • Note: Proposals for Google Summer of Code projects are significantly different in structure, are submitted via Google's web app and may or may not have a corresponding proposal page.


The Problem

Because we use a common dialog for Export and Export Multiple we should have a form of words that is applicable to both and accurate in both cases. The current form of words is inaccurate when used for the Export Multiple use case as it refers to "Exporting the entire project..." when if fact it is exporting a labelled section only. We also have inconsistent wording usage between the various export forms with two different variations.

For Export Selected Audio we have a set of messages applicable only the exporting a selection of the audio

Proposed Feature

In the dialogs for Export and Export Multiple change the wording to read "Exporting the audio ..."

This should involve nine simple textual changes - and be very simple and straightforward.

Future improvements:
  • It would probably be better if all of these messages were handled in one place rather than multiple (near but inconsistent) duplications.
  • It would probably be better too if we had separate dialog message paths for Export and Export Multiple, Then we could have more targeted messages.

Developer/QA Backing

Peter: I dislike the inaccuracy of "entire project" when only a labelled part of a project is being exported.

Use Cases

  • Export Multiple displays an inaccurate and misleading information in its progress dialog.
  • For Exports that use the wording "Exporting entire file as..." this is grammatically incorrect the exporter is exporting audio (sometimes the entire project, sometimes not) to a file.

Details

It's a bit peculiar how this is done, in that the message comes from the exporter, so each exporter has it's own messages. For each exporter there is a choice of two messages, depending on whether the "selectionOnly" flag is set or not.

PCM exporter (WAV)

Existing strings

wxString::Format(_("Exporting the selected audio as %s"),
formatStr.c_str()) :
wxString::Format(_("Exporting the entire project as %s"),
formatStr.c_str()));

Change required

change "Exporting the entire project..." to "Exporting the audio ..."


FFmpeg exporter

Existing strings

wxString::Format(_("Exporting selected audio as %s"),
ExportFFmpegOptions::fmts[mSubFormat].Description()) :
wxString::Format(_("Exporting entire file as %s"),
ExportFFmpegOptions::fmts[mSubFormat].Description()));

Change required

change "Exporting entire file..." to "Exporting the audio ..."


FLAC exporter

Existing strings

_("Exporting the selected audio as FLAC") :
_("Exporting the entire project as FLAC"));

Change required

change "Exporting the entire project..." to "Exporting the audio ..."


MP2 Exporter

Existing strings

wxString::Format(_("Exporting selected audio at %ld kbps"), bitrate) :
wxString::Format(_("Exporting entire file at %ld kbps"), bitrate));

Change required

change "Exporting entire file..." to "Exporting the audio ..."


MP3 Exporter

Existing strings

if (rmode == MODE_SET) {
title.Printf(selectionOnly ?
_("Exporting selected audio with %s preset") :
_("Exporting entire file with %s preset"),
FindName(setRates, WXSIZEOF(setRates), brate).c_str());
}
else if (rmode == MODE_VBR) {
title.Printf(selectionOnly ?
_("Exporting selected audio with VBR quality %s") :
_("Exporting entire file with VBR quality %s"),
FindName(varRates, WXSIZEOF(varRates), brate).c_str());
}
else {
title.Printf(selectionOnly ?
_("Exporting selected audio at %d Kbps") :
_("Exporting entire file at %d Kbps"),
brate);
}

Change required

change "Exporting entire File..." to "Exporting the audio ..." x 3 occurrences


OGG exporter

Existing strings

_("Exporting the selected audio as Ogg Vorbis") :
_("Exporting the entire project as Ogg Vorbis"));

Change required

change "Exporting the entire project..." to "Exporting the audio ..."


Command line exporter

Existing strings

_("Exporting the selected audio using command-line encoder") :
_("Exporting the entire project using command-line encoder"));

Change required

change "Exporting the entire project..." to "Exporting the audio ..."


MIDI (Note tracks) and Label tracks

There would appear to be no progress dialogs for the Export of Note tracks or Label tracks, presumably because both are so rapid.

GUI Examples

Not required

Previous Feature Requests relating to this proposal

TBP