From 7054bea9bec226eaa47a643584fbaf0c63eebf37 Mon Sep 17 00:00:00 2001 From: Electric Keet Date: Wed, 16 Aug 2023 09:29:47 -0700 Subject: [PATCH] Interface docs work. Rearranged a couple things for clarity (folks should read about UI components before they get too much further into playing with stuff) and added info about Ctrl-scrollwheel on sliders. --- doc/2-interface/README.md | 15 +++++---- doc/2-interface/components.md | 57 ++++++++++++++++++----------------- 2 files changed, 39 insertions(+), 33 deletions(-) diff --git a/doc/2-interface/README.md b/doc/2-interface/README.md index 3d6067af..88ae7b1d 100644 --- a/doc/2-interface/README.md +++ b/doc/2-interface/README.md @@ -6,9 +6,14 @@ the default layout of Furnace is depicted below. ![interface](interface1.png) -primary topics: +## general info +- [UI components](components.md): recommended reading for all! +- [global keyboard shortcuts](keyboard.md) - [menu bar](menu-bar.md) + +## primary windows + - [order list](order-list.md) - [play/edit controls](play-edit-controls.md) - [instrument/wavetable/sample list](asset-list.md) @@ -19,7 +24,7 @@ primary topics: - [wavetable editor](../5-wave/README.md) - [sample editor](../6-sample/README.md) -advanced topics: +## advanced windows - [mixer](../8-advanced/mixer.md) - [grooves](../8-advanced/grooves.md) @@ -36,9 +41,7 @@ advanced topics: - [log viewer](../8-advanced/log-viewer.md) - [statistics](../8-advanced/stats.md) -other topics: +## other topics -- [settings](../2-interface/settings.md) -- [UI components](components.md) -- [global keyboard shortcuts](keyboard.md) - [basic mode](basic-mode.md) +- [settings](../2-interface/settings.md) diff --git a/doc/2-interface/components.md b/doc/2-interface/components.md index c2fce999..4381e61a 100644 --- a/doc/2-interface/components.md +++ b/doc/2-interface/components.md @@ -1,6 +1,35 @@ # UI components -the user interface consists of several components. this paper describes some of them. +the user interface consists of several kinds of components, some of which benefit from explanation. + +## text fields + +text fields are able to hold... text. + +click on a text field to start editing, and click away to stop editing. + +the following keyboard shortcuts work while on a text field: + +- `Ctrl-X`: cut +- `Ctrl-C`: copy +- `Ctrl-V`: paste +- `Ctrl-A`: select all + +(replace Ctrl with Command on macOS) + +## number input fields + +these work similar to text fields, but you may only input numbers. + +they also usually have two buttons which allow you to increase/decrease the amount when clicked (and rapidly do so when click-holding). + +## sliders + +sliders are used for controlling values in a quick manner by being dragged. + +using the scroll wheel while holding Ctrl will change the slider's value by one in either direction. + +right-clicking or Ctrl-clicking or a slider (Command-click on macOS) will turn it into a number input field for a short period of time, allowing you to input fine values. ## windows @@ -56,29 +85,3 @@ to bring it back, click on the top left corner. to undock a window, drag its tab away from where it is docked. then it will be floating again. -## text fields - -text fields are able to hold... text. - -click on a text field to start editing, and click away to stop editing. - -the following keyboard shortcuts work while on a text field: - -- `Ctrl-X`: cut -- `Ctrl-C`: copy -- `Ctrl-V`: paste -- `Ctrl-A`: select all - -(replace Ctrl with Command on macOS) - -## number input fields - -these work similar to text fields, but you may only input numbers. - -they also usually have two buttons which allow you to increase/decrease the amount when clicked (and rapidly do so when click-holding). - -## sliders - -sliders are used for controlling values in a quick manner by being dragged. - -alternatively, right-clicking or Ctrl-clicking or a slider (Command-click on macOS) will turn it into a number input field for a short period of time, allowing you to input fine values.