Difference between revisions of "Talk:Wording"

From Audacity Wiki
Jump to: navigation, search
(Rules for our Text: suggestions?)
(proposal to remove spurious ellipses)
Line 3: Line 3:
  
 
Old discussions should probably be removed from the main page in time, and archived here, and later removed altogether.  That's not the 'done' items, rather it's the items for which we decide wording after some discussion.
 
Old discussions should probably be removed from the main page in time, and archived here, and later removed altogether.  That's not the 'done' items, rather it's the items for which we decide wording after some discussion.
 +
 +
 +
== spurious ellipsis ==
 +
[[media:SpuriousEllipse.patch | patch]]
 +
 +
Inspecting the header files in src/effects we find the effects classes each of which has a function GetEffectAction() which returns a brief description of what the effect "does". Most have a well formed text but a few have a spurious ellipsis at the end. I propose removing the ellipse.
 +
 +
Additionally, almost every string is in title case (Every  Word Capitalized Except  the, for and to), so made the two or three exceptions comform.
 +
 +
This one is good:
 +
 +
class EffectWahwah:public EffectSimpleMono {
 +
[...]
 +
  virtual wxString GetEffectAction() {
 +
      return wxString(_("Applying Wahwah"));
 +
 +
These all have a spurious ellipsis:
 +
 +
class EffectTruncSilence: public Effect {
 +
[…]
 +
  virtual wxString GetEffectAction() {
 +
      return wxString(_("Truncating Silence..."));
 +
 +
class EffectSpikeCleaner: public EffectSimpleMono {
 +
[…]
 +
  virtual wxString GetEffectAction() {
 +
      return wxString(_("Applying Spike Cleaner..."));
 +
class EffectNormalize: public Effect
 +
[…]
 +
  virtual wxString GetEffectAction() {
 +
      return wxString(_("Normalizing..."));
 +
 +
class EffectLeveller: public EffectSimpleMono
 +
[…]
 +
  virtual wxString GetEffectAction() {
 +
      return wxString(_("Applying Leveller..."));
 +
 +
class EffectCompressor: public EffectTwoPassSimpleMono {
 +
[…]
 +
  virtual wxString GetEffectAction() {
 +
      return wxString(_("Applying Dynamic Range Compression..."));
 +
class EffectClickRemoval: public Effect {
 +
[…]
 +
  virtual wxString GetEffectAction() {
 +
        return wxString(_("Removing clicks and pops..."));
 +
class EffectChangeLength: public Effect {
 +
[…]
 +
  virtual wxString GetEffectAction() {
 +
      return wxString(_("Changing Length..."));
 +
 +
class EffectAutoDuck: public Effect
 +
[…]
 +
  virtual wxString GetEffectAction()
 +
  {
 +
      return wxString(_("Processing Auto Duck..."));
  
  

Revision as of 23:54, 7 November 2011

If it proves difficult to decide between different alternatives to wording, then we may need to have some kind of voting. I'm not keen on that as it adds overhead and takes longer to sort out. Probably a better scheme is to assume that we will easily reach consensus in most cases, and just flag the difficult cases if they arise. James 13:59, 7 October 2007 (PDT)


Old discussions should probably be removed from the main page in time, and archived here, and later removed altogether. That's not the 'done' items, rather it's the items for which we decide wording after some discussion.


spurious ellipsis

patch

Inspecting the header files in src/effects we find the effects classes each of which has a function GetEffectAction() which returns a brief description of what the effect "does". Most have a well formed text but a few have a spurious ellipsis at the end. I propose removing the ellipse.

Additionally, almost every string is in title case (Every Word Capitalized Except the, for and to), so made the two or three exceptions comform.

This one is good:

class EffectWahwah:public EffectSimpleMono { [...]

  virtual wxString GetEffectAction() {
     return wxString(_("Applying Wahwah"));

These all have a spurious ellipsis:

class EffectTruncSilence: public Effect { […]

  virtual wxString GetEffectAction() {
     return wxString(_("Truncating Silence..."));

class EffectSpikeCleaner: public EffectSimpleMono { […]

  virtual wxString GetEffectAction() {
     return wxString(_("Applying Spike Cleaner..."));

class EffectNormalize: public Effect […]

  virtual wxString GetEffectAction() {
     return wxString(_("Normalizing..."));

class EffectLeveller: public EffectSimpleMono […]

  virtual wxString GetEffectAction() {
     return wxString(_("Applying Leveller..."));

class EffectCompressor: public EffectTwoPassSimpleMono { […]

  virtual wxString GetEffectAction() {
     return wxString(_("Applying Dynamic Range Compression..."));

class EffectClickRemoval: public Effect { […]

  virtual wxString GetEffectAction() {
        return wxString(_("Removing clicks and pops..."));

class EffectChangeLength: public Effect { […]

  virtual wxString GetEffectAction() {
     return wxString(_("Changing Length..."));

class EffectAutoDuck: public Effect […]

  virtual wxString GetEffectAction()
  {
     return wxString(_("Processing Auto Duck..."));


Rules for our Text

Do we have any consistent rules about text? For example, we always capitalise 'Audacity'.

Do we capitalise, single quote or double quote menu item names when used in text?

Capitalise and double quote e.g. "Effect" Menu? [GA]

Do we use '->' or '>' when describing menu/submenu sequences?

'>' (without the quotes) ? [GA]

Do we have an upper limit on how much text we will put on a button or on a radio button?

Does it depend on the dialogue in question to some extent? [GA]

Old Discussions