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

Yuri Chornoivan noreply at phabricator.kde.org
Sun Oct 21 12:27:51 BST 2018


yurchor created this revision.
yurchor added reviewers: Documentation, Frameworks.
Herald added a project: Frameworks.
Herald added a subscriber: kde-frameworks-devel.
yurchor requested review of this revision.

REVISION 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.

REPOSITORY
  R265 KConfigWidgets

REVISION DETAIL
  https://phabricator.kde.org/D16350

AFFECTED FILES
  src/khelpclient.cpp

To: yurchor, #documentation, #frameworks
Cc: kde-frameworks-devel, michaelh, ngraham, bruns
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-doc-english/attachments/20181021/7e7b3bb1/attachment.html>


More information about the kde-doc-english mailing list