Work on learning center tutorials

[ThomasKroes]

Overview

This onboarding PR extends the current learning center API with tutorial functionality, see the video below.

This video shows how to access the tutorials from the website ánd from within ManiVault Studio

Main contributions

• Added a bunch of tutorials for basic interaction with ManiVault Studio and two for tSNE and HSNE hyperspectral image analysis
• Made these tutorials accessible through the website ánd from within ManiVault Studio
• Added a coupling between website tutorials and the tutorials shown in the application (uses the learning-center.json API from the website)
• Added core system Tutorial plugin located in: /ManiVault/src/plugins/TutorialPlugin which uses the learning-center.json API from the website to display the tutorial in an embedded browser
• Plugin-specific tutorials are now available in the plugin learning center
• Added help menu entries for learning center videos
• Added help menu entries for learning center tutorials
• Added tutorials to the learning center page
• Added tutorials to the start page (when launched, a project is downloaded and started, see video)
• Extended the functionality of the mv::FileDownloader class with more monitoring member functions and automatic (modal) progress indication
• Added mv::AbstractProjectManager::openProject(QUrl url,....) to download and open a project (with progress reporting etc.)
• Allow toggling tutorials section on start page

Added classes and refactors

• Added mv::LearningCenterTutorialsModel class which contains tutorials from the website and user-added tutorials
• Added mv::LearningCenterTutorialsFilterModel class which filters an mv::LearningCenterTutorialsModel instance
• Added mv:::util::LearningCenterTutorial class which contains tutorial properties (can be populated from the website or by the user)
• Renamed util::Video class to mv::util::LearningCenterVideo to harmonize with the above naming scheme and to be more exact and descriptive
• Moved classes from the Pages/StartPage to the Pages/Common source group because, from now on, they are also used by the learning center page
• Added member functions to mv::AbstractHelpManager for adding and retrieving tutorials
• Added mv::gui::WatchVideoAction which encapsulate video launching behaviour (we might support various types of videos in the future)

Tutorials for built-in plugins

Note: the documentation is available on the website ánd in ManiVault Studio

• Data hierarchy plugin
• Data properties plugin
• Logging plugin, available from within ManiVault Studio (with the tags filter) and not from the website
• Sample scope plugin, available from within ManiVault Studio (with the tags filter) and not from the website
• Shared parameters plugin, available from within ManiVault Studio (with the tags filter) and not from the website
• Tasks plugin, available from within ManiVault Studio (with the tags filter) and not from the website

Bug fixes

• Fixes plugin learning center alignment icon
• Multiple tags can be selected during a single OptionAction popup session
• Modal tasks dialog is now resizing properly when modal tasks are added and removed
• mv::gui::OptionsAction in collapsed mode with tags closes when a tag is toggled mv::gui::OptionsAction in collapsed mode with tags closes when a tag is toggled #748
• Default widget flags not always respected in horizontal group actions Default widget flags not always respected in horizontal group actions #747
• Improve plugin descriptions for Manivault built-int plugins and example plugins Improve plugin descriptions for Manivault built-int plugins and example plugins #697
• Icon-based mv::gui::TriggerAction push buttons are now re-sized in code rather than CSS (which turned out unreliable)

Miscellaneous

• Disables start page project from workspace section (for now)
• Added Resharper team settings for unified code style conventions
• Compiles also with MV_PRECOMPILED_HEADERS off
• Code style improvements where necessary
• Small refactors
• Marked some plugin learning center functions deprecated for now (markdown descriptions etc. will perhaps be removed or changed in the future)

[alxvth]

These functions are actually used now, right? Do they still need the deprecated attribute? They cause a bunch of warning during build

[ThomasKroes]

They have largely been superseded by the tutorials, so I am not sure yet what role they will play in the future. I could remove the deprecation warning or remove these functions entirely, what do you think?

[alxvth]

I think the function to just show the Readme of a plugin without an extra tutorial is still very nice. It can server different purposes as well, like mentioning authors and references in the readme vs detailed usage instructions in the tutorial.
I'd be in favor of keeping it.

[ThomasKroes]

Sounds reasonable. I will turn off the deprecation warnings then!

[alxvth]

auto readmeMarkdownUrl = QUrl(QString("https://raw.githubusercontent.com%1/master/README.md").arg(githubRepositoryUrl.path()));

PluginFactory::getReadmeMarkdownUrl::L283

It would be good to be able to specify the branch in PluginFactory::getReadmeMarkdownUrl with a similar function like getRepositoryUrl(), e.g. getDefaultBranch(). We have several plugins that are using main instead of master (like the jupyterplugin, PointDataConversionPlugin or UMAP-Plugin.

[ThomasKroes]

auto readmeMarkdownUrl = QUrl(QString("https://raw.githubusercontent.com%1/master/README.md").arg(githubRepositoryUrl.path()));

PluginFactory::getReadmeMarkdownUrl::L283

It would be good to be able to specify the branch in PluginFactory::getReadmeMarkdownUrl with a similar function like getRepositoryUrl(), e.g. getDefaultBranch(). We have several plugins that are using main instead of master (like the jupyterplugin, PointDataConversionPlugin or UMAP-Plugin.

Good suggestion, this is implemented now...