Manual Numark Mixtrack Platinum FX

[evoixmr]

Manual for mixxxdj/mixxx#12872

Preview:
https://deploy-preview-623--mixxx-manual.netlify.app/hardware/controllers/numark_mixtrack_platinum_fx

[ronso0]

Just a quick note regrading the images:
it would be preferred to create rather small SVG overviews instead of adding ~1 MB PNG images to the repo. You can create black/white SVGs by tracing the origial raster image (as you did in an earlier commit I think).
Or adopt an existing SVG, e.g. from the Platinum https://manual.mixxx.org/2.4/en/hardware/controllers/numark_mixtrack_platinum

[evoixmr]

@ronso0 I updated all photos and scripts to use svg. I also deleted the png files.

[ronso0]

This blank line before the dash line indicating a header makes the page generator pick Overview as page title.
Please remove.

[evoixmr]

Updated header.

[ronso0]

Suggested change

	---------------
	---------------

Please remove these lines. They prevent proper header rendering. Also some table rows are broken due to blank lines.
I suggest you check the preview and tweak until it looks as desired.
https://deploy-preview-623--mixxx-manual.netlify.app/hardware/controllers/numark_mixtrack_platinum_fx

[evoixmr]

I removed the lines.

[ronso0]

The appearance is still broken, just check the preview.
FYI you may also build the html locally with make html and double-check before pushing.

[evoixmr]

I just updated the appearance. Can you recheck and make suggestion on which areas need to be improve?

[ronso0]

Yes, it's loking good now. It were just the blank lines that enforced header formatting on each following line.

[ronso0]

Another rather shallow review focused on appearance.
I see you spent a lot of time on this, though the appearance is suboptimal (e.g. headers, controls table)

[ronso0]

Re the schematic overview:
correct me if I'm wrong: the Platinum FX is identical to the Pro FX except it has jog wheel displays.
So we can use the Pro FX overview and just change some numbers.

I'll prepare a PR.

[ronso0]

Here you go evoixmr#7

I have no idea what's causing the rstcheck to fail 🤷

[evoixmr]

I just corrected the rstcheck errors.

[evoixmr]

How do I correct this error? Is there anything I can do here?

Sphinx / Link Check (pull_request) Failing after 2m
/home/runner/work/manual/manual/source/chapters/appendix/changelog.rst:549: WARNING: broken link: file:line ()

[ronso0]

Don't care about that, links may time out occassionally, and you didn't touch that file 🤷
(the link in question is mixxxdj/mixxx#12253 and it works for me, formatting also looks okay)

[evoixmr]

I just added Shift+Cue Gain - Global Sample Volume Adjust..

[ronso0]

Thanks for the reminder @evoixmr
It looks like work/review on mixxxdj/mixxx#12872 has stalled, but this PR is mostly ready?
What do you think about effect toggles

Press one of these buttons to select a software effect.
• HPF (High pass filter)
• LPF (Low pass filter)
• Flanger
• Echo
• Reverb
• Phaser

IIUC work on this mapping started while 2.3 was the stable version, and 2.4 now allows to load specific effect presets (ie. items at specific position in the preset list, not by effect uuid or something).
Does it make sense to address this now?

[evoixmr]

Thanks for the reminder @evoixmr It looks like work/review on mixxxdj/mixxx#12872 has stalled, but this PR is mostly ready? What do you think about effect toggles

Press one of these buttons to select a software effect.
• HPF (High pass filter)
• LPF (Low pass filter)
• Flanger
• Echo
• Reverb
• Phaser

IIUC work on this mapping started while 2.3 was the stable version, and 2.4 now allows to load specific effect presets (ie. items at specific position in the preset list, not by effect uuid or something). Does it make sense to address this now?

Yes, the PR is ready. As far as he effects preset, is there a documentation that I can use to add preset?

[ronso0]

All effect / effect chain preset controls are documented here
https://manual.mixxx.org/2.4/en/chapters/appendix/mixxx_controls.html#controls

Loading specific Quick Effect presets can be done with [QuickEffectRack1_[ChannelI]],loaded_chain_preset.
This control expects an integer argument 0 .. [num_chain_presets - 1], so the user has to arrange the Quick Effect presets in Preferences -> Effects to match the button labels (or any desired custom mapping).

[ChrisTallon]

@ronso0
Hi, I'm having a go at setting preset effects from the init function of this controllers mapping. In JS, is there a way of finding the index number of a specific effect by its string title?

So far, I am assigning effects to the FX units to match the controller if the effects unit slots are empty, at initialisation time of the mapping. I have this working, but upgrading to 2.5 changed the list of available effects and so my hard coded assignments are off.

Thanks.

[ronso0]

In JS, is there a way of finding the index number of a specific effect by its string title?

Nope, and actually hard-coding effects wouldn't be ideal anyways.
Mappings for similar controllers simply use the quick effects preset list which users can customize in the preferences, for example the Traktor Kontrol S2 Mk3 and S4 Mk3.

[ronso0]

@evoixmr it seems you merged mixxx/2.5
Did you use git rebase or merge?
The rebase command would be git rebase -i mixxx/2.5
Make sure to fetch mixxx before that.

Oh, do you use the command line at all?

[evoixmr]

@ronso0 @Swiftb0y Rebased to 2.5

[Swiftb0y]

Thank you. Preview looks good on first look, but I don't have time for a proper review right now. What about you @ronso0?

[ChrisTallon]

@evoixmr Do you want me to try to push that effects paragraph I wrote into evoixmr/manual:2.5 ?

ChrisTallon@06ff501

[ronso0]

FYI I'm about to fix the rebase, there are 4k+ files changed here.

[ronso0]

Hmm I can't push as ususal when doing fixups in other's PRs.
We don't want to just close this PR and start anew, so one way forward would be for @evoixmr :

• rename you branch locally git checkout 2.4 then git branch -m 2.4_bak
  (and next time don't work on top of a Mixxx branch please)
• create a new branch git checkout -b 2.4 mixxx/2.5 --> replace 'mixxx' with the name of your Mixxx remote, might be 'upstream' or something
• add my repo as remote
  git remote add ronso0 [email protected]:ronso0/manual.git
• fetch git remote fetch ronso0 (now your git knows about all my branches and commits)
• cherry-pick the rebased commit git cherry-pick 7534d1029c3453d28d91dc3e3e6c2f32bfb706a2
• force-push to your repo, implicitly updating this PR

[ronso0]

that rebased commit is also here #724

[ronso0]

Made this a draft to prevent accidental merge.

LGTM btw 👍

[evoixmr]

@ronso0 done

Hmm I can't push as ususal when doing fixups in other's PRs. We don't want to just close this PR and start anew, so one way forward would be for @evoixmr :

• rename you branch locally git checkout 2.4 then git branch -m 2.4_bak
  (and next time don't work on top of a Mixxx branch please)
• create a new branch git checkout -b 2.4 mixxx/2.5 --> replace 'mixxx' with the name of your Mixxx remote, might be 'upstream' or something
• add my repo as remote
  git remote add ronso0 [email protected]:ronso0/manual.git
• fetch git remote fetch ronso0 (now your git knows about all my branches and commits)
• cherry-pick the rebased commit git cherry-pick 7534d1029c3453d28d91dc3e3e6c2f32bfb706a2
• force-push to your repo, implicitly updating this PR

[ronso0]

Hmm no, apparently not. We still see

Should now be 1 Commit, 3 Files changed

What does this print?
git log -1 --oneline
Should be this, just that *** shows your remote state
7534d1029 *** add mapping for Numark Mixtrack Platinum FX

[evoixmr]

@ronso0 4eab7259 (HEAD -> 2.4, origin/HEAD, origin/2.4) add mapping for Numark Mixtrack Platinum FX

Can you check now?

[ronso0]

Ah, now you've pushed!
LGTM, except that we should add a white background to the outline SVG so that it can be read on dark backgrounds, too.
Please replace it with this one

Than git add, git commit --amend and force-push again please.

[evoixmr]

@evoixmr Do you want me to try to push that effects paragraph I wrote into evoixmr/manual:2.5 ?

ChrisTallon@06ff501

@ChrisTallon not yet, Itrying to resolve the rebase issues.

[ronso0]

Pleeeeease use the command line and squash all into one commit.
git fetch to get all commits you did in the web UI
git reset d4eab7259cdd5f260bf3fa5643d659856ab381c1
you should the changes with git status, should be the SVG only
git add --all
git commit --amend
and force-push.

[evoixmr]

@ronso0 Sorry about that., updated on the command line.

[ronso0]

Great, LGTM!
Thanks for your patience!

Next time: pick a descriptive branch name like numark-fix-typos or something, this will save us some hazzle.
Thank you!

[ronso0]

(just letting CI run once more to be sure)

[evoixmr]

@ronso0 I tried the descriptive branch name. I could not push it from fixing_svg_error to 2.4. It was asking me to do a PR, the PR I open did not see the changes I made.

[ronso0]

Don't chage the branch name while there already is a PR with that branch! It'll just create unnecessary trouble.
That's why I wrote "next time".
And you can't change the base branch while a PR is open. You can only change the target branch

I could not push it from fixing_svg_error to 2.4

You could do that with git push [remote] localBranch:remoteBranch. But that's pointless here (see above).
Simply pick a descriptive branch name for your next feature / bugfix.

[ronso0]

Oh, apparently pre-commit is not happy with the optimized SVG.
But we can use the patch file provided by CI (see above: 1 failing check, click it, click on Summary at the top left, scrol to bottom, see patch file)

Next git exercise 😉

• download the pre-commit patch, copy the location (/path/to/patch.file)
• apply the patch with git apply /path/to/patch.file
• git add --all
• git commit --amend
• force-push

[ronso0]

(I presume you don't have pre-commit installed, otherwise you'd have noticed when commiting the SVG I sent)

[evoixmr]

Oh, apparently pre-commit is not happy with the optimized SVG. But we can use the patch file provided by CI (see above: 1 failing check, click it, click on Summary at the top left, scrol to bottom, see patch file)

Next git exercise 😉

• download the pre-commit patch, copy the location (/path/to/patch.file)
• apply the patch with git apply /path/to/patch.file
• git add --all
• git commit --amend
• force-push

@ronso0 Done