Document beats_translate_earlier_move_half_beat and beats_translate_later_move_half_beat

[Swiftb0y]

Please also document the new control in https://manual.mixxx.org/2.5/en/chapters/appendix/mixxx_controls.html
The manual PR should target the main branch (refers to next major release 2.6)

Thank you!

Originally posted by @ronso0 in #14279 (comment)

[jstolberg]

Shouldn't the documentation be for beats_translate_half, as this is the name of the deck control we have added in controlpickermenu.cpp? beats_translate_earlier_move_half_beat and beats_translate_earlier_move_half_beat are in the tooltip description for each button, but they both use the deck control beats_translate_half.

Also, should the documentation still include [SamplerN] and [PreviewDeckN], when it is added with addDeckControl and not addDeckAndSamplerControl nor addDeckAndSamplerAndPreviewDeckControl?

[ronso0]

Yes, it's about beats_translate_half.
If it's created for all players we should also mentioned all player groups in the documentation.

I don't remember, but one reason to not add it to the control menu for all players is to not bloat the menu too much when the official skins don't provide scrolling waveforms for other players than the main decks, which are required IMO to see / verify the effect of beat grid moves.
Wdyt?

[jstolberg]

Yes, that was exactly what I thought, and therefore chose addDeckControl in the controlpickermenu. I'm not entirely sure, but I would suppose that means it is not created for all players? On the other hand there are other controls such as beats_translate_corpus, which is added with addDeckControl, but they are still documented with [PreviewDeckN] and [SamplerN] shown too. So I'm a bit confused.

[ronso0]

addDeckControl and the other add..Control functions are only for the control picker menu for MIDI Learn and have nothing to do with BasePlayer which is the -as the name suggests- the base class for all players (main decks, samplers, preview deck) where the controls are created.

[jstolberg]

I have made a pull request for the documentation now: #740
It fails 4 of the checks, despite the fact I just added a few lines, which are basically just copied. How can that be? I have installed pre-commit, and also build the html locally, without any issues.

[Swiftb0y]

Not your fault, you're targeting main (which is correct in this case), but most fixes (especially CI related ones) have only been made into 2.5 and not main yet. I just merged 2.5 to main, so if you rebase on main CI should mostly work (ignore the linkcheck stuff).