Difference between revisions of "Standards and Conventions"

From Audacity Wiki
Jump to: navigation, search
(Initial draft of new page)
(Amplitude Scale and Gain: conventionally we use the {{todo}} as a prefix rather than suffix)
Line 28: Line 28:
'''Occurances of Non-Standard Behavior:'''
'''Occurances of Non-Standard Behavior:'''
# Track vertical ruler in "Waveform" view {{todo}}
# Track vertical ruler in "Waveform" view  
# [https://manual.audacityteam.org/man/chirp.html Chirp] {{todo}}
# {{todo}} [https://manual.audacityteam.org/man/chirp.html Chirp]
# [https://manual.audacityteam.org/man/dtmf_tones.html DTMF Tones] {{todo}}
# {{todo}} [https://manual.audacityteam.org/man/dtmf_tones.html DTMF Tones]
# [https://manual.audacityteam.org/man/noise.html Noise] {{todo}}
# {{todo}} [https://manual.audacityteam.org/man/noise.html Noise]
# [https://manual.audacityteam.org/man/risset_drum.html Risset Drum] {{todo}}
# {{todo}} [https://manual.audacityteam.org/man/risset_drum.html Risset Drum]
# [https://manual.audacityteam.org/man/tone.html Tone] {{todo}}
# {{todo}} [https://manual.audacityteam.org/man/tone.html Tone]

Revision as of 14:01, 17 March 2020

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.
Date Logged: 16Mar20

Occurances of Non-Standard Behavior:

  1. Right click drag to resize track height.ToDo.png

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. 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