Skip to content

Draft: Add HelpPage

Evgeny Chesnokov requested to merge echesnokov/kirigami-addons:help_page into master

Description

Currently, the AboutPage view is not consistent compared to applications that use KXMLGui. KXMLGui allows the user to add the following information to their application:

  • Open application user help
  • Go to What This mode
  • Open a window with application description (productName, app version, OS version) and a link to bugs.kde.org
  • Open a tab in the browser where the user can support the project
  • Switch the language of the application
  • Open a window with detailed information about the application
  • Open a window with detailed information about KDE

All these actions can be disabled using kdeglobals settings.

At the same time, if we are working with a QML-based application, we have the opportunity to use two components AboutKDE and AboutPage. Through AboutPage you can use only part of the functionality that is provided in KXMLGui:

  • Open a tab in the browser where the user can support the project
  • Open the project home page
  • Open bugs.kde.org
  • Open the Get Involved page

All these actions are not disabled using global settings.

The AboutKDE page is a separate component and the user decides whether to use it.

Solution

Create a separate component that will store all this information and can work with global settings. This will allow the end user to think less about what needs to be displayed. For us, this provides the opportunity to have more control over applications, reduces some inconsistencies between 1 and 2. There won't be a situation where half of the applications show AboutKDE and half don't.

Why Draft

  1. Discuss design of the ReportBug page
  2. Discuss the possibility of moving AboutKDE, AboutPage and ReportBugPage to the private section of the plugin
  3. Remove the donation, report and possibly Get Involved items from AboutPage so as not to duplicate information
  4. Perhaps it’s worth making not a FormCardPage, but one FormCard component with all the information

Screenshots

Screenshot_20240401_052730 Screenshot_20240401_052733 Screenshot_20240401_052738

P.S.

I think in the future it will be possible to add support for changing the application language to this component.

Merge request reports