Skip to content

Latest commit

 

History

History
155 lines (130 loc) · 31.8 KB

GLOSSARY.md

File metadata and controls

155 lines (130 loc) · 31.8 KB

Waveform Manual Terminology Glossary

Companion to STYLE.md: STYLE.md covers voice, punctuation and gating, and this file fixes the words.

Owner decisions (2026-10-17)

Where these decisions conflict with the tables below, they take precedence.

  • J1: The bottom panel is the Detail Editor, not "Content Editor". When telling the reader how to open it, quote the View menu item exactly as the app shows it.
  • J2: Browser means the whole side container. The search tool is the Search tab, and its left column is the category list. Don't use "sidebar" or "side panel".
  • J3: Write Edit, the document, with a capital E.
  • J4: Quote Quick Actions menu items exactly as shown ("Show Quick actions bar"). In prose, write Quick Actions bar and Quick Actions window.
  • J5: Use cursor in prose. Write "playhead" only when quoting a setting name that contains it.
  • J6: Write In marker and Out marker, with no hyphen, as the app does.
  • J7: Call the panel-selector button the eye button.
  • J8: Capitalise clip types: Audio clip, MIDI clip, Step clip.
  • J9: After the first full name in a section, short plugin names are fine ("MIDI Arpeggiator", then "Arpeggiator").
  • J10: Write Volume & Pan.
  • J11: Call the File / Edit / Options ... menus at the top the main menu, not "menu bar".
  • J12: Order modifier keys as the app shows them: Mac Ctrl + Shift + Opt + Cmd + K, Windows Ctrl + Shift + Alt + K.
  • J13: Put control and button names in bold and menu paths in italics, for example View > Show Mixer. Settings paths are menu paths too: Settings > General.
  • J14: Write "quantise", "quantising" and "quantisation" in prose. The chapter title is "Quantising MIDI Notes". The file name stays quantizing-midi-notes.md so the URL doesn't change.
  • Edition lines: Use the form in STYLE.md, > 📝 **Edition:** ..., placed directly under the badged heading. This replaces the "Available in ..." shapes in the formats section below.
  • J15: Quote UI labels exactly, including US spellings such as "Synthesizer", "License" and "Analyzer". Use British spelling in prose.

Evidence paths are relative to waveform/common/Source/ unless they start with modules/. Quoted strings are the exact TRANS() / NEEDS_TRANS() text.

Rule of thumb for UI names. Copy the noun phrase the UI uses. When the UI name is a proper name plus a generic noun, capitalise the proper name and lower-case the generic noun: "Actions panel", "Plugin panel", "Quick Actions bar", "Folder track", "Step clip", "Render dialog". When there is no proper name, lower case: "transport bar", "menu bar", "inline mixer", "track header", "cursor". Title case is only for headings and chapter titles. Quote menu items, buttons and settings exactly as the UI spells them, even when that breaks these rules (Show Quick actions bar, Show Inline mixer).

(a) Glossary

Canonical term (prose uses) Avoid (variant, count, top files) Evidence Notes
Panels and windows
Actions panel (199) Actions Panel (11) [using-markers:5, midi-editing:4]; actions panel (3) [actions-panel:3]; Properties panel (as the current panel) (1) [whats-new:1]; Actions tab (for the dedicated panel) (3) [actions-panel:1, edit-tab:1] ui/edit/TransportComponent.cpp:2221 "Show or hide Actions panel"; ui/commands/StandardShortcuts.h:71 "Lock/Unlock Actions panel"; View menu ui/mainwindow/EditTab.cpp:1287 "Show Actions"; tab name ui/edit/sidebar/ActionsPanel.h:36 "Actions"; floating window ui/edit/StripWindow.cpp:185 "Actions" Product decision. Exists both as the Browser's Actions tab and as the dedicated panel/window; both are "the Actions panel". The old bottom Properties panel is gone - only mention it historically (whats-new). The floating plugin "properties panel" still exists in the UI (ui/commands/ShortcutActions.cpp:98), so never use "Properties panel" for the Actions panel. UI has lowercase strays (StandardShortcuts.h:606, StripWindow.cpp:783).
Quick Actions bar, Quick Actions window (5) Quick actions bar/window (2) [actions-panel:2]; quick actions bar/window (2) [actions-panel:2]; Quick Action bar (1) [layouts:1]; quick actions panel (1) [actions-panel:1] ui/edit/QuickActionPanel.cpp:192 "Quick Actions"; ui/edit/TransportComponent.cpp:2200 "Show or hide Quick Actions window". UI is mixed: View menu EditTab.cpp:1306 "Show Quick actions bar", EditTab.cpp:1336 "Open Quick actions window", StandardShortcuts.h:629-630 all lowercase, tooltip StripWindow.cpp:777 "quick actions panel" Feature name is "Quick Actions" (title case). In prose: "the Quick Actions bar", "the Quick Actions window". Quote menu items verbatim (Show Quick actions bar). See J4.
Browser (the whole side container) (102) sidebar (meaning the container) (26) [browser:16, reference-settings:4]; side panel (7) [plugin-side-panel:3, whats-new:2]; left-hand Browser/sidebar (2) [actions-panel:1, plugin-side-panel:1]; edit view / Edit window (7) [groove-doctor:2, browser:2] View menu ui/mainwindow/EditTab.cpp:1289 "Show Browser"; ui/commands/StandardShortcuts.h:607 "Show or hide Browser"; Settings > Appearance ui/propertypanels/PropertyIDs.cpp:673 "Browser position"; PropertyIDs.cpp:767 "Show Plugin panel in browser". Default position is right (misc/UserSettings.cpp:404) The Browser holds tabs named exactly Actions, Files, Search, Groups, Tracks, Markers, Plugin, Assistant (ui/edit/sidebar/SidePanel.cpp:55-77). Write "the Search tab of the Browser". "sidebar" count includes browser.md using it for the category column inside the Search tab - call that the category list (Favourites, Categories, Smart Lists, Bookmarks). Do not say "left-hand" (default is right). UI strays: "side panel" (ui/settings/AppearanceSettingsPanel.h:73), "sidebar" (ui/settings/AISettingsPanel.h:57). See J2.
Search tab (13) Search browser (5) [browser:5] Tab name ui/edit/sidebar/browser/BrowserPanel.h:36 "Search"; ui/commands/StandardShortcuts.h:52 "Show Browser search" browser.md is titled "The Browser" but mostly documents the Search tab; it calls the Search tab "the Browser" throughout. See J2.
Content Editor (bottom panel with Track / Clip / Plugins modes) (1) Detail editor (26) [plugins-detail-editor:11, whats-new:3]; Detail Editor (0); bottom panel (1) [4osc:1]; editor panel (2) [reference-settings:2] Only user-facing names: View menu ui/mainwindow/EditTab.cpp:1295 "Show Content Editor" and ui/commands/StandardShortcuts.h:614 "Show or hide Content Editor" (renamed from "MIDI editor" in 2e4be7f2f). No TRANS string says "Detail". Mode buttons ui/midi/MidiEditorPanel.cpp:230-238 "Track", "Clip", "Plugins"; tooltip ui/edit/StripWindow.cpp:780 still says "midi editor" Biggest open naming question - see J1. Whichever wins, the modes are "the Track tab", "the Clip tab", "the Plugins tab". Keep "MIDI editor" / Piano Roll (MidiEditorPanel.cpp:242) for the note editor inside the Clip tab only. racks.md "detail panel" is the Rack editor's own panel and is fine.
Mixer (the separate full mixer) (40) mixer panel (5) [edit-tab:4, clip-launcher:1]; mixer view / Mixer view (3) [introduction:3]; mixer window (1) [using-plugins:1] View menu ui/mainwindow/EditTab.cpp:1300 "Show Mixer"; ui/commands/StandardShortcuts.h:611 "Show or hide Mixer"; ui/commands/ShortcutActions.cpp:356 "the view state of the Mixer"; tooltip ui/edit/StripWindow.cpp:781 "mixer panel" Capitalise when it names the panel ("open the Mixer"); generic "mixer" is fine for the concept. The Quick Actions window also contains a mixer - describe, do not name.
inline mixer (per-track plugin/fader area beside the tracks) (7) mixer section (9) [midi-recording:2, using-an-amp-simulator-plugin:2]; Mixer section / Mixer Section (4) [using-plugins:4]; In-line mixer (3) [using-plugins:3]; plugin area (1) [racks:1] View menu ui/mainwindow/EditTab.cpp:1290 "Show Inline mixer"; tooltip ui/edit/StripWindow.cpp:776 "outputs panel" Lower case in prose; quote the menu item as Show Inline mixer. "In-line editing" for MIDI clips (GeneralSettingsPanel.h:950) is a different thing and stays.
Plugin panel (Browser tab hosting one plugin) (8) Plugin side panel / Plugin Side Panel (1) [whats-new:1]; plugin panel (lower case) (3) [plugins-detail-editor:2, modifiers:1] Tab name ui/edit/sidebar/PluginPanel.cpp:351 "Plugin"; ui/settings/PluginsSettingsPanel.h:270 "Shows the Plugin panel in the side panel list"; ui/propertypanels/PropertyIDs.cpp:767 "Show Plugin panel in browser" Chapter title "The Plugin Side Panel" (SUMMARY.md, plugin-side-panel.md) could become "The Plugin Panel". plugins-detail-editor.md uses lower-case "plugin panel" for each plugin's card in the Plugins tab - say "the plugin's panel" there to avoid the clash.
transport bar (38) Transport Bar (3) [edit-tab:3] ui/settings/AppearanceSettingsPanel.h:115 "Whether the transport bar should show..."; ui/propertypanels/PropertyIDs.cpp:717 "Show master plugins in transport bar" No proper name, so lower case.
menu bar (File, Edit, Options ... at the top) (11) Menu section (1) [quantizing-midi-notes:1]; the Menu (capital M, old UI) (2) [quantizing-midi-notes:1, using-plugins:1]; main menu (10) [macros:3, recording-overdubs:2]; Run Script (button/menu) (0) Top-level menus ui/mainwindow/EditTab.cpp:1755-1770. No "Menu section" or "Run Script" string exists in the app source any more; scripts live in the Actions menu (EditTab.cpp:1770) The old bottom-left "Menu section" is gone. "main menu" is rising while this glossary was built (another edit pass is replacing "Menu section" with it) - pick one, see J11. On macOS the menus sit in the system menu bar; on Windows/Linux in the window's own menu bar, so "menu bar" is right on all three.
eye button (show/hide panel selector, top right) (7) Eye panel selector / panel selector (3) [actions-panel:2, basic-navigation:1]; eye icon (3) [racks:2, basic-navigation:1]; Eye panel (1) [basic-navigation:1] No name in the UI; tooltip only: ui/edit/StripWindow.cpp:377 "Click to hide and show various parts of the user interface" Pick one descriptive name and use it everywhere. See J7.
Render dialog (12) render dialog (8) [mixing-down:6, rendering-and-stems:2] Window root/title "Render" (ui/edit/RenderDialog.cpp; see memory note on wfctl) mixing-down.md uses lower case throughout.
Edit tab, Projects tab, Settings tab, Welcome tab (63) Edit Tab (3) [reference-settings:1, edit-tab:1]; Projects Tab (3) [basic-navigation:2, mixing-down:1]; Project tab (2) [basic-navigation:2]; Settings Tab (4) [audio-clips-and-editing-audio:1, keyboard-shortcuts:1]; Welcome Tab (1) [installing-the-demo-projects:1] ui/commands/StandardShortcuts.h:36-38 "Go to Projects tab", "Go to Edit tab", "Go to Settings tab"; tab labels ui/mainwindow/MainWindow.cpp:1252 "Projects", :1259 "Welcome", :1266 "Settings" Title case only in headings/chapter titles ("The Edit Tab"). StandardShortcuts.h:17 "Edit Tab" is a shortcut category name, quote verbatim if needed.
Settings > page names: Appearance, Audio Devices, Chords, Control Surfaces, Downloads, File Locations, General, Keyboard Shortcuts, Licensing, Maintenance, MIDI Devices, Plugins, Advanced, AI (60) - Page constructors in ui/settings/*.h, e.g. AppearanceSettingsPanel.h:22 "Appearance", MidiSettingsPanel.h "MIDI Devices", ExternalControllerSettings.h "Control Surfaces"; Audio Devices page NEEDS_TRANS("Audio Devices") about-this-book.md release log uses "Settings>Appearance" without spaces.
Concepts
Edit (the document; capital E) (162) the/your/an/this edit ('s) (63) [browser:16, racks:6] UI mostly capitalises the noun in labels: misc/Licensing.cpp:1139 "Re-open Edits", ui/settings/GeneralSettingsPanel.h:250 "auto-saving of Edits", ui/mainwindow/ProjectTab.cpp:427 "default Edit for this Project". But tooltips are mixed: 53 "the/this/an/your Edit" vs 120 lower case in TRANS strings Capital E separates the noun from the verb "edit". Avoid "song", "session" and "project" when the Edit file is meant. See J3.
Project (container in the Projects tab, holds Edits and media) (18) your project / the project (often means the Edit) (77) [reference-settings:11, ai-assistant:9]; song / songs (as the file) (63) [using-markers:7, working-with-loops:6]; session(s) (15) [clip-launcher:3, ai-assistant:3] ui/mainwindow/ProjectTab.cpp:186 "New Project", :427 "Opens the default Edit for this Project" Counts are upper bounds: "song" is fine for the music ("the chorus of your song"), "session" for a recording session or AI chat session. Each hit needs a human read; only replace where the Edit/Project object is meant.
clip (never "region" for a clip) (959) audio/MIDI region (1) [importing-and-exchanging-projects:1]; clip region (4) [rendering-and-stems:3, stem-separation:1] "clip" is used throughout the UI; "region" in the UI always means a time range ("marked region", "Each Marker Region") Clean already; the one "audio regions" hit describes another DAW's import.
track header (10) track name area (1) [recording-overdubs:1]; track panel (1) [whats-new:1] ui/propertypanels/PropertyIDs.cpp:672 "Double-click track header to toggle height" "clip header" (MIDI/audio clip title strip) is a different, valid term.
cursor (the playback position line) (112) playhead (outside quoted labels) (22) [reference-settings:10, working-with-video:3]; playback cursor (2) [reference-settings:1, basic-navigation:1]; playback/transport position (4) [browser:1, clip-launcher:1]; now time (1) [basic-navigation:1] Commands use "cursor": ui/commands/StandardShortcuts.h:227 "Split selected clips at cursor", ShortcutActions.cpp:155 "Sets the in marker to the current cursor position". But three settings labels say "playhead": ui/settings/GeneralSettingsPanel.h:199,202,207, ui/propertypanels/PropertyIDs.cpp:694 basic-navigation.md already defines "cursor" as the term. Quote the "playhead" setting labels verbatim. edit cursor only for the optional second cursor (PropertyIDs.cpp:876 "Enable separate edit cursor"). See J5.
marked region (range between the In and Out markers) (27) marked range (1) [basic-navigation:1]; loop range (2) [using-markers:1, groove-doctor:1]; loop region (timeline) (1) [samplers-and-instruments:1] 62 UI strings, e.g. ui/commands/StandardShortcuts.h:63 "Delete marked region of selected clips", ui/settings/GeneralSettingsPanel.h:106 "...size of the marked region". UI also uses "loop range" (StandardShortcuts.h:211 "Set loop range over selected clips", ui/edit/audio_editing/AudioEditingWindow.cpp:40 "From loop range") and "Copy Marked Section" (ui/mainwindow/EditTab.cpp:1718) Quote "loop range"/"Marked Section" labels verbatim; prose says marked region. samplers-and-instruments "loop region within the sample" is a sampler setting, not this.
In marker, Out marker (together: In and Out markers) (2) In-marker / Out-marker (92) [using-markers:39, automation:14]; in/out markers (prose) (2) [automation:1, basic-navigation:1]; In/Out marker(s) (1) [rendering-and-stems:1]; loop markers (2) [reference-settings:2]; Loop in / Loop out (as marker names) (2) [step-clips:2] Popup help title ui/PopupHelp.cpp:1028 "In/Out Markers"; ui/commands/ShortcutActions.cpp:155-161 "in marker", "out marker", "Mark in", "Jump to mark in"; ui/commands/StandardShortcuts.h:209-210 "Set loop in", "Set loop out" The manual majority is the hyphenated "In-marker"/"Out-marker" (mostly using-markers, automation, loop-recording, edit-tab); the UI never hyphenates. Capital In/Out so "in" does not read as a preposition. Quote command names verbatim (Set loop in, Mark in). See J6.
Clip and track types: Audio clip, MIDI clip, Step clip, Edit clip; Folder track, Submix track, Marker track, Tempo track, Chord track, Arranger track, Master track (344) Step Clip (32) [step-clips:25, audio-clips-and-editing-audio:3]; MIDI Clip (15) [midi-editing:4, step-clips:4]; Folder Track (56) [folder-tracks:53, submix-tracks:3]; Submix Track (13) [submix-tracks:10, folder-tracks:2]; Chord Track (20) [chord-track:12, pattern-generator:7]; Arranger Track (14) [arranger-track:12, rendering-and-stems:2]; audio clip (lower) (18) [reference-settings:5, audio-clips-and-editing-audio:2]; folder/submix/chord/arranger/tempo/master track (lower) (31) [clip-launcher:6, reference-settings:3] Menu items: ui/mainwindow/EditTab.cpp:1268-1274 "Show Arranger track", "Show Tempo track", "Show Marker track", "Show Chord track"; EditTab.cpp:1455-1458 "Pack selected tracks to a Folder track / Submix track"; ui/edit/SelectableTrackComponent.cpp:120,226-227 "Show Master track", "Add Folder track", "Add Submix track"; ui/midi/MidiToolStatus.cpp:508 "Step clips". Title-case strays: PropertyIDs.cpp:313 "Convert to Step Clip", PopupHelp.cpp:2272 "Folder Track" Rule: capitalise the type word, lower-case "clip"/"track". The UI writes "audio clip" in lower case in tooltips (24 hits) - see J8. Lower-case counts include sentence-start capitals elsewhere, so treat them as review lists.
clip launcher (10) Clip Launcher (6) [clip-launcher:4, reference-settings:2] ui/mixer/MixerComponent.cpp:405 "Show clip launcher"; ui/edit/cliplauncher/ClipLauncherCommon.h:618. Product name is the "Launcher Expansion"
AI Assistant (feature); Assistant tab (9) AI assistant (4) [quick-start:1, introduction:1] ui/settings/AISettingsPanel.h:57 "Enables the AI Assistant panel..."; tab ui/edit/sidebar/assistant/AssistantPanel.cpp:615 "Assistant" "the assistant" in running prose after first mention is acceptable.
Editions and expansions
Waveform Pro (first mention), then Pro (45) (Pro edition) heading suffix (1) [midi-effects:1]; Pro-only / Pro only (4) [samplers-and-instruments:3, working-with-video:1] misc/Expansions.cpp:47 "Waveform Pro"; ui/settings/MaintenanceSettingsPanel.h:97 "Unlock Waveform Pro". "Waveform PRO" only in one licensing message (misc/Licensing.cpp:1306) Gating uses the badge <span class="pro">PRO</span> on the heading plus one edition line (STYLE.md). Only rendering-and-stems, utility-plugins and whats-new use the badge so far; midi-effects uses "(Pro edition)", working-with-video "(Pro)".
Waveform Free, then Free (11) Free edition (1) [introduction:1] misc/Expansions.cpp:49 "Waveform Free" "the Free edition" is acceptable in a sentence about editions.
Waveform OEM, then OEM (19) EOM (typo) (0) misc/Expansions.cpp:48 "Waveform OEM"; Settings > Advanced feature-set choice ui/settings/AdvancedSettingsPanel.h:66 "OEM" Typo is in about-this-book.md ("Free, EOM, and Pro").
Expansion names, always with capital Expansion: Recording Engineer Expansion, MIDI Producer Expansion, Synth Pack Expansion, DJ Mix Tools Expansion, Pro Video Expansion, Launcher Expansion, Surround Expansion (26) MIDI Producer (no "Expansion") (4) [samplers-and-instruments:3, racks:1]; Synth Pack (no "Expansion") (3) [samplers-and-instruments:3]; "X / Y expansions" (shared suffix) (2) [samplers-and-instruments:2]; add-on (2) [built-in-effects-plugins:1, working-with-video:1] misc/Expansions.cpp:111 Recording Engineer, :136 MIDI Producer, :166 Synth Pack, :188 DJ Mix Tools, :212 Pro Video, :230 Launcher, :251 Surround (each "... Expansion") Generic plural stays lower case: "expansions" (ui/settings/LicensingSettingsPanel.h:251 "Buy expansions/content packs"). Write lists in full: "the MIDI Producer Expansion or the Synth Pack Expansion". Downloadable add-ons for stem separation are feature packs, stored under Feature Extensions (ui/settings/LocationsSettingsPanel.h:137, model/AudioSeparation.cpp:498).
Version numbers only in whats-new.md Waveform 1x outside whats-new (1) [about-this-book:1] STYLE.md "Facts and sources" Counts include whats-new.md and about-this-book.md, which are allowed.
Plugin and product names
4OSC (15) 4 OSC / 4Osc (0) modules/tracktion_engine/.../tracktion_FourOscPlugin.h:173 Clean. Chapter title "4OSC Synthesizer" uses US spelling (see spelling list).
Master Mix (7) MasterMix (1) [introduction:1] ui/edit/plugins/PluginTreeView.cpp:582
Micro Sampler, Micro Drum Sampler, Multi Sampler, Wavetable, Subtractive (22) MultiSampler / Multi-Sampler / Multisampler (0); MicroSampler (0) ui/edit/plugins/PluginTreeView.cpp:676-684 Clean.
1-Band / 3-Band / 4-Band / 8-Band Equaliser (8) Equalizer (1) [built-in-effects-plugins:1]; n-band EQ (1) [plugins-detail-editor:1] plugins/internal/Equaliser3BandPlugin.h:23 and siblings "EQ" is fine as the generic word.
MIDI Arpeggiator, MIDI Chord Companion, MIDI Note Repeater (6) Arpeggiator (bare) (4) [midi-effects:2, whats-new:1]; Chord Companion (bare) (3) [midi-effects:2, whats-new:1]; Note Repeater (bare) (1) [midi-effects:1] plugins/internal/ArpPlugin.h:33, ChordCompanionPlugin.h:56, NoteRepeatPlugin.h:23 Bare "Arpeggiator" count includes Wavetable's built-in arpeggiator section, which is correct. See J9 on short forms.
Volume & Pan (32) Volume and Pan (0); Vol & Pan / VolPan (0) UI is split: modules/tracktion_engine/.../tracktion_VolumeAndPan.h:25 getPluginName "Volume and Pan" vs :54 getName "Volume & Pan Plugin", ui/PopupHelp.cpp:761 "Volume & Pan Plugin" Manual is consistent on "Volume & Pan". See J10.
Mid Side (plugin) (4) Mid/Side (2) [built-in-effects-plugins:2] plugins/internal/MidSidePlugin.h:17 "mid/side" lower case is fine for the technique.
plugin (one word) (963) plug-in(s) (8) [reference-settings:5, using-an-amp-simulator-plugin:3] 504 UI strings use "plugin"; "plug-in" survives in 4 old strings (ui/settings/PluginsSettingsPanel.h:365,367, ui/PopupHelp.cpp:469)
Rack editor (9) Rack Editor (4) [racks:4]; rack editor (7) [racks:7] UI itself mixed (1/2/1 hits); follows the house pattern "proper name + generic noun" All hits are in racks.md.
Cmajor, VST3, AU, LV2, CLAP (20) AudioUnit(s) (2) [macros:1, reference-settings:1] UI "Cmajor" 6 hits; "VST3" 3 hits "Audio Units" (two words) is Apple's spelling if spelled out.
macOS (the OS), Mac (the computer), Windows, Linux (26) PC (meaning Windows) (3) [introduction:2, reference-settings:1] Introduction already uses macOS; "Mac / PC" convention line in introduction.md:106 should say "Mac / Windows"

(b) Formats

Menus and menu paths

  • Top-level menus in the Edit tab (exact names, ui/mainwindow/EditTab.cpp:1755-1770): File, Edit, Options, Automation, Click, Snap, Sync, Track, Video, View, Help, Actions. The Projects tab adds Project (ui/mainwindow/ProjectTab.cpp:648). There is no Tools, Window, Settings or Preferences menu, and no "Run Script" button. In prose: "the View menu".
  • Separator: > with a space either side: File > Export > Render to a file. Never → (0 menu uses left), ->, / or > without spaces (about-this-book.md "Settings>Appearance").
  • Emphasis: one bold span around the whole path: View > Show Mixer. Today the manual has 86 italic paths (*A > B*, mostly older chapters: reference-settings, edit-tab, recording-audio, audio-clips-and-editing-audio) and 29 bold ones (newer chapters). See J13.
  • Settings pages use the same form: Settings > Audio Devices, Settings > Keyboard Shortcuts. A setting inside a page: "Settings > General, Paste at edit cursor" or "the Paste at edit cursor setting on the General page".
  • Ellipsis: copy the UI, which always uses three full stops (Edit custom macro commands...). The docs have 27 Unicode … (working-with-video 8, importing-and-exchanging-projects 7, midi-setup 5) against 64 ....
  • Right-click menus: "right-click the clip and choose Rename". Call it the right-click menu (17 hits) rather than "context menu" (16, step-clips 12) or "pop-up/popup menu" (8). A list control is a dropdown (11), not "drop down" (4).

Keyboard shortcuts

  • Pairs: Mac first, then Windows, separated by /, each side complete: Cmd + Z / Ctrl + Z (39 hits, the convention set out in introduction.md and STYLE.md). Variants to fix: Windows first (1, using-plugins), combined Cmd/Ctrl + Z (1, reference-settings), tight Cmd+Z / Shift+C (2, chord-track), (Windows) / (Mac) suffixes (4: installing-the-demo-projects, introduction, reference-settings, chord-track), lower-case ctrl (1, comping). ⌘ is gone.
  • Spaces around + inside a chord (Cmd + Shift + Z). This matches how the app prints shortcuts (command + Z, JUCE juce_KeyPress.cpp:249-256).
  • Modifier-only pairs: "hold Cmd / Ctrl" (21), "hold Opt / Alt" (10). Same Mac / Windows order.
  • Click and drag with a modifier: hyphenate and pair: "Cmd-click / Ctrl-click", "Opt-drag / Alt-drag". Avoid Cmd/Ctrl-click (2, browser).
  • Key names: Cmd, Ctrl, Opt, Alt, Shift (introduction.md "Modifier Keys Conventions"). Not "Option" (4: chord-track, recording-audio, visual-plugin-selector), "Command", "Control" or "Meta" except in the Linux note. On Windows the Mac Opt becomes Alt and Cmd becomes Ctrl; check the app's mapping when Mac uses Ctrl.
  • Multi-modifier order: as the app shows it (JUCE order): Mac Ctrl + Shift + Opt + Cmd + K, Windows Ctrl + Shift + Alt + K. The docs currently mix "Opt + Cmd + T" and "Cmd + Opt". See J12.
  • Single keys: plain capital, no code font: "press D", "F9", "Delete or Backspace", "Space bar", "Return". Function keys always with F.
  • introduction.md:106 says "the convention Mac / PC"; write "Mac / Windows" (Linux follows Windows).

Spelling (British, as STYLE.md requires and as the UI uses)

Counts are docs British / docs US, then UI British / UI US (UI US hits are mostly third-party Airwindows plugin descriptions, which stay as written).

Use Not Docs UI Notes
colour, coloured color 80 / 21 84 / 7 US hits: midi-editing 8 (incl. heading "Note Colors"), step-clips, racks
behaviour behavior 13 / 4 13 / 0 wavetable 2
quantise, quantisation, quantising quantize... 44 / 47 64 / 1 quantizing-midi-notes.md alone has 29 US hits, midi-recording 11; see J14 for the chapter title and file name
analyse, analyser analyze, analyzer 11 / 0 12 / 2 UI has "Analyzer" (ui/propertypanels/PropertyIDs.cpp:929, ui/edit/plugins/InternalPluginUIs.cpp:889): quote it verbatim when naming that control
normalise normalize 20 / 1 6 / 0 clip-layer-effects 1
centre, centred center 21 / 24 12 / 2 built-in-effects-plugins 5, wavetable 5, reference-settings 4; quote an engine label verbatim if it says "Center"
organise organize 5 / 13 1 / 2 edit-tab, basic-navigation
customise customize 6 / 12 0 / 1 UI stray ui/settings/GeneralSettingsPanel.h:37 "Customize how you interact..."
optimise, minimise, maximise, initialise, recognise, visualise, summarise, authorise -ize small numbers British in UI
randomise randomize 5 / 9 20 / 2 UI strays ui/edit/StepClipEditor.cpp:1577 "Randomize row", ui/edit/ContextMenus.cpp:787 "Randomize velocity"
synchronise synchronize 5 / 3 2 / 1 UI stray ui/edit/plugins/PluginComponents.cpp:232 "Synchronize Timestretch / Pitchshift"
harmonise, categorise, emphasise -ize 0 / 2, 0 / 1, 5 / 4 -
favourite favorite 41 / 4 16 / 1
grey, greyed out gray, grayed 9 / 2 - wavetable "grayed out"
labelled, cancelled, modelling labeled, canceled 6 / 6 - 4osc 2
Equaliser, equalise Equalizer 13 / 3 19 / 0 plugin names are "n-Band Equaliser"
catalogue, neighbour, flavour, analogue catalog, neighbor, flavor, analog 1/1, 3/1, 1/2, 0/7 - analog/analogue is low priority
synthesiser synthesizer 3 / 24 0 / 4 UI is US here - see J15
licence (noun), license (verb) - 5 / 19 2 / 12 UI mostly uses "License" as the noun - see J15

Keep as they are (correct in British technical writing and matching the UI): dialog (92 vs "dialogue" 5; UI "dialog"), program (software, MIDI Program Change), meter (the measuring device and plugin names), while (142; drop "whilst", 4), toward(s) either.

Compounds and hyphenation

right-click (120; "right click" 5), double-click (31; "double click" 1), built-in (75; "built in" 1 as an adjective), count-in, sidechain (11, UI 24; "side-chain" 6 in racks and modifiers, "side chain" 1), time-stretch (UI), mixdown (noun) / mix down (verb), multitrack (4 vs "multi-track" 4, pick one), greyed out (6; "grayed out" 1), pop-up help (Help menu ui/mainwindow/TabBase.cpp:59-64 "Enable pop-up help", "Pop-up help"; the shortcut names spell it "popup help"), plugin (963; "plug-in" 8 in reference-settings and using-an-amp-simulator-plugin), dropdown, tooltip, keyboard shortcut (not hotkey, key command, accelerator).

Units and acronyms: dB, Hz, kHz, ms, BPM (16; "bpm" 1), MIDI (never "Midi"/"midi": 1 hit in rendering-and-stems), WAV, MP3, FLAC, Ogg (format) / .ogg (extension), VST3, AU, LV2, CLAP, ASIO, Core Audio, ALSA, JACK, Cmajor.

Capitalisation of UI names

  1. Exact UI label in bold when the reader clicks or reads it: Show Content Editor, Snap, Paste at edit cursor.
  2. Named panels, windows and objects in running prose: proper name capitalised, generic noun lower case (see the table): Actions panel, Plugin panel, Quick Actions bar, Quick Actions window, Rack editor, Render dialog, Edit tab, Folder track, Step clip, MIDI clip.
  3. Plain nouns without a proper name: transport bar, menu bar, track header, inline mixer, cursor, marked region, clip launcher, eye button.
  4. Single-word proper names: Browser, Mixer, Edit (the document), Project (the container).
  5. Tabs of the Browser: "the Search tab", "the Markers tab". Modes of the Content Editor: "the Clip tab".
  6. Headings and chapter titles use title case ("The Actions Panel", "Folder Tracks"); prose under them does not.

Writing edition and expansion names

  • Editions: Waveform Pro, Waveform Free, Waveform OEM in full on first mention in a chapter, then Pro, Free, OEM. Lists ascend: "Free, OEM and Pro". Never "PRO" or "FREE" in prose (the badge text is the only all-caps PRO), never "Pro version", "Free version", "Pro-only" (4) or "(Pro edition)" / "(Pro)" heading suffixes.
  • Expansions: full product name with capital Expansion every time: "the MIDI Producer Expansion", "the Pro Video Expansion". Do not share the suffix across a list ("MIDI Producer / Synth Pack expansions", 2 in samplers-and-instruments): write "the MIDI Producer Expansion or the Synth Pack Expansion". Generic plural stays lower case: "expansions", "content packs" (matches ui/settings/LicensingSettingsPanel.h:251). Not "add-on" (2) or "Expansion Pack".
  • Gating markup (STYLE.md): heading badge <span class="pro">PRO</span> plus one line directly under the title, using one of these shapes:
    • "Available in Waveform Pro."
    • "Available in Waveform Pro, or with the Recording Engineer Expansion."
    • "Available in Waveform Pro, or with the MIDI Producer Expansion or the DJ Mix Tools Expansion."
    • "Available in every edition." (only where a reader would otherwise assume Pro)
  • Stem separation downloads are feature packs; their folder setting is Feature Extensions (Settings > File Locations).
  • Edition names inside Settings > Advanced feature-set choices are quoted as shown there (Pro, OEM, ...).