Allow KHelpCenter to open the right pages of KDE help when KHelpClient is invoked with an anchor
ClosedPublic

Authored by yurchor on Oct 21 2018, 11:27 AM.

Details

Summary

The current KDE help is built up to contain the anchors to its topics in the following way

help:/<appname>/<anchor>.html (for separate pages)

example:

https://docs.kde.org/trunk5/en/applications/dolphin/using-dolphin.html

or

help:/<appname>/<anchor1.html#anchor2> (for sections)

example:

https://docs.kde.org/trunk5/en/applications/dolphin/location-bar.html#location-bar-bread-crumb

It is impossible to build such schemes with the current code. It works only for schemes help:/<appname>/index.html#<anchor>. This scheme is nowhere to be found in our current catalog.

Test Plan
  1. Compile and install some application with two non-empty arguments in the KHelpClient::invokeHelp call (e.g. Kalzium from git/master).
  2. Open a page with the "Help" button (Tools -> Perform Calculation in Kalzium). Push the button.
  3. The corresponding page of the manual should be opened.

Diff Detail

Repository
R265 KConfigWidgets
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
yurchor created this revision.Oct 21 2018, 11:27 AM
Restricted Application added a project: Frameworks. · View Herald TranscriptOct 21 2018, 11:27 AM
Restricted Application added a subscriber: kde-frameworks-devel. · View Herald Transcript
yurchor requested review of this revision.Oct 21 2018, 11:27 AM
yurchor updated this revision to Diff 44126.Oct 23 2018, 6:39 PM

Save some clazy's kittens by using overloaded arg().

mlaurent accepted this revision.Oct 24 2018, 5:00 AM
mlaurent added a subscriber: mlaurent.

seems ok for me

This revision is now accepted and ready to land.Oct 24 2018, 5:00 AM
This revision was automatically updated to reflect the committed changes.