Difference between revisions of "Wording"

From Audacity Wiki
Jump to: navigation, search
(suggested changes to HelpText.cpp)
(changes following code updates.)
Line 18: Line 18:
  
 
=HelpText.cpp=
 
=HelpText.cpp=
 +
 +
Edit hint: All HelpText.cpp changes have been made.  Gale, feel free to delete these two comments once you've read them.
  
 
'''(Current) Lines:'''
 
'''(Current) Lines:'''
 
'''109:''' Suggested this section title could be changed from "Export" to "Exporting and Saving".
 
 
'''new 146:''' "For more detailed reading, please read our full Help by clicking the 'Help' menu, then 'Index', or <a href=\"*URL*\">download our Manual</a> in PDF format.\"
 
 
'''157:''' Replace "File > Import > Audio" with <nowiki>"<b>File > Import > Audio</b>"</nowiki>
 
 
'''158:''' Replace "File > Open" with <nowiki>"<b>File > Open</b>"</nowiki> 
 
 
'''160:''' Replace "import for you" with "play"
 
 
'''167:''' "use the |<< and |>> buttons" is correct in the file but in the browser appears as "use the |> buttons"
 
 
'''201:''' Replace "To do this: \" with:
 
 
"To do this, see this <nowiki>[[wiki:Recording levels|illustrated guide]] or follow these two steps: \" </nowiki>
 
 
'''211:''' Replace <nowiki>"[[wiki:Recording Tips|Recordin Tips]]"</nowiki> with <nowiki>"[[wiki:Recording Tips|Recording Tips]]"</nowiki> 
 
 
'''222:''' Replace "under the Edit" with <nowiki>"under the <b>Edit</b>"</nowiki>
 
 
Replace "under the Effect \" with <nowiki>"under the <b>Effect</b> \"</nowiki>
 
 
'''249:''' Replace "When you want to listen to your work in other computer programs or burn it to CD, you \"export\" it as \" with:
 
  
 
"when you want to listen to your work in other computer programs you \"export\" it as an audio file such as \"
 
"when you want to listen to your work in other computer programs you \"export\" it as an audio file such as \"
 
'''250:''' Replace "an audio file such as a WAV, AIFF or MP3. \" with
 
 
 
"a WAV, AIFF or MP3. When burning to CD, you export as WAV or AIFF.\"  
 
"a WAV, AIFF or MP3. When burning to CD, you export as WAV or AIFF.\"  
  
'''265:''' Replace "screen and want to export each as a separate file. \" with:
+
'''Minor quibble:''' Some portable CD players can play MP3 format CDsIt's unusual, and would just cause confusion, so we're using the text as above. -JC
 
 
"screen and want to export each as a separate file. If exporting tracks from a recorded LP or tape to multiple files, \"
 
 
 
'''new 266:''' "use <nowiki>[[wiki:|Splitting recordings into separate tracks|labels with Export Multiple]]. \"</nowiki>
 
 
 
'''267:''' replace "you need to add" with "you may need to add"
 
 
 
'''302:''' replace "burn that file to CD -" with "burn that file to CD with a CD burning program like iTunes -"
 
 
 
'''316''' replace <BR>
 
 
 
"_("You can download the help files and then access them from Audacity or you can click <a href=\"*URL*\">here</a> to read the help online.")" with:
 
  
 
"_("You can <a href=\"*URL*\">download</a> the help files and then access them from Audacity as you have just attempted, or you can click <a href=\"*URL*\">here</a> to read the help online.")"
 
"_("You can <a href=\"*URL*\">download</a> the help files and then access them from Audacity as you have just attempted, or you can click <a href=\"*URL*\">here</a> to read the help online.")"
  
 +
The download page must also tell you where to install the help files!  (In the data directory, under a new sub directory called 'Help') -JC
  
 
= Preferences =
 
= Preferences =
Line 81: Line 45:
  
 
<font color = "green"> If we can make more space, then we could elaborate: "higher value = more latency but more reliable recording" ; "Applies when playing tracks whilst recording. Negative value shifts recording backwards." Of course this is a substitute until we have context-sensitive help. - GA</font>     
 
<font color = "green"> If we can make more space, then we could elaborate: "higher value = more latency but more reliable recording" ; "Applies when playing tracks whilst recording. Negative value shifts recording backwards." Of course this is a substitute until we have context-sensitive help. - GA</font>     
 +
 +
Not in favour.  I don't see enough space for this.  -JC
  
 
==Batch tab==
 
==Batch tab==
  
 
'''Current Text:'''
 
'''Current Text:'''
 
"When importing audio, normalize all tracks" (n.b. doesn't really belong on batch tab and should be moved to File Formats tab and that tab renamed more appropriately -see below).
 
 
What this option does is to normalise any imported track to the current normalise level set at Effect > Normalize (whether or not done as part of a batch process) and additionally, normalise any other audio tracks already on screen. It doesn't normalise audio tracks on screen when you apply a chain to the current project, which it's possible users might have interpreted it as doing.
 
 
 
'''Suggested replacement:'''
 
  
 
"When importing audio files, normalize all tracks in project"  
 
"When importing audio files, normalize all tracks in project"  
  
<font color="green">GA suggests this revised wording clarifies to a user who may be thinking only about importing into an empty project. This wording would be consistent with the other text on the current File Formats tab and we have space for it there.  
+
<font color="green">Move this option into the "Audio Files". Also consider a change after 1.4 so that only one normalisation is done where you have a chain starting with that effect and "normalize" is turned on (this has been placed in "not aiming"). GA believes these are good moves and that "normalize all tracks" will be used when it is in an appropriate tab and clearer what it does.
 +
</font>
  
Then move this option into the "File Formats" tab after that tab has been renamed, see [[Wording#File_Formats_tab|File Formats tab]] for more. Also consider a change after 1.4 so that only one normalisation is done where you have a chain starting with that effect and "normalize" is turned on (this has been placed in "not aiming"). GA believes these are good moves and that "normalize all tracks" will be used when it is in an appropriate tab and clearer what it does.
+
Needs more discussion. -JC
</font>
 
  
 
----
 
----
 
'''Current text:'''
 
 
"Show MP3-ID3 Dialog"
 
 
The dialogue now appears for all valid formats (FLAC, WAV etc.), so... 
 
 
'''Suggested replacement:'''
 
 
"Show Metadata Editor prior to export step"
 
 
  
 
==Directories tab==
 
==Directories tab==
Line 117: Line 65:
 
'''Current text:'''
 
'''Current text:'''
  
"Auto save every [  ] minutes"
+
"Auto save interval [  ] minutes"
  
 
'''Suggested replacement:'''
 
'''Suggested replacement:'''
  
None if [MM] changes autosave to strict interval saving as per aim-to. Wording needs changing if strict interval saving not implemented. Suggested would be "Auto Save interval" (fudge).
+
If [MM] changes autosave to strict interval saving, as per aim-to, change 'interval' back to 'every'.
 
 
 
 
==File Formats tab==
 
 
 
'''Problem with tab name:'''
 
 
 
Since the exporting options for formats were removed from here, the tab description is no longer clear as to what it contains, and suggests it contains what it does not.
 
 
 
'''Suggested replacement:'''  
 
 
 
GA: No solution is ideal due to the disparate nature of what's in there. "Export & Import" is one possibility except that does not really cover the dependencies option. I have three renaming suggestions:
 
  
# "File Behaviors" or
+
The coding change probably won't get done in time for 1.4.0 -JC
# "Audio Files"
 
# "Files"
 
  
In any of these three cases I have these additional suggestions:
+
==Audio Files tab==
  
'''New text, at top of this tab and moved in from Batch tab:'''
+
'''Move in from Batch tab:'''
  
 
"When importing audio files, normalize all tracks in project"  
 
"When importing audio files, normalize all tracks in project"  
  
See discussion of wording of this item in [[Wording#Batch tab|Batch tab section]].   
+
See discussion in [[Wording#Batch tab|Batch tab section]].  Needs more discussion.  -JC
 
 
 
 
'''Current text:'''
 
 
 
"When importing uncompressed audio files into Audacity"
 
 
 
'''Suggested replacement:'''
 
 
 
"When importing uncompressed audio files"
 
 
 
Yes - JC, GA.
 
 
 
 
 
'''Current wording and order:'''
 
 
 
"When saving a project that depends on other audio files"
 
 
 
[*] Ask user
 
*Always copy all audio (safest)
 
*Never copy any audio
 
 
 
'''Suggested change:''' 
 
 
 
*Always copy all audio into project (safest)
 
*Do not copy any audio  
 
[*] Ask user
 
     
 
<font color="green"> GA thinks this does not read well with "Ask user" at top - you have to look further down to see what you are being asked. This change will also match the "importing" option by having the safe option at the top. "Do not copy any audio" is the new standard button text. It may not be better here than "Never copy any audio", but I think it's worth asking. </font> 
 
 
 
 
 
'''Current text:'''
 
 
 
"When exporting tracks"
 
 
 
'''Suggested change:''' 
 
 
 
"When exporting tracks to an audio file"
 
 
 
<font color="green"> Just re-emphasizes saving/export distinction but am prepared for it to be considered verbiage.</font>
 
 
 
'''Current Text:''' 
 
 
 
"MP3 Export Setup"
 
 
 
Especially with the proposed renaming of this tab, I think this should be moved into Directories tab and renamed to:
 
 
 
'''Suggested change:'''
 
 
 
"MP3 Export Library Location"
 
 
 
which is what it actually is.
 
  
 +
===MP3 Export Library Location===
  
 
'''Suggested additional text:'''   
 
'''Suggested additional text:'''   
Line 204: Line 89:
 
"Note: Export quality options for WAV, AIFF, MP3 and other formats can be chosen by clicking the Options button at time of export."   
 
"Note: Export quality options for WAV, AIFF, MP3 and other formats can be chosen by clicking the Options button at time of export."   
 
   
 
   
 
+
Needs discussion -JC
  
 
== Interface tab ==  
 
== Interface tab ==  
 
'''Behaviours:'''
 
 
'''Current text:'''
 
 
"Dragging of left and right selection edges"
 
 
'''Suggested replacement:'''
 
 
"Enable dragging of left and right selection edges"
 
  
 
'''Current text:'''
 
'''Current text:'''
Line 227: Line 102:
  
 
<font color = "green"> Is this a screen reader function, not anything that appears visually? Or what does this do and is there a better description we can make? - GA </font>
 
<font color = "green"> Is this a screen reader function, not anything that appears visually? Or what does this do and is there a better description we can make? - GA </font>
 +
 +
Perhaps it is presenting the numbers '''to''' the accessibility aid?  Leaving as is until clarified. -JC
 +
  
  
 
=Done=
 
=Done=
  
 +
* '''Enable dragging of left and right selection edges''' added the word 'enable'.
 +
----
 +
* '''MP3 Export Setup''' to '''MP3 Export Library Location''' which is what it is.
 +
----
 +
* '''When exporting tracks to an audio file''' added emphasis, 'to an audio file'.
 +
----
 +
* '''When saving a project...''' wording for dependencies and order of options changed.
 +
----
 +
* '''When importing uncompressed audio files into Audacity''' to '''When importing uncompressed audio files'''
 +
----
 +
* '''File Formats''' tab name changed to '''Audio Files'''
 +
----
 +
* '''HelpText.cpp''' many wording changes, including fix to |<< and >>|.
 +
----
 
* '''Normalize on Load''' changed to '''When importing audio, normalize all tracks'''.
 
* '''Normalize on Load''' changed to '''When importing audio, normalize all tracks'''.
 
----
 
----

Revision as of 14:23, 27 October 2007




Outside the program itself

This is for any documents included in source code but not part of the program wording. See Documentation Checklist for all other documentation requirements including issues that must be release noted if not fixed.

  • [RA] Update the Unix manual page  to distinguish between 1.3 and 1.2. In particular, remove reference to 1.3 importing multiple files from command line into the same Project, unless this ability is reinstated before release (See Aim to for details).


HelpText.cpp

Edit hint: All HelpText.cpp changes have been made. Gale, feel free to delete these two comments once you've read them.

(Current) Lines:

"when you want to listen to your work in other computer programs you \"export\" it as an audio file such as \" "a WAV, AIFF or MP3. When burning to CD, you export as WAV or AIFF.\"

Minor quibble: Some portable CD players can play MP3 format CDs. It's unusual, and would just cause confusion, so we're using the text as above. -JC

"_("You can <a href=\"*URL*\">download</a> the help files and then access them from Audacity as you have just attempted, or you can click <a href=\"*URL*\">here</a> to read the help online.")"

The download page must also tell you where to install the help files! (In the data directory, under a new sub directory called 'Help') -JC

Preferences

Audio I/O tab

Latency panel:

Ideally this needs a few helpful words, but there is little space. Is it essential we keep the panels of equal height? If it is, then how about adding after "milliseconds":

Audio to buffer: - "higher = more latency"

Latency correction: - "negative = backwards"

If we can make more space, then we could elaborate: "higher value = more latency but more reliable recording" ; "Applies when playing tracks whilst recording. Negative value shifts recording backwards." Of course this is a substitute until we have context-sensitive help. - GA

Not in favour. I don't see enough space for this. -JC

Batch tab

Current Text:

"When importing audio files, normalize all tracks in project"

Move this option into the "Audio Files". Also consider a change after 1.4 so that only one normalisation is done where you have a chain starting with that effect and "normalize" is turned on (this has been placed in "not aiming"). GA believes these are good moves and that "normalize all tracks" will be used when it is in an appropriate tab and clearer what it does.

Needs more discussion. -JC


Directories tab

Current text:

"Auto save interval [ ] minutes"

Suggested replacement:

If [MM] changes autosave to strict interval saving, as per aim-to, change 'interval' back to 'every'.

The coding change probably won't get done in time for 1.4.0 -JC

Audio Files tab

Move in from Batch tab:

"When importing audio files, normalize all tracks in project"

See discussion in Batch tab section. Needs more discussion. -JC

MP3 Export Library Location

Suggested additional text:

Significant numbers of users have reported difficulty finding the new location of file format export options. Whilst "when exporting tracks" needs to remain here instead of in the Export File dialogue where it should be, I suggest adding text explaining where the export options have gone to. I suggest this could go inside the "when exporting tracks" panel under the radio buttons, and say:

"Note: Export quality options for WAV, AIFF, MP3 and other formats can be chosen by clicking the Options button at time of export."

Needs discussion -JC

Interface tab

Current text:

"Present track number to accessibility aid"

Suggested replacement:

"Present track number as accessibility aid"

Is this a screen reader function, not anything that appears visually? Or what does this do and is there a better description we can make? - GA

Perhaps it is presenting the numbers to the accessibility aid? Leaving as is until clarified. -JC


Done

  • Enable dragging of left and right selection edges added the word 'enable'.

  • MP3 Export Setup to MP3 Export Library Location which is what it is.

  • When exporting tracks to an audio file added emphasis, 'to an audio file'.

  • When saving a project... wording for dependencies and order of options changed.

  • When importing uncompressed audio files into Audacity to When importing uncompressed audio files

  • File Formats tab name changed to Audio Files

  • HelpText.cpp many wording changes, including fix to |<< and >>|.

  • Normalize on Load changed to When importing audio, normalize all tracks.

  • Innertext:Recording written and text on monitoring added

  • Innertext:Export written and three typos corrected.

  • Innertext:Editing written and title changed to 'Editing and Greyed out Menus'.

  • Save Changes? Dialogue with empty Project: changed from "\n\nSaved project will be empty!!\n\nTo save the tracks you previously\nhad, click cancel, restore the tracks\nusing undo, and then save." to "\n\nSaved project will be empty!!\n\nTo save the tracks that were previously\nopen, click Cancel, Edit > Undo until all your\ntracks are open, then File > Save Project."

  • Interface tab, Show/Hide: "Show Welcome Message at program start up" , was 'Splash Screen'.

  • Find Clipping: "Start and stop must be greater than 0", was 'positive and greater than zero'.

  • Dependencies dialogue: The former "Close" and "Skip" buttons now both read "Do not copy any audio".

  • Export Multiple progress dialogue: "Exporting the entire project as a WAV/AIFF file" or (for MP3) "exporting the entire file..." now changed to "Exporting entire project" with (filename) in the dialogue title and (format) above the progress bar.

  • Latency Shift Dialogue: In "I have brought it back to start at zero", "I have" has been replaced with "Audacity has".

  • Preferences: Interface tab: "Tracks &fit vertically zoomed" changed to "Automatically &fit tracks vertically zoomed"

  • "Audacious!" buttons -> "OK... Audacious!"

  • GUIPrefs.CPP:

- "&Select all audio, if none selected, on applying effect"

+ "&Select all audio in project, if none selected"

- "&Circular track keyboard navigation"

+ "\"Move track focus\" &cycles repeatedly through tracks"

- "&Quit Audacity upon closing last window"

+ "Any Close/Exit command completely &quits Audacity"


  • Import.CPP:

- " is an encrypted audio file, typically from an online music store. \nAudacity cannot open this type of file due to the encryption.\nYou need to convert it to a supported, unencrypted audio format."

+ " is an encrypted audio file. These typically are from an online music store. \nAudacity cannot open this type of file due to the encryption. \nTry recording the file into Audacity, or burn it to audio CD then \nextract the CD track to a supported audio format such as WAV or AIFF."

- " is an audio CD file. \nAudacity does not open this type of file.\nTry ripping it to a native audio format that Audacity can import."

+ " is an audio CD track. \nAudacity cannot open audio CDs directly. \nExtract (rip) the CD tracks to an audio format that \nAudacity can import, such as WAV or AIFF.");

Add "WAV or AIFF" references to Real, AAC and WMA:

- " is a RealPlayer media file. \nAudacity cannot open this..."

+ " is a RealPlayer media file. \nAudacity cannot open this proprietary format. \nYou need to convert it to a supported audio format, such as WAV or AIFF."

- " is an Advanced Audio Coding file. \nAudacity cannot open this..."

+ " is an Advanced Audio Coding file. \nAudacity cannot open this type of file. \nYou need to convert it to a supported audio format, such as WAV or AIFF."

- " is a Windows Media Audio file. \nAudacity cannot open this..."

+ " is a Windows Media Audio file. \nAudacity cannot open this type of file due to patent restrictions. \nYou need to convert it to a supported audio format, such as WAV or AIFF."



  • Default temporary directory: changed from "/tmp/audacity1.2-%USERNAME" to AUDACITY_VERSION, AUDACITY_RELEASE string