Consistency

Wording

These are our suggested guidelines for consistency in wording. Please add to them, or comment if a change is thought desirable.

• US English ... examples:
  • "behavior" not "behaviour"
  • "check/uncheck the box" not "tick/untick the box"
  • "color" not "colour"
  • "dialog" not "dialogue"
  • "gray/grayed" not "grey/greyed"
  • "labeling" not "labelling"
  • "normalize" not "normalise"

• menu paths are indicated by " > " e.g. "File > Export..."
• numbers have no spaces or commas ("44100 Hz", not "44,100 Hz " or "44 100 Hz"). Any numbers over a million (probably none) we'll consider if they arise. Numbers less than 10 are written out as text ("five tracks" not "5 tracks")
• quotes are inside " ", not ' '
• units: "dB" not "db", "seconds" and "milliseconds" not "s" and "ms". There must always be a space between the value and the unit (for example, "10 dB" not "10dB").

GUI Elements

• "Time Shift Tool", not "Move Tool"
• "Track Drop-Down Menu", not Track "Pop-Down Menu" (items "drop" down or "pop" up)

Layout

Headers

The page title will render as a first order heading, so place the primary headers in your text inside second order tags (two equals signs) thus:

== Primary heading ==

Use incremental headings in the structure, so that second level headings in your text are third order headers:

=== Secondary heading ===

then third level headings are inside fourth order headers and so on.

Page families

Pages may fall into families according to their purpose and pages within a family should share the same style of layout. Layout to use for particular families is still being discussed.

Currently we have decided on this scheme for pages describing the individual Preferences tabs:

• enclose the name of each static box or panel section inside second order headers (==)
• then use a bulleted list for items within the static box or panel section. The first text in each list item should be the name of the item within the box or section, followed by a colon, both in bold. The first word of the succeeding text should be capitalized. For example:

• Axis: Determines if a linear or logarithmic scale is used.