Lmms: Xpressive help dialog maximize behavior

Created on 9 Jul 2020  路  8Comments  路  Source: LMMS/lmms

Xpressive's help dialogue does not fill the screen when maximized, which looks awkward and also allows un-maximized window to be placed on top of it.

Steps to reproduce

Add an Xpressive instance to the song editor, open it's instrument window, and press the button labeled "HELP?". Next, press the maximize button belonging to the new window that appears.

Expected behavior

(1) Text area makes use of full screen real estate, or (2) the maximize button is not available in the first place.

Screenshot

image

Affected LMMS versions

Build of PR PR 5117 via LMMSBot, from 2020-07-09. Since that PR was updated today, build should include everything up to and including commit 5aba3d2a73f91d5c6268b258f2c6f167df1a8e62.

Side note

In addition, I find that the writing in the documentation isn't great, but since this isn't the point of the issue I'll just point out some objectively incorrect aspects:

  • "Panning is controled by PN1 and PN2." -> Panning is controlled by PN1 and PN2.
  • "Gives 0.0 while the key is holded" -> "Gives 0.0 while the key is held"
  • "Time after release. While the note is holded, it gives 0.0. Afterwards, it start counting seconds."

    • Once again "holded -> held"

    • "Afterward, it start counting seconds" -> "Afterward, it starts counting seconds"

I'll also note one especially confusing part: "Afterward, it start counting seconds" + "The time it takes to shift from 0.0 to 1.0 after key release is determined by the REL knob". Does trel return seconds since key release, or time since release/release length? Also "it start counting" -> "it starts counting"

bug good first issue

All 8 comments

I would prefer if the window didn't have a maximize button which should be a fairly simple fix. There are several windows without maximize buttons already:

  • Controller rack
  • Mixer
  • Instrument windows

In my opinion, this sort of documentation belongs on https://docs.lmms.io/, not in the software itself. Can we just remove the window altogether?

That's a fair point. On the other hand, this dialogue ensures that you have access to the info even if you don't have internet access, and the info within might be something you need to reference more frequently than the instructions for our other synths.

Working on this.

Have working versions of both proposals. Your call on which one to be merged.

In my opinion, this sort of documentation belongs on https://docs.lmms.io/, not in the software itself. Can we just remove the window altogether?

To @Spekular's point, offline documentation is valuable. Whether or not it belongs here is a tricky one. First, this plugin isn't just buttons and knobs, it's an interpreted language.

... but to @DomClark's point, if we're to have long-winded documentation, it should be stashed somewhere more digestible (such as online and/or a built-in help function). I vote that we merge #5586 to close the bug and discuss where help belongs as a more holistic change.

I vote that we merge #5586 to close the bug and discuss where help belongs as a more holistic change.

Done!

I vote that we [...] discuss where help belongs as a more holistic change.

Issue opened: #5596.

Was this page helpful?
0 / 5 - 0 ratings