Merge pull request #1247 from ElectricKeet/doc-general

General documentation fixes and additions.

doc/1-intro/hex.md

@@ -95,3 +95,24 @@ now for decimal number `69420`:
 
 = 10F2C
 ```
+
+# hex-decimal table
+
+  hex | `0` | `1` | `2` | `3` | `4` | `5` | `6` | `7` | `8` | `9` | `A` | `B` | `C` | `D` | `E` | `F`
+-----:|----:|----:|----:|----:|----:|----:|----:|----:|----:|----:|----:|----:|----:|----:|----:|----:
+ `00` |   0 |   1 |   2 |   3 |   4 |   5 |   6 |   7 |   8 |   9 |  10 |  11 |  12 |  13 |  14 |  15
+ `10` |  16 |  17 |  18 |  19 |  20 |  21 |  22 |  23 |  24 |  25 |  26 |  27 |  28 |  29 |  30 |  31
+ `20` |  32 |  33 |  34 |  35 |  36 |  37 |  38 |  39 |  40 |  41 |  42 |  43 |  44 |  45 |  46 |  47
+ `30` |  48 |  49 |  50 |  51 |  52 |  53 |  54 |  55 |  56 |  57 |  58 |  59 |  60 |  61 |  62 |  63
+ `40` |  64 |  65 |  66 |  67 |  68 |  69 |  70 |  71 |  72 |  73 |  74 |  75 |  76 |  77 |  78 |  79
+ `50` |  80 |  81 |  82 |  83 |  84 |  85 |  86 |  87 |  88 |  89 |  90 |  91 |  92 |  93 |  94 |  95
+ `60` |  96 |  97 |  98 |  99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111
+ `70` | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | 125 | 126 | 127
+ `80` | 128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143
+ `90` | 144 | 145 | 146 | 147 | 148 | 149 | 150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 | 158 | 159
+ `A0` | 160 | 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 | 174 | 175
+ `B0` | 176 | 177 | 178 | 179 | 180 | 181 | 182 | 183 | 184 | 185 | 186 | 187 | 188 | 189 | 190 | 191
+ `C0` | 192 | 193 | 194 | 195 | 196 | 197 | 198 | 199 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207
+ `D0` | 208 | 209 | 210 | 211 | 212 | 213 | 214 | 215 | 216 | 217 | 218 | 219 | 220 | 221 | 222 | 223
+ `E0` | 224 | 225 | 226 | 227 | 228 | 229 | 230 | 231 | 232 | 233 | 234 | 235 | 236 | 237 | 238 | 239
+ `F0` | 240 | 241 | 242 | 243 | 244 | 245 | 246 | 247 | 248 | 249 | 250 | 251 | 252 | 253 | 254 | 255

doc/2-interface/README.md

@@ -9,6 +9,7 @@ the default layout of Furnace is depicted below.
 primary topics:
 
 - [menu bar](menu-bar.md)
+- [order list](order-list.md)
 - [play/edit controls](play-edit-controls.md)
 - [instrument/wavetable/sample list](asset-list.md)
 - [song information](song-info.md)

doc/2-interface/menu-bar.md

@@ -1,6 +1,6 @@
 # menu bar
 
-the menu bar allows you to select five menus: file, edit, settings, window and help.
+the menu bar allows you to select from five menus: file, edit, settings, window and help.
 
 # file
 
@@ -154,8 +154,8 @@ it's not really useful, unless you're a developer and want to use a command stre
   - if a column is already selected, it will select the entire channel.
   - if a channel is already selected, it will select the entire pattern.
 
-- **operation mask**: this is an advanced feature. see [this page](../3-pattern/opmask.md) for more information.
-- **input latch**: this is an advanced feature. see [this page](../3-pattern/inputlatch.md) for more information.
+- **operation mask**: toggles which columns will be affected by the listed operations. [more information here.](../8-advanced/opmask.md)
+- **input latch**: determines which data are placed along with a note. [more information here.](../8-advanced/inputlatch.md)
 
 - **note/octave up/down**: transposes notes in the current selection.
 
@@ -176,7 +176,7 @@ it's not really useful, unless you're a developer and want to use a command stre
 - **invert values**: `00` becomes `FF`, `01` becomes `FE`, `02` becomes `FD` and so on.
 
 - **flip selection**: flips the selection so it is backwards.
-- **collapse/expand amount**: allows you to specify how much to collapse/expand in the next options.
+- **collapse/expand amount**: allows you to specify how much to collapse/expand in the next two menu items.
 - **collapse**: shrinks the selected contents.
 - **expand**: expands the selected contents.
 
@@ -188,7 +188,7 @@ it's not really useful, unless you're a developer and want to use a command stre
 - **expand song**: same as expand, but affects the entire song.
   - it also changes speeds and pattern length to compensate.
 
-- **find/replace**: opens the Find/Replace window. see [this page](../3-pattern/find-replace.md) for more information.
+- **find/replace**: shows [the Find/Replace window](../8-advanced/find-replace.md).
 
 - **clear**: allows you to mass-delete things like songs, instruments and the like.
 
@@ -199,46 +199,52 @@ it's not really useful, unless you're a developer and want to use a command stre
 - **basic mode**: toggles [Basic Mode](basic-mode.md).
 - **visualizer**: toggles pattern view particle effects when the song plays.
 - **reset layout**: resets the workspace to its defaults.
-- **settings...**: opens the Settings window. these are detailed in [settings.md].
+- **settings...**: shows the Settings window. these are detailed in [settings.md].
 
 # window
 
-- **song information**: shows/hides the Song Information window.
-- **subsongs**: shows/hides the Subsongs window.
-- **speed**: shows/hides the Speed window.
-- **instruments**: shows/hides the instrument list.
-- **wavetables**: shows/hides the wavetable list.
-- **samples**: shows/hides the sample list.
-- **orders**: shows/hides the Orders window.
-- **pattern**: shows/hides the pattern view.
-- **mixer**: shows/hides the Mixer window.
-- **grooves**: shows/hides the Grooves window.
-- **channels**: shows/hides the Channels window.
-- **pattern manager**: shows/hides the Pattern Manager window.
-- **chip manager**: shows/hides the Chip Manager window.
-- **compatibility flags**: shows/hides the Compatibility Flags window.
-- **song comments**: shows/hides the Song Comments window.
+all these menu items show or hide their associated windows.
 
-- **instrument editor**: shows/hides the Instrument Editor
-- **wavetable editor**: shows/hides the Wavetable Editor.
-- **sample editor**: shows/hides the Sample Editor.
+- [song information](song-info.md)
+- [subsongs](song-info.md)
+- [speed](song-info.md)
+- [instruments](../4-instrument/README.md)
+- [wavetables](../5-wave/README.md)
+- [samples](../6-sample/README.md)
+- [orders](order-list.md)
+- [pattern](../3-pattern/README.md)
+- [mixer](mixer.md)
+- [grooves](grooves.md)
+- [channels](channels.md)
+- [pattern manager](pat-manager.md)
+- [chip manager](chip-manager.md)
+- [compatibility flags](compat-flags.md)
+- [song comments](comments.md)
 
-- **play/edit controls**: shows/hides the Play/Edit Controls.
-- **piano/input pad**: shows/hides the Piano/Input Pad window.
-- **oscilloscope (master)**: shows/hides the oscilloscope.
-- **oscilloscope (per-channel)**: shows/hides the per-channel oscilloscope.
-- **volume meter**: shows/hides the volume meter.
-- **clock**: shows/hides the clock.
-- **register view**: shows/hides the Register View window.
-- **log viewer**: shows/hides the log Viewer.
-- **statistics**: shows/hides the Statistics window.
+- [piano](piano.md)
+- [oscilloscope](osc.md)
+- [oscilloscopes (per-channel)](chanosc.md)
+- [clock](clock.md)
+- [register view](regview.md)
+- [log viewer](log-viewer.md)
+- [stats](stats.md)
 
 # help
 
 - **effect list**: displays the effect list.
 - **debug menu**: this menu contains various debug utilities.
   - unless you are working with the Furnace codebase, it's not useful.
-- **inspector**: this options opens the Dear ImGui Metrics/Debugger window.
+- **inspector**: this option shows the Dear ImGui Metrics/Debugger window.
   - unless you are working with the Furnace codebase, it's not useful.
 - **panic**: this resets all chips while the song is playing, effectively silencing everything.
 - **about...**: displays the About screen.
+
+at the end of the menu bar, more information may be shown:
+- during editing, information about the data under the cursor will be shown here:
+  - note or note modifier.
+  - instrument number and name.
+  - volume in decimal, hex, and percentage.
+  - effect type and description.
+- during playback, the current values of the following will be listed:\
+  speed/groove @ tick rate (BPM) | order | row | elapsed time.
+- if any changes or edits have been made but not yet saved, "modified" will appear.

doc/2-interface/order-list.md

@@ -0,0 +1,29 @@
+# order list
+
+the order list is a playlist for patterns.
+
+![order list](order-list.png)
+
+along the top are the available channels. their abbreviations can be set in the [channels window](../8-advanced/channels.md). the highlighted channel follows the channel the pattern view cursor is in.
+
+along the left are the order numbers. these are referenced with the `0Bxx` command. the highlighted row follows the order the pattern view cursor is in.
+
+each entry in the table is the pattern that will play during that order. these can be changed according to the order edit mode.
+
+hovering over a pattern number will pop up a tooltip showing the name of that pattern, if it has one.
+
+The buttons are as follows:
+- **Add new order**.
+- **Remove order**.
+- **Duplicate order**: adds a new order with patterns matching the selected one directly below it. right-click to "deep clone"; this copies all patterns involved to new ones.
+- **Move order up**: swaps the selected order with the one above it.
+- **Move order down**: swaps the selected order with the one below it.
+- **Duplicate order at end of song**: same as "Duplicate order" except the new order is added at the bottom of the list.
+- **Order change mode**: selects how much of the order will change with an edit. only applies if "Order edit mode" is set to "Click to change".
+  - **one**: only current channel's pattern will change.
+  - **entire row**: all patterns in the order will change.
+- **Order edit mode**: selects the method of changing orders.
+  - **Click to change**: a click will add one to the pattern number. a right-click will subtract one.
+  - **Select and type (don't scroll)**: select a pattern and type.
+  - **Select and type (scroll horizontally)**: as above, but after entering two digits, the cursor moves to the next channel.
+  - **Select and type (scroll vertically)**: as above, but after entering two digits, the cursor moves to the next order.

doc/8-advanced/inputlatch.md

@@ -0,0 +1,11 @@
+# input latch
+
+![input latch menu item](inputlatch.png)
+
+input latch determines which data are placed along with a note. as in the pattern view, the columns are note (not changeable), instrument, volume, effect type, and effect value.
+- `&&` fills in the currently selected instrument.
+- `..` ignores the column.
+- all columns (except note) can be reset with a right-click.
+- **Set**: sets latch according to the data found at the cursor.
+- **Reset**: resets all columns to default (selected instrument, ignore others).
+- only the first effect type and effect value may be latched.

doc/8-advanced/opmask.md

@@ -0,0 +1,7 @@
+# operation mask
+
+![operation mask popup](opmask.png)
+
+the operation mask toggles which columns will be affected by the listed operations. as in the pattern view, the columns are note, instrument, volume, effect types, and effect values. the effect toggles apply to all effect columns.
+
+click any area to toggle it. a `---` or `--` means the operation will ignore any data in that column.