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.

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

Traktor S3: Restructured effect section #485

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

Conversation

soerenbe
Copy link

@soerenbe soerenbe commented May 15, 2022

Hi there,
I just got my S3 and set it up for Mixxx. I read the documentation and the most parts where very good explained and quite understandable.

I had a really hard time reading the effect section. As described in the manual they are a little complex. It took me 2 evenings to understand all the functions and the different modes. Since I was a first time reader/user I thought this is a good time to work on it.

I found 2 major issues with this section:

  1. ) The button names in the document are a little confusing. Especially the 'Filter enabled' button is labeled as 'On' on the controller. So I renamed it to 'Filter On'. I also introduced the buttons at the begin of the section.
  2. ) The 3 different modes are mentioned in 3 different section: introduction, change mode, mode description. So I was constantly scrolling up and down to get my information. Also the "filter mode" was not listed as a section - just is functionality "Assigning Effects".
    I restructured the section that it should now be easier to read it from top to bottom.

Preview:
https://manual.mixxx.org/2.3/en/hardware/controllers/native_instruments_traktor_kontrol_s3.html#effects
https://deploy-preview-485--mixxx-manual.netlify.app/hardware/controllers/native_instruments_traktor_kontrol_s3.html#effects

Comment on lines 189 to 191
#. Filter Mode (initial)
#. Effect Chain Edit Mode
#. Effect Focus Mode
Copy link
Member

Choose a reason for hiding this comment

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

For a better overview, I think would help to mention the mode indicators here as well, instead of 'hiding' this info in each mode's section (maybe have it both places)

Copy link
Author

Choose a reason for hiding this comment

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

Sounds reasonable. I added a short description. Since I want to avoid up/down scolling, I kept the description in the section.


Soft Takeover
~~~~~~~~~~~~~
The knobs have Soft Takeover mode enabled, which means you need to turn the physical knob to match the current position of the UI knob before the value will change. If you are wondering why it seems like the values aren't changing, you may need to rotate the knob more.
Copy link
Member

Choose a reason for hiding this comment

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

I think we should add softTakeover to https://manual.mixxx.org/2.3/en/glossary.html
I filed #486

Copy link
Author

Choose a reason for hiding this comment

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

For now I do not reference the glossary. I think this should be done in this PR.

@ronso0
Copy link
Member

ronso0 commented May 16, 2022

@soerenbe
Copy link
Author

soerenbe commented Jun 9, 2022

I did not left a comment, but I finished already 3 weeks ago. Feel free to send me more feedback (or merge the PR). :-)

@Swiftb0y
Copy link
Member

Swiftb0y commented Jun 9, 2022

I'm sorry for not merging this yet. We were waiting for the original author to state their opinion. Unfortunately it doesn't seem like they have time right now. @ronso0 Do you consider your review sufficient and want to merge this now?

Copy link
Member

@ronso0 ronso0 left a comment

Choose a reason for hiding this comment

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

Thank you, just a clean-up idea and one more hwlabel

Comment on lines +189 to +191
#. Filter Mode (initial) - It is indicated when the :hwlabel:`FILTER ON` buttons have the same colors as the individual decks.
#. Effect Chain Edit Mode - It is indicated when the :hwlabel:`FILTER ON` buttons are all the same color as one of the effect buttons.
#. Effect Focus Mode - It is indicated when :hwlabel:`FILTER ON` buttons are all the same color as one of the effects, and one of the :hwlabel:`FX SELECT` buttons is blinking.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
#. Filter Mode (initial) - It is indicated when the :hwlabel:`FILTER ON` buttons have the same colors as the individual decks.
#. Effect Chain Edit Mode - It is indicated when the :hwlabel:`FILTER ON` buttons are all the same color as one of the effect buttons.
#. Effect Focus Mode - It is indicated when :hwlabel:`FILTER ON` buttons are all the same color as one of the effects, and one of the :hwlabel:`FX SELECT` buttons is blinking.
#. Filter Mode (initial): :hwlabel:`FILTER ON` buttons have the same color as the respective decks.
#. Effect Chain Edit Mode: :hwlabel:`FILTER ON` buttons are all the same color as one of the :hwlabel:`FX SELECT` buttons
#. Effect Focus Mode: :hwlabel:`FILTER ON` buttons are all the same color as one of the effects, and one of the :hwlabel:`FX SELECT` buttons is blinking.

@ronso0
Copy link
Member

ronso0 commented Jun 12, 2022

Thanks for the reminder. Seems @ywwg is n/a, so I left a final review, then let's merge it and improve further when necessary.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants