From 5a376042178dd66df26651c1ba9ff11b45375999 Mon Sep 17 00:00:00 2001 From: tildearrow Date: Sun, 10 Sep 2023 19:12:56 -0500 Subject: [PATCH] eliminate use of backslash in doc --- doc/2-interface/menu-bar.md | 4 ++-- doc/2-interface/settings.md | 27 ++++++++------------------- doc/3-pattern/effects.md | 5 +++-- doc/7-systems/snes.md | 36 +++++++++++++++--------------------- doc/8-advanced/chanosc.md | 6 +++--- doc/8-advanced/comments.md | 5 ++--- 6 files changed, 33 insertions(+), 50 deletions(-) diff --git a/doc/2-interface/menu-bar.md b/doc/2-interface/menu-bar.md index 16012eb46..1496ca21c 100644 --- a/doc/2-interface/menu-bar.md +++ b/doc/2-interface/menu-bar.md @@ -244,6 +244,6 @@ at the end of the menu bar, more information may be shown: - 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. +- during playback, these values will be displayed: + - `speed/groove @ tick rate (BPM) | order | row | elapsed time` - if any changes or edits have been made but not yet saved, "modified" will appear. diff --git a/doc/2-interface/settings.md b/doc/2-interface/settings.md index adfc88a2a..66b70d7d2 100644 --- a/doc/2-interface/settings.md +++ b/doc/2-interface/settings.md @@ -173,17 +173,10 @@ settings are saved when clicking the **OK** or **Apply** buttons at the bottom o ### Cores -- **Arcade/YM2151 core**\ - **Genesis/YM2612 core**\ - **SN76489 core**\ - **NES core**\ - **FDS core**\ - **SID core**\ - **POKEY core**\ - **OPN/OPNA/OPNB cores**: - - **Playback Core(s)**: core(s) to use for playback. - - **Render Core(s)**: core(s) to use when exporting audio. - - all of these are covered in the [guide to choosing emulation cores](../9-guides/emulation-cores.md). +- **Playback Core(s)**: core(s) to use for playback. +- **Render Core(s)**: core(s) to use when exporting audio. + +all of these are covered in the [guide to choosing emulation cores](../9-guides/emulation-cores.md). - **PC Speaker strategy**: this is covered in the [PC speaker page](../7-systems/pcspkr.md). @@ -311,16 +304,12 @@ below all the binds, select a key from the dropdown list to add it. it will appe ### Text -- **Main font**: overall interface font.\ - **Header font**: font for section headers.\ - **Pattern font** font for the pattern view, the order list, and related. +- **Main font**: overall interface font. +- **Header font**: font for section headers. +- **Pattern font** font for the pattern view, the order list, and related. - if "Custom...", a file path selector will appear. - **Size**: font size. -- **Display Japanese characters**\ - **Display Chinese (Simplified) characters**\ - **Display Chinese (Traditional) characters**\ - **Display Korean characters** - - only toggle these options if you have enough graphics memory. +- **Display Japanese characters**, **Display Chinese (Simplified) characters**, **Display Chinese (Traditional) characters** and **Display Korean characters**: only toggle these options if you have enough graphics memory. - these are a temporary solution until dynamic font atlas is implemented in Dear ImGui. ### Program diff --git a/doc/3-pattern/effects.md b/doc/3-pattern/effects.md index d46bc3978..10eda981a 100644 --- a/doc/3-pattern/effects.md +++ b/doc/3-pattern/effects.md @@ -91,8 +91,9 @@ not all chips support these effects. - does not apply on Amiga. - `EExx`: **Send external command.** - this effect is currently incomplete. -- `F5xx`: **Disable macro.**\ - `F6xx`: **Enable macro.** see macro table at the end of this document for possible values. +- `F5xx`: **Disable macro.** +- `F6xx`: **Enable macro.** + - see macro table at the end of this document for possible values. additionally, [each chip has its own effects](../7-systems/README.md). diff --git a/doc/7-systems/snes.md b/doc/7-systems/snes.md index 75f8599db..fc5a5fd9c 100644 --- a/doc/7-systems/snes.md +++ b/doc/7-systems/snes.md @@ -37,33 +37,27 @@ Furnace also allows the SNES to use wavetables (and the wavetable synthesizer) i - `16xx`: **set gain.** `00` to `7F` if direct, `00` to `1F` otherwise. - `18xx`: **enable echo buffer.** - `19xx`: **set echo delay.** range is `0` to `F`. -- `1Axx`: **set left echo channel volume.**\ - `1Bxx`: **set right echo channel volume.**\ - `1Cxx`: **set echo feedback.** +- `1Axx`: **set left echo channel volume.** +- `1Bxx`: **set right echo channel volume.** +- `1Cxx`: **set echo feedback.** - all of these are signed numbers. - `00` to `7F` for 0 to 127. - `80` to `FF` for -128 to -1. - - setting these to -128 is not recommended as it may cause echo output to overflow and therefore click. + - setting these to -128 is not recommended as it may cause echo output to overflow and therefore click. - `1Dxx`: **set noise generator frequency.** range is `00` to `1F`. see noise frequencies chart below. -- `1Exx`: **set left dry / global volume.**\ - `1Fxx`: **set right dry / global volume.** +- `1Exx`: **set left dry / global volume.** +- `1Fxx`: **set right dry / global volume.** - these do not affect echo. -- `20xx`: **set attack.** range is `0` to `F`.\ - `21xx`: **set decay.** range is `0` to `7`.\ - `22xx`: **set sustain.** range is `0` to `7`.\ - `23xx`: **set release.** range is `00` to `1F`. +- `20xx`: **set attack.** range is `0` to `F`. +- `21xx`: **set decay.** range is `0` to `7`. +- `22xx`: **set sustain.** range is `0` to `7`. +- `23xx`: **set release.** range is `00` to `1F`. - these four are only used in ADSR envelope mode. see ADSR chart below. -- `30xx`: **set echo filter coefficient 0.**\ - `31xx`: **set echo filter coefficient 1.**\ - `32xx`: **set echo filter coefficient 2.**\ - `33xx`: **set echo filter coefficient 3.**\ - `34xx`: **set echo filter coefficient 4.**\ - `35xx`: **set echo filter coefficient 5.**\ - `36xx`: **set echo filter coefficient 6.**\ - `37xx`: **set echo filter coefficient 7.** - - all of these are signed numbers. - - `00` to `7F` for 0 to 127. - - `80` to `FF` for -128 to -1. +- `3xyy`: **set echo filter coefficient.** + - `x` is the coefficient from 0 to 7. + - `yy` is the value (signed number). + - `00` to `7F` for 0 to 127. + - `80` to `FF` for -128 to -1. - note: be sure the sum of all coefficients is between -128 and 127. sums outside that may result in overflow and therefore clicking. - see [SnesLab](https://sneslab.net/wiki/FIR_Filter) for a full explanation and examples. diff --git a/doc/8-advanced/chanosc.md b/doc/8-advanced/chanosc.md index 631fa5d09..b811add81 100644 --- a/doc/8-advanced/chanosc.md +++ b/doc/8-advanced/chanosc.md @@ -49,13 +49,13 @@ in this mode, the color selector is replaced by a square field onto which circul - **Spread**: the size of the solid center of the circle. increasing it fills more of the circle with the target color. - **Background**: sets background color for entire field. -- **X Axis**: determines what the horizontal maps to, from left to right.\ - **Y Axis**: determines what the vertical maps to, from bottom to top. these can be set to the following: +- **X Axis**: determines what the horizontal maps to, from left to right. +- **Y Axis**: determines what the vertical maps to. from bottom to top. these can be set to the following: - **None (0%)**: stays at the left or bottom. - **None (50%)**: stays at the center. - **None (100%)**: stays at the right or top. - **Frequency**: changes color with note frequency. - **Volume**: changes color with volume. - **Channel**: changes color based on channel number. - - **Brightness**: {{document this}} + - **Brightness**: currently does nothing. - **Note Trigger**: changes color when a new note is played. diff --git a/doc/8-advanced/comments.md b/doc/8-advanced/comments.md index 2c53bf7c1..ebb05d700 100644 --- a/doc/8-advanced/comments.md +++ b/doc/8-advanced/comments.md @@ -2,7 +2,6 @@ ![comments dialog](comments.png) -comments, credits, or any arbitrary text may be entered here.\ -it has no effect on the song. +comments, credits, or any arbitrary text may be entered here. it has no effect on the song. -there is no word wrap; long lines must be broken manually with the Enter key. \ No newline at end of file +there is no word wrap; long lines must be broken manually with the Enter key.