Remove "What's This?" and update tooltips. #4128

Sawuare · 2018-01-23T11:07:00Z

Removes the "What's This?" feature which uses the QWhatsThis class, and removes its text.
The removed translatable strings are useful and should be considered when writing the documentation/manual.

After removing the "What's This?" feature, some widgets don't have any help text (tooltips) and some have vague tooltips, so existing tooltips will be updated and new ones will be created.
Tooltips progress:

Per #4119 (comment).
Fixes #4119 and closes #896.

Umcaruje · 2018-01-23T11:31:33Z

plugins/FreeBoy/FreeBoy.cpp

@@ -467,39 +467,30 @@ FreeBoyInstrumentView::FreeBoyInstrumentView( Instrument * _instrument,
 	m_ch1SweepTimeKnob->setHintText( tr( "Sweep Time:" ), "" );
 	m_ch1SweepTimeKnob->move( 5 + 4*32, 106 );
 	ToolTip::add( m_ch1SweepTimeKnob, tr( "Sweep Time" ) );
-	m_ch1SweepTimeKnob->setWhatsThis( tr( "The amount of increase or"
-									" decrease in frequency" ) );

 	m_ch1SweepRtShiftKnob = new FreeBoyKnob( this );
 	m_ch1SweepRtShiftKnob->setHintText( tr( "Sweep RtShift amount:" )
 										, "" );
 	m_ch1SweepRtShiftKnob->move( 5 + 3*32, 106 );
 	ToolTip::add( m_ch1SweepRtShiftKnob, tr( "Sweep RtShift amount" ) );


These tooltips are very vague, I think the whatsthis text(or a shorter version of it) should become the tooltip text.

Yes. Many tooltips will be updated, and created.

musikBear · 2018-01-23T15:57:16Z

FYI i made whatsthis text for all missing 1.0 component, but could not add it, because i had no ..? fork.. in a branch.. of tarballs.. ?.. 🤡

Git did not support xp
Noone was willing to do the actual update
I still have all sentences

tresf · 2018-01-23T15:59:32Z

@musikBear thanks for the information, perhaps you can help review this PR instead to make the tooltip better for users.

musikBear · 2018-01-24T14:11:07Z

@tresf sure But what PR exactly do you mean? - and @everyone just say if the list of WITs is needed now, i will upload the 10 pages.

tresf · 2018-01-24T15:28:33Z

@musikBear this is a Pull Request a.k.a "pull", it has code changes that are proposed.

You can see the code changes by clicking "Files changed" tab on the top. In this case there's only one commit, so you can also comment on each change if needed. This is done by clicking the + next to the change.
Click "add single comment". Here's an example:

plugins/monstro/Monstro.cpp

zonkmachine · 2018-01-25T14:02:48Z

I think for 1.3 it's better to:

Just remove the info knob but keep the context menu item.
Improve the strings.

musikBear · 2018-01-25T17:28:18Z

@tresf Understood
I must have missed this. Killing the WITs feature as such, is imo not good. But tiswhatitis.
That aside i think that in most incidences the WITs are much better than the tool-tips. My thought would then be to do this pull inverted.
That is:

preserve WITs text, with a tiny change
refurbish these changed WITs as new tool-tips
kill all old tool-tips
An example:
Current block:

Knob *dk = new sidKnob( this );
 		dk->setHintText( tr("Decay:") , "" );
 		dk->move( 7 + 28, 114 + i*50 );
-		dk->setWhatsThis( tr ( "Decay rate determines how rapidly the output "
-				"falls from the peak amplitude to the selected Sustain level." ) );

new block Proposal 1:

Knob *dk = new sidKnob( this ); 		
 		dk->move( 7 + 28, 114 + i*50 );
-		dk->setHintText( tr ( "Decay. -The rate determines how rapidly the output "
-				"falls from the peak amplitude to the selected Sustain level." ) );

Proposal one has a serious flaw.
There should newer be string-information in source-code
For that reason, i would propose a new class
public class ToolTips
This class would contain ALL tooltips for ALL features

This leads to final and imo best way: (only pseudo im afraid..)
new block Proposal 2:

Knob *dk = new sidKnob( this );
 		dk->setHintText( tr(ToolTips.sid.knobDecay.hintTx));
 		dk->move( 7 + 28, 114 + i*50 );

Ofcause ToolTips.sid.knobDecay.hintTx would be

 "Decay. -The rate determines how rapidly the output "
				"falls from the peak amplitude to the selected Sustain level."

This approach has imo only advantages :

the first word has the functionality of the previous used tool-tip, so it IS a tooltip -The rest of the sentence can be ignored
Reading the whole sentence has deep information value, much like WITs
All strings are in one class, and are very easy to maintain and change if/ when needed.
This makes for a cleaner source-code, and wont bloat the classes size.

tresf · 2018-01-25T17:47:35Z

@musikBear thanks. Architecturally, we'll be keeping ToolTips inside the GUI classes in which they represent. Content-wise your points are spot on. It sounds like @Sawuare has a good handle on this. Perhaps a second look once he's completed his work would be more warranted at this point.

I see a few comments about this being "Removal of functionality" and that's partially correct, but as a GUI developer for other technologies, this is a foreign concept and one that has received varying quality over the years.

I strongly agree @Sawuare that the source code is not a good place for this much text. Our software should be fairly quick and easy to translate and this is a step in that direction.

I think part of the observation here is that some of our synths are so complicated that we need a novel to use them. I don't think the CPP code is the place for this novel. We don't do this for our largest synth -- Zyn, I really don't think we should do it for the others.

musikBear · 2018-01-26T17:32:40Z

Architecturally, we'll be keeping ToolTips inside the GUI classes in which they represent.
Im really puzzled why you want that?
Bulky strings in source-code is bad!
I feel that my argumentation for a string-class has been presented with enough quality, that at least some real argumentation for preserving current 'in-class' structure, is in place?
Besides that, yes i will do a review asa im asked to :)

@Sawuare I attach 10 pages of WITs. You are welcome to use or dispose as you like.
They are for all main windows components
WITs Main.txt

I had a thought about the actual tool-tip.
Is it possible to 'divide' the tool-tip in two tempi?
If so, then the short real tool-tip could be shown first, and then ~2 scd later, the whole WIT-like text. Its just a thought..

Spekular · 2018-01-26T18:47:26Z

I would argue against tined tooltips: 1. If the user wants to read the short text, they're put under time pressure. 2. If the user wants to read the long text, they have to wait. If the short tooltips differ in length to a significant degree, a single timer would work even worse. If we're offering two texts (which as far as I can tell we don't want to do as we'd rather use the wiki) it makes more sense to offer a "What's This?" in the context menu. Speaking of the wiki & the context menu, it might make sense to offer links to the wiki from within LMMS to replace the What's This text? If this is implemented as a call to the default browser* then LMMS doesn't need to access the internet itself. *I'm not sure what to call this, but for example links on webpages can launch Spotify (open/play track) or Discord (join server) and IIRC that can happen in the opposite direction as well.

…

On Jan 26, 2018 18:32, "musikBear" ***@***.***> wrote: Architecturally, we'll be keeping ToolTips inside the GUI classes in which they represent. Im really puzzled why you want that? Bulky strings in source-code is bad! I feel that my argumentation for a string-class has been presented with enough quality, that at least some real argumentation for preserving current 'in-class' structure, is in place? Besides that, yes i will do a review asa im asked to :) @Sawuare <https://github.com/sawuare> I attach 10 pages of WITs. You are welcome to use or dispose as you like. They are for all *main windows* components WITs Main.txt <https://github.com/LMMS/lmms/files/1668581/WITs.Main.txt> I had a thought about the actual tool-tip. Is it possible to 'divide' the tool-tip in two tempi? If so, then the short real tool-tip could be shown first, and then ~2 scd later, the whole WIT-like text. Its just a thought.. — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#4128 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AIgVmsAbFuAremoI1fUizBbF6imC3ld3ks5tOgw8gaJpZM4RpdpF> .

tresf · 2018-01-26T18:53:43Z

Bulky strings in source-code is bad!
I feel that my argumentation for a string-class has been presented with enough quality, that at least some real argumentation for preserving current 'in-class' structure, is in place?

I'm sorry, but please don't back-seat code here. You're bringing this off topic.

tresf · 2018-01-26T18:56:48Z

Is it possible to 'divide' the tool-tip in two tempi?

Yes, but if were were to show larger tooltips, it would make more sense to do an active help-area like Ableton does, which is really out of scope of this PR and would fit better as part of the single-window-interface initiatives.

plugins/sid/sid_instrument.cpp

zonkmachine · 2018-01-30T22:35:40Z

Closes #896 - More texts for "What is this"

Wallacoloo

Looks like a notable improvement to the existing code base. Left a few suggestions, but nothing show-stopping. I'll merge this in a few days regardless of how you choose to address them.

In the future, try to break apart large PRs like this if they decompose nicely. For example, this could have been one PR which removes all the whats this messages, and a separate PR which normalizes all the label casing. That would have made things easier to review.

Wallacoloo · 2018-06-02T20:22:10Z

plugins/OpulenZ/OpulenZ.cpp

+	op2_s_mdl(14.0, 0.0, 15.0, 1.0, this, tr( "Op 2 austain" ) ),
+	op2_r_mdl(12.0, 0.0, 15.0, 1.0, this, tr( "Op 2 release" )   ),
+	op2_lvl_mdl(63.0, 0.0, 63.0, 1.0, this, tr( "Op 2 level" )   ),
+	op2_scale_mdl(0.0, 0.0, 3.0, 1.0, this, tr( "Op 2 level Scaling" ) ),


I think you meant to change the case of "Scaling" here, too?

Wallacoloo · 2018-06-02T20:27:30Z

plugins/monstro/Monstro.cpp

+		m_osc1Crs( 0.0, -24.0, 24.0, 1.0, this, tr( "Osc 1 coarse detune" ) ),
+		m_osc1Ftl( 0.0, -100.0, 100.0, 1.0, this, tr( "Osc 1 fine detune left" ) ),
+		m_osc1Ftr( 0.0, -100.0, 100.0, 1.0, this, tr( "Osc 1 fine detune right" ) ),
+		m_osc1Spo( 0.0, -180.0, 180.0, 0.1, this, tr( "Osc 1 stereo phase-offset" ) ),


I think the hyphens here are not necessary. I appreciate that you've been removing hyphens from things like "VST-plugin", and I think this is the same idea: "phase" and "offset" are separate and complete words. They don't need hyphenating.

Wallacoloo · 2018-06-02T20:41:52Z

plugins/peak_controller_effect/peak_controller_effect_control_dialog.cpp

@@ -76,10 +76,10 @@ PeakControllerEffectControlDialog::PeakControllerEffectControlDialog(
 	m_tresholdKnob->setModel( &_controls->m_tresholdModel );
 	m_tresholdKnob->setHintText( tr( "Treshold:" ) , "" );

-	m_muteLed = new LedCheckBox( "Mute Effect", this );
+	m_muteLed = new LedCheckBox( tr( "Mute output audio" ), this );


"output audio" seems a bit redundant. I see that in peak_controller_effect_controls.cpp we name m_muteModel "Mute output", so perhaps that would work here too (or even just "Mute")?

Yes, it is m_muteModel. I'll change it accordingly.

Wallacoloo · 2018-06-02T20:47:15Z

plugins/sf2_player/sf2_player.cpp

-	m_chorusSpeed( FLUID_CHORUS_DEFAULT_SPEED, 0.29, 5.0, 0.01, this, tr( "Chorus Speed" ) ),
-	m_chorusDepth( FLUID_CHORUS_DEFAULT_DEPTH, 0, 46.0, 0.05, this, tr( "Chorus Depth" ) )
+	m_chorusNum( FLUID_CHORUS_DEFAULT_N, 0, 10.0, 1.0, this, tr( "Lines" ) ),
+	m_chorusLevel( FLUID_CHORUS_DEFAULT_LEVEL, 0, 10.0, 0.01, this, tr( "Level" ) ),


I can't open LMMS at the moment: is the UI clear to distinguish the reverb-related knobs from the chorus-related ones? Otherwise know we have some knobs with the same name.

These texts show when the knobs are automated, so you're right, "Reverb" and "Chorus" should be kept for distinction.

Wallacoloo · 2018-06-02T20:48:36Z

plugins/sf2_player/sf2_player.cpp


 	m_chorusNumKnob = new sf2Knob( this );
-	m_chorusNumKnob->setHintText( tr("Chorus Lines:"), "" );
+	m_chorusNumKnob->setHintText( tr("Lines:"), "" );


Would the nomenclature for this usually be "voices"?

Yes. FWIW, the effects Calf Multi Chorus and Multivoice Chorus use the term "voices".

Wallacoloo · 2018-06-02T21:12:39Z

src/gui/LfoControllerDialog.cpp

-			"bigger this value the faster the LFO oscillates and "
-			"the faster the effect." ) );
-
+	m_speedKnob->setHintText( tr( "Modulation speed:" ), "" );


I understand trying to preserve some uniformity between "Modulation speed" and "modulation amount", but I think this is better as "LFO speed" or "LFO frequency".

It's sort of a two-step thing: you have an LFO, and you adjust its frequency (i.e. the "LFO frequency" - not "Modulation frequency") and then you modulate some other signal with it ("Modulation amount").

src/gui/LfoControllerDialog.cpp

Wallacoloo · 2018-06-02T21:18:51Z

src/gui/MainWindow.cpp



 	// window-toolbar
 	ToolButton * song_editor_window = new ToolButton(
 					embed::getIconPixmap( "songeditor" ),
-					tr( "Show/hide Song-Editor" ) + " (F5)",
+					tr( "Song-Editor" ) + " (F5)",


dehyphenate "Song editor" and "Piano roll" to match "Automation editor" and "FX mixer", while you're at it?

Wallacoloo · 2018-06-02T21:24:44Z

src/gui/SetupDialog.cpp

@@ -696,17 +688,11 @@ SetupDialog::SetupDialog( ConfigTabs _tab_to_open ) :

 	QPushButton * autoSaveResetBtn = new QPushButton(
 			embed::getIconPixmap( "reload" ), "", auto_save_tw );
-	autoSaveResetBtn->setGeometry( 290, 70, 28, 28 );
+	autoSaveResetBtn->setGeometry( 320, 70, 28, 28 );
 	connect( autoSaveResetBtn, SIGNAL( clicked() ), this,
 						SLOT( resetAutoSave() ) );
 	ToolTip::add( autoSaveResetBtn, tr( "Reset to default-value" ) );


dehyphenate "default value"?

Wallacoloo · 2018-06-02T21:32:58Z

src/gui/widgets/EnvelopeAndLfoView.cpp

@@ -590,8 +518,7 @@ void EnvelopeAndLfoView::lfoUserWaveChanged()
 		if( m_params->m_userWave.frames() <= 1 )
 		{
 			TextFloat::displayMessage( tr( "Hint" ),
-				tr( "Drag a sample from somewhere and drop "
-					"it in this window." ),
+				tr( "Drag and drop a sample in this window." ),


How about "Drag and drop a sample into this window"? Because, correct me if I'm wrong, but I don't think you can drag a sample out of it.

You're correct. I'll change it.

SecondFlight · 2018-06-03T19:09:39Z

plugins/vestige/vestige.cpp

@@ -263,7 +263,7 @@ void vestigeInstrument::loadFile( const QString & _file )
 	{
 		tf = TextFloat::displayMessage(
 				tr( "Loading plugin" ),
-				tr( "Please wait while loading VST-plugin..." ),
+				tr( "Please wait while loading VST plugin..." ),


Maybe add a "the" before "VST"? In this case it's talking about a specific VST plugin that it's loading and not just any plugin.

Sawuare · 2018-06-05T22:54:33Z

Thanks @Wallacoloo and @SecondFlight for reviewing this. Sorry for squashing all this work into this PR.

Wallacoloo · 2018-06-06T02:40:41Z

@Sawuare Thanks so much for coding these changes! I wish I could have polished the wording on that last comment about the size of the PR, but I was in a slight hurry when I wrote it. Anyway, it's not much of a bother - while smaller PRs can be more manageable, large PRs are infinitely better than no PRs :-)

Remove "What's This?".

90f4253

Umcaruje reviewed Jan 23, 2018

View reviewed changes

Sawuare changed the title ~~Remove "What's This?".~~ Remove "What's This?" and update tooltips. Jan 25, 2018

Sawuare added this to the 1.3.0 milestone Jan 25, 2018

Sawuare added enhancement in progress labels Jan 25, 2018

zonkmachine reviewed Jan 25, 2018

View reviewed changes

plugins/monstro/Monstro.cpp Show resolved Hide resolved

tresf reviewed Jan 26, 2018

View reviewed changes

plugins/sid/sid_instrument.cpp Show resolved Hide resolved

Remove an unused variable.

e385c11

Hussam Eddin Alhomsi added 7 commits February 9, 2018 09:31

Update main-window tooltips.

9de7bf3

Update Song-Editor tooltips.

c2183c5

Update time line tooltips.

a8d6d6f

Update Piano-Roll tooltips.

e41d741

Update Automation-Editor tooltips.

95bb754

Update LFO Controller tooltips.

8c33b7b

Update LMMS plugins text.

ba834b8

zonkmachine mentioned this pull request Feb 26, 2018

Allow Channel Chaining to allow better Signal Flow #4195

Closed

Update track and instrument text.

85e48e5

Hussam Eddin Alhomsi and others added 4 commits March 15, 2018 18:37

DualFilter fix.

d5f4b4d

Merge branch 'master' into WhatsThis

8b93281

Fix a missing semicolon

2ef9cc8

Remove redundant /*

892a7d2

Sawuare removed the in progress label Apr 26, 2018

PhysSong added 2 commits May 4, 2018 10:19

Merge branch 'master' into WhatsThis

2e15118

Merge branch 'master' into WhatsThis

0966eb4

Wallacoloo approved these changes Jun 2, 2018

View reviewed changes

Fixes

211c51e

SecondFlight reviewed Jun 3, 2018

View reviewed changes

Fix

7cb370c

SecondFlight approved these changes Jun 4, 2018

View reviewed changes

Sawuare merged commit 6d46bd4 into LMMS:master Jun 5, 2018

Sawuare deleted the WhatsThis branch June 5, 2018 22:56

PhysSong mentioned this pull request Jun 6, 2018

Rewrite the setup dialog #3820

Merged

This was referenced Jun 7, 2018

BUG: The "Info" button does not work with the Controller Rack button in the 2nd row #4119

Closed

More texts for "What is this" #896

Closed

PhysSong mentioned this pull request Sep 20, 2018

Add Carla automation support #4571

Closed

Sawuare mentioned this pull request Sep 6, 2019

Remove "What's This?" leftovers #5173

Merged

PhysSong mentioned this pull request May 5, 2020

Lv2 core implementation #4899

Closed

PhysSong mentioned this pull request Nov 4, 2020

Apply minor CodeFactor code quality fixes #5762

Closed

sdasda7777 pushed a commit to sdasda7777/lmms that referenced this pull request Jun 28, 2022

Remove "What's This?" and update tooltips (LMMS#4128)

1e78d4a

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove "What's This?" and update tooltips. #4128

Remove "What's This?" and update tooltips. #4128

Sawuare commented Jan 23, 2018 •

edited

Loading

Umcaruje Jan 23, 2018

Sawuare Jan 25, 2018

musikBear commented Jan 23, 2018

tresf commented Jan 23, 2018

musikBear commented Jan 24, 2018

tresf commented Jan 24, 2018 •

edited

Loading

zonkmachine commented Jan 25, 2018

musikBear commented Jan 25, 2018

tresf commented Jan 25, 2018

musikBear commented Jan 26, 2018

Spekular commented Jan 26, 2018 via email

tresf commented Jan 26, 2018

tresf commented Jan 26, 2018

zonkmachine commented Jan 30, 2018

Wallacoloo left a comment

Wallacoloo Jun 2, 2018

Sawuare Jun 2, 2018

Wallacoloo Jun 2, 2018 •

edited

Loading

Sawuare Jun 2, 2018

Wallacoloo Jun 2, 2018

Sawuare Jun 2, 2018

Wallacoloo Jun 2, 2018 •

edited

Loading

Sawuare Jun 2, 2018

Wallacoloo Jun 2, 2018

Sawuare Jun 2, 2018

Wallacoloo Jun 2, 2018

Wallacoloo Jun 2, 2018

Sawuare Jun 2, 2018

Wallacoloo Jun 2, 2018

Wallacoloo Jun 2, 2018

Sawuare Jun 2, 2018

SecondFlight Jun 3, 2018

Sawuare commented Jun 5, 2018

Wallacoloo commented Jun 6, 2018

Remove "What's This?" and update tooltips. #4128

Remove "What's This?" and update tooltips. #4128

Conversation

Sawuare commented Jan 23, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

musikBear commented Jan 23, 2018

tresf commented Jan 23, 2018

musikBear commented Jan 24, 2018

tresf commented Jan 24, 2018 • edited Loading

zonkmachine commented Jan 25, 2018

musikBear commented Jan 25, 2018

tresf commented Jan 25, 2018

musikBear commented Jan 26, 2018

Spekular commented Jan 26, 2018 via email

tresf commented Jan 26, 2018

tresf commented Jan 26, 2018

zonkmachine commented Jan 30, 2018

Wallacoloo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Wallacoloo Jun 2, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Wallacoloo Jun 2, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Sawuare commented Jun 5, 2018

Wallacoloo commented Jun 6, 2018

Sawuare commented Jan 23, 2018 •

edited

Loading

tresf commented Jan 24, 2018 •

edited

Loading

Wallacoloo Jun 2, 2018 •

edited

Loading

Wallacoloo Jun 2, 2018 •

edited

Loading