Standards and Conventions

From Audacity Wiki
Revision as of 10:49, 3 September 2021 by Leo Wattenberg (talk | contribs) (+deprecated)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
Warning icon This page has been deprecated.
The information on this page are likely out-of-date and will not be updated in the forseeable future. It may be removed at any time.
Audacity aims to follow recognized standards and conventions whenever applicable. This includes the choice of terminology (see: Wording), Human interface guidelines, format specifications, and platform specific conventions. For various reasons, Audacity sometimes diverges from accepted norms. This page is for tracking known issues where Audacity contravenes accepted standards.
New features or behaviors that conflict with established standards should NOT be logged here. They should be logged as bugs on Bugzilla, and ideally be fixed prior to release.
Warning icon Human Interface Guidelines

There are multiple "Human Interface Guidelines" (HIGs) for Desktop applications, and by and large they agree with each other:

Right Click Behavior

Reference: Microsoft HIG.

Microsoft and Apple (and may others) have GUI design guidelines that specify that right-click gestures should normally be reserved for a context menu or null.

Date Logged: 16Mar20

Occurances of Non-Standard Behavior:

  1. ToDo.png Right click&drag to resize track height.
  2. ToDo.png Right click&drag to resize relative channel sizes in a stereo track
  3. ToDo.png Right click&drag to resize relative sizes in a Multi-view.
  4. Done.png Right click&drag to reposition the pinned play head in the Timeline
  5. ToDo.png Right click&drag to set the sliders in Mixer Toolbar
  6. ToDo.png Right click&drag to set the slider in Play-at-Speed Toolbar
  7. ToDo.png Right click&drag to set the slider in Mixer Board
Peter 17Apr20: the sliders in TCP and effects appear to be OK with null action on right-click&drag.

Amplitude Scale and Gain

Reference: Standard practice in audio software is to use dBFS for amplitude, and dB for gain.
Date Logged: 16Mar20

Description: Audacity is inconsistent in it's representation of amplitude, sometimes using dBFS (like the rest of the audio world) and sometimes using a linear scale of +/- 1. It is particularly confusing that Audacity's shipped generators use a linear scale of 0 to 1, and Audacity's shipped effects use dB.

Occurances of Non-Standard Behavior:

  1. ToDo.png Track vertical ruler in "Waveform" view
  2. ToDo.png Chirp
  3. ToDo.png DTMF Tones
  4. ToDo.png Noise
  5. ToDo.png Risset Drum
  6. ToDo.png Tone