Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update korg_kaoss_dj.rst #430

Open
wants to merge 2 commits into
base: 2.3
Choose a base branch
from
Open

Update korg_kaoss_dj.rst #430

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fd4c6ad
Update korg_kaoss_dj.rst
raphaelquast Sep 18, 2021
6c73a60
correc looping behavior
raphaelquast Sep 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 18 additions & 17 deletions source/hardware/controllers/korg_kaoss_dj.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Mapping
+------------------------------------------------+------------------------------------------------+------------------------------------------------+------------------------------------------------+
| 3 | Master knob | Adjust the master volume level | |
+------------------------------------------------+------------------------------------------------+------------------------------------------------+------------------------------------------------+
| 4 | Browse knob | Selects a song from the library | Moves between levels (TODO) |
| 4 | Browse knob | Selects a song from the library | Moves between levels |
+------------------------------------------------+------------------------------------------------+------------------------------------------------+------------------------------------------------+
| 5 | Display | Indicates the effect number or parameter | Indicates the key or scale |
+------------------------------------------------+------------------------------------------------+------------------------------------------------+------------------------------------------------+
Expand All @@ -42,15 +42,15 @@ Mapping
+------------------------------------------------+------------------------------------------------+------------------------------------------------+------------------------------------------------+
| 7 | Program/Value Knob | Selects an effect | Selects a key, selects a scale |
+------------------------------------------------+------------------------------------------------+------------------------------------------------+------------------------------------------------+
| 8 | Tap Button | Sets the tempo | Key setting mode |
| | | Long-press this button to access the auto BPM | |
| | | function | |
| 8 | Tap Button | tap to open a folder in the file-browser | use left / right shift to set the tempo |
| | | (double-tap to close an open folder) | of left / right track |
| | | | |
+------------------------------------------------+------------------------------------------------+------------------------------------------------+------------------------------------------------+
| 9 | Hold Button | Enables/disables the touchpad’s hold function | Scale setting mode |
+------------------------------------------------+------------------------------------------------+------------------------------------------------+------------------------------------------------+
| 10 | Touchpad (controller mode) | Controls the effects of the DJ software. The | Adjusts the Beats Multiplier (TODO) |
| | | vertical axis controls the mix (dry/wet) knob | |
| | | and the horizontal axis controls the super | |
| 10 | Touchpad (controller mode) | Controls the effects of the DJ software. The | Controls Quick-Effect super knobs |
| | | vertical axis controls the mix (dry/wet) knob | the horizontal-axis controls deck 1 |
| | | and the horizontal axis controls the super | the vertical-axis controls deck 2 |
Comment on lines +51 to +53
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you're touching this unrelated lines, please try to boil down the text
Controls the effects of the DJ software. The vertical axis controls the mix (dry/wet) knob and the horizontal axis controls the super knob.
to something like

Controls effect unit 1.
Y axis: Mix knob (dry/wet)
X axis: Super knob.

| | | knob. | |
+------------------------------------------------+------------------------------------------------+------------------------------------------------+------------------------------------------------+
| | Touchpad (Kaoss Effect mode) | Controls the KAOSS effect | Adjusts the depth of the KAOSS Effect |
Expand All @@ -62,29 +62,30 @@ Mapping
+------------------------------------------------+------------------------------------------------+------------------------------------------------+------------------------------------------------+
| 12 | Touch Slider mode button | Switches between the three touch slider mode | |
+------------------------------------------------+------------------------------------------------+------------------------------------------------+------------------------------------------------+
| 13 | Touch Slider (Normal mode) | Left Side - Nudges (pitch -) | Moves to the specified position in the song |
| 13 | Touch Slider (Normal mode) | Left - Nudges (pitch -) | Moves to the specified position in the song |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this and the rows below:
I think some formatting or line breaks in columns 3+4 would improve readability a lot.
Current state looks like this:
image

The text can also be improved, for example

Set hotcue / go to set hotcue
Left: 1 / Center: 2 / Right: 3

and in a similiar way for the shifted mode description.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the text is in fact formatted with line-breaks like this:

| ... | ... | Left - Deletes Hot Cue 1  |
| ... | ... | Center - Deletes Hot Cue 2|
| ... | ... | Right- Deletes Hot Cue 3  |

It should be formatted in the doc (parsed via Sphinx i guess) as 3 individual lines.
However Github's preview interprets this as a Markdown table that does not support newlines which is why it looks like a mess in your screenshot 😄

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is not just a preview, it's the actual online manual.
for markdown we need better separators then to increase readability.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm, well as far as I know this is supposed to be the correct way for specifying newlines in re-structured text...
I think what's happening here is that the lines exceed the max. number of characters and then auto-wrapping takes over and the newlines are no longer correctly parsed...

this would explain this: (from the online-doc)
(all entries are written with newlines but it only works as intended for "Deletes Hot Cue ."
image

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, I understand that.
what I was proposing as "better separators" is simply something like Left: set hotcue... instead of Left - set hotcue...

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, yep that seems reasonable!
I'll try to come up with a better readable version as soon as i find the time!

| | | Center - Enables the touch wheel's Scratch | (slider) |
| | | mode | |
| | | Right Side - Nudges (pitch +) | |
| | | Right - Nudges (pitch +) | |
+------------------------------------------------+------------------------------------------------+------------------------------------------------+------------------------------------------------+
| | Touch Slider (Hot Cue mode) | Left Side - Sets Hot Cue 1, and moves to Hot | Deletes Hot Cue 1 |
| | | Cue 1 | Deletes Hot Cue 2 |
| | | Center - Sets Hot Cue 2, and moves to Hot Cue | Deletes Hot Cue 3 |
| | Touch Slider (Hot Cue mode) | Left - Sets Hot Cue 1, and moves to Hot | Left - Deletes Hot Cue 1 |
| | | Cue 1 | Center - Deletes Hot Cue 2 |
| | | Center - Sets Hot Cue 2, and moves to Hot Cue | Right - Deletes Hot Cue 3 |
| | | 2 | |
| | | Right Side - Sets Hot Cue 3, and moves to Hot | |
| | | Right - Sets Hot Cue 3, and moves to Hot | |
| | | Cue 3 | |
+------------------------------------------------+------------------------------------------------+------------------------------------------------+------------------------------------------------+
| | Touch Slider (Loop mode) | Left Side - Auto Loop × 1/2 | Sets the Loop In point |
| | | Center - Loop on/off | Auto Loop × 1 |
| | | Right Side - Auto Loop × 2 | Sets the Loop Out point |
| | Touch Slider (Loop mode) | Left - Auto Loop × 1/2 | Left - Sets the Loop In point |
| | | Center - New beatloop at playback position | Center - Re-loop |
| | | Right - Auto Loop × 2 | Right - Sets the Loop Out point |
+------------------------------------------------+------------------------------------------------+------------------------------------------------+------------------------------------------------+
| 14 | EQ | Boosts or Cuts the Hi EQ | |
| | | Boosts or Cuts the Mid EQ | |
| | | Boosts or Cuts the Lo EQ | |
+------------------------------------------------+------------------------------------------------+------------------------------------------------+------------------------------------------------+
| 15 | Gain knob | Adjusts the gain | |
+------------------------------------------------+------------------------------------------------+------------------------------------------------+------------------------------------------------+
| 16 | Load button | Loads the song into the selected deck | |
| 16 | Load button | Loads the song into the selected deck | A : close selected folder in the file-browser |
| | | | B : open selected folder in the file-browser |
+------------------------------------------------+------------------------------------------------+------------------------------------------------+------------------------------------------------+
| 17 | Fx button | Left - FX1 rack mix knob can be manipulated | |
| | | when enabled | |
Expand Down