Page MenuHomePhabricator

Multiple Views for the help system
Closed, ResolvedPublic

Description

There are three buttons / plugins with a big question mark which all open parts of the help pages of MITK. This is confusing for the user. There should only be one button for the help system.

Event Timeline

This issue was alluded to in T11546 .

As far as I can tell in the current setup there are two ways to go about this:

  1. Leave it as it is (keep all the help views in the view list separately)
  2. Remove all help views from the view list

Which way is the one to choose should probably be discussed (adding sascha and marco cc).

If option 2 is chosen the way to go about i would be:

In the QmitkExtAppWorkbenchAdvisor.cpp add the views-to-be-excluded to the exclude list.

The QmitkExtWorkbenchWindowAdvisor offers the function:
void QmitkExtWorkbenchWindowAdvisor::SetViewExcludeList(std::vector<std::string> v)

Just add the ids to a string vector and call the function.

From a user's point of view (!) having one help view would be the nicest.

Yes, but which one should we keep?

Search?
Contents?
Index?

If only one is kept I would probably prefer the search view.

As I understand it, one of the primary reasons for the "user confusion" is the usage of identical icons for the three views. This could be changed.

We could also leave all three menu entries in the Show View menu but only have the icon for the search view in the toolbar (I agree that the search view should be kept).

Regarding the toolbar I think diverging too much between the views accessible from the show view menu and those accessible from the toolbar will probably cause more user confusion than having two less options will solve. (Please correct me if you think differently)

Different icons are a good idea. Do the rest agree, that these would help reduce confusion (so much, that no other steps need to be taken)?

(In reply to comment #5)

Regarding the toolbar I think diverging too much between the views
accessible from the show view menu and those accessible from the toolbar
will probably cause more user confusion than having two less options will
solve. (Please correct me if you think differently)

My reasoning was that it is custom practice to have only a subset of all actions available via toolbars and menus providing access to them all. Further, the menu entries always contain the action text which differentiates clearly between the help views, but the toolbar doesn't (by default at least).

Updating target milestone to upcoming release

If there are no further comments I will change the current implementation as follows:

  • Only the search view will remain in the Toolbar, all of them will remain in the dropdown menu
  • I will change the names of the views to "Help - Contents" etc. so that they are grouped together in the dropdown menu, due to their name

After discussion with Sascha:

I will only rename the views, as he is currently working on a different mechanism of providing views based on the perspective. This will invalidate any work to further tweak the workbench advisor.

New remote branch pushed: bug-13781-rename-help-views

[06f327]: Merge branch 'bug-13781-rename-help-views'

Merged commits:

2013-01-18 12:58:32 Caspar Goch [3e6f0a]
Renamed help views to feature Help - Viewname

Closing and moving to Sascha as reminder.

kislinsk claimed this task.